MOAIBox2DWheelJoint Class Reference

Inheritance diagram for MOAIBox2DWheelJoint:

Function List
	getJointTranslation
	getJointSpeed
	isMotorEnabled
	getMotorSpeed
	getSpringDampingRatio
	getMaxMotorTorque
	getMotorTorque
	getSpringFrequencyHz
	setMotor
	setMotorSpeed
	setMotorEnabled
	setMaxMotorTorque
	setSpringDampingRatio
	setSpringFrequencyHz

Additional Inherited Members
Function List inherited from MOAIBox2DJoint
	destroy
	getAnchorA
	getAnchorB
	getBodyA
	getBodyB
	getReactionForce
	getReactionTorque

Function Documentation

getJointSpeed

See Box2D documentation.

---

function getJointSpeed ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number jointSpeed

getJointTranslation

See Box2D documentation.

---

function getJointTranslation ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number jointTranslation

getMaxMotorTorque

See Box2D documentation.

---

function getMaxMotorTorque ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number maxMotorTorque

getMotorSpeed

See Box2D documentation.

---

function getMotorSpeed ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number motorSpeed

getMotorTorque

See Box2D documentation.

---

function getMotorTorque ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number torque

getSpringDampingRatio

See Box2D documentation.

---

function getSpringDampingRatio ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number dampingRatio

getSpringFrequencyHz

See Box2D documentation.

---

function getSpringFrequencyHz ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

number springFrequency

isMotorEnabled

See Box2D documentation.

---

function isMotorEnabled ( MOAIBox2DWheelJoint self )

Parameters

MOAIBox2DWheelJoint

self

Returns

boolean motorEnabled

setMaxMotorTorque

See Box2D documentation.

---

function setMaxMotorTorque ( MOAIBox2DWheelJoint self [, number maxMotorTorque ] )

Parameters

MOAIBox2DWheelJoint	self
number	maxMotorTorque Optional. in (kg * units / s^2) * units, converted to N-m. Default value is 0.

Returns

nil

setMotor

See Box2D documentation. If speed is determined to be zero, the motor is disabled, unless forceEnable is set.

---

function setMotor ( MOAIBox2DWheelJoint self [, number speed, number maxMotorTorque, boolean forceEnable ] )

Parameters

MOAIBox2DWheelJoint	self
number	speed Optional. in degrees/s, converted to radians/s. Default value is 0.
number	maxMotorTorque Optional. in (kg * units / s^2) * units, converted from N-m. Default value is 0.
boolean	forceEnable Optional. Default value is false.

Returns

nil

setMotorEnabled

See Box2D documentation.

---

function setMotorEnabled ( MOAIBox2DWheelJoint self [, boolean enabled ] )

Parameters

MOAIBox2DWheelJoint	self
boolean	enabled Optional. Default value is 'true'

Returns

nil

setMotorSpeed

See Box2D documentation.

---

function setMotorSpeed ( MOAIBox2DWheelJoint self [, number motorSpeed ] )

Parameters

MOAIBox2DWheelJoint	self
number	motorSpeed Optional. in degrees/s, converted to radians/s. Default value is 0.

Returns

nil

setSpringDampingRatio

See Box2D documentation.

---

function setSpringDampingRatio ( MOAIBox2DWheelJoint self [, number dampingRatio ] )

Parameters

MOAIBox2DWheelJoint	self
number	dampingRatio Optional. Default value is 0.

Returns

nil

setSpringFrequencyHz

See Box2D documentation.

---

function setSpringFrequencyHz ( MOAIBox2DWheelJoint self [, number springFrequencyHz ] )

Parameters

MOAIBox2DWheelJoint	self
number	springFrequencyHz Optional. in Hz. Default value is 0.

Returns

nil