Class OverrideRigLayer

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

Inheritance
object
OverrideRigLayer
Implements
Inherited Members
Namespace: UnityEngine.Animations.Rigging
Assembly: Unity.Animation.Rigging.dll
Syntax
[Serializable]
public class OverrideRigLayer : IRigLayer

Constructors

OverrideRigLayer(Rig, IRigConstraint[], bool)

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.
bool 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
bool

constraints

The list of constraints associated with the OverrideRigLayer.

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

isInitialized

Returns true if OverrideRigLayer was initialized or false otherwise.

Declaration
public bool isInitialized { get; }
Property Value
Type Description
bool
See Also

jobs

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

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

name

The OverrideRigLayer name.

Declaration
public string name { get; }
Property Value
Type Description
string

rig

The Rig associated to the OverrideRigLayer

Declaration
public Rig rig { get; }
Property Value
Type Description
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
bool

True if RigLayer was initialized properly, false otherwise.

IsValid()

Queries whether the OverrideRigLayer is valid.

Declaration
public bool IsValid()
Returns
Type Description
bool

True if OverrideRigLayer is valid, false otherwise.

Reset()

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

Declaration
public void Reset()

Update()

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

Declaration
public void Update()

Implements