Documentation

Page contents

Updated

Generate PDF from page.

Tween Animator Controller Editor Tool

Files: CGFTweenAnimatorControllerEditorTool.cs

Path: "CGF/Editor/Tools/TweenAnimation"

Menu: "CGF/Animation/Tween Animator Controller"

Description

Graph window used to author layered and hierarchical CGF tween animator controllers.

Reference

  • Parameters and Layers – Show the controller's shared parameters and animation-layer settings in the inspector.
  • Add State – Create a new animation state in the currently open state machine.
  • Add Machine – Create a nested state machine in the currently open state machine.
  • Fit to view – Center and scale the graph so all nodes are visible.
  • Name – Display name of this controller layer.
  • Enabled – Include this layer when the controller evaluates and blends animation output.
  • Weight – Contribution of this layer to the final animated values, from 0 (none) to 1 (full).
  • Blend Mode – How this layer combines with values produced by lower layers: replace them or add an offset.
  • Include Unmatched Bindings – Animate properties that do not match any Property Mask entry. Disable this to make the mask opt-in.
  • Property Mask – Rules that include or exclude animated property bindings from this layer.
  • Shared Parameters – Parameters exposed by the controller and used by transition conditions and blend trees.
  • Layers – Ordered animation layers evaluated and combined by this controller.
  • Set – Activate this trigger parameter on the previewed Tween Animator.
  • Reset – Clear this trigger parameter on the previewed Tween Animator.
  • Add Any State Transition – Create a transition from Any State to a destination selected in the graph.
  • Name – Display name of this animation state.
  • Motion – Source evaluated while this state is active: a Tween Animation Clip or a 1D/2D blend tree.
  • Blend Tree 1D – One-dimensional blend tree that combines child motions from a single float parameter.
  • Blend Tree 2D – Two-dimensional blend tree that combines child motions from two float parameters.
  • Clip – Tween Animation Clip played while this state is active.
  • Speed – Playback speed multiplier for this state's motion. Negative values play in reverse when supported.
  • Set as Layer Default State – Use this state as the entry state of the current layer or state machine.
  • Add Transition – Create an outgoing transition from this state, then choose its destination.
  • Delete State – Delete this state and transitions that reference it from the controller graph.
  • Has Exit Time – Require the source state to reach Exit Time before this transition can occur.
  • Exit Time – Normalized playback position of the source state at which this transition may begin; 1 is one complete cycle.
  • Duration – Crossfade duration, in seconds, used to blend from the source state to the destination.
  • Remove Transition – Delete this transition from the controller graph.
  • Parameter – Controller parameter evaluated by this transition condition.
  • Threshold – Value compared with the selected parameter when evaluating this transition condition.
  • Remove – Remove this condition from the selected transition.
  • Add Condition – Add a parameter condition that must be satisfied for this transition to occur.
  • Mode – Comparison applied to the selected parameter, such as greater, less, equals, true or false.
  • Name – Display name of this nested state machine.
  • Set As Default – Enter this nested state machine by default when its parent state machine starts.
  • Open State Machine – Open this nested state machine in the graph editor.
  • Delete State Machine – Delete this nested state machine and transitions that reference it.
  • Conditions – Parameter conditions that must all be satisfied before this transition can occur.
  • Destination – State or nested state machine entered when this transition occurs.
  • Default – Default state or nested state machine entered when this state machine starts.

Use

Open the tool from CGF/Animation/Tween Animator Controller in the Unity editor.
Use the controls listed in Reference to configure the window workflow.