Class Tween

public class Tween
A Tween is an interpolation between start values and target values over a given time period. It modifies the start values by applying an easing function (TweenEquation) each tick.

  • Constructor Details

    • Tween

      public Tween(Tweenable target, TweenType type, int duration)
      Instantiates a new tween.
      Parameters:
      target - the Tweenable target object
      type - the TweenType determining which values of the target object will be modified.
      duration - the duration of the Tween in ticks.

  • Method Details

    • start

      public Tween start()
      Starts the Tween by setting its start time to the current game time in ticks.
      Returns:
      the Tween instance

    • isRunning

      public boolean isRunning()
      Checks if the Tween is currently running.
      Returns:
      true if the Tween is running, false otherwise.

    • ease

      public Tween ease(TweenEquation easeEquation)
      Sets a custom easing function for this Tween.
      Parameters:
      easeEquation - the TweenEquation applied to the tween values.
      Returns:
      the Tween instance.

    • ease

      public Tween ease(TweenFunction easingFunction)
      Sets a predefined easing function for this Tween.
      Parameters:
      easingFunction - the TweenFunction applied to the tween values.
      Returns:
      the Tween instance.

    • getDuration

      public int getDuration()
      Gets the duration of the Tween.
      Returns:
      the duration of the Tween in ticks

    • getEquation

      public TweenEquation getEquation()
      Gets the tween equation that modifies the start values each tick.
      Returns:
      the TweenEquation

    • getStartTime

      public long getStartTime()
      Gets the start tick of the Tween.
      Returns:
      the start time in ticks

    • getStartValues

      public float[] getStartValues()
      Gets the start values.
      Returns:
      the start values

    • getTarget

      public Tweenable getTarget()
      Gets the Tweenable target object.
      Returns:
      the target

    • getTargetValues

      public float[] getTargetValues()
      Gets the target values.
      Returns:
      the target values

    • getType

      public TweenType getType()
      Gets the tween type determining which values of the Tweenable object will be modified.
      Returns:
      the TweenType of this Tween

    • hasStopped

      public boolean hasStopped()
      Checks if the Tween has stopped.
      Returns:
      true, if successful

    • reset

      public Tween reset()
      Resets the Tween values to the start values.
      Returns:
      the Tween instance

    • resume

      public Tween resume()
      Resumes the stopped Tween.
      Returns:
      the Tween instance

    • setDuration

      public void setDuration(int duration)
      Sets the Tween duration.
      Parameters:
      duration - the new duration in ticks

    • stop

      public Tween stop()
      Stops the Tween.
      Returns:
      the Tween instance

    • getLoop

      public TweenLoop getLoop()
      Gets the configured loop mode for this Tween.
      Returns:
      the TweenLoop mode.

    • loop

      public Tween loop(TweenLoop loop)
      Sets the loop mode for this Tween. When the Tween completes its duration, it will either stop, restart from the beginning, or reverse direction depending on the configured loop mode.
      Parameters:
      loop - the desired TweenLoop mode.
      Returns:
      the Tween instance.

    • isReversed

      public boolean isReversed()
      Checks whether the Tween is currently running in its reversed direction. This is only relevant for TweenLoop.PINGPONG tweens.
      Returns:
      true if the Tween currently interpolates from its target values back to its start values.

    • addListener

      public Tween addListener(TweenListener listener)
      Registers a TweenListener that gets notified about the Tween's lifecycle events.
      Parameters:
      listener - the listener to add.
      Returns:
      the Tween instance.

    • removeListener

      public Tween removeListener(TweenListener listener)
      Removes a previously registered TweenListener.
      Parameters:
      listener - the listener to remove.
      Returns:
      the Tween instance.

    • target

      public Tween target(float... targetValues)
      Sets the target values absolutely.
      Parameters:
      targetValues - the absolute target values
      Returns:
      the Tween instance

    • targetRelative

      public Tween targetRelative(float... targetValues)
      Sets the target values relatively to the start values.
      Parameters:
      targetValues - the relative target values with respect to the start values
      Returns:
      the Tween instance