Class OverrideRigLayer | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Class OverrideRigLayer

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

    Inheritance
    Object
    OverrideRigLayer
    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public class OverrideRigLayer : IRigLayer

    Constructors

    OverrideRigLayer(Rig, IRigConstraint[], Boolean)

    Constructor.

    Declaration
    public OverrideRigLayer(Rig rig, IRigConstraint[] constraints, bool active = true)
    Parameters
    Type Name Description
    Rig rig

    The rig represented by this override rig layer.

    IRigConstraint[] constraints

    The constraints that override those of the rig.

    Boolean active

    The active state of the override rig layer.

    Properties

    active

    The active state. True if the OverrideRigLayer is active, false otherwise.

    Declaration
    public bool active { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IRigLayer.active

    constraints

    The list of constraints associated with the OverrideRigLayer.

    Declaration
    public IRigConstraint[] constraints { get; }
    Property Value
    Type Description
    IRigConstraint[]
    Implements
    IRigLayer.constraints

    isInitialized

    Returns true if OverrideRigLayer was initialized or false otherwise.

    Declaration
    public bool isInitialized { get; }
    Property Value
    Type Description
    Boolean
    See Also
    Initialize(Animator)

    jobs

    The list of jobs built from constraints associated with the OverrideRigLayer.

    Declaration
    public IAnimationJob[] jobs { get; }
    Property Value
    Type Description
    IAnimationJob[]
    Implements
    IRigLayer.jobs

    name

    The OverrideRigLayer name.

    Declaration
    public string name { get; }
    Property Value
    Type Description
    String
    Implements
    IRigLayer.name

    rig

    The Rig associated to the OverrideRigLayer

    Declaration
    public Rig rig { get; }
    Property Value
    Type Description
    Rig
    Implements
    IRigLayer.rig

    Methods

    Initialize(Animator)

    Initializes the OverrideRigLayer. This will create animation jobs using the rig constraints provided to the OverrideRigLayer.

    Declaration
    public bool Initialize(Animator animator)
    Parameters
    Type Name Description
    Animator animator

    The Animator used to animate the RigLayer constraints.

    Returns
    Type Description
    Boolean

    True if RigLayer was initialized properly, false otherwise.

    Implements
    IRigLayer.Initialize(Animator)

    IsValid()

    Queries whether the OverrideRigLayer is valid.

    Declaration
    public bool IsValid()
    Returns
    Type Description
    Boolean

    True if OverrideRigLayer is valid, false otherwise.

    Implements
    IRigLayer.IsValid()

    Reset()

    Resets the OverrideRigLayer. This will destroy the animation jobs and free up memory.

    Declaration
    public void Reset()
    Implements
    IRigLayer.Reset()

    Update()

    Updates the OverrideRigLayer jobs. This is called during the Update loop before the Animator evaluates the PlayableGraph.

    Declaration
    public void Update()
    Implements
    IRigLayer.Update()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023