Module javafx.graphics
Package javafx.animation

Class TranslateTransition

java.lang.Object
javafx.animation.Animation
javafx.animation.Transition
javafx.animation.TranslateTransition
public final class TranslateTransition extends Transition
This 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 Details

    • node

      public final ObjectProperty<Node> nodeProperty
      The target node of this 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
      The duration of this 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
      Specifies the start X coordinate value of this 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
      Specifies the start Y coordinate value of this 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
      Specifies the start Z coordinate value of this 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
      Specifies the stop X coordinate value of this 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
      Specifies the stop Y coordinate value of this 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
      Specifies the stop Z coordinate value of this 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
      Specifies the incremented stop X coordinate value, from the start, of this 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
      Specifies the incremented stop Y coordinate value, from the start, of this 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
      Specifies the incremented stop Z coordinate value, from the start, of this 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)
      The constructor of TranslateTransition
      Parameters:
      duration - The duration of the TranslateTransition
      node - The node which will be translated

    • TranslateTransition

      public TranslateTransition(Duration duration)
      The constructor of TranslateTransition
      Parameters:
      duration - The duration of the TranslateTransition

    • TranslateTransition

      public TranslateTransition()
      The constructor of TranslateTransition

  • Method Details

    • setNode

      public final void setNode(Node value)
      Sets the value of the property node.
      Property description:
      The target node of this 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.

    • getNode

      public final Node getNode()
      Gets the value of the property node.
      Property description:
      The target node of this 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.

    • nodeProperty

      public final ObjectProperty<Node> nodeProperty()
      The target node of this 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:

    • setDuration

      public final void setDuration(Duration value)
      Sets the value of the property duration.
      Property description:
      The duration of this 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

    • getDuration

      public final Duration getDuration()
      Gets the value of the property duration.
      Property description:
      The duration of this 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

    • durationProperty

      public final ObjectProperty<Duration> durationProperty()
      The duration of this 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:

    • 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 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

    • 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 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

    • fromXProperty

      public final DoubleProperty fromXProperty()
      Specifies the start X coordinate value of this 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:

    • 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 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

    • 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 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

    • fromYProperty

      public final DoubleProperty fromYProperty()
      Specifies the start Y coordinate value of this 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:

    • 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 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

    • 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 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

    • fromZProperty

      public final DoubleProperty fromZProperty()
      Specifies the start Z coordinate value of this 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:

    • 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 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

    • 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 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

    • toXProperty

      public final DoubleProperty toXProperty()
      Specifies the stop X coordinate value of this 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:

    • 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 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

    • 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 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

    • toYProperty

      public final DoubleProperty toYProperty()
      Specifies the stop Y coordinate value of this 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:

    • 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 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

    • 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 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

    • toZProperty

      public final DoubleProperty toZProperty()
      Specifies the stop Z coordinate value of this 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:

    • 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 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.

    • 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 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.

    • byXProperty

      public final DoubleProperty byXProperty()
      Specifies the incremented stop X coordinate value, from the start, of this 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:

    • 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 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.

    • 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 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.

    • byYProperty

      public final DoubleProperty byYProperty()
      Specifies the incremented stop Y coordinate value, from the start, of this 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:

    • 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 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.

    • 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 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.

    • byZProperty

      public final DoubleProperty byZProperty()
      Specifies the incremented stop Z coordinate value, from the start, of this 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:

    • interpolate

      public void interpolate(double frac)
      The method 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:
      interpolate in class Transition
      Parameters:
      frac - The relative position