Package com.inductiveautomation.rm.graphics

Class RMTransition

java.lang.Object
com.inductiveautomation.rm.graphics.RMTransition
All Implemented Interfaces:
Comparable<RMTransition>
Direct Known Subclasses:
RMTransition.Rotate, RMTransition.Translate
public class RMTransition extends Object implements Comparable<RMTransition>
An animation class that represents a change of an object property from one value to another.

  • Constructor Details

    • RMTransition

      public RMTransition(Object aTarget, String aKey, Object aValue, int aDuration, boolean isRelative)
      Creates a new transition.

    • RMTransition

      public RMTransition(RMKeyValue aKeyVal1, RMKeyValue aKeyVal2)
      Creates a new transition.

  • Method Details

    • getTarget

      public Object getTarget()
      Returns the target.

    • getKey

      public String getKey()
      Returns the key.

    • getValue1

      public Object getValue1()
      Returns the first value.

    • setValue1

      public void setValue1(Object aValue)
      Sets the first value.

    • getValue2

      public Object getValue2()
      Returns the second value.

    • setValue2

      public void setValue2(Object aValue)
      Sets the second value.

    • getDuration

      public int getDuration()
      Returns the duration of the transition in milliseconds.

    • setDuration

      public void setDuration(int aValue)
      Sets the duration of the transition in milliseconds.

    • getDelay

      public int getDelay()
      Returns the delay of the transition from the time it is told to play to when transition starts.

    • setDelay

      public void setDelay(int aDelay)
      Sets the delay of the transition from the time it is told to play to when transition starts.

    • isAutoReverse

      public boolean isAutoReverse()
      Returns whether the transition does an auto-reverse.

    • setAutoReverse

      public void setAutoReverse(boolean doAutoReverse)
      Sets whether the transition does an auto-reverse.

    • getCycleCount

      public int getCycleCount()
      Returns the number of cycles in animation.

    • setCycleCount

      public void setCycleCount(int aCount)
      Sets the number of cycles in animation.

    • getInterpolator

      public RMInterpolator getInterpolator()
      Returns the interpolator.

    • setInterpolator

      public void setInterpolator(RMInterpolator anInterpolator)
      Sets the interpolator.

    • getDelayedDuration

      public int getDelayedDuration()
      Returns the duration plus delay.

    • getTotalDuration

      public int getTotalDuration()
      Returns the total duration of the animation (delayed duration times cycle count).

    • isRunning

      public boolean isRunning()
      Returns whether transition is running.

    • isPaused

      public boolean isPaused()
      Returns whether transition is paused.

    • getRunStatus

      public RMTransition.RunStatus getRunStatus()
      Returns the run status of the transition.

    • setRunStatus

      public void setRunStatus(RMTransition.RunStatus aStatus)
      Sets the run status of the transition.

    • getProgress

      public int getProgress()
      Returns the progress this transition has made since it was started, in milliseconds.

    • setProgress

      protected void setProgress(int aProgress)
      Sets the progress this transition has made since it was started, in milliseconds.

    • getProgressRatio

      public double getProgressRatio()
      Returns the progress ratio for current progress.

    • getProgressRatio

      protected double getProgressRatio(int aProgress)
      Returns the progress ratio for a progress.

    • play

      public void play()
      Tells the transition to start playing.

    • playFromStart

      public void playFromStart()
      Tells the transition to start playing from the beginning.

    • playFrom

      public void playFrom(int aTime)
      Tells the transition to start playing at given time of transition duration (in milliseconds).

    • pause

      public void pause()
      Pauses the animation.

    • stop

      public void stop()
      Stops the transition.

    • isTransitioning

      public static boolean isTransitioning(Object aTarget, String aKey)
      Returns whether transition is running for given target and key.

    • getTransition

      public static RMTransition getTransition(Object aTarget, String aKey)
      Returns the transition for given target and key.

    • updateTransitions

      protected static void updateTransitions()
      Updates transitions.

    • compareTo

      public int compareTo(RMTransition aTrans)
      Standard compare implementation.
      Specified by:
      compareTo in interface Comparable<RMTransition>

    • getInterpolation

      public static Object getInterpolation(double aFraction, Object aValue1, Object aValue2)
      Returns an invocation by blending this invocation with given invocation using the given fraction of this invocation.