Transition
creates a move/translate animation that spans its
duration
. This is done by updating the translateX
,
translateY
and translateZ
variables of the node
at
regular interval.
It starts from the (fromX
, fromY
, fromZ
) value if
provided else uses the node
's (translateX
, translateY
, translateZ
) value.
It stops at the (toX
, toY
, toZ
) value if provided
else it will use start value plus (byX
, byY
, byZ
)
value.
The (toX
, toY
, toZ
) value takes precedence if both (
toX
, toY
, toZ
) and (byX
, byY
,
byZ
) values are specified.
Code Segment Example:
import javafx.scene.shape.*;
import javafx.animation.*;
...
Rectangle rect = new Rectangle (100, 40, 100, 100);
rect.setArcHeight(50);
rect.setArcWidth(50);
rect.setFill(Color.VIOLET);
TranslateTransition tt = new TranslateTransition(Duration.millis(2000), rect);
tt.setByX(200f);
tt.setCycleCount(4f);
tt.setAutoReverse(true);
tt.play();
...
- Since:
- JavaFX 2.0
- See Also:
-
Property Summary
TypePropertyDescriptionfinal DoubleProperty
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition
.final DoubleProperty
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition
.final DoubleProperty
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition
.final ObjectProperty<Duration>
The duration of thisTranslateTransition
.final DoubleProperty
Specifies the start X coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the start Y coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the start Z coordinate value of thisTranslateTransition
.final ObjectProperty<Node>
The target node of thisTranslateTransition
.final DoubleProperty
Specifies the stop X coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the stop Y coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the stop Z coordinate value of thisTranslateTransition
.Properties declared in class javafx.animation.Transition
interpolator
Properties declared in class javafx.animation.Animation
autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration
-
Nested Class Summary
Nested classes/interfaces declared in class javafx.animation.Animation
Animation.Status
-
Field Summary
Fields declared in class javafx.animation.Animation
INDEFINITE
-
Constructor Summary
ConstructorDescriptionThe constructor ofTranslateTransition
TranslateTransition
(Duration duration) The constructor ofTranslateTransition
TranslateTransition
(Duration duration, Node node) The constructor ofTranslateTransition
-
Method Summary
Modifier and TypeMethodDescriptionfinal DoubleProperty
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition
.final DoubleProperty
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition
.final DoubleProperty
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition
.final ObjectProperty<Duration>
The duration of thisTranslateTransition
.final DoubleProperty
Specifies the start X coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the start Y coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the start Z coordinate value of thisTranslateTransition
.final double
getByX()
Gets the value of thebyX
property.final double
getByY()
Gets the value of thebyY
property.final double
getByZ()
Gets the value of thebyZ
property.final Duration
Gets the value of theduration
property.final double
getFromX()
Gets the value of thefromX
property.final double
getFromY()
Gets the value of thefromY
property.final double
getFromZ()
Gets the value of thefromZ
property.final Node
getNode()
Gets the value of thenode
property.final double
getToX()
Gets the value of thetoX
property.final double
getToY()
Gets the value of thetoY
property.final double
getToZ()
Gets the value of thetoZ
property.void
interpolate
(double frac) The methodinterpolate()
has to be provided by implementations ofTransition
.final ObjectProperty<Node>
The target node of thisTranslateTransition
.final void
setByX
(double value) Sets the value of thebyX
property.final void
setByY
(double value) Sets the value of thebyY
property.final void
setByZ
(double value) Sets the value of thebyZ
property.final void
setDuration
(Duration value) Sets the value of theduration
property.final void
setFromX
(double value) Sets the value of thefromX
property.final void
setFromY
(double value) Sets the value of thefromY
property.final void
setFromZ
(double value) Sets the value of thefromZ
property.final void
Sets the value of thenode
property.final void
setToX
(double value) Sets the value of thetoX
property.final void
setToY
(double value) Sets the value of thetoY
property.final void
setToZ
(double value) Sets the value of thetoZ
property.final DoubleProperty
Specifies the stop X coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the stop Y coordinate value of thisTranslateTransition
.final DoubleProperty
Specifies the stop Z coordinate value of thisTranslateTransition
.Methods declared in class javafx.animation.Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolator
Methods declared in class javafx.animation.Animation
autoReverseProperty, 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
-
node
The target node of thisTranslateTransition
.It is not possible to change the target
node
of a runningTranslateTransition
. If the value ofnode
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
duration
The duration of thisTranslateTransition
.It is not possible to change the
duration
of a runningTranslateTransition
. If the value ofduration
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
.- Default value:
- 400ms
- See Also:
-
fromX
Specifies the start X coordinate value of thisTranslateTransition
.It is not possible to change
fromX
of a runningTranslateTransition
. If the value offromX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
fromY
Specifies the start Y coordinate value of thisTranslateTransition
.It is not possible to change
fromY
of a runningTranslateTransition
. If the value offromY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
fromZ
Specifies the start Z coordinate value of thisTranslateTransition
.It is not possible to change
fromZ
of a runningTranslateTransition
. If the value offromZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
toX
Specifies the stop X coordinate value of thisTranslateTransition
.It is not possible to change
toX
of a runningTranslateTransition
. If the value oftoX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
toY
Specifies the stop Y coordinate value of thisTranslateTransition
.It is not possible to change
toY
of a runningTranslateTransition
. If the value oftoY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
toZ
Specifies the stop Z coordinate value of thisTranslateTransition
.It is not possible to change
toZ
of a runningTranslateTransition
. If the value oftoZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
byX
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byX
of a runningTranslateTransition
. If the value ofbyX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
byY
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byY
of a runningTranslateTransition
. If the value ofbyY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
byZ
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byZ
of a runningTranslateTransition
. If the value ofbyZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
-
Constructor Details
-
TranslateTransition
The constructor ofTranslateTransition
- Parameters:
duration
- The duration of theTranslateTransition
node
- Thenode
which will be translated
-
TranslateTransition
The constructor ofTranslateTransition
- Parameters:
duration
- The duration of theTranslateTransition
-
TranslateTransition
public TranslateTransition()The constructor ofTranslateTransition
-
-
Method Details
-
setNode
Sets the value of thenode
property.- Property description:
- The target node of this
TranslateTransition
.It is not possible to change the target
node
of a runningTranslateTransition
. If the value ofnode
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thenode
property- See Also:
-
getNode
Gets the value of thenode
property.- Property description:
- The target node of this
TranslateTransition
.It is not possible to change the target
node
of a runningTranslateTransition
. If the value ofnode
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
node
property - See Also:
-
nodeProperty
The target node of thisTranslateTransition
.It is not possible to change the target
node
of a runningTranslateTransition
. If the value ofnode
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
node
property - See Also:
-
setDuration
Sets the value of theduration
property.- Property description:
- The duration of this
TranslateTransition
.It is not possible to change the
duration
of a runningTranslateTransition
. If the value ofduration
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
. - Default value:
- 400ms
- Parameters:
value
- the value for theduration
property- See Also:
-
getDuration
Gets the value of theduration
property.- Property description:
- The duration of this
TranslateTransition
.It is not possible to change the
duration
of a runningTranslateTransition
. If the value ofduration
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
. - Default value:
- 400ms
- Returns:
- the value of the
duration
property - See Also:
-
durationProperty
The duration of thisTranslateTransition
.It is not possible to change the
duration
of a runningTranslateTransition
. If the value ofduration
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
.- Default value:
- 400ms
- Returns:
- the
duration
property - See Also:
-
setFromX
public final void setFromX(double value) Sets the value of thefromX
property.- Property description:
- Specifies the start X coordinate value of this
TranslateTransition
.It is not possible to change
fromX
of a runningTranslateTransition
. If the value offromX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thefromX
property- See Also:
-
getFromX
public final double getFromX()Gets the value of thefromX
property.- Property description:
- Specifies the start X coordinate value of this
TranslateTransition
.It is not possible to change
fromX
of a runningTranslateTransition
. If the value offromX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
fromX
property - See Also:
-
fromXProperty
Specifies the start X coordinate value of thisTranslateTransition
.It is not possible to change
fromX
of a runningTranslateTransition
. If the value offromX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
fromX
property - See Also:
-
setFromY
public final void setFromY(double value) Sets the value of thefromY
property.- Property description:
- Specifies the start Y coordinate value of this
TranslateTransition
.It is not possible to change
fromY
of a runningTranslateTransition
. If the value offromY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thefromY
property- See Also:
-
getFromY
public final double getFromY()Gets the value of thefromY
property.- Property description:
- Specifies the start Y coordinate value of this
TranslateTransition
.It is not possible to change
fromY
of a runningTranslateTransition
. If the value offromY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
fromY
property - See Also:
-
fromYProperty
Specifies the start Y coordinate value of thisTranslateTransition
.It is not possible to change
fromY
of a runningTranslateTransition
. If the value offromY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
fromY
property - See Also:
-
setFromZ
public final void setFromZ(double value) Sets the value of thefromZ
property.- Property description:
- Specifies the start Z coordinate value of this
TranslateTransition
.It is not possible to change
fromZ
of a runningTranslateTransition
. If the value offromZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thefromZ
property- See Also:
-
getFromZ
public final double getFromZ()Gets the value of thefromZ
property.- Property description:
- Specifies the start Z coordinate value of this
TranslateTransition
.It is not possible to change
fromZ
of a runningTranslateTransition
. If the value offromZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
fromZ
property - See Also:
-
fromZProperty
Specifies the start Z coordinate value of thisTranslateTransition
.It is not possible to change
fromZ
of a runningTranslateTransition
. If the value offromZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
fromZ
property - See Also:
-
setToX
public final void setToX(double value) Sets the value of thetoX
property.- Property description:
- Specifies the stop X coordinate value of this
TranslateTransition
.It is not possible to change
toX
of a runningTranslateTransition
. If the value oftoX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thetoX
property- See Also:
-
getToX
public final double getToX()Gets the value of thetoX
property.- Property description:
- Specifies the stop X coordinate value of this
TranslateTransition
.It is not possible to change
toX
of a runningTranslateTransition
. If the value oftoX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
toX
property - See Also:
-
toXProperty
Specifies the stop X coordinate value of thisTranslateTransition
.It is not possible to change
toX
of a runningTranslateTransition
. If the value oftoX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
toX
property - See Also:
-
setToY
public final void setToY(double value) Sets the value of thetoY
property.- Property description:
- Specifies the stop Y coordinate value of this
TranslateTransition
.It is not possible to change
toY
of a runningTranslateTransition
. If the value oftoY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thetoY
property- See Also:
-
getToY
public final double getToY()Gets the value of thetoY
property.- Property description:
- Specifies the stop Y coordinate value of this
TranslateTransition
.It is not possible to change
toY
of a runningTranslateTransition
. If the value oftoY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
toY
property - See Also:
-
toYProperty
Specifies the stop Y coordinate value of thisTranslateTransition
.It is not possible to change
toY
of a runningTranslateTransition
. If the value oftoY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
toY
property - See Also:
-
setToZ
public final void setToZ(double value) Sets the value of thetoZ
property.- Property description:
- Specifies the stop Z coordinate value of this
TranslateTransition
.It is not possible to change
toZ
of a runningTranslateTransition
. If the value oftoZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thetoZ
property- See Also:
-
getToZ
public final double getToZ()Gets the value of thetoZ
property.- Property description:
- Specifies the stop Z coordinate value of this
TranslateTransition
.It is not possible to change
toZ
of a runningTranslateTransition
. If the value oftoZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
toZ
property - See Also:
-
toZProperty
Specifies the stop Z coordinate value of thisTranslateTransition
.It is not possible to change
toZ
of a runningTranslateTransition
. If the value oftoZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
toZ
property - See Also:
-
setByX
public final void setByX(double value) Sets the value of thebyX
property.- Property description:
- Specifies the incremented stop X coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byX
of a runningTranslateTransition
. If the value ofbyX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thebyX
property- See Also:
-
getByX
public final double getByX()Gets the value of thebyX
property.- Property description:
- Specifies the incremented stop X coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byX
of a runningTranslateTransition
. If the value ofbyX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byX
property - See Also:
-
byXProperty
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byX
of a runningTranslateTransition
. If the value ofbyX
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
byX
property - See Also:
-
setByY
public final void setByY(double value) Sets the value of thebyY
property.- Property description:
- Specifies the incremented stop Y coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byY
of a runningTranslateTransition
. If the value ofbyY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thebyY
property- See Also:
-
getByY
public final double getByY()Gets the value of thebyY
property.- Property description:
- Specifies the incremented stop Y coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byY
of a runningTranslateTransition
. If the value ofbyY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byY
property - See Also:
-
byYProperty
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byY
of a runningTranslateTransition
. If the value ofbyY
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
byY
property - See Also:
-
setByZ
public final void setByZ(double value) Sets the value of thebyZ
property.- Property description:
- Specifies the incremented stop Z coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byZ
of a runningTranslateTransition
. If the value ofbyZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thebyZ
property- See Also:
-
getByZ
public final double getByZ()Gets the value of thebyZ
property.- Property description:
- Specifies the incremented stop Z coordinate value, from the start, of
this
TranslateTransition
.It is not possible to change
byZ
of a runningTranslateTransition
. If the value ofbyZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byZ
property - See Also:
-
byZProperty
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition
.It is not possible to change
byZ
of a runningTranslateTransition
. If the value ofbyZ
is changed for a runningTranslateTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
byZ
property - See Also:
-
interpolate
public 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.- Specified by:
interpolate
in classTransition
- Parameters:
frac
- The relative position
-