Box2D.Joint Class Reference

Joints allow you to connect rigid bodies together while allowing various forms of relative motions. More...

Inheritance diagram for Box2D.Joint:

Public Member Functions
unsafe void	Destroy ()
	Destroys this joint.
unsafe void	WakeBodies ()
	Wakes the bodies connected to this joint.
	unsafe (float hertz, float dampingRatio) ConstraintTuning
	Gets or sets the joint constraint tuning in Hertz and damping ratio. Advanced feature.

Properties
unsafe bool	Valid [get]
	Checks if this joint is valid.
unsafe JointType	Type [get]
	Gets the joint type.
unsafe Body	BodyA [get]
	Gets body A on this joint.
unsafe Body	BodyB [get]
	Gets body B on this joint.
unsafe World	World [get]
	Gets the world that owns this joint.
unsafe Vec2	LocalAnchorA [get, set]
	The local anchor on body A.
unsafe Vec2	LocalAnchorB [get, set]
	The local anchor on body B.
unsafe bool	CollideConnected [get, set]
	Set this flag to true if the attached bodies should collide.
unsafe? object	UserData [get, set]
	The user data object for this joint.
unsafe Vec2	ConstraintForce [get]
	Gets the current constraint force for this joint.
unsafe float	ConstraintTorque [get]
	Gets the current constraint torque for this joint.
unsafe float	LinearSeparation [get]
	Gets the current linear separation error for this joint.
unsafe float	AngularSeparation [get]
	Gets the current angular separation error for this joint.
unsafe float	ReferenceAngle [get, set]
	The reference angle in radians for joints that support it.
unsafe Vec2	LocalAxisA [get, set]
	The local axis on body A for joints that support it.

Detailed Description

Joints allow you to connect rigid bodies together while allowing various forms of relative motions.

Member Function Documentation

unsafe()

Box2D.Joint.unsafe ( float  hertz, float  dampingRatio  )

inline

Gets or sets the joint constraint tuning in Hertz and damping ratio. Advanced feature.

Exceptions

InvalidOperationException

If the joint is not valid

Property Documentation

AngularSeparation

unsafe float Box2D.Joint.AngularSeparation

get

Gets the current angular separation error for this joint.

Does not consider admissible movement. Usually in meters.

BodyA

unsafe Body Box2D.Joint.BodyA

get

Gets body A on this joint.

Returns

The body A on this joint

BodyB

unsafe Body Box2D.Joint.BodyB

get

Gets body B on this joint.

Returns

The body B on this joint

ConstraintForce

unsafe Vec2 Box2D.Joint.ConstraintForce

get

Gets the current constraint force for this joint.

Returns

The current constraint force for this joint

Usually in Newtons

ConstraintTorque

unsafe float Box2D.Joint.ConstraintTorque

get

Gets the current constraint torque for this joint.

Returns

The current constraint torque for this joint

Usually in Newton * meters

LinearSeparation

unsafe float Box2D.Joint.LinearSeparation

get

Gets the current linear separation error for this joint.

Does not consider admissible movement. Usually in meters.

Type

unsafe JointType Box2D.Joint.Type

get

Gets the joint type.

Returns

The joint type

Valid

unsafe bool Box2D.Joint.Valid

get

Checks if this joint is valid.

Returns

true if this joint is valid

Provides validation for up to 64K allocations

---

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

• src/Box2DBindings/Joints/Joint.cs
• src/Box2DBindings/Joints/Joint_Externs.cs