AnimationModifierTool Class

Summary

[Editor-Only] [Pro-Only] A base Animancer.Editor.Tools.AnimancerToolsWindow.Tool for modifying UnityEngine.AnimationClips.
Assembly
Animancer.dll
Namespace
Animancer.Editor.Tools
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["AnimancerToolsWindow.Tool"] click Base0 "/animancer/api/Animancer.Editor.Tools/Tool" Base0-->Base1["Object"] Type-.->Interface0["IComparable<AnimancerToolsWindow.Tool>"] Type["AnimationModifierTool"] class Type type-node Derived0["ModifyAnimationSpeedTool"]-->Type click Derived0 "/animancer/api/Animancer.Editor.Tools/ModifyAnimationSpeedTool" Derived1["RemapAnimationBindingsTool"]-->Type click Derived1 "/animancer/api/Animancer.Editor.Tools/RemapAnimationBindingsTool" Derived2["LoopAnimationTool"]-->Type click Derived2 "/animancer/api/Animancer.Editor.Tools/LoopAnimationTool" Derived3["RemapSpriteAnimationTool"]-->Type click Derived3 "/animancer/api/Animancer.Editor.Tools/RemapSpriteAnimationTool"

Syntax

[Serializable]
public abstract class AnimationModifierTool : AnimancerToolsWindow.Tool, 
    IComparable<AnimancerToolsWindow.Tool>

Remarks

Documentation: Animancer Tools

Attributes

Type Description
SerializableAttribute

Properties

Name Value Summary
Animation AnimationClip
The currently selected UnityEngine.AnimationClip asset.
DisplayOrder int
Lower numbers display first.
HelpIcon Texture
The help icon image used in the tool header.
static
HelpURL string
The URL for the help button in the header to open.
Instructions string
The usage instructions to display at the top of this tool.
IsExpanded bool
Is the body of this tool currently visible?
IsVisible bool
Is this tool currently visible?
Name string
The display name of this tool.

Methods

Name Value Summary
CompareTo(AnimancerToolsWindow.Tool) int
Compares the Animancer.Editor.Tools.AnimancerToolsWindow.Tool.DisplayOrder to put lower numbers first.
DoBodyGUI() void
Draws the Body GUI for this tool which is only displayed while it is expanded.
DoGUI() void
Draws the GUI for this tool.
DoHeaderGUI() void
Draws the Header GUI for this tool which is displayed regardless of whether it is expanded or not.
HandleDragAndDropIntoList<T>(Rect, IList<T>, bool) void
Adds any objects dropped in the `area` to the `list`.
Modify(AnimationClip) void
Override this to apply the desired modifications to the `animation` before it is saved.
OnAnimationChanged() void
Called whenever the selected Animancer.Editor.Tools.AnimationModifierTool.Animation changes.
OnDisable() void
Called by Animancer.Editor.Tools.AnimancerToolsWindow.OnDisable.
OnEnable(int) void
Called by Animancer.Editor.Tools.AnimancerToolsWindow.OnEnable.
OnSelectionChanged() void
Called whenever the UnityEditor.Selection changes.
SaveAs() bool
Calls Animancer.Editor.Tools.AnimancerToolsWindow.Tool.SaveModifiedAsset``1(System.String,System.String,``0,System.Action{``0}) on the animation.
SaveModifiedAsset<T>(string, string, T, Action<T>) bool
Asks the user where they want to save a modified asset, calls `modify` on it, and saves it.
static