AnimancerLayerMixerList Class

Summary

An Animancer.AnimancerLayerList which uses an UnityEngine.Animations.AnimationLayerMixerPlayable.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
graph BT Type-->Base0["AnimancerLayerList"] click Base0 "/animancer/api/Animancer/AnimancerLayerList" Base0-->Base1["Object"] Type-.->Interface0["IEnumerable<AnimancerLayer>"] Type-.->Interface1["IAnimationClipCollection"] click Interface1 "/animancer/api/Animancer/IAnimationClipCollection" Type["AnimancerLayerMixerList"] class Type type-node

Syntax

public class AnimancerLayerMixerList : AnimancerLayerList, IEnumerable<AnimancerLayer>, 
    IAnimationClipCollection

Remarks

Documentation: Layers

Constructors

Name Summary
AnimancerLayerMixerList(AnimancerGraph) Creates a new Animancer.AnimancerLayerMixerList.

Fields

Name Constant Value Summary
Graph
The Animancer.AnimancerGraph containing this list.
Inherited from AnimancerLayerList

Properties

Name Value Summary
AverageVelocity Vector3
The average velocity of the root motion of all currently playing animations, taking their current Animancer.AnimancerNode.Weight into account.
Inherited from AnimancerLayerList
Capacity int
[Pro-Only] The maximum number of layers that can be created before an System.ArgumentOutOfRangeException will be thrown. The initial capacity is determined by Animancer.AnimancerLayerList.DefaultCapacity.
Inherited from AnimancerLayerList
Count int
[Pro-Only] The number of layers in this list.
Inherited from AnimancerLayerList
DefaultCapacity int
[Pro-Only] The maximum number of layers that can be created before an System.ArgumentOutOfRangeException will be thrown (default 4).

Lowering this value will not affect layers that have already been created.
Inherited from AnimancerLayerList
static
LayerMixer AnimationLayerMixerPlayable
The UnityEngine.Animations.AnimationLayerMixerPlayable which blends the layers.
Playable Playable
The UnityEngine.Playables.Playable which blends the layers.
Inherited from AnimancerLayerList
this[int] AnimancerLayer
Returns the layer at the specified index. If it didn't already exist, this method creates it.
Inherited from AnimancerLayerList

Methods

Name Value Summary
Add() AnimancerLayer
[Pro-Only] Creates and returns a new Animancer.AnimancerLayer at the end of this list.
Inherited from AnimancerLayerList
GatherAnimationClips(ICollection<AnimationClip>) void
[Animancer.IAnimationClipCollection] Gathers all the animations in all layers.
Inherited from AnimancerLayerList
GetEnumerator() FastEnumerator<AnimancerLayer>
Returns an enumerator that will iterate through all layers.
Inherited from AnimancerLayerList
GetLayer(int) AnimancerLayer
Returns the layer at the specified index.
Inherited from AnimancerLayerList
IsAdditive(int) bool
[Pro-Only] Is the layer at the specified index is set to additive blending? Otherwise it will override lower layers.
SetAdditive(int, bool) void
[Pro-Only] Sets the layer at the specified index to blend additively with earlier layers (if true) or to override them (if false). Newly created layers will override by default.
SetDebugName(int, string) void
[Editor-Conditional] Sets the Inspector display name of the layer at the specified index.
Inherited from AnimancerLayerList
SetMask(int, AvatarMask) void
[Pro-Only] Sets an UnityEngine.AvatarMask to determine which bones the layer at the specified index will affect.
SetMinCount(int) void
[Pro-Only] If the Animancer.AnimancerLayerList.Count is below the specified `min`, this method increases it to that value.
Inherited from AnimancerLayerList
SetMinDefaultCapacity(int) void
[Pro-Only] If the Animancer.AnimancerLayerList.DefaultCapacity is below the specified `min`, this method increases it to that value.
Inherited from AnimancerLayerList
static