Class InverseKinematicsJointConfiguration

Configuration for a single joint of an IK chain.

Hierarchy

FrameworkObject
- InverseKinematicsJointConfiguration

Index

Constructors

Accessors

angleConstraint boneName isCollisionEnabled poleTargetInfluence rollConstraint

Constructors

constructor

new InverseKinematicsJointConfiguration(boneName, rollConstraint, angleConstraint, poleTargetInfluence, isCollisionEnabled, isInternalConstructor?): InverseKinematicsJointConfiguration
Parameters
- boneName: string
- rollConstraint: InverseKinematicsRollConstraint
- angleConstraint: InverseKinematicsAngleConstraint
- poleTargetInfluence: number
- 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): void
Parameters
- value: Immutable<InverseKinematicsAngleConstraint>
Returns void

boneName

get boneName(): string
Name of the corresponding bone in a skeleton

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

isCollisionEnabled

get isCollisionEnabled(): boolean
Whether the bone between this joint and the next has collision testing enabled

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

poleTargetInfluence

get poleTargetInfluence(): number
Influence of the pole target on the joint

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

rollConstraint

get rollConstraint(): Immutable<InverseKinematicsRollConstraint>
Roll constraint of the joint

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