Struct ChainIKConstraintData

The ChainIK constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct ChainIKConstraintData : IAnimationJobData, IChainIKConstraintData

Properties

chainRotationWeight

The weight for which ChainIK target has an effect on chain (up to tip Transform). This is a value in between 0 and 1.

Declaration
public float chainRotationWeight { get; set; }
Property Value
Type Description
Single

maintainTargetPositionOffset

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

Declaration
public bool maintainTargetPositionOffset { get; set; }
Property Value
Type Description
Boolean
Implements

maintainTargetRotationOffset

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

Declaration
public bool maintainTargetRotationOffset { get; set; }
Property Value
Type Description
Boolean
Implements

maxIterations

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

Declaration
public int maxIterations { get; set; }
Property Value
Type Description
Int32
Implements

root

The root Transform of the ChainIK hierarchy.

Declaration
public Transform root { get; set; }
Property Value
Type Description
Transform
Implements

target

The ChainIK target Transform.

Declaration
public Transform target { get; set; }
Property Value
Type Description
Transform
Implements

tip

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

Declaration
public Transform tip { get; set; }
Property Value
Type Description
Transform
Implements

tipRotationWeight

The weight for which ChainIK target has and effect on tip Transform. This is a value in between 0 and 1.

Declaration
public float tipRotationWeight { get; set; }
Property Value
Type Description
Single

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
public float tolerance { get; set; }
Property Value
Type Description
Single
Implements

Explicit Interface Implementations

IAnimationJobData.IsValid()

Retrieves the data valid state.

Declaration
bool IAnimationJobData.IsValid()
Returns
Type Description
Boolean

Returns true if data can be successfully used in a constraint. Returns false otherwise.
Implements

IAnimationJobData.SetDefaultValues()

Resets values to defaults.

Declaration
void IAnimationJobData.SetDefaultValues()
Implements

IChainIKConstraintData.chainRotationWeightFloatProperty

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

Declaration
readonly string IChainIKConstraintData.chainRotationWeightFloatProperty { get; }
Returns
Type Description
String
Implements

IChainIKConstraintData.tipRotationWeightFloatProperty

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

Declaration
readonly string IChainIKConstraintData.tipRotationWeightFloatProperty { get; }
Returns
Type Description
String
Implements