Class InverseKinematicsTarget

Describes a dynamic inverse kinematics target

Index

Constructors

Accessors

fallbackEdgeDistance fallbackMinimumDistance offset options rayCastEnd rayCastFallback rayCastStart targetObjectPath targetTransform

Constructors

constructor

new InverseKinematicsTarget(
isInternalConstructor?: boolean,
): InverseKinematicsTarget
Parameters
- OptionalisInternalConstructor: boolean
Returns InverseKinematicsTarget

Overrides FrameworkObject.constructor

Accessors

fallbackEdgeDistance

get fallbackEdgeDistance(): number

When using the raycast fallback target, the fallback target will stay this distance away from edges.

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

fallbackMinimumDistance

get fallbackMinimumDistance(): number

When using the raycast fallback target, this distance is kept between the fallback chain's target and this chain's target

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

offset

get offset(): Immutable<Vector3>

Offset to apply when calculating the target transform

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

options

get options(): EnumValue<InverseKinematicsTargetOption>

Options for this target

Returns EnumValue<InverseKinematicsTargetOption>
set options(value: EnumValue<InverseKinematicsTargetOption>): void
Parameters
- value: EnumValue<InverseKinematicsTargetOption>
Returns void

rayCastEnd

get rayCastEnd(): Immutable<Vector3>

Target ray cast end relative to either the last bone or InverseKinematicsChainState.Target depending on RayCastRelativeToEnd. Requires RayCastTarget to be enabled.

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

rayCastFallback

get rayCastFallback(): string

Name of the bone at the end of another chain. The other chain's IK target transform will be used if the raycast for this chain fails to find a target

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

rayCastStart

get rayCastStart(): Immutable<Vector3>

Target ray cast start relative to either the last bone or InverseKinematicsChainState.Target depending on RayCastRelativeToEnd. Requires RayCastTarget to be enabled.

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

targetObjectPath

get targetObjectPath(): string

Scene object target path. Relative to the animated object. If set, and targetTransform is not set, the IK chain will track this object. If not set, the IK chain will track the world origin.

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

targetTransform

get targetTransform(): Immutable<Transform>

Target transform in world space.

Returns Immutable<Transform>
set targetTransform(value: Immutable<Transform>): void
Parameters
- value: Immutable<Transform>
Returns void