AnimationGatherer Class

Summary

[Editor-Only] A system that procedurally gathers animations throughout the hierarchy without needing explicit references.
Assembly
Animancer.dll
Namespace
Animancer.Editor
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IAnimationClipCollection"] click Interface0 "/animancer/api/Animancer/IAnimationClipCollection" Type["AnimationGatherer"] class Type type-node

Syntax

public sealed class AnimationGatherer : IAnimationClipCollection

Fields

Name Constant Value Summary
Clips
All the UnityEngine.AnimationClips that have been gathered.
Transitions
All the Animancer.ITransitions that have been gathered.

Properties

Name Value Summary
ExceptionCapacity int
[Editor-Only] A positive value causes exceptions thrown while gathering animations to be stores in a list so they can be displayed in the Animancer.Editor.TransitionPreviewWindow if the user wants to debug them rather than logging them immediately.

0 causes exceptions to be ignored entirely and any negative value causes them to be logged immediately.
static

Methods

Name Value Summary
ClearCache() void
Clears all cached gatherers.
static
GatherAnimationClips(ICollection<AnimationClip>) void
Adds all the animations associated with this object to the `clips`.
GatherFromGameObject(GameObject) AnimationGatherer
Returns a cached Animancer.Editor.AnimationGatherer containing any UnityEngine.AnimationClips referenced by components in the same hierarchy as the `gameObject`. See Animancer.ICharacterRoot for details.
static
GatherFromGameObject(GameObject, AnimationClip[], bool) void
Fills the `clips` with any UnityEngine.AnimationClips referenced by components in the same hierarchy as the `gameObject`. See Animancer.ICharacterRoot for details.
static
GatherFromGameObject(GameObject, ICollection<AnimationClip>) void
Fills the `clips` with any UnityEngine.AnimationClips referenced by components in the same hierarchy as the `gameObject`. See Animancer.ICharacterRoot for details.
static