Class RigLayer

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

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

Constructors

RigLayer(Rig, bool)

Constructor.

Declaration
public RigLayer(Rig rig, bool active = true)
Parameters
Type Name Description
Rig rig

The rig represented by this rig layer.
bool active

The active state of the rig layer.

Properties

active

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

Declaration
public bool active { get; set; }
Property Value
Type Description
bool

constraints

The list of constraints associated with the RigLayer.

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

isInitialized

Returns true if RigLayer 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 RigLayer.

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

name

The RigLayer name.

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

rig

The Rig associated to the RigLayer

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

Methods

Initialize(Animator)

Initializes the RigLayer. This will retrieve the constraints associated with the Rig and create the animation jobs required by the PlayableGraph.

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 RigLayer is valid.

Declaration
public bool IsValid()
Returns
Type Description
bool

True if RigLayer is valid, false otherwise.

Reset()

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

Declaration
public void Reset()

Update()

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

Declaration
public void Update()

Implements