javafx.animation

Class PathTransition

java.lang.Object

javafx.animation.Animation

javafx.animation.Transition

javafx.animation.PathTransition

public final class PathTransition
extends Transition

This Transition creates a path animation that spans its duration. The translation along the path is done by updating the translateX and translateY variables of the node, and the rotate variable will get updated if orientation is set to OrientationType.ORTHOGONAL_TO_TANGENT, at regular interval.

The animated path is defined by the outline of a shape.

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);


     Path path = new Path();
     path.getElements().add (new MoveTo (0f, 50f));
     path.getElements().add (new CubicCurveTo (40f, 10f, 390f, 240f, 1904, 50f));

     pathTransition.setDuration(Duration.millis(10000));
     pathTransition.setNode(rect);
     pathTransition.setPath(path);
     pathTransition.setOrientation(OrientationType.ORTHOGONAL_TO_TANGENT);
     pathTransition.setCycleCount(4f);
     pathTransition.setAutoReverse(true);

     pathTransition.play();

 ...

 
 

Since:

JavaFX 2.0

See Also:

Transition, Animation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathTransition.OrientationType Specifies the upright orientation of node along the path.

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

Animation.Status

Field Summary

Fields inherited from class javafx.animation.Animation

INDEFINITE

Constructor Summary

Constructors

Constructor and Description
PathTransition() The constructor of PathTransition.
PathTransition(Duration duration, Shape path) The constructor of PathTransition.
PathTransition(Duration duration, Shape path, Node node) The constructor of PathTransition.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Duration>	durationProperty()
Duration	getDuration()
Node	getNode()
PathTransition.OrientationType	getOrientation()
Shape	getPath()
void	interpolate(double frac) The method interpolate() has to be provided by implementations of Transition.
ObjectProperty<Node>	nodeProperty()
ObjectProperty<PathTransition.OrientationType>	orientationProperty()
ObjectProperty<Shape>	pathProperty()
void	setDuration(Duration value)
void	setNode(Node value)
void	setOrientation(PathTransition.OrientationType value)
void	setPath(Shape value)

Methods inherited from class javafx.animation.Transition

getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolator

Methods 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathTransition

public PathTransition(Duration duration,
                      Shape path,
                      Node node)

The constructor of PathTransition.

Parameters:

duration - The duration of this PathTransition

path - The path of this PathTransition

node - The node of this PathTransition

PathTransition

public PathTransition(Duration duration,
                      Shape path)

The constructor of PathTransition.

Parameters:

duration - The duration of this PathTransition

path - The path of this PathTransition

PathTransition

public PathTransition()

The constructor of PathTransition.

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()

setPath

public final void setPath(Shape value)

getPath

public final Shape getPath()

pathProperty

public final ObjectProperty<Shape> pathProperty()

setOrientation

public final void setOrientation(PathTransition.OrientationType value)

getOrientation

public final PathTransition.OrientationType getOrientation()

orientationProperty

public final ObjectProperty<PathTransition.OrientationType> orientationProperty()

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