Class InverseKinematicsChainConfiguration

Stores the configuration of an IK chain.

Hierarchy

FrameworkObject
- InverseKinematicsChainConfiguration

Index

Constructors

Accessors

footDetectionLayer footPlacementYMaximum footPlacementYMinimum joints options pelvisDamping rootMode targetConfiguration tipJointOffset

Constructors

constructor

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

Accessors

footDetectionLayer

get footDetectionLayer(): rsx.LayerMask
Determines what objects the foot placement can detect

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

footPlacementYMaximum

get footPlacementYMaximum(): number
When using foot placement, the foot will not go higher than this value

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

footPlacementYMinimum

get footPlacementYMinimum(): number
When using foot placement, the foot will not go lower than this value

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

joints

get joints(): Iterable<string>
Joints of the IK chain

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

options

get options(): EnumValue<InverseKinematicsChainOption, number>
Options for this chain

Returns EnumValue<InverseKinematicsChainOption, number>
set options(value): void
Parameters
- value: EnumValue<InverseKinematicsChainOption, number>
Returns void

pelvisDamping

get pelvisDamping(): number
When using Pelvis root mode, determines how much the pelvis position is damped

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

rootMode

get rootMode(): EnumValue<InverseKinematicsRootMode, number>
Root joint mode. See InverseKinematicsRootMode

Returns EnumValue<InverseKinematicsRootMode, number>
set rootMode(value): void
Parameters
- value: EnumValue<InverseKinematicsRootMode, number>
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