Class Transition
- Direct Known Subclasses:
FadeTransition
,ParallelTransition
,PauseTransition
,ScaleTransition
,SequentialTransition
,TranslateTransition
Transition
based animations, such as PathTransition
and
RotateTransition
.
This class offers a simple framework to define animation. It provides all the
basic functionality defined in Animation
. Transition
requires
the implementation of a method interpolate(double)
which is the
called in each frame, while the Transition
is running.
In addition an extending class needs to set the duration of a single cycle
with Animation.setCycleDuration(javafx.util.Duration)
. This duration
is usually set by the user via a duration property (as in
duration
) for example. But it can also be calculated
by the extending class as is done in ParallelTransition
and
FadeTransition
.
Below is a simple example. It creates a small animation that updates the
text
property of a Text
node. It starts
with an empty String
and adds gradually letter by letter until the
full String
was set when the animation finishes.
final String content = "Lorem ipsum";
final Text text = new Text(10, 20, "");
final Animation animation = new Transition() {
{
setCycleDuration(Duration.millis(2000));
}
protected void interpolate(double frac) {
final int length = content.length();
final int n = Math.round(length * (float) frac);
text.setText(content.substring(0, n));
}
};
animation.play();
- Since:
- JavaFX 2.0
- See Also:
-
Property Summary
PropertiesTypePropertyDescriptionfinal ObjectProperty<Interpolator>
Controls the timing for acceleration and deceleration at eachTransition
cycle.Properties inherited from class javafx.animation.Animation
autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration
-
Nested Class Summary
Nested classes/interfaces inherited from class javafx.animation.Animation
Animation.Status
-
Field Summary
Fields inherited from class javafx.animation.Animation
INDEFINITE, INDEFINITE_DURATION
-
Constructor Summary
ConstructorsConstructorDescriptionThe constructor ofTransition
.Transition
(double targetFramerate) The constructor ofTransition
. -
Method Summary
Modifier and TypeMethodDescriptionprotected Interpolator
Returns theInterpolator
, that was set when theTransition
was started.final Interpolator
Gets the value of theinterpolator
property.protected Node
Returns the first non-null
targetNode
in the parent hierarchy of thisTransition
, ornull
if such a node is not found.protected abstract void
interpolate
(double frac) The methodinterpolate()
has to be provided by implementations ofTransition
.final ObjectProperty<Interpolator>
Controls the timing for acceleration and deceleration at eachTransition
cycle.final void
setInterpolator
(Interpolator value) Sets the value of theinterpolator
property.Methods inherited from class javafx.animation.Animation
autoReverseProperty, callOnFinishedHandler, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, getCuePoints, getCurrentRate, getCurrentTime, getCycleCount, getCycleDuration, getDelay, getOnFinished, getRate, getStatus, getTargetFramerate, getTotalDuration, isAutoReverse, jumpTo, jumpTo, onFinishedProperty, pause, play, playFrom, playFrom, playFromStart, rateProperty, setAutoReverse, setCycleCount, setCycleDuration, setDelay, setOnFinished, setRate, setStatus, statusProperty, stop, totalDurationProperty
-
Property Details
-
interpolator
Controls the timing for acceleration and deceleration at eachTransition
cycle.This may only be changed prior to starting the transition or after the transition has ended. If the value of
interpolator
is changed for a runningTransition
, the animation has to be stopped and started again to pick up the new value.Default interpolator is set to
Interpolator.EASE_BOTH
.- Default value:
- EASE_BOTH
- See Also:
-
-
Constructor Details
-
Transition
public Transition(double targetFramerate) The constructor ofTransition
. This constructor allows to define atarget framerate
.- Parameters:
targetFramerate
- The custom target frame rate for thisTransition
-
Transition
public Transition()The constructor ofTransition
.
-
-
Method Details
-
setInterpolator
Sets the value of theinterpolator
property.- Property description:
- Controls the timing for acceleration and deceleration at each
Transition
cycle.This may only be changed prior to starting the transition or after the transition has ended. If the value of
interpolator
is changed for a runningTransition
, the animation has to be stopped and started again to pick up the new value.Default interpolator is set to
Interpolator.EASE_BOTH
. - Default value:
- EASE_BOTH
- Parameters:
value
- the value for theinterpolator
property- See Also:
-
getInterpolator
Gets the value of theinterpolator
property.- Property description:
- Controls the timing for acceleration and deceleration at each
Transition
cycle.This may only be changed prior to starting the transition or after the transition has ended. If the value of
interpolator
is changed for a runningTransition
, the animation has to be stopped and started again to pick up the new value.Default interpolator is set to
Interpolator.EASE_BOTH
. - Default value:
- EASE_BOTH
- Returns:
- the value of the
interpolator
property - See Also:
-
interpolatorProperty
Controls the timing for acceleration and deceleration at eachTransition
cycle.This may only be changed prior to starting the transition or after the transition has ended. If the value of
interpolator
is changed for a runningTransition
, the animation has to be stopped and started again to pick up the new value.Default interpolator is set to
Interpolator.EASE_BOTH
.- Default value:
- EASE_BOTH
- Returns:
- the
interpolator
property - See Also:
-
getCachedInterpolator
Returns theInterpolator
, that was set when theTransition
was started. Changing theinterpolator
of a runningTransition
should have no immediate effect. Instead the runningTransition
should continue to use the originalInterpolator
until it is stopped and started again.- Returns:
- the
Interpolator
that was set when thisTransition
was started
-
getParentTargetNode
Returns the first non-null
targetNode
in the parent hierarchy of thisTransition
, ornull
if such a node is not found.A parent animation is one that can have child animations. Examples are
SequentialTransition
andParallelTransition
. A parent animation can also be a child of another parent animation.Note that if this
Transition
has a target node set and is not a parent animation, it will be ignored during the call as this method only queries parent animations.- Returns:
- the target
Node
-
interpolate
protected abstract void interpolate(double frac) The methodinterpolate()
has to be provided by implementations ofTransition
. While aTransition
is running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be0.0
and at the end it will be1.0
. How the parameter increases, depends on theinterpolator
, e.g. if theinterpolator
isInterpolator.LINEAR
, the fraction will increase linear. This method must not be called by the user directly.- Parameters:
frac
- The relative position
-