Play
Starts a looping animation on the referenced wire.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: Unity.GraphToolkit.Editor.GraphVisualization
- Assembly: UnityEditor
Play(WireReference, float)
Starts a looping animation on the referenced wire.
public void Play(WireReference wire, float animationSpeed = 1)
Parameters
The wire on which to play the animation.
Speed multiplier for the animation. Higher values move the animated segment faster.
Remarks
Throws ArgumentException when doesn't correspond to a wire in the current Context.
wireStart a flow animation on a wire to highlight an active data path through the graph at the default speed.
Examples
WireReference wire = context.GetWireReference(outputPortID, inputPortID);context.Motion.Play(wire);
Play(TransitionReference, float)
Starts a looping animation on the referenced transition.
public void Play(TransitionReference transition, float animationSpeed = 1)
Parameters
The transition on which to play the animation.
Speed multiplier for the animation. Higher values move the animated segment faster.
Remarks
On a transition between two states, the animation sweeps a gradient band along the transition wire. On a self transition, the animation sweeps the same gradient band around the transition arrow's border. Throws ArgumentException when doesn't correspond to a transition in the current Context.
transitionStart a flow animation on a transition to highlight an active state machine path at the default speed.
Examples
TransitionReference transitionRef = context.GetTransitionReference(transitionID);context.Motion.Play(transitionRef);
Play(NodeReference, float)
Starts a looping animation on the referenced node's accent.
public void Play(NodeReference node, float animationSpeed = 1)
Parameters
The node on which to play the animation.
Speed multiplier for the animation. Higher values move the animated segment faster. The default value is 1.
Remarks
The animation loops indefinitely until you call GraphMotion.Stop or GraphMotion.Pause. While the animation plays, the accent bar overrides any fill amount previously set through NodeReference.FillAmount or the node model's property. Call GraphMotion.Play again on the same node after GraphMotion.Pause to resume the animation at the new speed. Throws ArgumentException when doesn't correspond to a node in the current Context.
FillAmountnodeExamples
NodeReference nodeRef = context.GetNodeReference(nodeID);context.Motion.Play(nodeRef);
Play(StateReference, float)
Starts a looping animation on the referenced state's accent.
public void Play(StateReference state, float animationSpeed = 1)
Parameters
The state on which to play the animation.
Speed multiplier for the animation. Higher values move the animated segment faster. The default value is 1.
Remarks
The animation loops indefinitely until you call GraphMotion.Stop or GraphMotion.Pause. While the animation plays, the accent bar overrides any fill amount previously set through StateReference.FillAmount or the state's IState.FillAmount property. Call GraphMotion.Play again on the same state after GraphMotion.Pause to resume the animation at the new speed. Throws ArgumentException when doesn't correspond to a state in the current Context.
stateExamples
StateReference stateRef = context.GetStateReference(stateID);context.Motion.Play(stateRef);