PointForceController Class Reference

Inherits PickingSceneController.

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

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static S32 QSORT_CALLBACK	compareFields (const void *a, const void *b)

Constructor & Destructor Documentation

string 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.

Member Function Documentation

float getAngularDrag

(

)

Gets the angular drag coefficient.

Returns

The angular drag coefficient.

float getForce

(

)

Gets the point force being used.

Returns

The point force being used.

float getLinearDrag

(

)

Gets the linear drag coefficient.

Returns

The linear drag coefficient.

bool 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 getRadius

(

)

Gets the radius of the point force being used.

Returns

The radius of the point force being used.

string 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 setAngularDrag

(

angularDrag

)

Sets the angular drag coefficient (0.0 to 1.0).

Parameters

angularDrag

The angular drag coefficient

Returns

No return value.

void setForce

(

force

)

Sets the point force to use.

Parameters

force

The point force to use.

Returns

No return value.

void setLinearDrag

(

linearDrag

)

Sets the linear drag coefficient (0.0 to 1.0).

Parameters

linearDrag

The linear drag coefficient

Returns

No return value.

void setNonLinear

(

nonLinear

)

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

Parameters

nonLinear

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

Returns

No return value.

void setPosition	(	float	x,
		float	y
	)

Sets the position of the force center.

Parameters

x	The position along the horizontal axis.
y	The position along the vertical axis.

Returns

No return value.

void setRadius

(

radius

)

Sets the radius of the point force to use.

Parameters

radius

The radius of the point force to use.

Returns

No return value.

void setTrackedObject

(

sceneObject

)

Sets a scene object from which the position will be tracked.

Parameters

sceneObject

The scene object from which the position will be tracked. An empty string will stop tracking.

Returns

No return value.