Interface IRigLayer
Interface for rig layers.
Namespace: UnityEngine.Animations.Rigging
Assembly: Unity.Animation.Rigging.dll
Syntax
public interface IRigLayerProperties
active
The active state. True if the IRigLayer is active, false otherwise.
Declaration
bool active { get; }Property Value
| Type | Description |
|---|---|
| bool |
constraints
The list of constraints associated with the IRigLayer.
Declaration
IRigConstraint[] constraints { get; }Property Value
| Type | Description |
|---|---|
| IRigConstraint[] |
jobs
The list of jobs built from constraints associated with the IRigLayer.
Declaration
IAnimationJob[] jobs { get; }Property Value
| Type | Description |
|---|---|
| IAnimationJob[] |
name
The IRigLayer name.
Declaration
string name { get; }Property Value
| Type | Description |
|---|---|
| string |
rig
The Rig associated to the IRigLayer
Declaration
Rig rig { get; }Property Value
| Type | Description |
|---|---|
| Rig |
Methods
Initialize(Animator)
Initializes the IRigLayer
Declaration
bool Initialize(Animator animator)Parameters
| Type | Name | Description |
|---|---|---|
| Animator | animator | The Animator used to animate the IRigLayer constraints. |
Returns
| Type | Description |
|---|---|
| bool | True if IRigLayer was initialized properly, false otherwise. |
IsValid()
Queries whether the IRigLayer is valid.
Declaration
bool IsValid()Returns
| Type | Description |
|---|---|
| bool | True if IRigLayer is valid, false otherwise. |
Reset()
Resets the IRigLayer.
Declaration
void Reset()Update()
Updates the IRigLayer jobs.
Declaration
void Update()