Struct MultiAimConstraintData

The MultiAim constraint data.

Namespace: UnityEngine.Animations.Rigging
Syntax
[Serializable]
public struct MultiAimConstraintData : IAnimationJobData, IMultiAimConstraintData

Properties

aimAxis

Specifies the local aim axis of the constrained Transform to use in order to orient itself to the Source Transforms.

Declaration
public MultiAimConstraintData.Axis aimAxis { get; set; }
Property Value
Type Description
MultiAimConstraintData.Axis

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 rotate along the X axis.

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

constrainedYAxis

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

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

constrainedZAxis

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

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

limits

Minimum and maximum value of the rotation permitted for the constraint. The values are in degrees.

Declaration
public Vector2 limits { get; set; }
Property Value
Type Description
Vector2

maintainOffset

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

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

offset

Post-Rotation 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 orientation. Each source has a weight from 0 to 1.

Declaration
public WeightedTransformArray sourceObjects { get; set; }
Property Value
Type Description
WeightedTransformArray
Implements

upAxis

Specified the local up axis of the constrained Transform to use in order to orient itself to the Source Transforms.

Declaration
public MultiAimConstraintData.Axis upAxis { get; set; }
Property Value
Type Description
MultiAimConstraintData.Axis

worldUpAxis

Specifies the local aim axis of the constrained Transform to use in order to orient itself to the Source Transforms.

Declaration
public MultiAimConstraintData.Axis worldUpAxis { get; set; }
Property Value
Type Description
MultiAimConstraintData.Axis

worldUpObject

The Transform used to calculate the upward direction. This is used when World Up Type is set to WorldUpType.ObjectUp or WorldUpType.ObjectRotationUp.

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

worldUpType

Specifies which mode to use to keep the upward direction of the constrained Object.

Declaration
public MultiAimConstraintData.WorldUpType worldUpType { get; set; }
Property Value
Type Description
MultiAimConstraintData.WorldUpType
See Also

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

IMultiAimConstraintData.aimAxis

Specifies the local aim axis of the constrained Transform to use in order to orient itself to the Source Transforms.

Declaration
readonly Vector3 IMultiAimConstraintData.aimAxis { get; }
Returns
Type Description
Vector3
Implements

IMultiAimConstraintData.maxLimitFloatProperty

The path to the maximum limit property in the constraint component.

Declaration
readonly string IMultiAimConstraintData.maxLimitFloatProperty { get; }
Returns
Type Description
String
Implements

IMultiAimConstraintData.minLimitFloatProperty

The path to the minimum limit property in the constraint component.

Declaration
readonly string IMultiAimConstraintData.minLimitFloatProperty { get; }
Returns
Type Description
String
Implements

IMultiAimConstraintData.offsetVector3Property

The path to the offset property in the constraint component.

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

IMultiAimConstraintData.sourceObjectsProperty

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

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

IMultiAimConstraintData.upAxis

Specified the local up axis of the constrained Transform to use in order to orient itself to the Source Transforms.

Declaration
readonly Vector3 IMultiAimConstraintData.upAxis { get; }
Returns
Type Description
Vector3
Implements

IMultiAimConstraintData.worldUpAxis

A static vector in world coordinates that is the general upward direction. This is used when World Up Type is set to WorldUpType.Vector.

Declaration
readonly Vector3 IMultiAimConstraintData.worldUpAxis { get; }
Returns
Type Description
Vector3
Implements

IMultiAimConstraintData.worldUpType

Specifies which mode to use to keep the upward direction of the constrained Object.

Declaration
readonly int IMultiAimConstraintData.worldUpType { get; }
Returns
Type Description
Int32
Implements
See Also