box2d::FrictionJoint Class Reference

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

#include <FrictionJoint.hpp>

Inheritance diagram for box2d::FrictionJoint:

Public Member Functions
	FrictionJoint (const FrictionJointDef &def)
Length2D	GetAnchorA () const override
	Get the anchor point on bodyA in world coordinates. More...
Length2D	GetAnchorB () const override
	Get the anchor point on bodyB in world coordinates. More...
Force2D	GetReactionForce (Frequency inv_dt) const override
	Get the reaction force on bodyB at the joint anchor in Newtons. More...
Torque	GetReactionTorque (Frequency inv_dt) const override
	Get the reaction torque on bodyB in N*m. More...
Length2D	GetLocalAnchorA () const
	The local anchor point relative to bodyA's origin. More...
Length2D	GetLocalAnchorB () const
	The local anchor point relative to bodyB's origin. More...
void	SetMaxForce (Force force)
	Set the maximum friction force in N. More...
Force	GetMaxForce () const
	Get the maximum friction force in N. More...
void	SetMaxTorque (Torque torque)
	Set the maximum friction torque in N*m. More...
Torque	GetMaxTorque () const
	Get the maximum friction torque in N*m. More...
Public Member Functions inherited from box2d::Joint
JointType	GetType () const noexcept
	Get the type of the concrete joint. More...
Body *	GetBodyA () noexcept
	Get the first body attached to this joint. More...
Body *	GetBodyB () noexcept
	Get the second body attached to this joint. More...
const Body *	GetBodyA () const noexcept
	Get the first body attached to this joint. More...
const Body *	GetBodyB () const noexcept
	Get the second body attached to this joint. More...
void *	GetUserData () const noexcept
	Get the user data pointer. More...
void	SetUserData (void *data) noexcept
	Set the user data pointer. More...
bool	GetCollideConnected () const noexcept
	Get collide connected. Note: modifying the collide connect flag won't work correctly because the flag is only checked when fixture AABBs begin to overlap. More...
virtual void	ShiftOrigin (const Length2D newOrigin)
	Shift the origin for any points stored in world coordinates. More...

Additional Inherited Members
Public Types inherited from box2d::Joint
enum	LimitState { e_inactiveLimit, e_atLowerLimit, e_atUpperLimit, e_equalLimits }
using	index_t = size_t
Static Public Member Functions inherited from box2d::Joint
static bool	IsOkay (const JointDef &def) noexcept
Protected Member Functions inherited from box2d::Joint
	Joint (const JointDef &def)
virtual	~Joint () noexcept
void	SetBodyA (Body *value) noexcept
void	SetBodyB (Body *value) noexcept

Detailed Description

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

Constructor & Destructor Documentation

FrictionJoint()

FrictionJoint::FrictionJoint

(

const FrictionJointDef &

def

)

Member Function Documentation

GetAnchorA()

Length2D FrictionJoint::GetAnchorA ( ) const

overridevirtual

Get the anchor point on bodyA in world coordinates.

Implements box2d::Joint.

GetAnchorB()

Length2D FrictionJoint::GetAnchorB ( ) const

overridevirtual

Get the anchor point on bodyB in world coordinates.

Implements box2d::Joint.

GetLocalAnchorA()

Length2D box2d::FrictionJoint::GetLocalAnchorA ( ) const

inline

The local anchor point relative to bodyA's origin.

GetLocalAnchorB()

Length2D box2d::FrictionJoint::GetLocalAnchorB ( ) const

inline

The local anchor point relative to bodyB's origin.

GetMaxForce()

Force FrictionJoint::GetMaxForce

(

)

const

Get the maximum friction force in N.

GetMaxTorque()

Torque FrictionJoint::GetMaxTorque

(

)

const

Get the maximum friction torque in N*m.

GetReactionForce()

Force2D FrictionJoint::GetReactionForce ( Frequency  inv_dt ) const

overridevirtual

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

Implements box2d::Joint.

GetReactionTorque()

Torque FrictionJoint::GetReactionTorque ( Frequency  inv_dt ) const

overridevirtual

Get the reaction torque on bodyB in N*m.

Implements box2d::Joint.

SetMaxForce()

void FrictionJoint::SetMaxForce

(

Force

force

)

Set the maximum friction force in N.

SetMaxTorque()

void FrictionJoint::SetMaxTorque

(

Torque

torque

)

Set the maximum friction torque in N*m.

---

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

• FrictionJoint.hpp
• FrictionJoint.cpp