Struct ChainIKConstraintData

The ChainIK constraint data.

Implements

IAnimationJobData

IChainIKConstraintData

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Animations.Rigging

Assembly: Unity.Animation.Rigging.dll

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
float

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
bool

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
bool

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
int

root

The root Transform of the ChainIK hierarchy.

Declaration

public Transform root { get; set; }

Property Value

Type	Description
Transform

target

The ChainIK target Transform.

Declaration

public Transform target { get; set; }

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

public Transform tip { get; set; }

Property Value

Type	Description
Transform

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
float

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
float

Implements

IAnimationJobData

IChainIKConstraintData