Class: DistanceJoint

A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod.

Extends

• Joint

Constructors

Constructor

new DistanceJoint(def): DistanceJoint

Parameters

def

DistanceJointDef

DistanceJoint definition.

Returns

DistanceJoint

Overrides

Joint.constructor

Constructor

new DistanceJoint(def, bodyA, bodyB, anchorA?, anchorB?): DistanceJoint

Parameters

def

DistanceJointOpt

bodyA

Body

bodyB

Body

anchorA?

Vec2Value

Anchor A in global coordination.

anchorB?

Vec2Value

Anchor B in global coordination.

Returns

DistanceJoint

Overrides

Joint.constructor

Properties

style

style: Style = {}

Styling for dev-tools.

Inherited from

Joint.style

---

TYPE

static TYPE: "distance-joint"

Methods

getAnchorA()

getAnchorA(): Vec2

Get the anchor point on bodyA in world coordinates.

Returns

Vec2

Overrides

Joint.getAnchorA

---

getAnchorB()

getAnchorB(): Vec2

Get the anchor point on bodyB in world coordinates.

Returns

Vec2

Overrides

Joint.getAnchorB

---

getBodyA()

getBodyA(): Body

Get the first body attached to this joint.

Returns

Body

Inherited from

Joint.getBodyA

---

getBodyB()

getBodyB(): Body

Get the second body attached to this joint.

Returns

Body

Inherited from

Joint.getBodyB

---

getCollideConnected()

getCollideConnected(): boolean

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.

Returns

boolean

Inherited from

Joint.getCollideConnected

---

getDampingRatio()

getDampingRatio(): number

Returns

number

---

getFrequency()

getFrequency(): number

Returns

number

---

getLength()

getLength(): number

Get the natural length.

Returns

number

---

getLocalAnchorA()

getLocalAnchorA(): Vec2

The local anchor point relative to bodyA's origin.

Returns

Vec2

---

getLocalAnchorB()

getLocalAnchorB(): Vec2

The local anchor point relative to bodyB's origin.

Returns

Vec2

---

getNext()

getNext(): Joint

Get the next joint the world joint list.

Returns

Joint

Inherited from

Joint.getNext

---

getReactionForce()

getReactionForce(inv_dt): Vec2

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

Parameters

inv_dt

number

Returns

Vec2

Overrides

Joint.getReactionForce

---

getReactionTorque()

getReactionTorque(inv_dt): number

Get the reaction torque on bodyB in N*m.

Parameters

inv_dt

number

Returns

number

Overrides

Joint.getReactionTorque

---

getType()

getType(): string

Get the type of the concrete joint.

Returns

string

Inherited from

Joint.getType

---

getUserData()

getUserData(): unknown

Returns

unknown

Inherited from

Joint.getUserData

---

initVelocityConstraints()

initVelocityConstraints(step): void

Parameters

step

TimeStep

Returns

void

Overrides

Joint.initVelocityConstraints

---

isActive()

isActive(): boolean

Short-cut function to determine if either body is inactive.

Returns

boolean

Inherited from

Joint.isActive

---

setDampingRatio()

setDampingRatio(ratio): void

Parameters

ratio

number

Returns

void

---

setFrequency()

setFrequency(hz): void

Parameters

hz

number

Returns

void

---

setLength()

setLength(length): void

Set the natural length. Manipulating the length can lead to non-physical behavior when the frequency is zero.

Parameters

length

number

Returns

void

---

setUserData()

setUserData(data): void

Parameters

data

unknown

Returns

void

Inherited from

Joint.setUserData

---

shiftOrigin()

shiftOrigin(newOrigin): void

Shift the origin for any points stored in world coordinates.

Parameters

newOrigin

Vec2Value

Returns

void

Inherited from

Joint.shiftOrigin

---

solvePositionConstraints()

solvePositionConstraints(step): boolean

This returns true if the position errors are within tolerance.

Parameters

step

TimeStep

Returns

boolean

Overrides

Joint.solvePositionConstraints

---

solveVelocityConstraints()

solveVelocityConstraints(step): void

Parameters

step

TimeStep

Returns

void

Overrides

Joint.solveVelocityConstraints