Struct OverrideTransformData

The OverrideTransform constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
public struct OverrideTransformData : IAnimationJobData, IOverrideTransformData

Properties

constrainedObject

The Transform affected by the constraint source Transform.

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

position

The override position. This is taken into account only if sourceObject is null.

Declaration
public Vector3 position { get; set; }
Property Value
Type Description
Vector3

positionWeight

The weight for which override position has an effect on constrained Transform. This is a value in between 0 and 1.

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

rotation

The override rotation. This is taken into account only if sourceObject is null.

Declaration
public Vector3 rotation { get; set; }
Property Value
Type Description
Vector3

rotationWeight

The weight for which override rotation has an effect on constrained Transform. This is a value in between 0 and 1.

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

sourceObject

The override source Transform.

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

space

The override space.

Declaration
public OverrideTransformData.Space space { get; set; }
Property Value
Type Description
OverrideTransformData.Space

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

IOverrideTransformData.positionVector3Property

The path to the override position property in the constraint component.

Declaration
string IOverrideTransformData.positionVector3Property { get; }
Returns
Type Description
String
Implements

IOverrideTransformData.positionWeightFloatProperty

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

Declaration
string IOverrideTransformData.positionWeightFloatProperty { get; }
Returns
Type Description
String
Implements

IOverrideTransformData.rotationVector3Property

The path to the override rotation property in the constraint component.

Declaration
string IOverrideTransformData.rotationVector3Property { get; }
Returns
Type Description
String
Implements

IOverrideTransformData.rotationWeightFloatProperty

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

Declaration
string IOverrideTransformData.rotationWeightFloatProperty { get; }
Returns
Type Description
String
Implements

IOverrideTransformData.space

The override space.

Declaration
int IOverrideTransformData.space { get; }
Returns
Type Description
Int32
Implements