Struct TwoBoneIKConstraintData

The TwoBoneIK constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct TwoBoneIKConstraintData : IAnimationJobData, ITwoBoneIKConstraintData

Properties

hint

The IK hint transform.

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

hintWeight

The weight for which hint transform has an effect on IK calculations. This is a value in between 0 and 1.

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

maintainTargetPositionOffset

This is used to maintain the offset of the tip position to the target position.

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

maintainTargetRotationOffset

This is used to maintain the offset of the tip rotation to the target rotation.

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

mid

The mid transform of the two bones hierarchy.

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

root

The root transform of the two bones hierarchy.

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

target

The IK target transform.

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

targetPositionWeight

The weight for which target position has an effect on IK calculations. This is a value in between 0 and 1.

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

targetRotationWeight

The weight for which target rotation has an effect on IK calculations. This is a value in between 0 and 1.

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

tip

The tip transform of the two bones hierarchy.

Declaration
public Transform tip { get; set; }
Property Value
Type Description
Transform
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

ITwoBoneIKConstraintData.hintWeightFloatProperty

The path to the hint weight property in the constraint component.

Declaration
readonly string ITwoBoneIKConstraintData.hintWeightFloatProperty { get; }
Returns
Type Description
String
Implements

ITwoBoneIKConstraintData.targetPositionWeightFloatProperty

The path to the target position weight property in the constraint component.

Declaration
readonly string ITwoBoneIKConstraintData.targetPositionWeightFloatProperty { get; }
Returns
Type Description
String
Implements

ITwoBoneIKConstraintData.targetRotationWeightFloatProperty

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

Declaration
readonly string ITwoBoneIKConstraintData.targetRotationWeightFloatProperty { get; }
Returns
Type Description
String
Implements