Class: DistanceConstraint
physics/constraints/distance.DistanceConstraint
Represents a distance/pin joint between two CollisionObjects or a CollisionObject and a point.
This constraint will maintain a set distance between the two anchor points.
Hierarchy
↳
DistanceConstraint
Constructors
constructor
• new DistanceConstraint(a, b, length)
Creates a new DistanceConstraint between two bodies.
Parameters
| Name | Type | Description |
|---|---|---|
a | CollisionObject | The first body |
b | CollisionObject | The second body |
length | number | The distance to maintain between the bodies |
Overrides
Defined in
src/physics/constraints/distance.ts:34
• new DistanceConstraint(opts)
Creates a new Constraint with the given options.
Parameters
| Name | Type | Description |
|---|---|---|
opts | DistanceConstraintOptions | The constraint options |
Overrides
Defined in
src/physics/constraints/distance.ts:41
• new DistanceConstraint(a, point, length)
Creates a new DistanceConstraint between a body and a point.
Parameters
| Name | Type | Description |
|---|---|---|
a | CollisionObject | The body to constrain |
point | vec2 | A point in world space |
length | number | The distance to maintain between the body and point. |
Overrides
Defined in
src/physics/constraints/distance.ts:50
Properties
a
• a: CollisionObject
Inherited from
Defined in
src/physics/constraints/constraint.ts:22
anchorA
• anchorA: vec2
Inherited from
Defined in
src/physics/constraints/constraint.ts:23
anchorB
• anchorB: vec2
Inherited from
Defined in
src/physics/constraints/constraint.ts:27
b
• b: CollisionObject
Inherited from
Defined in
src/physics/constraints/constraint.ts:26
bias
• bias: number
Defined in
src/physics/constraints/distance.ts:22
errorBias
• errorBias: number
Inherited from
Defined in
src/physics/constraints/constraint.ts:32
jnAcc
• jnAcc: number
Defined in
src/physics/constraints/distance.ts:25
length
• length: number
Defined in
src/physics/constraints/distance.ts:20
maxBias
• maxBias: number = Infinity
Inherited from
Defined in
src/physics/constraints/constraint.ts:33
maxForce
• maxForce: number = Infinity
Inherited from
Defined in
src/physics/constraints/constraint.ts:35
nDelta
• nDelta: vec2
Defined in
src/physics/constraints/distance.ts:23
nMass
• nMass: number
Defined in
src/physics/constraints/distance.ts:24
point
• point: vec2
Inherited from
Defined in
src/physics/constraints/constraint.ts:30
rotA
• rotA: number = 0
Inherited from
Defined in
src/physics/constraints/constraint.ts:24
rotB
• rotB: number = 0
Inherited from
Defined in
src/physics/constraints/constraint.ts:28
Methods
applyImpulses
▸ Protected applyImpulses(impulse, direction): void
Parameters
| Name | Type |
|---|---|
impulse | number |
direction | vec2 |
Returns
void
Inherited from
Defined in
src/physics/constraints/constraint.ts:111
▸ Protected applyImpulses(impulse): void
Parameters
| Name | Type |
|---|---|
impulse | vec2 |
Returns
void
Inherited from
Defined in
src/physics/constraints/constraint.ts:113
biasCoef
▸ Protected biasCoef(dt): number
Calculates the velocity bias coefficient.
Parameters
| Name | Type | Description |
|---|---|---|
dt | number | The time since the last update |
Returns
number
Inherited from
Defined in
src/physics/constraints/constraint.ts:182
calculateRelativeVelocity
▸ Protected calculateRelativeVelocity(pointA, pointB): vec2
Calculate the relative velocity of the bodies in the constraint.
Parameters
| Name | Type | Description |
|---|---|---|
pointA | vec2 | The anchor point on body a |
pointB | vec2 | The anchor point on body b |
Returns
vec2
The relative velocity between body a and b or body a and the anchor point
Inherited from
Constraint.calculateRelativeVelocity
Defined in
src/physics/constraints/constraint.ts:164
isBodyToPoint
▸ isBodyToPoint(): boolean
Determines wether or not the constraint is between a body and a point.
Returns
boolean
Wether or not the constraint is between a body and a point.
Inherited from
Defined in
src/physics/constraints/constraint.ts:107
kScalar
▸ Protected kScalar(n): number
Computes the k scalar value for the constraint.
Parameters
| Name | Type | Description |
|---|---|---|
n | vec2 | The constraint's delta normal |
Returns
number
The k scalar value for the constraint
Inherited from
Defined in
src/physics/constraints/constraint.ts:205
kScalarBody
▸ Protected kScalarBody(body, r, n): number
Computes the k scalar value for the given body.
Parameters
| Name | Type | Description |
|---|---|---|
body | CollisionObject | The body to calculate for |
r | vec2 | The anchor point on the body |
n | vec2 | The constraint's delta normal |
Returns
number
The k scalar value for the given body
Inherited from
Defined in
src/physics/constraints/constraint.ts:194
kTensor
▸ Protected kTensor(): mat2
Computes the k tensor matrix for the constraint.
Returns
mat2
k tensor matrix
Inherited from
Defined in
src/physics/constraints/constraint.ts:220
postSolve
▸ postSolve(): void
Applies the cached impulse.
Returns
void
Overrides
Defined in
src/physics/constraints/distance.ts:128
preSolve
▸ preSolve(dt): void
Prepares for constraint solving.
Parameters
| Name | Type |
|---|---|
dt | number |
Returns
void
Overrides
Defined in
src/physics/constraints/distance.ts:73
solve
▸ solve(dt): void
Computes and applies the impulse to keep the bodies at the joint's length.
Parameters
| Name | Type | Description |
|---|---|---|
dt | number | The time since the last update |
Returns
void
Overrides
Defined in
src/physics/constraints/distance.ts:105
updateAnchors
▸ Protected updateAnchors(): void
Updates the constraint's anchor points to match the rotations of their bodies.
Returns
void
Inherited from
Defined in
src/physics/constraints/constraint.ts:141