Class VirtualAnimatorController

Namespace

nadena.dev.ndmf.animator

Represents an animator controller that has been indexed by NDMF for faster manipulation. This class also guarantees that certain assets have been cloned, specifically:

• AnimatorController
• StateMachine
• AnimatorState
• AnimatorStateTransition
• BlendTree
• AnimationClip
• Any state behaviors attached to the animator controller

public sealed class VirtualAnimatorController : VirtualNode

Inheritance

object

VirtualNode

VirtualAnimatorController

Inherited Members

VirtualNode.AllReachableNodes()

VirtualNode.EnumerateChildren()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Layers

Returns all layers in this controller.

When used in 'set' mode, the set of layers will be replaced by the provided value, with all layers at layer priority zero.

public IEnumerable<VirtualLayer> Layers { get; set; }

Property Value

IEnumerable<VirtualLayer>

Name

public string Name { get; set; }

Property Value

string

Parameters

public ImmutableDictionary<string, AnimatorControllerParameter> Parameters { get; set; }

Property Value

ImmutableDictionary<string, AnimatorControllerParameter>

Methods

AddLayer(LayerPriority, string)

Creates a new layer and adds it to this controller

public VirtualLayer AddLayer(LayerPriority priority, string name)

Parameters

priority LayerPriority

name string

Returns

VirtualLayer

AddLayer(LayerPriority, VirtualLayer)

Adds a layer to this controller

public void AddLayer(LayerPriority priority, VirtualLayer layer)

Parameters

priority LayerPriority

layer VirtualLayer

Exceptions

InvalidOperationException

Create(CloneContext, string)

Constructs a new animator controller

public static VirtualAnimatorController Create(CloneContext context, string name = "(unnamed)")

Parameters

context CloneContext

The CloneContext to use for virtual layer assignment (can be obtained from @"VirtualControllerContext")

name string

The name of the new controller

Returns

VirtualAnimatorController

NormalizeFirstLayerWeights()

Sets the layer weight for all layers with a zero OriginalPhysicalLayerIndex to one, and sets OriginalPhysicalLayerIndex to null for all layers except the first layer. This should be invoked after merging controllers to correct for the fact that Unity considers the first layer to always have weight one, even if the serialized weight is not one. This function is automatically invoked when deactivating the VirtualControllerContext.

public void NormalizeFirstLayerWeights()

RemoveLayer(VirtualLayer)

Removes a layer from this controller

public void RemoveLayer(VirtualLayer layer)

Parameters

layer VirtualLayer

RemoveLayers(Func<VirtualLayer, bool>)

Removes all layers that match the given predicate

public void RemoveLayers(Func<VirtualLayer, bool> shouldRemove)

Parameters

shouldRemove Func<VirtualLayer, bool>

_EnumerateChildren()

protected override IEnumerable<VirtualNode> _EnumerateChildren()

Returns

IEnumerable<VirtualNode>