public final class Timeline extends Animation
Timeline
can be used to define a free form animation of any
javafx.beans.value.WritableValue
, for example, all
JavaFX Properties
.
A Timeline
, defined by one or more KeyFrame
s, processes
individual KeyFrame
sequentially, in the order specified by
KeyFrame.time
. The animated properties, defined as key values in
KeyFrame.values
, are interpolated
to/from the targeted key values at the specified time of the KeyFrame
to Timeline
's initial position, depends on Timeline
's
direction.
Timeline
processes individual KeyFrame
at or after specified
time interval elapsed, it does not guarantee the timing when KeyFrame
is processed.
The Animation.cycleDurationProperty()
will be set to the largest time value
of Timeline's keyFrames.
If a KeyFrame
is not provided for the time==0s
instant, one
will be synthesized using the target values that are current at the time
Animation.play()
or Animation.playFromStart()
is called.
It is not possible to change the keyFrames
of a running Timeline
.
If the value of keyFrames
is changed for a running Timeline
, it
has to be stopped and started again to pick up the new value.
A simple Timeline can be created like this:
final Timeline timeline = new Timeline();
timeline.setCycleCount(2);
timeline.setAutoReverse(true);
timeline.getKeyFrames().add(new KeyFrame(Duration.millis(5000),
new KeyValue (node.translateXProperty(), 25)));
timeline.play();
This Timeline will run for 10s, animating the node by x axis to value 25 and then back to 0 on the second cycle.
Warning: A running Timeline is being referenced from the FX runtime. Infinite Timeline might result in a memory leak if not stopped properly. All the objects with animated properties would not be garbage collected.
autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, onFinishedProperty, rateProperty, statusProperty, totalDurationProperty
Animation.Status
Modifier and Type | Field and Description |
---|---|
(package private) TimelineClipCore |
clipCore |
private <any> |
keyFrames |
clipEnvelope, INDEFINITE, parent, pulseReceiver
Constructor and Description |
---|
Timeline()
The constructor of
Timeline . |
Timeline(AbstractMasterTimer timer) |
Timeline(double targetFramerate)
The constructor of
Timeline . |
Timeline(double targetFramerate,
KeyFrame... keyFrames)
The constructor of
Timeline . |
Timeline(KeyFrame... keyFrames)
The constructor of
Timeline . |
Modifier and Type | Method and Description |
---|---|
(package private) void |
doJumpTo(long currentTicks,
long cycleTicks,
boolean forceJump) |
(package private) void |
doPlayTo(long currentTicks,
long cycleTicks) |
(package private) void |
doStart(boolean forceSync) |
<any> |
getKeyFrames()
Returns the
KeyFrames of this Timeline . |
(package private) void |
setCurrentRate(double currentRate) |
void |
stop()
Stops the animation and resets the play head to its initial position.
|
autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, doPause, doResume, doStop, doTimePulse, finished, getCuePoints, getCurrentRate, getCurrentTime, getCycleCount, getCycleDuration, getDelay, getOnFinished, getRate, getStatus, getTargetFramerate, getTotalDuration, isAutoReverse, jumpTo, onFinishedProperty, pause, pauseReceiver, play, playFrom, playFrom, playFromStart, rateProperty, resumeReceiver, setAutoReverse, setCurrentTicks, setCycleCount, setCycleDuration, setDelay, setOnFinished, setRate, setStatus, startable, startReceiver, statusProperty, sync, totalDurationProperty
public Timeline(double targetFramerate, KeyFrame... keyFrames)
Timeline
.
This constructor allows to define a Animation.targetFramerate
.targetFramerate
- The custom target frame rate for this Timeline
keyFrames
- The keyframes of this Timeline
public Timeline(KeyFrame... keyFrames)
Timeline
.keyFrames
- The keyframes of this Timeline
public Timeline(double targetFramerate)
Timeline
.
This constructor allows to define a Animation.targetFramerate
.targetFramerate
- The custom target frame rate for this Timeline
public Timeline()
Timeline
.Timeline(AbstractMasterTimer timer)
public final <any> getKeyFrames()
KeyFrames
of this Timeline
.KeyFrames
void doPlayTo(long currentTicks, long cycleTicks)
void doJumpTo(long currentTicks, long cycleTicks, boolean forceJump)
void setCurrentRate(double currentRate)
setCurrentRate
in class Animation