Class: MouseConstraint

physics/constraints/mouse.MouseConstraint

Constrains an CollisionObject's position to the mouse's world position in the current Camera's view.

Hierarchy

• PivotConstraint

  ↳ MouseConstraint

Constructors

constructor

• new MouseConstraint(obj)

Creates an MouseConstraint.

Parameters

Name	Type	Description
obj	CollisionObject	The object to constrain

Overrides

PivotConstraint.constructor

Defined in

src/physics/constraints/mouse.ts:16

Properties

a

• a: CollisionObject

Inherited from

PivotConstraint.a

Defined in

src/physics/constraints/constraint.ts:22

---

anchorA

• anchorA: vec2

Inherited from

PivotConstraint.anchorA

Defined in

src/physics/constraints/constraint.ts:23

---

anchorB

• anchorB: vec2

Inherited from

PivotConstraint.anchorB

Defined in

src/physics/constraints/constraint.ts:27

---

b

• b: CollisionObject

Inherited from

PivotConstraint.b

Defined in

src/physics/constraints/constraint.ts:26

---

bias

• bias: vec2

Inherited from

PivotConstraint.bias

Defined in

src/physics/constraints/pivot.ts:18

---

errorBias

• errorBias: number

Inherited from

PivotConstraint.errorBias

Defined in

src/physics/constraints/constraint.ts:32

---

jAcc

• jAcc: vec2

Inherited from

PivotConstraint.jAcc

Defined in

src/physics/constraints/pivot.ts:19

---

k

• k: mat2

Inherited from

PivotConstraint.k

Defined in

src/physics/constraints/pivot.ts:20

---

maxBias

• maxBias: number = Infinity

Inherited from

PivotConstraint.maxBias

Defined in

src/physics/constraints/constraint.ts:33

---

maxForce

• maxForce: number = Infinity

Inherited from

PivotConstraint.maxForce

Defined in

src/physics/constraints/constraint.ts:35

---

point

• point: vec2

Inherited from

PivotConstraint.point

Defined in

src/physics/constraints/constraint.ts:30

---

rotA

• rotA: number = 0

Inherited from

PivotConstraint.rotA

Defined in

src/physics/constraints/constraint.ts:24

---

rotB

• rotB: number = 0

Inherited from

PivotConstraint.rotB

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

PivotConstraint.applyImpulses

Defined in

src/physics/constraints/constraint.ts:111

▸ Protected applyImpulses(impulse): void

Parameters

Name	Type
impulse	vec2

Returns

void

Inherited from

PivotConstraint.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

PivotConstraint.biasCoef

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

PivotConstraint.calculateRelativeVelocity

Defined in

src/physics/constraints/constraint.ts:164

---

getMousePosition

▸ Private getMousePosition(): vec2

Gets the mouse's world position in the current camera's view.

Returns

vec2

Defined in

src/physics/constraints/mouse.ts:44

---

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

PivotConstraint.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

PivotConstraint.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

PivotConstraint.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

PivotConstraint.kTensor

Defined in

src/physics/constraints/constraint.ts:220

---

mouseListener

▸ Private mouseListener(): void

Returns

void

Defined in

src/physics/constraints/mouse.ts:36

---

postSolve

▸ postSolve(): void

Applies the cached impulse.

Returns

void

Inherited from

PivotConstraint.postSolve

Defined in

src/physics/constraints/pivot.ts:119

---

preSolve

▸ preSolve(dt): void

Prepares for constraint solving.

Parameters

Name	Type
dt	number

Returns

void

Inherited from

PivotConstraint.preSolve

Defined in

src/physics/constraints/pivot.ts:65

---

remove

▸ remove(): void

Removes the mouse constraint's listeners from the canvas.

Returns

void

Defined in

src/physics/constraints/mouse.ts:32

---

solve

▸ solve(dt): void

Computes and applies the impulse to keep the bodies at the joint's length.

see Chipmunk2D Pin Joint

see MatterJS Constraint

see Dyn4j Distance Constraint

see Constraints and Solvers

Parameters

Name	Type	Description
dt	number	The time since the last update

Returns

void

Inherited from

PivotConstraint.solve

Defined in

src/physics/constraints/pivot.ts:95

---

updateAnchors

▸ Protected updateAnchors(): void

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

Returns

void

Inherited from

PivotConstraint.updateAnchors

Defined in

src/physics/constraints/constraint.ts:141