docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace UnityEngine.Animations.Rigging

    Classes

    AnimationJobBinder<TJob, TData>

    The is the base class for all animation job binders.

    AnimationJobCacheBuilder

    AnimationJobCacheBuilder can be used to create a new AnimationJobCache object.

    AnimationRuntimeUtils

    Utility functions for runtime constraints.

    BlendConstraint

    Blend constraint.

    BlendConstraintJobBinder<T>

    The Blend constraint job binder.

    BoneRenderer

    The BoneRenderer component is responsible for displaying pickable bones in the Scene View. This component does nothing during runtime.

    ChainIKConstraint

    ChainIK constraint

    ChainIKConstraintJobBinder<T>

    The ChainIK constraint job binder.

    ConstraintsUtils

    Utility functions for constraints.

    DampedTransform

    DampedTransform constraint.

    DampedTransformJobBinder<T>

    The DampedTransform job binder.

    MultiAimConstraint

    MultiAim constraint.

    MultiAimConstraintJobBinder<T>

    The MultiAim constraint job binder.

    MultiParentConstraint

    MultiParent constraint

    MultiParentConstraintJobBinder<T>

    The MultiParent constraint job binder.

    MultiPositionConstraint

    MultiPosition constraint.

    MultiPositionConstraintJobBinder<T>

    The MultiPosition constraint job binder.

    MultiReferentialConstraint

    MultiReferential constraint.

    MultiReferentialConstraintJobBinder<T>

    The MultiReferential constraint job binder.

    MultiRotationConstraint

    MultiRotation constraint.

    MultiRotationConstraintJobBinder<T>

    The MultiRotation constraint job binder.

    OverrideRigConstraint<TConstraint, TJob, TData, TBinder>

    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.

    OverrideTransform

    OverrideTransform constraint.

    OverrideTransformJobBinder<T>

    The OverrideTransform job binder.

    PropertyUtils

    Utility functions for constraints (deprecated).

    QuaternionExt

    Supplementary functions for Quaternion.

    Rig

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

    RigBuilder

    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.

    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, float, float).

    WeightedTransformArrayBinder

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

    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.

    BoneRenderer.TransformPair

    Bone described by two Transform references.

    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.

    Interfaces

    IAnimatableProperty<T>

    Interface for animatable property handles used to read and write values in the AnimationStream.

    IAnimationJobBinder

    This is the base interface for all animation job binders.

    IAnimationJobData

    This interface is used to represent all constraint data structs.

    IBlendConstraintData

    This interface defines the data mapping for the Blend constraint.

    IChainIKConstraintData

    This interface defines the data mapping for the ChainIK constraint.

    IDampedTransformData

    This interface defines the data mapping for DampedTransform.

    IMultiAimConstraintData

    This interface defines the data mapping for the MultiAim constraint.

    IMultiParentConstraintData

    This interface defines the data mapping for the MultiParent constraint.

    IMultiPositionConstraintData

    This interface defines the data mapping for the MultiPosition constraint.

    IMultiReferentialConstraintData

    This interface defines the data mapping for the MultiReferential constraint.

    IMultiRotationConstraintData

    This interface defines the data mapping for the MultiRotation constraint.

    IOverrideTransformData

    This interface defines the data mapping for OverrideTransform.

    IRigConstraint

    This interface is used to represent all constraints classes.

    IRigEffectorHolder

    This interface represents classes that hold and serialize effectors. Effectors do nothing during runtime.

    IRigLayer

    Interface for rig layers.

    ITransformProvider

    Provides an accessor to a Transform component reference.

    ITwistChainConstraintData

    This interface defines the data mapping for the TwistChain constraint.

    ITwistCorrectionData

    This interface defines the data mapping for TwistCorrection.

    ITwoBoneIKConstraintData

    This interface defines the data mapping for the TwoBoneIK constraint.

    IWeightProvider

    Provides an access to a weight value.

    IWeightedAnimationJob

    This interface represents an animation job with a weight value.

    Enums

    BoneRenderer.BoneShape

    Shape used by individual bones.

    MultiAimConstraintData.Axis

    Axis type for MultiAimConstraint.

    MultiAimConstraintData.WorldUpType

    Specifies how the world up vector used by the Multi-Aim constraint is defined.

    MultiAimConstraintJob.WorldUpType

    Specifies how the world up vector used by the Multi-Aim constraint is defined.

    OverrideTransformData.Space

    The override space controls how the override source Transform is copied unto constrained Transform.

    OverrideTransformJob.Space

    The override space controls how the override source Transform is copied unto constrained Transform.

    TwistCorrectionData.Axis

    Axis type for TwistCorrection.

    Delegates

    BoneRenderer.OnAddBoneRendererCallback

    Delegate function that covers a BoneRenderer calling OnEnable.

    BoneRenderer.OnRemoveBoneRendererCallback

    Delegate function that covers a BoneRenderer calling OnDisable.

    RigBuilder.OnAddRigBuilderCallback

    Delegate function that covers a RigBuilder calling OnEnable.

    RigBuilder.OnRemoveRigBuilderCallback

    Delegate function that covers a RigBuilder calling OnDisable.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)