Class InverseKinematicsJointConfiguration

Configuration for a single joint of an IK chain.

Index

Constructors

Accessors

angleConstraint boneName collisionLayers isCollisionEnabled isUsingPreferredAngles positionDamping preferredAngles rollConstraint rotationDamping

Constructors

constructor

new InverseKinematicsJointConfiguration(
    boneName: string,
    rollConstraint: Immutable<InverseKinematicsRollConstraint>,
    angleConstraint: Immutable<InverseKinematicsAngleConstraint>,
    isCollisionEnabled: boolean,
    isInternalConstructor?: boolean,
): InverseKinematicsJointConfiguration
Parameters
- boneName: string
- rollConstraint: Immutable<InverseKinematicsRollConstraint>
- angleConstraint: Immutable<InverseKinematicsAngleConstraint>
- isCollisionEnabled: boolean
- OptionalisInternalConstructor: boolean
Returns InverseKinematicsJointConfiguration

Overrides FrameworkObject.constructor

Accessors

angleConstraint

get angleConstraint(): Immutable<InverseKinematicsAngleConstraint>

Angle constraint of the joint

Returns Immutable<InverseKinematicsAngleConstraint>
set angleConstraint(value: Immutable<InverseKinematicsAngleConstraint>): void
Parameters
- value: Immutable<InverseKinematicsAngleConstraint>
Returns void

boneName

get boneName(): string

Name of the corresponding bone in a skeleton

Returns string
set boneName(value: string): void
Parameters
- value: string
Returns void

collisionLayers

get collisionLayers(): rsx.LayerMask

Determines what objects this bone collides with when solving IK

Returns rsx.LayerMask
set collisionLayers(value: rsx.LayerMask): void
Parameters
- value: rsx.LayerMask
Returns void

isCollisionEnabled

get isCollisionEnabled(): boolean

Whether the bone between this joint and the next has collision testing enabled

Returns boolean
set isCollisionEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isUsingPreferredAngles

get isUsingPreferredAngles(): boolean

Whether this joint uses preferred angles

Returns boolean
set isUsingPreferredAngles(value: boolean): void
Parameters
- value: boolean
Returns void

positionDamping

get positionDamping(): number

Damps the position applied to this joint by the solver.

Returns number
set positionDamping(value: number): void
Parameters
- value: number
Returns void

preferredAngles

get preferredAngles(): Immutable<Vector3>

Preferred angles of the joint. Joint will prefer to buckle to its preferred angle.

Returns Immutable<Vector3>
set preferredAngles(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

rollConstraint

get rollConstraint(): Immutable<InverseKinematicsRollConstraint>

Roll constraint of the joint

Returns Immutable<InverseKinematicsRollConstraint>
set rollConstraint(value: Immutable<InverseKinematicsRollConstraint>): void
Parameters
- value: Immutable<InverseKinematicsRollConstraint>
Returns void

rotationDamping

get rotationDamping(): number

Damps the rotation applied to this joint by the solver.

Returns number
set rotationDamping(value: number): void
Parameters
- value: number
Returns void

Class InverseKinematicsJointConfiguration

Index

Constructors

Accessors

Constructors

constructor

Parameters

Returns InverseKinematicsJointConfiguration

Accessors

angleConstraint

Returns Immutable<InverseKinematicsAngleConstraint>

Parameters

Returns void

boneName

Returns string

Parameters

Returns void

collisionLayers

Returns rsx.LayerMask

Parameters

Returns void

isCollisionEnabled

Returns boolean

Parameters

Returns void

isUsingPreferredAngles

Returns boolean

Parameters

Returns void

positionDamping

Returns number

Parameters

Returns void

preferredAngles

Returns Immutable<Vector3>

Parameters

Returns void

rollConstraint

Returns Immutable<InverseKinematicsRollConstraint>

Parameters

Returns void

rotationDamping

Returns number

Parameters

Returns void

Settings

On This Page