Box2D  3.0.0
A Real-Time-Oriented 2-D Physics Engine
Public Member Functions | List of all members
box2d::WeldJoint Class Reference

A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate. More...

#include <WeldJoint.hpp>

Inheritance diagram for box2d::WeldJoint:
box2d::Joint

Public Member Functions

 WeldJoint (const WeldJointDef &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...
 
Angle GetReferenceAngle () const
 Get the reference angle. More...
 
void SetFrequency (Frequency hz)
 Set/get frequency in Hz. More...
 
Frequency GetFrequency () const
 
void SetDampingRatio (RealNum ratio)
 Set/get damping ratio. More...
 
RealNum GetDampingRatio () const
 
- Public Member Functions inherited from box2d::Joint
JointType GetType () const noexcept
 Get the type of the concrete joint. More...
 
BodyGetBodyA () noexcept
 Get the first body attached to this joint. More...
 
BodyGetBodyB () noexcept
 Get the second body attached to this joint. More...
 
const BodyGetBodyA () const noexcept
 Get the first body attached to this joint. More...
 
const BodyGetBodyB () 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

A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate.

Constructor & Destructor Documentation

◆ WeldJoint()

WeldJoint::WeldJoint ( const WeldJointDef def)

Member Function Documentation

◆ GetAnchorA()

Length2D WeldJoint::GetAnchorA ( ) const
overridevirtual

Get the anchor point on bodyA in world coordinates.

Implements box2d::Joint.

◆ GetAnchorB()

Length2D WeldJoint::GetAnchorB ( ) const
overridevirtual

Get the anchor point on bodyB in world coordinates.

Implements box2d::Joint.

◆ GetDampingRatio()

RealNum box2d::WeldJoint::GetDampingRatio ( ) const
inline

◆ GetFrequency()

Frequency box2d::WeldJoint::GetFrequency ( ) const
inline

◆ GetLocalAnchorA()

Length2D box2d::WeldJoint::GetLocalAnchorA ( ) const
inline

The local anchor point relative to bodyA's origin.

◆ GetLocalAnchorB()

Length2D box2d::WeldJoint::GetLocalAnchorB ( ) const
inline

The local anchor point relative to bodyB's origin.

◆ GetReactionForce()

Force2D WeldJoint::GetReactionForce ( Frequency  inv_dt) const
overridevirtual

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

Implements box2d::Joint.

◆ GetReactionTorque()

Torque WeldJoint::GetReactionTorque ( Frequency  inv_dt) const
overridevirtual

Get the reaction torque on bodyB in N*m.

Implements box2d::Joint.

◆ GetReferenceAngle()

Angle box2d::WeldJoint::GetReferenceAngle ( ) const
inline

Get the reference angle.

◆ SetDampingRatio()

void box2d::WeldJoint::SetDampingRatio ( RealNum  ratio)
inline

Set/get damping ratio.

◆ SetFrequency()

void box2d::WeldJoint::SetFrequency ( Frequency  hz)
inline

Set/get frequency in Hz.


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