Summary

A list of Animancer.AnimancerLayers with methods to control their mixing and masking.

Assembly

Animancer.dll

Namespace

Animancer

Interfaces

IEnumerable<AnimancerLayer>
IAnimationClipCollection

Base Types

Object

Derived Types

graph BT Type-->Base0["Object"] Type-.->Interface0["IEnumerable<AnimancerLayer>"] Type-.->Interface1["IAnimationClipCollection"] click Interface1 "/animancer/api/Animancer/IAnimationClipCollection" Type["AnimancerLayerList"] class Type type-node Derived0["WeightedMaskLayerList"]-->Type click Derived0 "/animancer/api/Animancer/WeightedMaskLayerList" Derived1["AnimancerLayerMixerList"]-->Type click Derived1 "/animancer/api/Animancer/AnimancerLayerMixerList"

Syntax

public abstract class AnimancerLayerList : IEnumerable<AnimancerLayer>, IAnimationClipCollection

Remarks

The default implementation of this class is Animancer.AnimancerLayerMixerList.

Documentation: Layers

Constructors

Name	Summary
AnimancerLayerList(AnimancerGraph)	Creates a new `Animancer.AnimancerLayerList`.

Fields

Name	Constant Value	Summary
Graph		The `Animancer.AnimancerGraph` containing this list.

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.
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`.
Count	int	[Pro-Only] The number of layers in this list.
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. static
Playable	Playable	The `UnityEngine.Playables.Playable` which blends the layers.
this[int]	AnimancerLayer	Returns the layer at the specified index. If it didn't already exist, this method creates it.

Methods

Name	Value	Summary
Add()	AnimancerLayer	[Pro-Only] Creates and returns a new `Animancer.AnimancerLayer` at the end of this list.
GatherAnimationClips(ICollection<AnimationClip>)	void	[`Animancer.IAnimationClipCollection`] Gathers all the animations in all layers.
GetEnumerator()	FastEnumerator<AnimancerLayer>	Returns an enumerator that will iterate through all layers.
GetLayer(int)	AnimancerLayer	Returns the layer at the specified index.
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.
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.
SetMinDefaultCapacity(int)	void	[Pro-Only] If the `Animancer.AnimancerLayerList.DefaultCapacity` is below the specified `min`, this method increases it to that value. static