Struct TwistCorrectionData

The TwistCorrection constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct TwistCorrectionData : IAnimationJobData, ITwistCorrectionData

Properties

sourceObject

The source Transform that influences the twist nodes.

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

twistAxis

Declaration
public TwistCorrectionData.Axis twistAxis { get; set; }
Property Value
Type Description
TwistCorrectionData.Axis

twistNodes

The list of Transforms on which to apply twist corrections. Each twist node has a weight that ranges from -1 to 1 to control how closely a twist node follows source rotation (from 0 to 1), or opposite rotation (from -1 to 0).

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

ITwistCorrectionData.source

The source Transform that influences the twist nodes.

Declaration
readonly Transform ITwistCorrectionData.source { get; }
Returns
Type Description
Transform
Implements

ITwistCorrectionData.twistAxis

The local twist axis of the source Transform on which to evaluate twist rotation.

Declaration
readonly Vector3 ITwistCorrectionData.twistAxis { get; }
Returns
Type Description
Vector3
Implements

ITwistCorrectionData.twistNodesProperty

The path to the twist nodes property in the constraint component.

Declaration
readonly string ITwistCorrectionData.twistNodesProperty { get; }
Returns
Type Description
String
Implements