Class: SpringConstraint

physics/constraints/spring.SpringConstraint

Represents a damped spring joint between two CollisionObjects or a CollisionObject and a point.

Hierarchy

• Constraint

  ↳ SpringConstraint

Constructors

constructor

• new SpringConstraint(a, b, length, stiffness, damping?)

Creates a new SpringConstraint between two bodies.

Parameters

Name	Type	Description
a	CollisionObject	The first body
b	CollisionObject	The second body
length	number	The resting length of the spring
stiffness	number	The stiffness of the spring
damping?	number	The damping of the spring

Overrides

Constraint.constructor

Defined in

src/physics/constraints/spring.ts:36

• new SpringConstraint(opts)

Creates a new SpringConstraint with the given options.

Parameters

Name	Type	Description
opts	SpringConstraintOptions	The constraint options

Overrides

Constraint.constructor

Defined in

src/physics/constraints/spring.ts:43

• new SpringConstraint(a, point, length, stiffness, damping?)

Creates a new SpringConstraint 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 resting length of the spring.
stiffness	number	The stiffness of the spring
damping?	number	The damping of the spring

Overrides

Constraint.constructor

Defined in

src/physics/constraints/spring.ts:54

Properties

a

• a: CollisionObject

Inherited from

Constraint.a

Defined in

src/physics/constraints/constraint.ts:22

---

anchorA

• anchorA: vec2

Inherited from

Constraint.anchorA

Defined in

src/physics/constraints/constraint.ts:23

---

anchorB

• anchorB: vec2

Inherited from

Constraint.anchorB

Defined in

src/physics/constraints/constraint.ts:27

---

angularStiffness

• angularStiffness: number

Defined in

src/physics/constraints/spring.ts:18

---

b

• b: CollisionObject

Inherited from

Constraint.b

Defined in

src/physics/constraints/constraint.ts:26

---

damping

• damping: number

Defined in

src/physics/constraints/spring.ts:19

---

errorBias

• errorBias: number

Inherited from

Constraint.errorBias

Defined in

src/physics/constraints/constraint.ts:32

---

jAcc

• jAcc: number

Defined in

src/physics/constraints/spring.ts:25

---

length

• length: number

Defined in

src/physics/constraints/spring.ts:16

---

maxBias

• maxBias: number = Infinity

Inherited from

Constraint.maxBias

Defined in

src/physics/constraints/constraint.ts:33

---

maxForce

• maxForce: number = Infinity

Inherited from

Constraint.maxForce

Defined in

src/physics/constraints/constraint.ts:35

---

nDelta

• nDelta: vec2

Defined in

src/physics/constraints/spring.ts:21

---

nMass

• nMass: number

Defined in

src/physics/constraints/spring.ts:22

---

point

• point: vec2

Inherited from

Constraint.point

Defined in

src/physics/constraints/constraint.ts:30

---

rotA

• rotA: number = 0

Inherited from

Constraint.rotA

Defined in

src/physics/constraints/constraint.ts:24

---

rotB

• rotB: number = 0

Inherited from

Constraint.rotB

Defined in

src/physics/constraints/constraint.ts:28

---

stiffness

• stiffness: number

Defined in

src/physics/constraints/spring.ts:17

---

targetVrn

• targetVrn: number

Defined in

src/physics/constraints/spring.ts:23

---

vCoef

• vCoef: number

Defined in

src/physics/constraints/spring.ts:24

Methods

applyImpulses

▸ Protected applyImpulses(impulse, direction): void

Parameters

Name	Type
impulse	number
direction	vec2

Returns

void

Inherited from

Constraint.applyImpulses

Defined in

src/physics/constraints/constraint.ts:111

▸ Protected applyImpulses(impulse): void

Parameters

Name	Type
impulse	vec2

Returns

void

Inherited from

Constraint.applyImpulses

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

Constraint.biasCoef

Defined in

src/physics/constraints/constraint.ts:182

---

calcForce

▸ Private calcForce(length): number

Parameters

Name	Type
length	number

Returns

number

Defined in

src/physics/constraints/spring.ts:146

---

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

Constraint.isBodyToPoint

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

Constraint.kScalar

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

Constraint.kScalarBody

Defined in

src/physics/constraints/constraint.ts:194

---

kTensor

▸ Protected kTensor(): mat2

Computes the k tensor matrix for the constraint.

see Chipmunk2D kTensor

Returns

mat2

k tensor matrix

Inherited from

Constraint.kTensor

Defined in

src/physics/constraints/constraint.ts:220

---

postSolve

▸ postSolve(): void

Performs post solve operations.

Returns

void

Overrides

Constraint.postSolve

Defined in

src/physics/constraints/spring.ts:144

---

preSolve

▸ preSolve(dt): void

Updates the constraints anchors and prepares for solving.

Parameters

Name	Type	Description
dt	number	The time since the last update

Returns

void

Overrides

Constraint.preSolve

Defined in

src/physics/constraints/spring.ts:92

---

solve

▸ solve(dt): void

Applies the spring forces to the attached bodies.

see Chipmunk2D Damped Spring

see Constraints and Solvers

Parameters

Name	Type	Description
dt	number	The time since the last update

Returns

void

Overrides

Constraint.solve

Defined in

src/physics/constraints/spring.ts:126

---

updateAnchors

▸ Protected updateAnchors(): void

Updates the constraint's anchor points to match the rotations of their bodies.

Returns

void

Inherited from

Constraint.updateAnchors

Defined in

src/physics/constraints/constraint.ts:141