Use this class to define an override rig constraint on another rig constraint. While the overriden constraint data remains the same, the job is overriden.

OverrideRigLayer

The OverrideRigLayer is used to override constraints normally evaluated by a specified Rig component.

PropertyUtils

Utility functions for constraints (deprecated).

Rig

The Rig component is used to group constraints under its GameObject local hierarchy.

RigBuilder is the root component that holds the Rigs that create an Animation Rigging hierarchy. Its purpose is to create the PlayableGraph that will be used in the associated Animator component to animate a character with constraints.

RigConstraint<TJob, TData, TBinder>

This is the base class for rig constraints. Inherit from this class to implement custom constraints.

RigEffectorData

This class holds the serialized data necessary to build a rig effector. This is saved in either the RigBuilder, or the Rig component.

RigLayer

The RigLayer is used by the RigBuilder to control in which order rigs will be evaluated and whether they are active or not.

RigTransform

SyncSceneToStreamAttribute

The [SyncSceneToStream] attribute can be used to ensure constraints properties are read from the scene and written back in the AnimationStream if they were not previously animated. Supported value types are: Float, Int, Bool, Vector2, Vector3, Vector4, Quaternion, Vector3Int, Vector3Bool, Transform, Transform[], WeightedTransform and WeightedTransformArray.

TwistChainConstraint

TwistChain constraint

TwistChainConstraintJobBinder<T>

The TwistChain constraint job binder.

TwistCorrection

TwistCorrection constraint.

TwistCorrectionJobBinder<T>

The TwistCorrection job binder.

TwoBoneIKConstraint

TwoBoneIK constraint

TwoBoneIKConstraintJobBinder<T>

The TwoBoneIK constraint job binder.

WeightedTransformArrayBinder

This class is used to create Animation C# jobs handles for WeightedTransformArray.

WeightRangeAttribute

By default, weight appears as a numeric input field in the Inspector. Decorate WeightedTransform or WeightedTransformArray fields with this attribute to make it display using a slider with the specified range. See also OnValidate(ref WeightedTransformArray, Single, Single).

Structs

AffineTransform

Rigid transform with only translation and rotation components.

AnimationJobCache

AnimationJobCache can be used in animation jobs to store values that can be updated through the AnimationJobCache during the Update loop without rebuilding the job.

BlendConstraintData

The Blend constraint data.

BlendConstraintJob

The Blend constraint job.

BoolProperty

Boolean property handle used to read and write values in the AnimationStream.

CacheIndex

CacheIndex is used in AnimationJobCache to recover the index to the cached data.

ChainIKConstraintData

The ChainIK constraint data.

ChainIKConstraintJob

The ChainIK constraint job.

DampedTransformData

The DampedTransform constraint data.

DampedTransformJob

The DampedTransform job.

FloatProperty

Float property handle used to read and write values in the AnimationStream.

IntProperty

Integer property handle used to read and write values in the AnimationStream.

MultiAimConstraintData

The MultiAim constraint data.

MultiAimConstraintJob

The MultiAim constraint job.

MultiParentConstraintData

The MultiParent constraint data.

MultiParentConstraintJob

The MultiParent constraint job.

MultiPositionConstraintData

The MultiPosition constraint job.

MultiPositionConstraintJob

The MultiPosition constraint job.

MultiReferentialConstraintData

The MultiReferential constraint data.

MultiReferentialConstraintJob

The MultiReferential constraint job.

MultiRotationConstraintData

The MultiRotation constraint job.

MultiRotationConstraintJob

The MultiRotation constraint job.

OverrideTransformData

The OverrideTransform constraint data.

OverrideTransformJob

The OverrideTransform job.

ReadOnlyTransformHandle

Read-only handle on a Transform component used in Animation C# Jobs.

ReadWriteTransformHandle

Read/write handle on a Transform component used in Animation C# Jobs.

RigEffectorData.Style

The effector visual style.

TwistChainConstraintData

The TwistChain constraint data.

TwistChainConstraintJob

The TwistChain constraint job.

TwistCorrectionData

The TwistCorrection constraint data.

TwistCorrectionJob

The TwistCorrection job.

TwoBoneIKConstraintData

The TwoBoneIK constraint data.

TwoBoneIKConstraintJob

The TwoBoneIK constraint job.

Vector2Property

Vector2 property handle used to read and write values in the AnimationStream.

Vector3Bool

Three-dimensional boolean vector.

Vector3BoolProperty

Vector3Bool property handle used to read and write values in the AnimationStream.

Vector3IntProperty

Vector3Int property handle used to read and write values in the AnimationStream.

Vector3Property

Vector3 property handle used to read and write values in the AnimationStream.

Vector4Property

Vector4 property handle used to read and write values in the AnimationStream.

WeightedTransform

Tuple of a Reference to a Transform component and a weight number. See also WeightedTransformArray and WeightRangeAttribute.

WeightedTransformArray

This struct defines a List of WeightedTransform. WeightedTransformArray can be animated (as opposed to System.List and C# arrays) and is implemented with a hard limit of eight WeightedTransform elements. See also WeightedTransform and WeightRangeAttribute.

Namespace UnityEngine.Animations.Rigging

Classes

Structs

Interfaces

Enums

Delegates