b2FrictionJoint Class Reference

#include <b2_friction_joint.h>

Inheritance diagram for b2FrictionJoint:

Public Member Functions
b2Vec2	GetAnchorA () const override
	Get the anchor point on bodyA in world coordinates. More...
b2Vec2	GetAnchorB () const override
	Get the anchor point on bodyB in world coordinates. More...
b2Vec2	GetReactionForce (float inv_dt) const override
	Get the reaction force on bodyB at the joint anchor in Newtons. More...
float	GetReactionTorque (float inv_dt) const override
	Get the reaction torque on bodyB in N*m. More...
const b2Vec2 &	GetLocalAnchorA () const
	The local anchor point relative to bodyA's origin.
const b2Vec2 &	GetLocalAnchorB () const
	The local anchor point relative to bodyB's origin.
void	SetMaxForce (float force)
	Set the maximum friction force in N.
float	GetMaxForce () const
	Get the maximum friction force in N.
void	SetMaxTorque (float torque)
	Set the maximum friction torque in N*m.
float	GetMaxTorque () const
	Get the maximum friction torque in N*m.
void	Dump () override
	Dump joint to dmLog. More...
Public Member Functions inherited from b2Joint
b2JointType	GetType () const
	Get the type of the concrete joint.
b2Body *	GetBodyA ()
	Get the first body attached to this joint.
b2Body *	GetBodyB ()
	Get the second body attached to this joint.
virtual b2Vec2	GetAnchorA () const =0
	Get the anchor point on bodyA in world coordinates. More...
virtual b2Vec2	GetAnchorB () const =0
	Get the anchor point on bodyB in world coordinates. More...
virtual b2Vec2	GetReactionForce (float inv_dt) const =0
	Get the reaction force on bodyB at the joint anchor in Newtons. More...
virtual float	GetReactionTorque (float inv_dt) const =0
	Get the reaction torque on bodyB in N*m. More...
b2Joint *	GetNext ()
	Get the next joint the world joint list.
const b2Joint *	GetNext () const
b2JointUserData &	GetUserData ()
	Get the user data pointer.
bool	IsEnabled () const
	Short-cut function to determine if either body is enabled.
bool	GetCollideConnected () const
virtual void	Dump ()
	Dump this joint to the log file. More...
virtual void	ShiftOrigin (const b2Vec2 &newOrigin)
	Shift the origin for any points stored in world coordinates. More...
virtual void	Draw (b2Draw *draw) const
	Debug draw this joint. More...

Protected Member Functions
	b2FrictionJoint (const b2FrictionJointDef *def)
void	InitVelocityConstraints (const b2SolverData &data) override
void	SolveVelocityConstraints (const b2SolverData &data) override
bool	SolvePositionConstraints (const b2SolverData &data) override
Protected Member Functions inherited from b2Joint
	b2Joint (const b2JointDef *def)
virtual void	InitVelocityConstraints (const b2SolverData &data)=0
virtual void	SolveVelocityConstraints (const b2SolverData &data)=0
virtual bool	SolvePositionConstraints (const b2SolverData &data)=0

Protected Attributes
b2Vec2	m_localAnchorA
b2Vec2	m_localAnchorB
b2Vec2	m_linearImpulse
float	m_angularImpulse
float	m_maxForce
float	m_maxTorque
int32	m_indexA
int32	m_indexB
b2Vec2	m_rA
b2Vec2	m_rB
b2Vec2	m_localCenterA
b2Vec2	m_localCenterB
float	m_invMassA
float	m_invMassB
float	m_invIA
float	m_invIB
b2Mat22	m_linearMass
float	m_angularMass
Protected Attributes inherited from b2Joint
b2JointType	m_type
b2Joint *	m_prev
b2Joint *	m_next
b2JointEdge	m_edgeA
b2JointEdge	m_edgeB
b2Body *	m_bodyA
b2Body *	m_bodyB
int32	m_index
bool	m_islandFlag
bool	m_collideConnected
b2JointUserData	m_userData

Friends
class	b2Joint

Additional Inherited Members
Static Protected Member Functions inherited from b2Joint
static b2Joint *	Create (const b2JointDef *def, b2BlockAllocator *allocator)
static void	Destroy (b2Joint *joint, b2BlockAllocator *allocator)

Detailed Description

Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction.

Member Function Documentation

Dump()

void b2FrictionJoint::Dump ( )

overridevirtual

Dump joint to dmLog.

Reimplemented from b2Joint.

GetAnchorA()

b2Vec2 b2FrictionJoint::GetAnchorA ( ) const

overridevirtual

Get the anchor point on bodyA in world coordinates.

Implements b2Joint.

GetAnchorB()

b2Vec2 b2FrictionJoint::GetAnchorB ( ) const

overridevirtual

Get the anchor point on bodyB in world coordinates.

Implements b2Joint.

GetReactionForce()

b2Vec2 b2FrictionJoint::GetReactionForce ( float  inv_dt ) const

overridevirtual

Get the reaction force on bodyB at the joint anchor in Newtons.

Implements b2Joint.

GetReactionTorque()

float b2FrictionJoint::GetReactionTorque ( float  inv_dt ) const

overridevirtual

Get the reaction torque on bodyB in N*m.

Implements b2Joint.

InitVelocityConstraints()

void b2FrictionJoint::InitVelocityConstraints ( const b2SolverData &  data )

overrideprotectedvirtual

Implements b2Joint.

SolvePositionConstraints()

bool b2FrictionJoint::SolvePositionConstraints ( const b2SolverData &  data )

overrideprotectedvirtual

Implements b2Joint.

SolveVelocityConstraints()

void b2FrictionJoint::SolveVelocityConstraints ( const b2SolverData &  data )

overrideprotectedvirtual

Implements b2Joint.

---

The documentation for this class was generated from the following file:

• include/box2d/b2_friction_joint.h