Struct MultiParentConstraintData

The MultiParent constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct MultiParentConstraintData : IAnimationJobData, IMultiParentConstraintData

Properties

constrainedObject

The Transform affected by the constraint Source Transforms.

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

constrainedPositionXAxis

Toggles whether the constrained transform will translate along the X axis.

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

constrainedPositionYAxis

Toggles whether the constrained transform will translate along the Y axis.

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

constrainedPositionZAxis

Toggles whether the constrained transform will translate along the Z axis.

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

constrainedRotationXAxis

Toggles whether the constrained transform will rotate along the X axis.

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

constrainedRotationYAxis

Toggles whether the constrained transform will rotate along the Y axis.

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

constrainedRotationZAxis

Toggles whether the constrained transform will rotate along the Z axis.

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

maintainPositionOffset

This is used to maintain the current position offset from the constrained GameObject to the source GameObjects.

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

maintainRotationOffset

This is used to maintain the current rotation offset from the constrained GameObject to the source GameObjects.

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

sourceObjects

The list of Transforms that influence the constrained Transform rotation. Each source has a weight from 0 to 1.

Declaration
public WeightedTransformArray sourceObjects { 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

IMultiParentConstraintData.sourceObjectsProperty

The path to the source objects property in the constraint component.

Declaration
readonly string IMultiParentConstraintData.sourceObjectsProperty { get; }
Returns
Type Description
String
Implements