Struct MultiPositionConstraintData

The MultiPosition constraint job.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct MultiPositionConstraintData : IAnimationJobData, IMultiPositionConstraintData

Properties

constrainedObject

The Transform affected by the constraint Source Transforms.

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

constrainedXAxis

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

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

constrainedYAxis

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

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

constrainedZAxis

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

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

maintainOffset

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

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

offset

Post-Translation offset applied to the constrained Transform.

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

sourceObjects

The list of Transforms that influence the constrained Transform position. 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

IMultiPositionConstraintData.offsetVector3Property

The path to the offset property in the constraint component.

Declaration
readonly string IMultiPositionConstraintData.offsetVector3Property { get; }
Returns
Type Description
String
Implements

IMultiPositionConstraintData.sourceObjectsProperty

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

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