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 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:
Transition,Animation
-
Property Summary
Properties Type Property Description DoublePropertybyXSpecifies the incremented stop X coordinate value, from the start, of thisTranslateTransition.DoublePropertybyYSpecifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition.DoublePropertybyZSpecifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition.ObjectProperty<Duration>durationThe duration of thisTranslateTransition.DoublePropertyfromXSpecifies the start X coordinate value of thisTranslateTransition.DoublePropertyfromYSpecifies the start Y coordinate value of thisTranslateTransition.DoublePropertyfromZSpecifies the start Z coordinate value of thisTranslateTransition.ObjectProperty<Node>nodeThe target node of thisTranslateTransition.DoublePropertytoXSpecifies the stop X coordinate value of thisTranslateTransition.DoublePropertytoYSpecifies the stop Y coordinate value of thisTranslateTransition.DoublePropertytoZSpecifies the stop Z coordinate value of thisTranslateTransition.Properties inherited from class javafx.animation.Animation
autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration -
Nested Class Summary
-
Field Summary
-
Constructor Summary
Constructors Constructor Description TranslateTransition()The constructor ofTranslateTransitionTranslateTransition(Duration duration)The constructor ofTranslateTransitionTranslateTransition(Duration duration, Node node)The constructor ofTranslateTransition -
Method Summary
Modifier and Type Method Description DoublePropertybyXProperty()Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition.DoublePropertybyYProperty()Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition.DoublePropertybyZProperty()Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition.ObjectProperty<Duration>durationProperty()The duration of thisTranslateTransition.DoublePropertyfromXProperty()Specifies the start X coordinate value of thisTranslateTransition.DoublePropertyfromYProperty()Specifies the start Y coordinate value of thisTranslateTransition.DoublePropertyfromZProperty()Specifies the start Z coordinate value of thisTranslateTransition.doublegetByX()Gets the value of the property byX.doublegetByY()Gets the value of the property byY.doublegetByZ()Gets the value of the property byZ.DurationgetDuration()Gets the value of the property duration.doublegetFromX()Gets the value of the property fromX.doublegetFromY()Gets the value of the property fromY.doublegetFromZ()Gets the value of the property fromZ.NodegetNode()Gets the value of the property node.doublegetToX()Gets the value of the property toX.doublegetToY()Gets the value of the property toY.doublegetToZ()Gets the value of the property toZ.voidinterpolate(double frac)The methodinterpolate()has to be provided by implementations ofTransition.ObjectProperty<Node>nodeProperty()The target node of thisTranslateTransition.voidsetByX(double value)Sets the value of the property byX.voidsetByY(double value)Sets the value of the property byY.voidsetByZ(double value)Sets the value of the property byZ.voidsetDuration(Duration value)Sets the value of the property duration.voidsetFromX(double value)Sets the value of the property fromX.voidsetFromY(double value)Sets the value of the property fromY.voidsetFromZ(double value)Sets the value of the property fromZ.voidsetNode(Node value)Sets the value of the property node.voidsetToX(double value)Sets the value of the property toX.voidsetToY(double value)Sets the value of the property toY.voidsetToZ(double value)Sets the value of the property toZ.DoublePropertytoXProperty()Specifies the stop X coordinate value of thisTranslateTransition.DoublePropertytoYProperty()Specifies the stop Y coordinate value of thisTranslateTransition.DoublePropertytoZProperty()Specifies the stop Z coordinate value of thisTranslateTransition.Methods inherited from class javafx.animation.Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolatorMethods inherited from 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
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.- See Also:
getNode(),setNode(Node)
-
duration
The duration of thisTranslateTransition.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
- See Also:
getDuration(),setDuration(Duration)
-
fromX
Specifies the start X coordinate value of thisTranslateTransition.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- See Also:
getFromX(),setFromX(double)
-
fromY
Specifies the start Y coordinate value of thisTranslateTransition.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- See Also:
getFromY(),setFromY(double)
-
fromZ
Specifies the start Z coordinate value of thisTranslateTransition.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- See Also:
getFromZ(),setFromZ(double)
-
toX
Specifies the stop X coordinate value of thisTranslateTransition.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- See Also:
getToX(),setToX(double)
-
toY
Specifies the stop Y coordinate value of thisTranslateTransition.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- See Also:
getToY(),setToY(double)
-
toZ
Specifies the stop Z coordinate value of thisTranslateTransition.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- See Also:
getToZ(),setToZ(double)
-
byX
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByX(),setByX(double)
-
byY
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByY(),setByY(double)
-
byZ
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByZ(),setByZ(double)
-
-
Constructor Details
-
TranslateTransition
The constructor ofTranslateTransition- Parameters:
duration- The duration of theTranslateTransitionnode- Thenodewhich 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 the property node.- 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.
-
getNode
Gets the value of the property node.- 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.
-
nodeProperty
The target node of thisTranslateTransition.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.- See Also:
getNode(),setNode(Node)
-
setDuration
Sets the value of the property duration.- 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
-
getDuration
Gets the value of the property duration.- 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
-
durationProperty
The duration of thisTranslateTransition.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
- See Also:
getDuration(),setDuration(Duration)
-
setFromX
public final void setFromX(double value)Sets the value of the property fromX.- 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
-
getFromX
public final double getFromX()Gets the value of the property fromX.- 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
-
fromXProperty
Specifies the start X coordinate value of thisTranslateTransition.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- See Also:
getFromX(),setFromX(double)
-
setFromY
public final void setFromY(double value)Sets the value of the property fromY.- 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
-
getFromY
public final double getFromY()Gets the value of the property fromY.- 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
-
fromYProperty
Specifies the start Y coordinate value of thisTranslateTransition.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- See Also:
getFromY(),setFromY(double)
-
setFromZ
public final void setFromZ(double value)Sets the value of the property fromZ.- 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
-
getFromZ
public final double getFromZ()Gets the value of the property fromZ.- 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
-
fromZProperty
Specifies the start Z coordinate value of thisTranslateTransition.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- See Also:
getFromZ(),setFromZ(double)
-
setToX
public final void setToX(double value)Sets the value of the property toX.- 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
-
getToX
public final double getToX()Gets the value of the property toX.- 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
-
toXProperty
Specifies the stop X coordinate value of thisTranslateTransition.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- See Also:
getToX(),setToX(double)
-
setToY
public final void setToY(double value)Sets the value of the property toY.- 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
-
getToY
public final double getToY()Gets the value of the property toY.- 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
-
toYProperty
Specifies the stop Y coordinate value of thisTranslateTransition.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- See Also:
getToY(),setToY(double)
-
setToZ
public final void setToZ(double value)Sets the value of the property toZ.- 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
-
getToZ
public final double getToZ()Gets the value of the property toZ.- 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
-
toZProperty
Specifies the stop Z coordinate value of thisTranslateTransition.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- See Also:
getToZ(),setToZ(double)
-
setByX
public final void setByX(double value)Sets the value of the property byX.- 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.
-
getByX
public final double getByX()Gets the value of the property byX.- 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.
-
byXProperty
Specifies the incremented stop X coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByX(),setByX(double)
-
setByY
public final void setByY(double value)Sets the value of the property byY.- 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.
-
getByY
public final double getByY()Gets the value of the property byY.- 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.
-
byYProperty
Specifies the incremented stop Y coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByY(),setByY(double)
-
setByZ
public final void setByZ(double value)Sets the value of the property byZ.- 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.
-
getByZ
public final double getByZ()Gets the value of the property byZ.- 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.
-
byZProperty
Specifies the incremented stop Z coordinate value, from the start, of thisTranslateTransition.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.- See Also:
getByZ(),setByZ(double)
-
interpolate
public void interpolate(double frac)The methodinterpolate()has to be provided by implementations ofTransition. While aTransitionis running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be0.0and at the end it will be1.0. How the parameter increases, depends on theinterpolator, e.g. if theinterpolatorisInterpolator.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
-