Class LockConstraint

Lock constraint. Will remove all degrees of freedom between the bodies.

Hierarchy (view full)

PointToPointConstraint
- LockConstraint

Index

Constructors

Properties

bodyA bodyB collideConnected equationX equationY equationZ equations id motorEquation? pivotA pivotB rotationalEquation1 rotationalEquation2 rotationalEquation3 xA xB yA yB zA zB idCounter

Methods

disable enable update

Constructors

constructor

new LockConstraint(bodyA, bodyB, options?): LockConstraint
Parameters
- bodyA: Body
- bodyB: Body
- Optional options: {
  maxForce?: number;
  }
  - Optional maxForce?: number
    The maximum force that should be applied to constrain the bodies.
    Default
    1e6
Returns LockConstraint
Overrides PointToPointConstraint.constructor

Properties

bodyA

bodyA: Body

Body A.

bodyB

bodyB: Body

Body B.

collideConnected

collideConnected: boolean

Set to false if you don't want the bodies to collide when they are connected.

equationX

equationX: ContactEquation

equationY

equationY: ContactEquation

equationZ

equationZ: ContactEquation

equations

equations: Equation[]

Equations to be solved in this constraint.

id

id: number

`Optional` motorEquation

motorEquation?: RotationalMotorEquation

pivotA

pivotA: Vec3

Pivot, defined locally in bodyA.

pivotB

pivotB: Vec3

Pivot, defined locally in bodyB.

rotationalEquation1

rotationalEquation1: RotationalEquation

rotationalEquation2

rotationalEquation2: RotationalEquation

rotationalEquation3

rotationalEquation3: RotationalEquation

xA

xA: Vec3

xB

xB: Vec3

yA

yA: Vec3

yB

yB: Vec3

zA

zA: Vec3

zB

zB: Vec3

`Static` idCounter

idCounter: number

Methods

disable

disable(): void
Disables all equations in the constraint.

Returns void
Inherited from PointToPointConstraint.disable

enable

enable(): void
Enables all equations in the constraint.

Returns void
Inherited from PointToPointConstraint.enable

update

update(): void
update

Returns void
Overrides PointToPointConstraint.update