Class 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.
Inherited Members
Namespace: UnityEngine.Animations.Rigging
Syntax
[RequireComponent(typeof(Animator))]
[DisallowMultipleComponent]
[ExecuteInEditMode]
[AddComponentMenu("Animation Rigging/Setup/Rig Builder")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.animation.rigging@1.0?preview=1&subfolder=/manual/index.html")]
public class RigBuilder : MonoBehaviour, IAnimationWindowPreview, IRigEffectorHolderFields
onAddRigBuilder
Notification callback that is sent whenever a RigBuilder calls OnEnable.
Declaration
public static RigBuilder.OnAddRigBuilderCallback onAddRigBuilderField Value
| Type | Description |
|---|---|
| RigBuilder.OnAddRigBuilderCallback |
onRemoveRigBuilder
Notification callback that is sent whenever a RigBuilder calls OnDisable.
Declaration
public static RigBuilder.OnRemoveRigBuilderCallback onRemoveRigBuilderField Value
| Type | Description |
|---|---|
| RigBuilder.OnRemoveRigBuilderCallback |
Properties
graph
Retrieves the PlayableGraph created by this RigBuilder.
Declaration
public PlayableGraph graph { get; }Property Value
| Type | Description |
|---|---|
| PlayableGraph |
layers
Returns a list of RigLayer associated to this RigBuilder.
Declaration
public List<RigLayer> layers { get; set; }Property Value
| Type | Description |
|---|---|
| List<RigLayer> |
Methods
Build()
Builds the RigBuilder PlayableGraph.
Declaration
public bool Build()Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the RigBuilder has created a valid PlayableGraph. Returns false otherwise. |
BuildPreviewGraph(PlayableGraph, Playable)
Appends custom Playable nodes to the animation previewer PlayableGraph.
Declaration
public Playable BuildPreviewGraph(PlayableGraph graph, Playable inputPlayable)Parameters
| Type | Name | Description |
|---|---|---|
| PlayableGraph | graph | The animation previewer PlayableGraph |
| Playable | inputPlayable | The current root of the PlayableGraph |
Returns
| Type | Description |
|---|---|
| Playable |
Implements
Clear()
Destroys the RigBuilder PlayableGraph and frees associated RigLayers memory.
Declaration
public void Clear()StartPreview()
Notification callback when the animation previewer starts previewing an AnimationClip.
Declaration
public void StartPreview()Implements
Remarks
This is called by the Animation Window or the Timeline Editor.
StopPreview()
Notification callback when the animation previewer stops previewing an AnimationClip.
Declaration
public void StopPreview()Implements
Remarks
This is called by the Animation Window or the Timeline Editor.
UpdatePreviewGraph(PlayableGraph)
Notification callback when the animation previewer updates its PlayableGraph before sampling an AnimationClip.
Declaration
public void UpdatePreviewGraph(PlayableGraph graph)Parameters
| Type | Name | Description |
|---|---|---|
| PlayableGraph | graph | The animation previewer PlayableGraph |
Implements
Remarks
This is called by the Animation Window or the Timeline Editor.