Class AnimationIndex

Namespace

nadena.dev.ndmf.animator

AnimationIndex indexes the full set of animations known to the VirtualControllerContext, and allows for efficient querying of animations by object path or binding, as well as some bulk editing operations. The AnimationIndex registers invalidation callbacks with all nodes in the virtual controller hierarchy, and will therefore be automatically updated if anything changes in the hierarchy. Normally, you should obtain an AnimationIndex from the AnimatorServicesContext, but constructors are provided for testing purposes.

public sealed class AnimationIndex

Inheritance

object

AnimationIndex

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AnimationIndex(IEnumerable<VirtualNode>)

Creates an animation index over a set of virtualized animator controllers. This method is primarily intended for use in tests.

public AnimationIndex(IEnumerable<VirtualNode> controllers)

Parameters

controllers IEnumerable<VirtualNode>

Properties

ClipsWithObjectCurves

public IEnumerable<VirtualClip> ClipsWithObjectCurves { get; }

Property Value

IEnumerable<VirtualClip>

GetPPtrReferencedObjects

public IEnumerable<UnityEngine.Object> GetPPtrReferencedObjects { get; }

Property Value

IEnumerable<UnityEngine.Object>

Methods

ApplyPathPrefix(string)

Applies a prefix to all paths in the index. Implicitly adds a "/" to the end of the path.

public void ApplyPathPrefix(string basePath)

Parameters

basePath string

EditClipsByBinding(IEnumerable<EditorCurveBinding>, Action<VirtualClip>)

Applies an arbitrary callback to all clips associated with a given object path. This operation can be more efficient than querying for all clips associated with a path and then applying the callback, as it avoids rebuilding the entire animation index when clips are edited.

public void EditClipsByBinding(IEnumerable<EditorCurveBinding> binding, Action<VirtualClip> processClip)

Parameters

binding IEnumerable<EditorCurveBinding>

processClip Action<VirtualClip>

GetClipsForBinding(EditorCurveBinding)

Returns all clips containing curves for a given binding.

public IEnumerable<VirtualClip> GetClipsForBinding(EditorCurveBinding binding)

Parameters

binding EditorCurveBinding

Returns

IEnumerable<VirtualClip>

GetClipsForObjectPath(string)

Returns all clips associated with a given virtual object path.

public IEnumerable<VirtualClip> GetClipsForObjectPath(string objectPath)

Parameters

objectPath string

Returns

IEnumerable<VirtualClip>

RewriteObjectCurves(Func<Object, Object>)

Maps all object curves in the animation index according to the provided mapping function. The mapping function must not return null. ClipsWithObjectCurves if you need to perform more complex manipulations.

public void RewriteObjectCurves(Func<UnityEngine.Object, UnityEngine.Object> mapping)

Parameters

mapping Func<UnityEngine.Object, UnityEngine.Object>

Mapping function to apply

RewritePaths(Dictionary<string, string?>)

Rewrites all object paths in animations and avatar masks according to the provided mapping dictionary. If the path is not present in the dictionary, it will be unchanged; if it is present and mapped to null, it will be deleted from animations.

public void RewritePaths(Dictionary<string, string?> rewriteRules)

Parameters

rewriteRules Dictionary<string, string>

RewritePaths(Func<string, string?>)

Rewrites all object paths in animations and avatar masks according to the provided mapping function. If the mapping function returns null, all animations referencing the path will be removed from the animation.

public void RewritePaths(Func<string, string?> rewriteRules)

Parameters

rewriteRules Func<string, string>