Class Joint

Physics joint.

Remarks

Used to constrain one rigid body relative to another. Can be used in combination with MotorComponent to drive parts along/about linear/rotational axes or paths.

Hierarchy (View Summary)

Referenceable
- Joint

Implements

ITrackable<Joint>

Index

Accessors

anchor axis base constraint deleted entity limits motor path position

Accessors

anchor

get anchor(): Vec3
The local anchor.

Returns Vec3
Remarks
Used for revolute, spherical and path joints.
set anchor(value: Vec3): void
Parameters
- value: Vec3
Returns void

axis

get axis(): Vec3
The local axis.

Returns Vec3
Remarks
Used for prismatic and revolute joints.
set axis(value: Vec3): void
Parameters
- value: Vec3
Returns void

base

get base(): null | Entity
The base entity to which the joint is connected.

Returns null | Entity
Remarks
If null, the joint is connected to the world.
set base(value: null | Entity): void
Parameters
- value: null | Entity
Returns void

constraint

get constraint(): Constraint
The constraint type.

Returns Constraint
set constraint(value: Constraint): void
Parameters
- value: Constraint
Returns void

deleted

get deleted(): Subscribable<Joint>
Notifies when the joint is removed from the physics component.

Returns Subscribable<Joint>
Implementation of ITrackable.deleted

entity

get entity(): Entity
The entity to which the physics component is attached.

Returns Entity

limits

get limits(): LimitPair
The limits for the joint.

Returns LimitPair
set limits(value: LimitPair): void
Parameters
- value: LimitPair
Returns void

motor

get motor(): null | MotorComponent
The motor bound to the joint.

Returns null | MotorComponent
set motor(value: null | MotorComponent): void
Parameters
- value: null | MotorComponent
Returns void

path

get path(): null | TrackComponent
The path bound to the joint.

Returns null | TrackComponent
Remarks
Used only for path joints.
set path(value: null | TrackComponent): void
Parameters
- value: null | TrackComponent
Returns void

position

get position(): number
The current position of the joint.

Returns number
Remarks
Only valid for prismatic, revolute and path joints.