Main   GitHub

Methods | Fields | List of all members
PointForceController Class Reference

Inherits PickingSceneController, and PickingSceneController.

Methods

string PointForceController ()
 
string PointForceController ()
 
float getAngularDrag ()
 
float getAngularDrag ()
 
float getForce ()
 
float getForce ()
 
float getLinearDrag ()
 
float getLinearDrag ()
 
bool getNonLinear ()
 
bool getNonLinear ()
 
float getRadius ()
 
float getRadius ()
 
string getTrackedObject ()
 
string getTrackedObject ()
 
void setAngularDrag (angularDrag)
 
void setAngularDrag (angularDrag)
 
void setForce (force)
 
void setForce (force)
 
void setLinearDrag (linearDrag)
 
void setLinearDrag (linearDrag)
 
void setNonLinear (nonLinear)
 
void setNonLinear (nonLinear)
 
void setPosition (float x, float y)
 
void setPosition (float x, float y)
 
void setRadius (radius)
 
void setRadius (radius)
 
void setTrackedObject (sceneObject)
 
void setTrackedObject (sceneObject)
 
- Methods inherited from PickingSceneController
string getControlGroups ()
 
string getControlGroups ()
 
string getControlLayers ()
 
string getControlLayers ()
 
void setControlGroups (groups $)
 
void setControlGroups (groups $)
 
void setControlLayers (layers $)
 
void setControlLayers (layers $)
 
- Methods inherited from SimObject
void addFieldFilter (fieldName)
 
void addFieldFilter (fieldName)
 
string call (%args)
 
string call (%args)
 
int clone ([bool copyDynamicFields?=false])
 
int clone ([bool copyDynamicFields?=false])
 
void delete ()
 
void delete ()
 
void dump ()
 
void dump ()
 
void dumpClassHierarchy ()
 
void dumpClassHierarchy ()
 
string getClassName ()
 
string getClassName ()
 
string getClassNamespace ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
int getDynamicFieldCount ()
 
string getField (int index)
 
string getField (int index)
 
int getFieldCount ()
 
int getFieldCount ()
 
string getFieldType (fieldName)
 
string getFieldType (fieldName)
 
string getFieldValue (fieldName)
 
string getFieldValue (fieldName)
 
int getGroup ()
 
int getGroup ()
 
int getId ()
 
int getId ()
 
string getInternalName ()
 
string getInternalName ()
 
string getName ()
 
string getName ()
 
string getProgenitorFile ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
string getSuperClassNamespace ()
 
int getType ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMemberOfClass (string classname)
 
bool isMethod (string method name)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool isTimerActive ()
 
void removeFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 
bool save (fileName,[selectedOnly])
 
bool save (fileName,[selectedOnly])
 
int schedule (time, command,< arg1...argN >)
 
int schedule (time, command,< arg1...argN >)
 
void setClassNamespace ()
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
bool setFieldValue (fieldName, value)
 
void setInternalName ()
 
void setInternalName ()
 
void setName (newName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
void stopTimer ()
 
void stopTimer ()
 

Fields

float AngularDrag
 
float Force
 
float LinearDrag
 
bool NonLinear
 
Vector2 Position
 
float Radius
 
SimBase
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
Namespace Linking
string superclass
 
string class
 
- Fields inherited from PickingSceneController
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Constructor & Destructor Documentation

string PointForceController::PointForceController ( )

Gets the position of the force center.

Returns
(float x/float y) The x and y (horizontal and vertical) position of the force center.
string PointForceController::PointForceController ( )

Gets the position of the force center.

Returns
(float x/float y) The x and y (horizontal and vertical) position of the force center.

Methods

float PointForceController::getAngularDrag ( )

Gets the angular drag coefficient.

Returns
The angular drag coefficient.
float PointForceController::getAngularDrag ( )

Gets the angular drag coefficient.

Returns
The angular drag coefficient.
float PointForceController::getForce ( )

Gets the point force being used.

Returns
The point force being used.
float PointForceController::getForce ( )

Gets the point force being used.

Returns
The point force being used.
float PointForceController::getLinearDrag ( )

Gets the linear drag coefficient.

Returns
The linear drag coefficient.
float PointForceController::getLinearDrag ( )

Gets the linear drag coefficient.

Returns
The linear drag coefficient.
bool PointForceController::getNonLinear ( )

Gets whether to apply the force non-linearly (using the inverse square law) or linearly.

Returns
Whether to apply the force non-linearly (using the inverse square law) or linearly.
bool PointForceController::getNonLinear ( )

Gets whether to apply the force non-linearly (using the inverse square law) or linearly.

Returns
Whether to apply the force non-linearly (using the inverse square law) or linearly.
float PointForceController::getRadius ( )

Gets the radius of the point force being used.

Returns
The radius of the point force being used.
float PointForceController::getRadius ( )

Gets the radius of the point force being used.

Returns
The radius of the point force being used.
string PointForceController::getTrackedObject ( )
  • Gets the scene object from which the position will be tracked.
    Returns
    The scene object from which the position will be tracked or an empty string if nothing is being tracked.
string PointForceController::getTrackedObject ( )
  • Gets the scene object from which the position will be tracked.
    Returns
    The scene object from which the position will be tracked or an empty string if nothing is being tracked.
void PointForceController::setAngularDrag ( angularDrag  )
  • Sets the angular drag coefficient (0.0 to 1.0).
    Parameters
    angularDragThe angular drag coefficient
    Returns
    No return value.
void PointForceController::setAngularDrag ( angularDrag  )
  • Sets the angular drag coefficient (0.0 to 1.0).
    Parameters
    angularDragThe angular drag coefficient
    Returns
    No return value.
void PointForceController::setForce ( force  )
  • Sets the point force to use.
    Parameters
    forceThe point force to use.
    Returns
    No return value.
void PointForceController::setForce ( force  )
  • Sets the point force to use.
    Parameters
    forceThe point force to use.
    Returns
    No return value.
void PointForceController::setLinearDrag ( linearDrag  )
  • Sets the linear drag coefficient (0.0 to 1.0).
    Parameters
    linearDragThe linear drag coefficient
    Returns
    No return value.
void PointForceController::setLinearDrag ( linearDrag  )
  • Sets the linear drag coefficient (0.0 to 1.0).
    Parameters
    linearDragThe linear drag coefficient
    Returns
    No return value.
void PointForceController::setNonLinear ( nonLinear  )
  • Sets whether to apply the force non-linearly (using the inverse square law) or linearly.
    Parameters
    nonLinearwhether to apply the force non-linearly (using the inverse square law) or linearly.
    Returns
    No return value.
void PointForceController::setNonLinear ( nonLinear  )
  • Sets whether to apply the force non-linearly (using the inverse square law) or linearly.
    Parameters
    nonLinearwhether to apply the force non-linearly (using the inverse square law) or linearly.
    Returns
    No return value.
void PointForceController::setPosition ( float  x,
float  y 
)
  • Sets the position of the force center.
    Parameters
    xThe position along the horizontal axis.
    yThe position along the vertical axis.
    Returns
    No return value.
void PointForceController::setPosition ( float  x,
float  y 
)
  • Sets the position of the force center.
    Parameters
    xThe position along the horizontal axis.
    yThe position along the vertical axis.
    Returns
    No return value.
void PointForceController::setRadius ( radius  )
  • Sets the radius of the point force to use.
    Parameters
    radiusThe radius of the point force to use.
    Returns
    No return value.
void PointForceController::setRadius ( radius  )
  • Sets the radius of the point force to use.
    Parameters
    radiusThe radius of the point force to use.
    Returns
    No return value.
void PointForceController::setTrackedObject ( sceneObject  )
  • Sets a scene object from which the position will be tracked.
    Parameters
    sceneObjectThe scene object from which the position will be tracked. An empty string will stop tracking.
    Returns
    No return value.
void PointForceController::setTrackedObject ( sceneObject  )
  • Sets a scene object from which the position will be tracked.
    Parameters
    sceneObjectThe scene object from which the position will be tracked. An empty string will stop tracking.
    Returns
    No return value.

Member Data Documentation

float PointForceController::AngularDrag

The angular drag co-efficient for the fluid.

bool PointForceController::canSaveDynamicFields
string PointForceController::class

Script SuperClass of object.

float PointForceController::Force

The force to apply to attact to the controller position.

string PointForceController::internalName
float PointForceController::LinearDrag

The linear drag co-efficient for the fluid.

bool PointForceController::NonLinear

Whether to apply the force non-linearly (using the inverse square law) or linearly.

SimObjectPtr PointForceController::parentGroup

Group hierarchy parent of the object.

Vector2 PointForceController::Position

The position of the attractor controller.

float PointForceController::Radius

The radius of the attractor circle centered on the attractors position.

string PointForceController::superclass

Script Class of object.



Copyright © 2013 GarageGames, LLC. All Rights Reserved.