Package org.jbox2d.dynamics.joints

Class FrictionJoint

java.lang.Object

org.jbox2d.dynamics.joints.Joint

org.jbox2d.dynamics.joints.FrictionJoint

public class FrictionJoint
extends Joint

Author:

Daniel Murphy

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h

Github: erincatto/box2d src/dynamics/b2_friction_joint.cpp

Field Summary

Fields inherited from class org.jbox2d.dynamics.joints.Joint

bodyA, bodyB, edgeA, edgeB, islandFlag, next, pool, prev, userData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FrictionJoint(WorldPool argWorldPool, FrictionJointDef def)

Method Summary

Modifier and Type	Method	Description
void	getAnchorA(Vec2 argOut)	Get the anchor point on bodyA in world coordinates.
void	getAnchorB(Vec2 argOut)	Get the anchor point on bodyB in world coordinates.
Vec2	getLocalAnchorA()	Get the local anchor point relative to bodyA's origin.
Vec2	getLocalAnchorB()	Get the local anchor point relative to bodyB's origin.
float	getMaxForce()	Get the maximum friction force in N.
float	getMaxTorque()	Get the maximum friction torque in N*m.
void	getReactionForce(float invDt, Vec2 argOut)	Get the reaction force on body2 at the joint anchor in Newtons.
float	getReactionTorque(float invDt)	Get the reaction torque on body2 in N*m.
void	initVelocityConstraints(SolverData data)	Internal
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 org.jbox2d.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 Details

FrictionJoint

protected FrictionJoint(WorldPool argWorldPool,
 FrictionJointDef def)

Method Details

getLocalAnchorA

public Vec2 getLocalAnchorA()

Get the local anchor point relative to bodyA's origin.

Returns:

The local anchor point relative to bodyA's origin.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 69 - 70

getLocalAnchorB

public Vec2 getLocalAnchorB()

Get the local anchor point relative to bodyB's origin.

Returns:

The local anchor point relative to bodyB's origin.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 72 - 73

getAnchorA

public void getAnchorA(Vec2 argOut)

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 argOut)

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 invDt,
 Vec2 argOut)

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 invDt)

Description copied from class: Joint

Get the reaction torque on body2 in N*m.

Specified by:

getReactionTorque in class Joint

setMaxForce

public void setMaxForce(float force)

Set the maximum friction force in N.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 75 - 76

getMaxForce

public float getMaxForce()

Get the maximum friction force in N.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 78 - 79

setMaxTorque

public void setMaxTorque(float torque)

Set the maximum friction torque in N*m.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 81 - 82

getMaxTorque

public float getMaxTorque()

Get the maximum friction torque in N*m.

Repolink:

Github: erincatto/box2d include/box2d/b2_friction_joint.h Lines 84 - 85

initVelocityConstraints

public void initVelocityConstraints(SolverData data)

Description copied from class: Joint

Internal

Specified by:

initVelocityConstraints in class Joint

See Also:

• Joint.initVelocityConstraints(org.jbox2d.dynamics.SolverData)

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