Package arc.scene.actions

Class TemporalAction

java.lang.Object
arc.scene.Action
arc.scene.actions.TemporalAction
All Implemented Interfaces:
Pool.Poolable
Direct Known Subclasses:
AlphaAction, ColorAction, FloatAction, IntAction, MoveToAction, RelativeTemporalAction, RotateToAction, ScaleToAction, SizeToAction
public abstract class TemporalAction extends Action
Base class for actions that transition over time using the percent complete.

  • Constructor Details

    • TemporalAction

      public TemporalAction()

    • TemporalAction

      public TemporalAction(float duration)

    • TemporalAction

      public TemporalAction(float duration, Interp interpolation)

  • Method Details

    • act

      public boolean act(float delta)
      Description copied from class: Action
      Updates the action based on time. Typically this is called each frame by Element.act(float).
      Specified by:
      act in class Action
      Parameters:
      delta - Time in seconds since the last frame.
      Returns:
      true if the action is done. This method may continue to be called after the action is done.

    • begin

      protected void begin()
      Called the first time act(float) is called. This is a good place to query the actor's starting state.

    • end

      protected void end()
      Called the last time act(float) is called.

    • update

      protected abstract void update(float percent)
      Called each frame.
      Parameters:
      percent - The percentage of completion for this action, growing from 0 to 1 over the duration. If reversed, this will shrink from 1 to 0.

    • finish

      public void finish()
      Skips to the end of the transition.

    • restart

      public void restart()
      Description copied from class: Action
      Sets the state of the action so it can be run again.
      Overrides:
      restart in class Action

    • reset

      public void reset()
      Description copied from class: Action
      Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused. State required to be set for every usage of this action or computed during the action does not need to be reset.

      The default implementation calls Action.restart().

      If a subclass has optional state, it must override this method, call super, and reset the optional state.

      Specified by:
      reset in interface Pool.Poolable
      Overrides:
      reset in class Action

    • getTime

      public float getTime()
      Gets the transition time so far.

    • setTime

      public void setTime(float time)
      Sets the transition time so far.

    • getDuration

      public float getDuration()

    • setDuration

      public void setDuration(float duration)
      Sets the length of the transition in seconds.

    • getInterpolation

      public Interp getInterpolation()

    • setInterpolation

      public void setInterpolation(Interp interpolation)

    • isReverse

      public boolean isReverse()

    • setReverse

      public void setReverse(boolean reverse)
      When true, the action's progress will go from 100% to 0%.