com.almasb.fxgl.physics.box2d.dynamics.joints

Class MotorJoint

java.lang.Object

com.almasb.fxgl.physics.box2d.dynamics.joints.Joint

com.almasb.fxgl.physics.box2d.dynamics.joints.MotorJoint

public class MotorJoint
extends Joint

A motor joint is used to control the relative motion between two bodies. A typical usage is to control the movement of a dynamic body with respect to the ground.

Author:

dmurph

Field Summary

Fields inherited from class com.almasb.fxgl.physics.box2d.dynamics.joints.Joint

m_bodyA, m_bodyB, m_edgeA, m_edgeB, m_islandFlag, m_next, m_prev, m_userData, pool

Constructor Summary

Constructors

Constructor and Description
MotorJoint(IWorldPool pool, MotorJointDef def)

Method Summary

Modifier and Type	Method and Description
void	getAnchorA(Vec2 out) get the anchor point on bodyA in world coordinates.
void	getAnchorB(Vec2 out) get the anchor point on bodyB in world coordinates.
float	getAngularOffset()
float	getCorrectionFactor()
Vec2	getLinearOffset() Get the target linear offset, in frame A, in meters.
void	getLinearOffset(Vec2 out) Get the target linear offset, in frame A, in meters.
float	getMaxForce() Get the maximum friction force in N.
float	getMaxTorque() Get the maximum friction torque in N*m.
void	getReactionForce(float inv_dt, Vec2 out) get the reaction force on body2 at the joint anchor in Newtons.
float	getReactionTorque(float inv_dt) get the reaction torque on body2 in N*m.
void	initVelocityConstraints(SolverData data) Internal
void	setAngularOffset(float angularOffset) Set the target angular offset, in radians.
void	setCorrectionFactor(float correctionFactor)
void	setLinearOffset(Vec2 linearOffset) Set the target linear offset, in frame A, in meters.
void	setMaxForce(float force) Set the maximum friction force in N.
void	setMaxTorque(float torque) Set the maximum friction torque in N*m.
boolean	solvePositionConstraints(SolverData data) This returns true if the position errors are within tolerance.
void	solveVelocityConstraints(SolverData data) Internal

Methods inherited from class com.almasb.fxgl.physics.box2d.dynamics.joints.Joint

create, destroy, destructor, getBodyA, getBodyB, getCollideConnected, getNext, getType, getUserData, isActive, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MotorJoint

public MotorJoint(IWorldPool pool,
                  MotorJointDef def)

Method Detail

getAnchorA

public void getAnchorA(Vec2 out)

Description copied from class: Joint

get the anchor point on bodyA in world coordinates.

Specified by:

getAnchorA in class Joint

getAnchorB

public void getAnchorB(Vec2 out)

Description copied from class: Joint

get the anchor point on bodyB in world coordinates.

Specified by:

getAnchorB in class Joint

getReactionForce

public void getReactionForce(float inv_dt,
                             Vec2 out)

Description copied from class: Joint

get the reaction force on body2 at the joint anchor in Newtons.

Specified by:

getReactionForce in class Joint

getReactionTorque

public float getReactionTorque(float inv_dt)

Description copied from class: Joint

get the reaction torque on body2 in N*m.

Specified by:

getReactionTorque in class Joint

Returns:

getCorrectionFactor

public float getCorrectionFactor()

setCorrectionFactor

public void setCorrectionFactor(float correctionFactor)

setLinearOffset

public void setLinearOffset(Vec2 linearOffset)

Set the target linear offset, in frame A, in meters.

getLinearOffset

public void getLinearOffset(Vec2 out)

Get the target linear offset, in frame A, in meters.

getLinearOffset

public Vec2 getLinearOffset()

Get the target linear offset, in frame A, in meters. Do not modify.

setAngularOffset

public void setAngularOffset(float angularOffset)

Set the target angular offset, in radians.

Parameters:

angularOffset -

getAngularOffset

public float getAngularOffset()

setMaxForce

public void setMaxForce(float force)

Set the maximum friction force in N.

Parameters:

force -

getMaxForce

public float getMaxForce()

Get the maximum friction force in N.

setMaxTorque

public void setMaxTorque(float torque)

Set the maximum friction torque in N*m.

getMaxTorque

public float getMaxTorque()

Get the maximum friction torque in N*m.

initVelocityConstraints

public void initVelocityConstraints(SolverData data)

Description copied from class: Joint

Internal

Specified by:

initVelocityConstraints in class Joint

solveVelocityConstraints

public void solveVelocityConstraints(SolverData data)

Description copied from class: Joint

Internal

Specified by:

solveVelocityConstraints in class Joint

solvePositionConstraints

public boolean solvePositionConstraints(SolverData data)

Description copied from class: Joint

This returns true if the position errors are within tolerance. Internal.

Specified by:

solvePositionConstraints in class Joint