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.transition.*;

 ...

     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

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.animation.Animation
  Animation.Status

Field Summary

Fields
Modifier and Type	Field and Description
`private DoubleProperty`	`byX` Specifies the incremented stop X coordinate value, from the start, of this `TranslateTransition`.
`private DoubleProperty`	`byY` Specifies the incremented stop Y coordinate value, from the start, of this `TranslateTransition`.
`private DoubleProperty`	`byZ` Specifies the incremented stop Z coordinate value, from the start, of this `TranslateTransition`.
`private Node`	`cachedNode`
`private static double`	`DEFAULT_BY_X`
`private static double`	`DEFAULT_BY_Y`
`private static double`	`DEFAULT_BY_Z`
`private static Duration`	`DEFAULT_DURATION`
`private static double`	`DEFAULT_FROM_X`
`private static double`	`DEFAULT_FROM_Y`
`private static double`	`DEFAULT_FROM_Z`
`private static Node`	`DEFAULT_NODE`
`private static double`	`DEFAULT_TO_X`
`private static double`	`DEFAULT_TO_Y`
`private static double`	`DEFAULT_TO_Z`
`private double`	`deltaX`
`private double`	`deltaY`
`private double`	`deltaZ`
`private ObjectProperty<Duration>`	`duration` The duration of this `TranslateTransition`.
`private static double`	`EPSILON`
`private DoubleProperty`	`fromX` Specifies the start X coordinate value of this `TranslateTransition`.
`private DoubleProperty`	`fromY` Specifies the start Y coordinate value of this `TranslateTransition`.
`private DoubleProperty`	`fromZ` Specifies the start Z coordinate value of this `TranslateTransition`.
`private ObjectProperty<Node>`	`node` The target node of this `TranslateTransition`.
`private double`	`startX`
`private double`	`startY`
`private double`	`startZ`
`private DoubleProperty`	`toX` Specifies the stop X coordinate value of this `TranslateTransition`.
`private DoubleProperty`	`toY` Specifies the stop Y coordinate value of this `TranslateTransition`.
`private DoubleProperty`	`toZ` Specifies the stop Z coordinate value of this `TranslateTransition`.

Fields inherited from class javafx.animation.Animation
clipEnvelope, INDEFINITE, parent, pulseReceiver

Constructor Summary

Constructors
Constructor and Description
`TranslateTransition()` The constructor of `TranslateTransition`
`TranslateTransition(Duration duration)` The constructor of `TranslateTransition`
`TranslateTransition(Duration duration, Node node)` The constructor of `TranslateTransition`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleProperty`	`byXProperty()`
`DoubleProperty`	`byYProperty()`
`DoubleProperty`	`byZProperty()`
`ObjectProperty<Duration>`	`durationProperty()`
`DoubleProperty`	`fromXProperty()`
`DoubleProperty`	`fromYProperty()`
`DoubleProperty`	`fromZProperty()`
`double`	`getByX()`
`double`	`getByY()`
`double`	`getByZ()`
`Duration`	`getDuration()`
`double`	`getFromX()`
`double`	`getFromY()`
`double`	`getFromZ()`
`Node`	`getNode()`
`private Node`	`getTargetNode()`
`double`	`getToX()`
`double`	`getToY()`
`double`	`getToZ()`
`(package private) boolean`	`impl_startable(boolean forceSync)`
`(package private) void`	`impl_sync(boolean forceSync)`
`void`	`interpolate(double frac)` The method `interpolate()` has to be provided by implementations of `Transition`.
`ObjectProperty<Node>`	`nodeProperty()`
`void`	`setByX(double value)`
`void`	`setByY(double value)`
`void`	`setByZ(double value)`
`void`	`setDuration(Duration value)`
`void`	`setFromX(double value)`
`void`	`setFromY(double value)`
`void`	`setFromZ(double value)`
`void`	`setNode(Node value)`
`void`	`setToX(double value)`
`void`	`setToY(double value)`
`void`	`setToZ(double value)`
`DoubleProperty`	`toXProperty()`
`DoubleProperty`	`toYProperty()`
`DoubleProperty`	`toZProperty()`

Methods inherited from class javafx.animation.Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, impl_jumpTo, impl_playTo, interpolatorProperty, setInterpolator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EPSILON
```
private static final double EPSILON
```
    See Also:
    
    Constant Field Values
  - startX
```
private double startX
```
  - startY
```
private double startY
```
  - startZ
```
private double startZ
```
  - deltaX
```
private double deltaX
```
  - deltaY
```
private double deltaY
```
  - deltaZ
```
private double deltaZ
```
  - node
```
private ObjectProperty<Node> node
```
    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.
  - DEFAULT_NODE
```
private static final Node DEFAULT_NODE
```
  - cachedNode
```
private Node cachedNode
```
  - duration
```
private ObjectProperty<Duration> duration
```
    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_DURATION
```
private static final Duration DEFAULT_DURATION
```
  - fromX
```
private DoubleProperty fromX
```
    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_FROM_X
```
private static final double DEFAULT_FROM_X
```
    See Also:
    
    Constant Field Values
  - fromY
```
private DoubleProperty fromY
```
    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_FROM_Y
```
private static final double DEFAULT_FROM_Y
```
    See Also:
    
    Constant Field Values
  - fromZ
```
private DoubleProperty fromZ
```
    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_FROM_Z
```
private static final double DEFAULT_FROM_Z
```
    See Also:
    
    Constant Field Values
  - toX
```
private DoubleProperty toX
```
    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_TO_X
```
private static final double DEFAULT_TO_X
```
    See Also:
    
    Constant Field Values
  - toY
```
private DoubleProperty toY
```
    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_TO_Y
```
private static final double DEFAULT_TO_Y
```
    See Also:
    
    Constant Field Values
  - toZ
```
private DoubleProperty toZ
```
    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_TO_Z
```
private static final double DEFAULT_TO_Z
```
    See Also:
    
    Constant Field Values
  - byX
```
private DoubleProperty byX
```
    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.
  - DEFAULT_BY_X
```
private static final double DEFAULT_BY_X
```
    See Also:
    
    Constant Field Values
  - byY
```
private DoubleProperty byY
```
    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.
  - DEFAULT_BY_Y
```
private static final double DEFAULT_BY_Y
```
    See Also:
    
    Constant Field Values
  - byZ
```
private DoubleProperty byZ
```
    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.
  - DEFAULT_BY_Z
```
private static final double DEFAULT_BY_Z
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - setNode
```
public final void setNode(Node value)
```
  - getNode
```
public final Node getNode()
```
  - nodeProperty
```
public final ObjectProperty<Node> nodeProperty()
```
  - setDuration
```
public final void setDuration(Duration value)
```
  - getDuration
```
public final Duration getDuration()
```
  - durationProperty
```
public final ObjectProperty<Duration> durationProperty()
```
  - setFromX
```
public final void setFromX(double value)
```
  - getFromX
```
public final double getFromX()
```
  - fromXProperty
```
public final DoubleProperty fromXProperty()
```
  - setFromY
```
public final void setFromY(double value)
```
  - getFromY
```
public final double getFromY()
```
  - fromYProperty
```
public final DoubleProperty fromYProperty()
```
  - setFromZ
```
public final void setFromZ(double value)
```
  - getFromZ
```
public final double getFromZ()
```
  - fromZProperty
```
public final DoubleProperty fromZProperty()
```
  - setToX
```
public final void setToX(double value)
```
  - getToX
```
public final double getToX()
```
  - toXProperty
```
public final DoubleProperty toXProperty()
```
  - setToY
```
public final void setToY(double value)
```
  - getToY
```
public final double getToY()
```
  - toYProperty
```
public final DoubleProperty toYProperty()
```
  - setToZ
```
public final void setToZ(double value)
```
  - getToZ
```
public final double getToZ()
```
  - toZProperty
```
public final DoubleProperty toZProperty()
```
  - setByX
```
public final void setByX(double value)
```
  - getByX
```
public final double getByX()
```
  - byXProperty
```
public final DoubleProperty byXProperty()
```
  - setByY
```
public final void setByY(double value)
```
  - getByY
```
public final double getByY()
```
  - byYProperty
```
public final DoubleProperty byYProperty()
```
  - setByZ
```
public final void setByZ(double value)
```
  - getByZ
```
public final double getByZ()
```
  - byZProperty
```
public final DoubleProperty byZProperty()
```
  - 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
  - getTargetNode
```
private Node getTargetNode()
```
  - impl_startable
```
boolean impl_startable(boolean forceSync)
```
    Overrides:
    
    impl_startable in class Transition
  - impl_sync
```
void impl_sync(boolean forceSync)
```
    Overrides:
    
    impl_sync in class Transition

Class TranslateTransition

Nested Class Summary

Nested classes/interfaces inherited from class javafx.animation.Animation

Field Summary

Fields inherited from class javafx.animation.Animation

Constructor Summary

Method Summary

Methods inherited from class javafx.animation.Transition

Methods inherited from class javafx.animation.Animation

Methods inherited from class java.lang.Object

Field Detail

EPSILON

startX

startY

startZ

deltaX

deltaY

deltaZ

node

DEFAULT_NODE

cachedNode

duration

DEFAULT_DURATION

fromX

DEFAULT_FROM_X

fromY

DEFAULT_FROM_Y

fromZ

DEFAULT_FROM_Z

toX

DEFAULT_TO_X

toY

DEFAULT_TO_Y

toZ

DEFAULT_TO_Z

byX

DEFAULT_BY_X

byY

DEFAULT_BY_Y

byZ

DEFAULT_BY_Z

Constructor Detail

TranslateTransition

TranslateTransition

TranslateTransition

Method Detail

setNode

getNode

nodeProperty

setDuration

getDuration

durationProperty

setFromX

getFromX

fromXProperty

setFromY

getFromY

fromYProperty

setFromZ

getFromZ

fromZProperty

setToX

getToX

toXProperty

setToY

getToY

toYProperty

setToZ

getToZ

toZProperty

setByX

getByX

byXProperty

setByY

getByY

byYProperty

setByZ

getByZ

byZProperty

interpolate