Moai SDK  2.0
Function List | List of all members
MOAIBox2DMouseJoint Class Reference
Moai Box2d
+ Inheritance diagram for MOAIBox2DMouseJoint:

Function List

getDampingRatio
 
getFrequency
 
getMaxForce
 
getTarget
 
setDampingRatio
 
setFrequency
 
setMaxForce
 
setTarget
 

Additional Inherited Members

- Function List inherited from MOAIBox2DJoint
destroy
 
getAnchorA
 
getAnchorB
 
getBodyA
 
getBodyB
 
getReactionForce
 
getReactionTorque
 

Function Documentation

getDampingRatio

See Box2D documentation.

function getDampingRatio ( MOAIBox2DMouseJoint self )

Parameters
MOAIBox2DMouseJointself
Returns
number dampingRatio
getFrequency

See Box2D documentation.

function getFrequency ( MOAIBox2DMouseJoint self )

Parameters
MOAIBox2DMouseJointself
Returns
number frequency
getMaxForce

See Box2D documentation.

function getMaxForce ( MOAIBox2DMouseJoint self )

Parameters
MOAIBox2DMouseJointself
Returns
number maxForce
getTarget

See Box2D documentation.

function getTarget ( MOAIBox2DMouseJoint self )

Parameters
MOAIBox2DMouseJointself
Returns
number x, number y
setDampingRatio

See Box2D documentation.

function setDampingRatio ( MOAIBox2DMouseJoint self [, number dampingRatio ] )

Parameters
MOAIBox2DMouseJointself
numberdampingRatio Optional. Default value is 0.
Returns
nil
setFrequency

See Box2D documentation.

function setFrequency ( MOAIBox2DMouseJoint self [, number frequency ] )

Parameters
MOAIBox2DMouseJointself
numberfrequency Optional. in Hz. Default value is 0.
Returns
nil
setMaxForce

See Box2D documentation.

function setMaxForce ( MOAIBox2DMouseJoint self [, number maxForce ] )

Parameters
MOAIBox2DMouseJointself
numbermaxForce Optional. in kg * units / s^2 converted to N [kg * m / s^2]. Default value is 0.
Returns
nil
setTarget

See Box2D documentation.

function setTarget ( MOAIBox2DMouseJoint self [, number x, number y ] )

Parameters
MOAIBox2DMouseJointself
numberx Optional. in units, world coordinates, converted to meters. Default value is 0.
numbery Optional. in units, world coordinates, converted to meters. Default value is 0.
Returns
nil