Class InverseKinematicsChainConfiguration

Stores the configuration of an IK chain.

Hierarchy

FrameworkObject
- InverseKinematicsChainConfiguration

Index

Constructors

Accessors

isEnabled isEndEffectorRotationOverridden isFootPlacementChain isParentChainInfluencingRotation isUsingTipJoint jointConfigurations targetConfiguration tipJointOffset

Constructors

constructor

new InverseKinematicsChainConfiguration(isInternalConstructor?): InverseKinematicsChainConfiguration
Parameters
- OptionalisInternalConstructor: boolean
Returns InverseKinematicsChainConfiguration
Overrides FrameworkObject.constructor

Accessors

isEnabled

get isEnabled(): boolean
If false, this IK chain will be disabled and not solved

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

isEndEffectorRotationOverridden

get isEndEffectorRotationOverridden(): boolean
If true, the end effector will try to match the target's rotation

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

isFootPlacementChain

get isFootPlacementChain(): boolean
If true, chain will use foot placement specific target calculations

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

isParentChainInfluencingRotation

get isParentChainInfluencingRotation(): boolean
If true, the parent chain's roll will influence this chain's roll

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

isUsingTipJoint

get isUsingTipJoint(): boolean
If true, adds an additional joint at the tip of the chain as the target. Useful if the skeleton does not have a dedicated tip bone.

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

jointConfigurations

get jointConfigurations(): Iterable<InverseKinematicsJointConfiguration>
Configuration for each joint of the IK chain

Returns Iterable<InverseKinematicsJointConfiguration>
set jointConfigurations(value): void
Parameters
- value: Iterable<InverseKinematicsJointConfiguration> | readonly InverseKinematicsJointConfiguration[]
Returns void

targetConfiguration

get targetConfiguration(): InverseKinematicsTarget
The target configuration that this chain uses.

Returns InverseKinematicsTarget
set targetConfiguration(value): void
Parameters
- value: InverseKinematicsTarget
Returns void

tipJointOffset

get tipJointOffset(): Immutable<Vector3>
The position of the tip joint, relative to the last joint, if isUsingTipJoint is true.

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