Animation

java.lang.Object
- javafx.animation.Animation

Direct Known Subclasses:

Timeline, Transition
```
public abstract class Animation
extends java.lang.Object
```
The class Animation provides the core functionality of all animations used in the JavaFX runtime.
An animation can run in a loop by setting cycleCount. To make an animation run back and forth while looping, set the autoReverse -flag.
Call play() or playFromStart() to play an Animation . The Animation progresses in the direction and speed specified by rate, and stops when its duration is elapsed. An Animation with indefinite duration (a cycleCount of INDEFINITE) runs repeatedly until the stop() method is explicitly called, which will stop the running Animation and reset its play head to the initial position.
An Animation can be paused by calling pause(), and the next play() call will resume the Animation from where it was paused.
An Animation's play head can be randomly positioned, whether it is running or not. If the Animation is running, the play head jumps to the specified position immediately and continues playing from new position. If the Animation is not running, the next play() will start the Animation from the specified position.
Inverting the value of rate toggles the play direction.

Since:

JavaFX 2.0

See Also:

Timeline, Transition

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`Animation.AnimationReadOnlyProperty<T>`
`private class`	`Animation.CurrentRateProperty`
`private class`	`Animation.CurrentTimeProperty`
`static class`	`Animation.Status` The possible states for `status`.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.security.AccessControlContext`	`accessCtrlCtx`
`private BooleanProperty`	`autoReverse` Defines whether this `Animation` reverses direction on alternating cycles.
`(package private) ClipEnvelope`	`clipEnvelope`
`private ObservableMap<java.lang.String,Duration>`	`cuePoints`
`private ReadOnlyDoubleProperty`	`currentRate` Read-only variable to indicate current direction/speed at which the `Animation` is being played.
`private long`	`currentTicks`
`private Animation.CurrentTimeProperty`	`currentTime` Defines the `Animation`'s play head position.
`private IntegerProperty`	`cycleCount` Defines the number of cycles in this animation.
`private ReadOnlyObjectProperty<Duration>`	`cycleDuration` Read-only variable to indicate the duration of one cycle of this `Animation`: the time it takes to play from time 0 to the end of the Animation (at the default `rate` of 1.0).
`private static boolean`	`DEFAULT_AUTO_REVERSE`
`private static double`	`DEFAULT_CURRENT_RATE`
`private static int`	`DEFAULT_CYCLE_COUNT`
`private static Duration`	`DEFAULT_CYCLE_DURATION`
`private static Duration`	`DEFAULT_DELAY`
`private static EventHandler<ActionEvent>`	`DEFAULT_ON_FINISHED`
`private static double`	`DEFAULT_RATE`
`private static Animation.Status`	`DEFAULT_STATUS`
`private static Duration`	`DEFAULT_TOTAL_DURATION`
`private ObjectProperty<Duration>`	`delay` Delays the start of an animation.
`private static double`	`EPSILON`
`static int`	`INDEFINITE` Used to specify an animation that repeats indefinitely, until the `stop()` method is called.
`private boolean`	`lastPlayedFinished`
`private boolean`	`lastPlayedForward`
`private long`	`lastPulse`
`private double`	`oldRate`
`private ObjectProperty<EventHandler<ActionEvent>>`	`onFinished` The action to be executed at the conclusion of this `Animation`.
`(package private) Animation`	`parent` The parent of this `Animation`.
`private boolean`	`paused`
`private long`	`pauseTime`
`(package private) PulseReceiver`	`pulseReceiver`
`private DoubleProperty`	`rate` Defines the direction/speed at which the `Animation` is expected to be played.
`private int`	`resolution`
`private long`	`startTime`
`private ReadOnlyObjectProperty<Animation.Status>`	`status` The status of the `Animation`.
`private double`	`targetFramerate`
`private AbstractMasterTimer`	`timer`
`private ReadOnlyObjectProperty<Duration>`	`totalDuration` Read-only variable to indicate the total duration of this `Animation`, including repeats.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Animation()` The constructor of `Animation`.
`(package private)`	`Animation(AbstractMasterTimer timer)`
`(package private)`	`Animation(AbstractMasterTimer timer, ClipEnvelope clipEnvelope, int resolution)`
`protected`	`Animation(double targetFramerate)` The constructor of `Animation`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addPulseReceiver()`
`BooleanProperty`	`autoReverseProperty()`
`ReadOnlyDoubleProperty`	`currentRateProperty()`
`ReadOnlyObjectProperty<Duration>`	`currentTimeProperty()`
`IntegerProperty`	`cycleCountProperty()`
`ReadOnlyObjectProperty<Duration>`	`cycleDurationProperty()`
`ObjectProperty<Duration>`	`delayProperty()`
`ObservableMap<java.lang.String,Duration>`	`getCuePoints()` The cue points can be used to mark important positions of the `Animation`.
`double`	`getCurrentRate()`
`Duration`	`getCurrentTime()`
`int`	`getCycleCount()`
`Duration`	`getCycleDuration()`
`Duration`	`getDelay()`
`EventHandler<ActionEvent>`	`getOnFinished()`
`double`	`getRate()`
`Animation.Status`	`getStatus()`
`double`	`getTargetFramerate()` The target framerate is the maximum framerate at which this `Animation` will run, in frames per second.
`Duration`	`getTotalDuration()`
`(package private) void`	`impl_finished()`
`(package private) abstract void`	`impl_jumpTo(long currentTicks, long cycleTicks, boolean forceJump)`
`(package private) void`	`impl_pause()`
`(package private) abstract void`	`impl_playTo(long currentTicks, long cycleTicks)`
`(package private) void`	`impl_resume()`
`(package private) void`	`impl_setCurrentRate(double currentRate)`
`(package private) void`	`impl_setCurrentTicks(long ticks)`
`(package private) void`	`impl_start(boolean forceSync)`
`(package private) boolean`	`impl_startable(boolean forceSync)`
`(package private) void`	`impl_stop()`
`(package private) void`	`impl_sync(boolean forceSync)`
`(package private) void`	`impl_timePulse(long elapsedTime)`
`boolean`	`isAutoReverse()`
`private boolean`	`isRunningEmbedded()`
`void`	`jumpTo(Duration time)` Jumps to a given position in this `Animation`.
`void`	`jumpTo(java.lang.String cuePoint)` Jumps to a predefined position in this `Animation`.
`private long`	`now()`
`ObjectProperty<EventHandler<ActionEvent>>`	`onFinishedProperty()`
`void`	`pause()` Pauses the animation.
`(package private) void`	`pauseReceiver()`
`void`	`play()` Plays `Animation` from current position in the direction indicated by `rate`.
`void`	`playFrom(Duration time)` A convenience method to play this `Animation` from a specific position.
`void`	`playFrom(java.lang.String cuePoint)` A convenience method to play this `Animation` from a predefined position.
`void`	`playFromStart()` Plays an `Animation` from initial position in forward direction.
`DoubleProperty`	`rateProperty()`
`(package private) void`	`resumeReceiver()`
`void`	`setAutoReverse(boolean value)`
`private void`	`setCurrentRate(double value)`
`void`	`setCycleCount(int value)`
`protected void`	`setCycleDuration(Duration value)`
`void`	`setDelay(Duration value)`
`void`	`setOnFinished(EventHandler<ActionEvent> value)`
`void`	`setRate(double value)`
`protected void`	`setStatus(Animation.Status value)`
`(package private) void`	`startReceiver(long delay)`
`ReadOnlyObjectProperty<Animation.Status>`	`statusProperty()`
`void`	`stop()` Stops the animation and resets the play head to its initial position.
`private void`	`syncClipEnvelope()`
`ReadOnlyObjectProperty<Duration>`	`totalDurationProperty()`
`private void`	`updateTotalDuration()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INDEFINITE
```
public static final int INDEFINITE
```
    Used to specify an animation that repeats indefinitely, until the stop() method is called.
    
    See Also:
    
    Constant Field Values
  - EPSILON
```
private static final double EPSILON
```
    See Also:
    
    Constant Field Values
  - startTime
```
private long startTime
```
  - pauseTime
```
private long pauseTime
```
  - paused
```
private boolean paused
```
  - timer
```
private final AbstractMasterTimer timer
```
  - accessCtrlCtx
```
private java.security.AccessControlContext accessCtrlCtx
```
  - pulseReceiver
```
final PulseReceiver pulseReceiver
```
  - parent
```
Animation parent
```
    The parent of this Animation. If this animation has not been added to another animation, such as ParallelTransition and SequentialTransition, then parent will be null.
  - clipEnvelope
```
ClipEnvelope clipEnvelope
```
  - lastPlayedFinished
```
private boolean lastPlayedFinished
```
  - lastPlayedForward
```
private boolean lastPlayedForward
```
  - rate
```
private DoubleProperty rate
```
    Defines the direction/speed at which the Animation is expected to be played.
    The absolute value of rate indicates the speed which the Animation is to be played, while the sign of rate indicates the direction. A positive value of rate indicates forward play, a negative value indicates backward play and 0.0 to stop a running Animation.
    Rate 1.0 is normal play, 2.0 is 2 time normal, -1.0 is backwards, etc...
    Inverting the rate of a running Animation will cause the Animation to reverse direction in place and play back over the portion of the Animation that has already elapsed.
  - DEFAULT_RATE
```
private static final double DEFAULT_RATE
```
    See Also:
    
    Constant Field Values
  - oldRate
```
private double oldRate
```
  - currentRate
```
private ReadOnlyDoubleProperty currentRate
```
    Read-only variable to indicate current direction/speed at which the Animation is being played.
    currentRate is not necessary equal to rate. currentRate is set to 0.0 when animation is paused or stopped. currentRate may also point to different direction during reverse cycles when autoReverse is true
  - DEFAULT_CURRENT_RATE
```
private static final double DEFAULT_CURRENT_RATE
```
    See Also:
    
    Constant Field Values
  - cycleDuration
```
private ReadOnlyObjectProperty<Duration> cycleDuration
```
    Read-only variable to indicate the duration of one cycle of this Animation: the time it takes to play from time 0 to the end of the Animation (at the default rate of 1.0).
  - DEFAULT_CYCLE_DURATION
```
private static final Duration DEFAULT_CYCLE_DURATION
```
  - totalDuration
```
private ReadOnlyObjectProperty<Duration> totalDuration
```
    Read-only variable to indicate the total duration of this Animation, including repeats. A Animation with a cycleCount of Animation.INDEFINITE will have a totalDuration of Duration.INDEFINITE.
    This is set to cycleDuration * cycleCount.
  - DEFAULT_TOTAL_DURATION
```
private static final Duration DEFAULT_TOTAL_DURATION
```
  - currentTime
```
private Animation.CurrentTimeProperty currentTime
```
    Defines the Animation's play head position.
  - currentTicks
```
private long currentTicks
```
  - delay
```
private ObjectProperty<Duration> delay
```
    Delays the start of an animation. Cannot be negative. Setting to a negative number will result in IllegalArgumentException.
  - DEFAULT_DELAY
```
private static final Duration DEFAULT_DELAY
```
  - cycleCount
```
private IntegerProperty cycleCount
```
    Defines the number of cycles in this animation. The cycleCount may be INDEFINITE for animations that repeat indefinitely, but must otherwise be > 0.
    It is not possible to change the cycleCount of a running Animation. If the value of cycleCount is changed for a running Animation, the animation has to be stopped and started again to pick up the new value.
  - DEFAULT_CYCLE_COUNT
```
private static final int DEFAULT_CYCLE_COUNT
```
    See Also:
    
    Constant Field Values
  - autoReverse
```
private BooleanProperty autoReverse
```
    Defines whether this Animation reverses direction on alternating cycles. If true, the Animation will proceed forward on the first cycle, then reverses on the second cycle, and so on. Otherwise, animation will loop such that each cycle proceeds forward from the start. It is not possible to change the autoReverse flag of a running Animation. If the value of autoReverse is changed for a running Animation, the animation has to be stopped and started again to pick up the new value.
  - DEFAULT_AUTO_REVERSE
```
private static final boolean DEFAULT_AUTO_REVERSE
```
    See Also:
    
    Constant Field Values
  - status
```
private ReadOnlyObjectProperty<Animation.Status> status
```
    The status of the Animation. In Animation can be in one of three states: Animation.Status.STOPPED, Animation.Status.PAUSED or Animation.Status.RUNNING.
  - DEFAULT_STATUS
```
private static final Animation.Status DEFAULT_STATUS
```
  - targetFramerate
```
private final double targetFramerate
```
  - resolution
```
private final int resolution
```
  - lastPulse
```
private long lastPulse
```
  - onFinished
```
private ObjectProperty<EventHandler<ActionEvent>> onFinished
```
    The action to be executed at the conclusion of this Animation.
  - DEFAULT_ON_FINISHED
```
private static final EventHandler<ActionEvent> DEFAULT_ON_FINISHED
```
  - cuePoints
```
private final ObservableMap<java.lang.String,Duration> cuePoints
```
- Constructor Detail
  - Animation
```
protected Animation(double targetFramerate)
```
    The constructor of Animation. This constructor allows to define a target framerate.
    
    Parameters:
    
    targetFramerate - The custom target frame rate for this Animation
    
    See Also:
    
    getTargetFramerate()
  - Animation
```
protected Animation()
```
    The constructor of Animation.
  - Animation
```
Animation(AbstractMasterTimer timer)
```
  - Animation
```
Animation(AbstractMasterTimer timer,
          ClipEnvelope clipEnvelope,
          int resolution)
```
- Method Detail
  - now
```
private long now()
```
  - addPulseReceiver
```
private void addPulseReceiver()
```
  - startReceiver
```
void startReceiver(long delay)
```
  - pauseReceiver
```
void pauseReceiver()
```
  - resumeReceiver
```
void resumeReceiver()
```
  - setRate
```
public final void setRate(double value)
```
  - getRate
```
public final double getRate()
```
  - rateProperty
```
public final DoubleProperty rateProperty()
```
  - isRunningEmbedded
```
private boolean isRunningEmbedded()
```
  - setCurrentRate
```
private void setCurrentRate(double value)
```
  - getCurrentRate
```
public final double getCurrentRate()
```
  - currentRateProperty
```
public final ReadOnlyDoubleProperty currentRateProperty()
```
  - setCycleDuration
```
protected final void setCycleDuration(Duration value)
```
  - getCycleDuration
```
public final Duration getCycleDuration()
```
  - cycleDurationProperty
```
public final ReadOnlyObjectProperty<Duration> cycleDurationProperty()
```
  - getTotalDuration
```
public final Duration getTotalDuration()
```
  - totalDurationProperty
```
public final ReadOnlyObjectProperty<Duration> totalDurationProperty()
```
  - updateTotalDuration
```
private void updateTotalDuration()
```
  - getCurrentTime
```
public final Duration getCurrentTime()
```
  - currentTimeProperty
```
public final ReadOnlyObjectProperty<Duration> currentTimeProperty()
```
  - setDelay
```
public final void setDelay(Duration value)
```
  - getDelay
```
public final Duration getDelay()
```
  - delayProperty
```
public final ObjectProperty<Duration> delayProperty()
```
  - setCycleCount
```
public final void setCycleCount(int value)
```
  - getCycleCount
```
public final int getCycleCount()
```
  - cycleCountProperty
```
public final IntegerProperty cycleCountProperty()
```
  - setAutoReverse
```
public final void setAutoReverse(boolean value)
```
  - isAutoReverse
```
public final boolean isAutoReverse()
```
  - autoReverseProperty
```
public final BooleanProperty autoReverseProperty()
```
  - setStatus
```
protected final void setStatus(Animation.Status value)
```
  - getStatus
```
public final Animation.Status getStatus()
```
  - statusProperty
```
public final ReadOnlyObjectProperty<Animation.Status> statusProperty()
```
  - getTargetFramerate
```
public final double getTargetFramerate()
```
    The target framerate is the maximum framerate at which this Animation will run, in frames per second. This can be used, for example, to keep particularly complex Animations from over-consuming system resources. By default, an Animation's framerate is not explicitly limited, meaning the Animation will run at an optimal framerate for the underlying platform.
    
    Returns:
    
    the target framerate
  - setOnFinished
```
public final void setOnFinished(EventHandler<ActionEvent> value)
```
  - getOnFinished
```
public final EventHandler<ActionEvent> getOnFinished()
```
  - onFinishedProperty
```
public final ObjectProperty<EventHandler<ActionEvent>> onFinishedProperty()
```
  - getCuePoints
```
public final ObservableMap<java.lang.String,Duration> getCuePoints()
```
    The cue points can be used to mark important positions of the Animation. Once a cue point was defined, it can be used as an argument of jumpTo() and playFrom() to move to the associated position quickly.
    Every Animation has two predefined cue points "start" and "end", which are set at the start respectively the end of the Animation. The predefined cuepoints do not appear in the map, attempts to override them have no effect.
    Another option to define a cue point in a Animation is to set the KeyFrame.name property of a KeyFrame.
    
    Returns:
    
    ObservableMap of cue points
  - jumpTo
```
public void jumpTo(Duration time)
```
    Jumps to a given position in this Animation. If the given time is less than Duration.ZERO, this method will jump to the start of the animation. If the given time is larger than the duration of this Animation, this method will jump to the end.
    
    Parameters:
    
    time - the new position
    
    Throws:
    
    java.lang.NullPointerException - if time is null
    
    java.lang.IllegalArgumentException - if time is Duration.UNKNOWN
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - jumpTo
```
public void jumpTo(java.lang.String cuePoint)
```
    Jumps to a predefined position in this Animation. This method looks for an entry in cue points and jumps to the associated position, if it finds one.
    If the cue point is behind the end of this Animation, calling jumpTo will result in a jump to the end. If the cue point has a negative Duration it will result in a jump to the beginning. If the cue point has a value of Duration.UNKNOWN calling jumpTo will have no effect for this cue point.
    There are two predefined cue points "start" and "end" which are defined to be at the start respectively the end of this Animation.
    
    Parameters:
    
    cuePoint - the name of the cue point
    
    Throws:
    
    java.lang.NullPointerException - if cuePoint is null
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
    
    See Also:
    
    getCuePoints()
  - playFrom
```
public void playFrom(java.lang.String cuePoint)
```
    A convenience method to play this Animation from a predefined position. The position has to be predefined in cue points. Calling this method is equivalent to
```
 
 animation.jumpTo(cuePoint);
 animation.play();
 
 
```
    Note that unlike playFromStart() calling this method will not change the playing direction of this Animation.
    Parameters:
    
    cuePoint - name of the cue point
    
    Throws:
    
    java.lang.NullPointerException - if cuePoint is null
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
    
    See Also:
    
    getCuePoints()
  - playFrom
```
public void playFrom(Duration time)
```
    A convenience method to play this Animation from a specific position. Calling this method is equivalent to
```
 
 animation.jumpTo(time);
 animation.play();
 
 
```
    Note that unlike playFromStart() calling this method will not change the playing direction of this Animation.
    Parameters:
    
    time - position where to play from
    
    Throws:
    
    java.lang.NullPointerException - if time is null
    
    java.lang.IllegalArgumentException - if time is Duration.UNKNOWN
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - play
```
public void play()
```
    Plays Animation from current position in the direction indicated by rate. If the Animation is running, it has no effect.
    When rate > 0 (forward play), if an Animation is already positioned at the end, the first cycle will not be played, it is considered to have already finished. This also applies to a backward ( rate < 0) cycle if an Animation is positioned at the beginning. However, if the Animation has cycleCount > 1, following cycle(s) will be played as usual.
    When the Animation reaches the end, the Animation is stopped and the play head remains at the end.
    To play an Animation backwards from the end:
    animation.setRate(negative rate); animation.jumpTo(overall duration of animation); animation.play();
    Note:
    - play() is an asynchronous call, the Animation may not start immediately.
    Throws:
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - playFromStart
```
public void playFromStart()
```
    Plays an Animation from initial position in forward direction.
    It is equivalent to
    animation.stop(); animation.setRate = setRate(Math.abs(animation.getRate())); animation.jumpTo(Duration.ZERO); animation.play();
    Note:
    - playFromStart() is an asynchronous call, Animation may not start immediately.
    Throws:
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - stop
```
public void stop()
```
    Stops the animation and resets the play head to its initial position. If the animation is not currently running, this method has no effect.
    Note:
    - stop() is an asynchronous call, the Animation may not stop immediately.
    Throws:
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - pause
```
public void pause()
```
    Pauses the animation. If the animation is not currently running, this method has no effect.
    Note:
    - pause() is an asynchronous call, the Animation may not pause immediately.
    Throws:
    
    java.lang.IllegalStateException - if embedded in another animation, such as SequentialTransition or ParallelTransition
  - impl_startable
```
boolean impl_startable(boolean forceSync)
```
  - impl_sync
```
void impl_sync(boolean forceSync)
```
  - syncClipEnvelope
```
private void syncClipEnvelope()
```
  - impl_start
```
void impl_start(boolean forceSync)
```
  - impl_pause
```
void impl_pause()
```
  - impl_resume
```
void impl_resume()
```
  - impl_stop
```
void impl_stop()
```
  - impl_timePulse
```
void impl_timePulse(long elapsedTime)
```
  - impl_playTo
```
abstract void impl_playTo(long currentTicks,
                          long cycleTicks)
```
  - impl_jumpTo
```
abstract void impl_jumpTo(long currentTicks,
                          long cycleTicks,
                          boolean forceJump)
```
  - impl_setCurrentTicks
```
void impl_setCurrentTicks(long ticks)
```
  - impl_setCurrentRate
```
void impl_setCurrentRate(double currentRate)
```
  - impl_finished
```
final void impl_finished()
```

Class Animation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDEFINITE

EPSILON

startTime

pauseTime

paused

timer

accessCtrlCtx

pulseReceiver

parent

clipEnvelope

lastPlayedFinished

lastPlayedForward

rate

DEFAULT_RATE

oldRate

currentRate

DEFAULT_CURRENT_RATE

cycleDuration

DEFAULT_CYCLE_DURATION

totalDuration

DEFAULT_TOTAL_DURATION

currentTime

currentTicks

delay

DEFAULT_DELAY

cycleCount

DEFAULT_CYCLE_COUNT

autoReverse

DEFAULT_AUTO_REVERSE

status

DEFAULT_STATUS

targetFramerate

resolution

lastPulse

onFinished

DEFAULT_ON_FINISHED

cuePoints

Constructor Detail

Animation

Animation

Animation

Animation

Method Detail

now

addPulseReceiver

startReceiver

pauseReceiver

resumeReceiver

setRate

getRate

rateProperty

isRunningEmbedded

setCurrentRate

getCurrentRate

currentRateProperty

setCycleDuration

getCycleDuration

cycleDurationProperty

getTotalDuration

totalDurationProperty

updateTotalDuration

getCurrentTime

currentTimeProperty

setDelay

getDelay

delayProperty

setCycleCount

getCycleCount

cycleCountProperty

setAutoReverse

isAutoReverse

autoReverseProperty

setStatus