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

Inheritance diagram for Box2D.Joint:

[legend]

Public Member Functions
void	Destroy ()
	Destroys this joint.

void	WakeBodies ()
	Wakes the bodies connected to this joint.

Properties
bool	Valid `[get]`
	Checks if this joint is valid.

JointType	Type `[get]`
	Gets the joint type.

Body	BodyA `[get]`
	Gets body A on this joint.

Body	BodyB `[get]`
	Gets body B on this joint.

World	World `[get]`
	Gets the world that owns this joint.

Vec2	LocalAnchorA `[get]`
	Gets the local anchor on body A.

Vec2	LocalAnchorB `[get]`
	Gets the local anchor on body B.

bool	CollideConnected `[get, set]`
	Set this flag to true if the attached bodies should collide.

object?	UserData `[get, set]`
	The user data object for this joint.

Vec2	ConstraintForce `[get]`
	Gets the current constraint force for this joint.

float	ConstraintTorque `[get]`
	Gets the current constraint torque for this joint.

Detailed Description

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

Property Documentation

◆ BodyA

Body Box2D.Joint.BodyA

get

Gets body A on this joint.

Returns: The body A on this joint

◆ BodyB

Body Box2D.Joint.BodyB

get

Gets body B on this joint.

Returns: The body B on this joint

◆ ConstraintForce

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

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

◆ LocalAnchorA

Vec2 Box2D.Joint.LocalAnchorA

get

Gets the local anchor on body A.

Returns: The local anchor on body A

◆ LocalAnchorB

Vec2 Box2D.Joint.LocalAnchorB

get

Gets the local anchor on body B.

Returns: The local anchor on body B

◆ Type

JointType Box2D.Joint.Type

get

Gets the joint type.

Returns: The joint type

◆ Valid

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 file:

src/Box2DBindings/Joints/Joint.cs

Public Member Functions

Properties