Class TranslateTransition
public final class TranslateTransition extends Transition
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 intervals. 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:
Nested Class Summary
Nested classes/interfaces declared in class javafx.animation.Animation
Animation.Status
Property Summary
| Type | Property | Description |
|---|---|---|
final DoubleProperty |
byX |
Specifies the incremented stop X coordinate value, from the start, of this TranslateTransition. |
final DoubleProperty |
byY |
Specifies the incremented stop Y coordinate value, from the start, of this TranslateTransition. |
final DoubleProperty |
byZ |
Specifies the incremented stop Z coordinate value, from the start, of this TranslateTransition. |
final ObjectProperty |
duration |
The duration of this TranslateTransition. |
final DoubleProperty |
fromX |
Specifies the start X coordinate value of this TranslateTransition. |
final DoubleProperty |
fromY |
Specifies the start Y coordinate value of this TranslateTransition. |
final DoubleProperty |
fromZ |
Specifies the start Z coordinate value of this TranslateTransition. |
final ObjectProperty |
node |
The target node of this TranslateTransition. |
final DoubleProperty |
toX |
Specifies the stop X coordinate value of this TranslateTransition. |
final DoubleProperty |
toY |
Specifies the stop Y coordinate value of this TranslateTransition. |
final DoubleProperty |
toZ |
Specifies the stop Z coordinate value of this TranslateTransition. |
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
Field Summary
Fields declared in class javafx.animation.Animation
INDEFINITE
Constructor Summary
| Constructor | Description |
|---|---|
TranslateTransition() |
The constructor of TranslateTransition
|
TranslateTransition |
The constructor of TranslateTransition
|
TranslateTransition |
The constructor of TranslateTransition
|
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
final DoubleProperty |
byXProperty() |
Specifies the incremented stop X coordinate value, from the start, of this TranslateTransition. |
final DoubleProperty |
byYProperty() |
Specifies the incremented stop Y coordinate value, from the start, of this TranslateTransition. |
final DoubleProperty |
byZProperty() |
Specifies the incremented stop Z coordinate value, from the start, of this TranslateTransition. |
final ObjectProperty |
durationProperty() |
The duration of this TranslateTransition. |
final DoubleProperty |
fromXProperty() |
Specifies the start X coordinate value of this TranslateTransition. |
final DoubleProperty |
fromYProperty() |
Specifies the start Y coordinate value of this TranslateTransition. |
final DoubleProperty |
fromZProperty() |
Specifies the start Z coordinate value of this TranslateTransition. |
final double |
getByX() |
Gets the value of the byX property. |
final double |
getByY() |
Gets the value of the byY property. |
final double |
getByZ() |
Gets the value of the byZ property. |
final Duration |
getDuration() |
Gets the value of the duration property. |
final double |
getFromX() |
Gets the value of the fromX property. |
final double |
getFromY() |
Gets the value of the fromY property. |
final double |
getFromZ() |
Gets the value of the fromZ property. |
final Node |
getNode() |
Gets the value of the node property. |
final double |
getToX() |
Gets the value of the toX property. |
final double |
getToY() |
Gets the value of the toY property. |
final double |
getToZ() |
Gets the value of the toZ property. |
void |
interpolate |
The method interpolate() has to be provided by implementations of Transition. |
final ObjectProperty |
nodeProperty() |
The target node of this TranslateTransition. |
final void |
setByX |
Sets the value of the byX property. |
final void |
setByY |
Sets the value of the byY property. |
final void |
setByZ |
Sets the value of the byZ property. |
final void |
setDuration |
Sets the value of the duration property. |
final void |
setFromX |
Sets the value of the fromX property. |
final void |
setFromY |
Sets the value of the fromY property. |
final void |
setFromZ |
Sets the value of the fromZ property. |
final void |
setNode |
Sets the value of the node property. |
final void |
setToX |
Sets the value of the toX property. |
final void |
setToY |
Sets the value of the toY property. |
final void |
setToZ |
Sets the value of the toZ property. |
final DoubleProperty |
toXProperty() |
Specifies the stop X coordinate value of this TranslateTransition. |
final DoubleProperty |
toYProperty() |
Specifies the stop Y coordinate value of this TranslateTransition. |
final DoubleProperty |
toZProperty() |
Specifies the stop Z coordinate value of this TranslateTransition. |
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
public final ObjectProperty<Node> nodeProperty
TranslateTransition. It is not possible to change the target node of a running TranslateTransition. If the value of node is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- See Also:
duration
public final ObjectProperty<Duration> durationProperty
TranslateTransition. It is not possible to change the duration of a running TranslateTransition. If the value of duration is changed for a running TranslateTransition, 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 than Duration.ZERO will result in IllegalArgumentException.
- Default value:
- 400ms
- See Also:
fromX
public final DoubleProperty fromXProperty
TranslateTransition. It is not possible to change fromX of a running TranslateTransition. If the value of fromX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
fromY
public final DoubleProperty fromYProperty
TranslateTransition. It is not possible to change fromY of a running TranslateTransition. If the value of fromY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
fromZ
public final DoubleProperty fromZProperty
TranslateTransition. It is not possible to change fromZ of a running TranslateTransition. If the value of fromZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
toX
public final DoubleProperty toXProperty
TranslateTransition. It is not possible to change toX of a running TranslateTransition. If the value of toX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
toY
public final DoubleProperty toYProperty
TranslateTransition. It is not possible to change toY of a running TranslateTransition. If the value of toY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
toZ
public final DoubleProperty toZProperty
TranslateTransition. It is not possible to change toZ of a running TranslateTransition. If the value of toZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- See Also:
byX
public final DoubleProperty byXProperty
TranslateTransition. It is not possible to change byX of a running TranslateTransition. If the value of byX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- See Also:
byY
public final DoubleProperty byYProperty
TranslateTransition. It is not possible to change byY of a running TranslateTransition. If the value of byY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- See Also:
byZ
public final DoubleProperty byZProperty
TranslateTransition. It is not possible to change byZ of a running TranslateTransition. If the value of byZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- See Also:
Constructor Details
TranslateTransition
public TranslateTransition(Duration duration, Node node)
TranslateTransition
- Parameters:
-
duration- The duration of theTranslateTransition -
node- Thenodewhich will be translated
TranslateTransition
public TranslateTransition(Duration duration)
TranslateTransition
- Parameters:
-
duration- The duration of theTranslateTransition
TranslateTransition
public TranslateTransition()
TranslateTransition
Method Details
setNode
public final void setNode(Node value)
node property.- Property description:
- The target node of this
TranslateTransition.It is not possible to change the target
nodeof a runningTranslateTransition. If the value ofnodeis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Parameters:
-
value- the value for thenodeproperty - See Also:
getNode
public final Node getNode()
node property.- Property description:
- The target node of this
TranslateTransition.It is not possible to change the target
nodeof a runningTranslateTransition. If the value ofnodeis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
nodeproperty - See Also:
nodeProperty
public final ObjectProperty<Node> nodeProperty()
TranslateTransition. It is not possible to change the target node of a running TranslateTransition. If the value of node is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Returns:
- the
nodeproperty - See Also:
setDuration
public final void setDuration(Duration value)
duration property.- Property description:
- The duration of this
TranslateTransition.It is not possible to change the
durationof a runningTranslateTransition. If the value ofdurationis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
durationis 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.ZEROwill result inIllegalArgumentException. - Default value:
- 400ms
- Parameters:
-
value- the value for thedurationproperty - See Also:
getDuration
public final Duration getDuration()
duration property.- Property description:
- The duration of this
TranslateTransition.It is not possible to change the
durationof a runningTranslateTransition. If the value ofdurationis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
durationis 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.ZEROwill result inIllegalArgumentException. - Default value:
- 400ms
- Returns:
- the value of the
durationproperty - See Also:
durationProperty
public final ObjectProperty<Duration> durationProperty()
TranslateTransition. It is not possible to change the duration of a running TranslateTransition. If the value of duration is changed for a running TranslateTransition, 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 than Duration.ZERO will result in IllegalArgumentException.
- Default value:
- 400ms
- Returns:
- the
durationproperty - See Also:
setFromX
public final void setFromX(double value)
fromX property.- Property description:
- Specifies the start X coordinate value of this
TranslateTransition.It is not possible to change
fromXof a runningTranslateTransition. If the value offromXis 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 thefromXproperty - See Also:
getFromX
public final double getFromX()
fromX property.- Property description:
- Specifies the start X coordinate value of this
TranslateTransition.It is not possible to change
fromXof a runningTranslateTransition. If the value offromXis 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
fromXproperty - See Also:
fromXProperty
public final DoubleProperty fromXProperty()
TranslateTransition. It is not possible to change fromX of a running TranslateTransition. If the value of fromX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
fromXproperty - See Also:
setFromY
public final void setFromY(double value)
fromY property.- Property description:
- Specifies the start Y coordinate value of this
TranslateTransition.It is not possible to change
fromYof a runningTranslateTransition. If the value offromYis 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 thefromYproperty - See Also:
getFromY
public final double getFromY()
fromY property.- Property description:
- Specifies the start Y coordinate value of this
TranslateTransition.It is not possible to change
fromYof a runningTranslateTransition. If the value offromYis 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
fromYproperty - See Also:
fromYProperty
public final DoubleProperty fromYProperty()
TranslateTransition. It is not possible to change fromY of a running TranslateTransition. If the value of fromY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
fromYproperty - See Also:
setFromZ
public final void setFromZ(double value)
fromZ property.- Property description:
- Specifies the start Z coordinate value of this
TranslateTransition.It is not possible to change
fromZof a runningTranslateTransition. If the value offromZis 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 thefromZproperty - See Also:
getFromZ
public final double getFromZ()
fromZ property.- Property description:
- Specifies the start Z coordinate value of this
TranslateTransition.It is not possible to change
fromZof a runningTranslateTransition. If the value offromZis 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
fromZproperty - See Also:
fromZProperty
public final DoubleProperty fromZProperty()
TranslateTransition. It is not possible to change fromZ of a running TranslateTransition. If the value of fromZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
fromZproperty - See Also:
setToX
public final void setToX(double value)
toX property.- Property description:
- Specifies the stop X coordinate value of this
TranslateTransition.It is not possible to change
toXof a runningTranslateTransition. If the value oftoXis 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 thetoXproperty - See Also:
getToX
public final double getToX()
toX property.- Property description:
- Specifies the stop X coordinate value of this
TranslateTransition.It is not possible to change
toXof a runningTranslateTransition. If the value oftoXis 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
toXproperty - See Also:
toXProperty
public final DoubleProperty toXProperty()
TranslateTransition. It is not possible to change toX of a running TranslateTransition. If the value of toX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
toXproperty - See Also:
setToY
public final void setToY(double value)
toY property.- Property description:
- Specifies the stop Y coordinate value of this
TranslateTransition.It is not possible to change
toYof a runningTranslateTransition. If the value oftoYis 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 thetoYproperty - See Also:
getToY
public final double getToY()
toY property.- Property description:
- Specifies the stop Y coordinate value of this
TranslateTransition.It is not possible to change
toYof a runningTranslateTransition. If the value oftoYis 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
toYproperty - See Also:
toYProperty
public final DoubleProperty toYProperty()
TranslateTransition. It is not possible to change toY of a running TranslateTransition. If the value of toY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
toYproperty - See Also:
setToZ
public final void setToZ(double value)
toZ property.- Property description:
- Specifies the stop Z coordinate value of this
TranslateTransition.It is not possible to change
toZof a runningTranslateTransition. If the value oftoZis 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 thetoZproperty - See Also:
getToZ
public final double getToZ()
toZ property.- Property description:
- Specifies the stop Z coordinate value of this
TranslateTransition.It is not possible to change
toZof a runningTranslateTransition. If the value oftoZis 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
toZproperty - See Also:
toZProperty
public final DoubleProperty toZProperty()
TranslateTransition. It is not possible to change toZ of a running TranslateTransition. If the value of toZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Default value:
Double.NaN- Returns:
- the
toZproperty - See Also:
setByX
public final void setByX(double value)
byX property.- Property description:
- Specifies the incremented stop X coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byXof a runningTranslateTransition. If the value ofbyXis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Parameters:
-
value- the value for thebyXproperty - See Also:
getByX
public final double getByX()
byX property.- Property description:
- Specifies the incremented stop X coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byXof a runningTranslateTransition. If the value ofbyXis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byXproperty - See Also:
byXProperty
public final DoubleProperty byXProperty()
TranslateTransition. It is not possible to change byX of a running TranslateTransition. If the value of byX is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Returns:
- the
byXproperty - See Also:
setByY
public final void setByY(double value)
byY property.- Property description:
- Specifies the incremented stop Y coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byYof a runningTranslateTransition. If the value ofbyYis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Parameters:
-
value- the value for thebyYproperty - See Also:
getByY
public final double getByY()
byY property.- Property description:
- Specifies the incremented stop Y coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byYof a runningTranslateTransition. If the value ofbyYis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byYproperty - See Also:
byYProperty
public final DoubleProperty byYProperty()
TranslateTransition. It is not possible to change byY of a running TranslateTransition. If the value of byY is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Returns:
- the
byYproperty - See Also:
setByZ
public final void setByZ(double value)
byZ property.- Property description:
- Specifies the incremented stop Z coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byZof a runningTranslateTransition. If the value ofbyZis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Parameters:
-
value- the value for thebyZproperty - See Also:
getByZ
public final double getByZ()
byZ property.- Property description:
- Specifies the incremented stop Z coordinate value, from the start, of this
TranslateTransition.It is not possible to change
byZof a runningTranslateTransition. If the value ofbyZis changed for a runningTranslateTransition, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byZproperty - See Also:
byZProperty
public final DoubleProperty byZProperty()
TranslateTransition. It is not possible to change byZ of a running TranslateTransition. If the value of byZ is changed for a running TranslateTransition, the animation has to be stopped and started again to pick up the new value.
- Returns:
- the
byZproperty - See Also:
interpolate
public void interpolate(double frac)
interpolate() has to be provided by implementations of Transition. While a Transition is running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be 0.0 and at the end it will be 1.0. How the parameter increases, depends on the interpolator, e.g. if the interpolator is Interpolator.LINEAR, the fraction will increase linear. This method must not be called by the user directly.- Specified by:
-
interpolatein classTransition - Parameters:
-
frac- The relative position
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.