The class AnimationTimer allows to create a timer, that is called in each frame while it is active.

An extending class has to override the method handle(long) which will be called in every frame.

The methods AnimationTimer#start() and stop() allow to start and stop the timer.

The animation timer runs on the JavaFX Application Thread.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	AnimationTimer.AnimationTimerReceiver

Field Summary

Modifier and Type	Field and Description
private boolean	active
private final AbstractPrimaryTimer	timer
private final AnimationTimer.AnimationTimerReceiver	timerReceiver

Constructor Summary

Access	Constructor and Description
public	AnimationTimer() Creates a new timer.
pack-priv	AnimationTimer(AbstractPrimaryTimer timer)

Method Summary

Modifier and Type	Method and Description
public abstract void	handle(long The timestamp of the current frame given in nanoseconds. This value will be the same for all `AnimationTimers` called during one frame. now) This method needs to be overridden by extending classes.
public void	start() Starts the `AnimationTimer`.
private void	startImpl() This method must be run on the JavaFX Application Thread.
public void	stop() Stops the `AnimationTimer`.
private void	stopImpl() This method must be run on the JavaFX Application Thread.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

active	back to summary
private boolean active

timer	back to summary
private final AbstractPrimaryTimer timer

timerReceiver	back to summary
private final AnimationTimer.AnimationTimerReceiver timerReceiver

Constructor Detail

AnimationTimer	back to summary
public AnimationTimer() Creates a new timer.

AnimationTimer	back to summary
pack-priv AnimationTimer(AbstractPrimaryTimer timer)

Method Detail

handle back to summary

handle	back to summary
public abstract void handle(long now) This method needs to be overridden by extending classes. It is going to be called in every frame while the `AnimationTimer` is active. Parameters now:long The timestamp of the current frame given in nanoseconds. This value will be the same for all `AnimationTimers` called during one frame.

public abstract void handle(long now)

This method needs to be overridden by extending classes. It is going to be called in every frame while the AnimationTimer is active.

Parameters

now:long: The timestamp of the current frame given in nanoseconds. This value will be the same for all AnimationTimers called during one frame.

start back to summary

start	back to summary
public void start() Starts the `AnimationTimer`. Once it is started, the `handle(long)` method of this `AnimationTimer` will be called in every frame. The `AnimationTimer` can be stopped by calling `stop()`. Note if this method is not called on the JavaFX Application Thread, it is delegated to it automatically. In this case, the call is asynchronous and may not happen immediately.

public void start()

Starts the AnimationTimer. Once it is started, the handle(long) method of this AnimationTimer will be called in every frame.

The AnimationTimer can be stopped by calling stop().

Note

if this method is not called on the JavaFX Application Thread, it is delegated to it automatically. In this case, the call is asynchronous and may not happen immediately.

startImpl back to summary

startImpl	back to summary
private void startImpl() This method must be run on the JavaFX Application Thread. See Also `start()`

private void startImpl()

This method must be run on the JavaFX Application Thread.

See Also: start()

stop	back to summary
public void stop() Stops the `AnimationTimer`. It can be activated again by calling `start()`. Note if this method is not called on the JavaFX Application Thread, it is delegated to it automatically. In this case, the call is asynchronous and may not happen immediately.

stopImpl back to summary

stopImpl	back to summary
private void stopImpl() This method must be run on the JavaFX Application Thread. See Also `stop()`

private void stopImpl()

This method must be run on the JavaFX Application Thread.

See Also: stop()

javafx.animation back to summary

private Class AnimationTimer.AnimationTimerReceiver

Class Inheritance

extends Object
implements TimerReceiver

java.lang.Object
javafx.animation.AnimationTimer.AnimationTimerReceiver

All Implemented Interfaces

com.sun.scenario.animation.shared.TimerReceiver

Constructor Summary

Access	Constructor and Description
private	AnimationTimerReceiver()

Method Summary

Modifier and Type	Method and Description
public void	handle(final long now) Implements com.sun.scenario.animation.shared.TimerReceiver.handle. Callback triggered to send a message to the TimerReceiver

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AnimationTimerReceiver	back to summary
private AnimationTimerReceiver()

Method Detail

handle	back to summary
public void handle(final long now) Implements com.sun.scenario.animation.shared.TimerReceiver.handle. Doc from com.sun.scenario.animation.shared.TimerReceiver.handle. Callback triggered to send a message to the TimerReceiver Annotations @Override

handle

back to summary

public void handle(final long now)

Implements com.sun.scenario.animation.shared.TimerReceiver.handle.

Doc from com.sun.scenario.animation.shared.TimerReceiver.handle.

Callback triggered to send a message to the TimerReceiver

Annotations

@Override

public abstract Class AnimationTimer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AnimationTimer.AnimationTimerReceiver

Constructor Summary

Method Summary

Constructor Detail

Method Detail