Interface IChainIKConstraintData

This interface defines the data mapping for the ChainIK constraint.

Namespace: UnityEngine.Animations.Rigging

Syntax

public interface IChainIKConstraintData

Properties

chainRotationWeightFloatProperty

The path to the chain rotation weight property in the constraint component.

Declaration

string chainRotationWeightFloatProperty { get; }

Property Value

Type	Description
String

maintainTargetPositionOffset

This is used to maintain the current position offset from the tip Transform to target Transform.

Declaration

bool maintainTargetPositionOffset { get; }

Property Value

Type	Description
Boolean

maintainTargetRotationOffset

This is used to maintain the current rotation offset from the tip Transform to target Transform.

Declaration

bool maintainTargetRotationOffset { get; }

Property Value

Type	Description
Boolean

maxIterations

The maximum number of iterations allowed for the ChainIK algorithm to converge to a solution.

Declaration

int maxIterations { get; }

Property Value

Type	Description
Int32

root

The root Transform of the ChainIK hierarchy.

Declaration

Transform root { get; }

Property Value

Type	Description
Transform

target

The ChainIK target Transform.

Declaration

Transform target { get; }

Property Value

Type	Description
Transform

tip

The tip Transform of the ChainIK hierarchy. The tip needs to be a descendant/child of the root Transform.

Declaration

Transform tip { get; }

Property Value

Type	Description
Transform

tipRotationWeightFloatProperty

The path to the tip rotation weight property in the constraint component.

Declaration

string tipRotationWeightFloatProperty { get; }

Property Value

Type	Description
String

tolerance

The allowed distance between the tip and target Transform positions. When the distance is smaller than the tolerance, the algorithm has converged on a solution and will stop.

Declaration

float tolerance { get; }

Property Value

Type	Description
Single