Class KinematicPrismaticJoint

Kinematic Prismatic Joint. Connects two kinematic links, allowing relative translation along a single axis.

Hierarchy (View Summary)

KinematicJoint
- KinematicPrismaticJoint

Index

Accessors

attachment axis base distance dof limits type

Methods

parameter updateLimits updateParameter

Accessors

attachment

get attachment(): KinematicLink
The first link connected by the joint.

Returns KinematicLink
Inherited from KinematicJoint.attachment
set attachment(value: KinematicLink): void
Parameters
- value: KinematicLink
Returns void
Inherited from KinematicJoint.attachment

axis

get axis(): IVec3
The local axis.

Returns IVec3
set axis(value: IVec3): void
Parameters
- value: IVec3
Returns void

base

get base(): KinematicLink
The second link connected by the joint.

Returns KinematicLink
Inherited from KinematicJoint.base
set base(value: KinematicLink): void
Parameters
- value: KinematicLink
Returns void
Inherited from KinematicJoint.base

distance

get distance(): number
The current joint distance.

Returns number

dof

get dof(): number
The number of degrees of freedom for the joint.

Returns number
Inherited from KinematicJoint.dof

limits

get limits(): LimitPair
Limits for the joint's degrees of freedom.

Returns LimitPair
Remarks
Spherical joints do not support limits.

Inherited from KinematicJoint.limits
set limits(value: LimitPair): void
Parameters
- value: LimitPair
Returns void
Inherited from KinematicJoint.limits

type

get type(): KinematicJointType
Returns KinematicJointType
Overrides KinematicJoint.type

Methods

parameter

parameter(dof: number): number
Gets the joint parameter for a degree of freedom.
Parameters
- dof: number
  The degree of freedom.
Returns number
The joint parameter.

Inherited from KinematicJoint.parameter

updateLimits

updateLimits(): void
Updates the joint limits.

Returns void
Inherited from KinematicJoint.updateLimits

updateParameter

updateParameter(dof: number, value: number): void
Sets the joint parameter for a degree of freedom.
Parameters
- dof: number
  The degree of freedom.
- value: number
  The joint parameter.
Returns void
Inherited from KinematicJoint.updateParameter