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

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

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


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

...

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	PathTransition.OrientationType Specifies the upright orientation of `node` along the `path`.
private static class	PathTransition.Segment

Field Summary

Modifier and Type	Field and Description
private boolean	cachedIsNormalRequired
private Node	cachedNode
private static final Duration	DEFAULT_DURATION
private static final Node	DEFAULT_NODE
private static final PathTransition.OrientationType	DEFAULT_ORIENTATION
private static final Shape	DEFAULT_PATH
private ObjectProperty<Duration>	duration The duration of this `Transition`.
private ObjectProperty<Node>	node The target node of this `PathTransition`.
private ObjectProperty<PathTransition.OrientationType>	orientation Specifies the upright orientation of `node` along the `path`.
private ObjectProperty<Shape>	path The shape on which outline the node should be animated.
private final ArrayList<PathTransition.Segment>	segments
private static final int	SMOOTH_ZONE
private double	totalLength

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Duration>	durationProperty()
private int	findSegment(int begin, int end, double length) Returns the index of the first segment having accumulated length from the path beginning, greater than `length`
public final Duration	getDuration()
public final Node	getNode()
public final PathTransition.OrientationType	getOrientation()
public final Shape	getPath()
private Node	getTargetNode()
public void	interpolate(double The relative position frac) Implements abstract javafx.animation.Transition.interpolate. The method `interpolate()` has to be provided by implementations of `Transition`.
private static double	interpolate(double fromAngle, double toAngle, double ratio) Interpolates angle according to rate, with correct 0->360 and 360->0 transitions
public final ObjectProperty<Node>	nodeProperty()
private static double	normalize(double angle) Converts angle to range 0-360
public final ObjectProperty<PathTransition.OrientationType>	orientationProperty()
public final ObjectProperty<Shape>	pathProperty()
private void	recomputeSegments()
public final void	setDuration(Duration value)
public final void	setNode(Node value)
public final void	setOrientation(PathTransition.OrientationType value)
public final void	setPath(Shape value)
pack-priv boolean	startable(boolean forceSync) Overrides javafx.animation.Transition.startable.
pack-priv void	sync(boolean forceSync) Overrides javafx.animation.Transition.sync.

Inherited from javafx.animation.Transition:: doJumpTo doPlayTo getCachedInterpolator getInterpolator getParentTargetNode interpolatorProperty setInterpolator

Field Detail

cachedIsNormalRequired	back to summary
private boolean cachedIsNormalRequired

cachedNode	back to summary
private Node cachedNode

DEFAULT_DURATION	back to summary
private static final Duration DEFAULT_DURATION

DEFAULT_NODE	back to summary
private static final Node DEFAULT_NODE

DEFAULT_ORIENTATION	back to summary
private static final PathTransition.OrientationType DEFAULT_ORIENTATION

DEFAULT_PATH	back to summary
private static final Shape DEFAULT_PATH

duration back to summary

duration	back to summary
private ObjectProperty<Duration> duration The duration of this `Transition`. It is not possible to change the `duration` of a running `PathTransition`. If the value of `duration` is changed for a running `PathTransition`, 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

private ObjectProperty<Duration> duration

The duration of this Transition.

It is not possible to change the duration of a running PathTransition. If the value of duration is changed for a running PathTransition, 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

node back to summary

node	back to summary
private ObjectProperty<Node> node The target node of this `PathTransition`. It is not possible to change the target `node` of a running `PathTransition`. If the value of `node` is changed for a running `PathTransition`, the animation has to be stopped and started again to pick up the new value.

private ObjectProperty<Node> node

The target node of this PathTransition.

It is not possible to change the target node of a running PathTransition. If the value of node is changed for a running PathTransition, the animation has to be stopped and started again to pick up the new value.

orientation back to summary

orientation	back to summary
private ObjectProperty<PathTransition.OrientationType> orientation Specifies the upright orientation of `node` along the `path`. The default orientation is set to `OrientationType#NONE`. It is not possible to change the `orientation` of a running `PathTransition`. If the value of `orientation` is changed for a running `PathTransition`, the animation has to be stopped and started again to pick up the new value. Default Value NONE

private ObjectProperty<PathTransition.OrientationType> orientation

Specifies the upright orientation of node along the path. The default orientation is set to OrientationType#NONE.

It is not possible to change the orientation of a running PathTransition. If the value of orientation is changed for a running PathTransition, the animation has to be stopped and started again to pick up the new value.

Default Value: NONE

path back to summary

path	back to summary
private ObjectProperty<Shape> path The shape on which outline the node should be animated. It is not possible to change the `path` of a running `PathTransition`. If the value of `path` is changed for a running `PathTransition`, the animation has to be stopped and started again to pick up the new value. Default Value null

private ObjectProperty<Shape> path

The shape on which outline the node should be animated.

It is not possible to change the path of a running PathTransition. If the value of path is changed for a running PathTransition, the animation has to be stopped and started again to pick up the new value.

Default Value: null

segments	back to summary
private final ArrayList<PathTransition.Segment> segments

SMOOTH_ZONE	back to summary
private static final int SMOOTH_ZONE

totalLength	back to summary
private double totalLength

Constructor Detail

PathTransition back to summary

PathTransition	back to summary
public PathTransition(Duration duration, Shape path, Node node) The constructor of `PathTransition`. Parameters duration:Duration The `duration` of this `PathTransition` path:Shape The `path` of this `PathTransition` node:Node The `node` of this `PathTransition`

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

The constructor of PathTransition.

Parameters

duration:Duration: The duration of this PathTransition
path:Shape: The path of this PathTransition
node:Node: The node of this PathTransition

PathTransition back to summary

PathTransition	back to summary
public PathTransition(Duration duration, Shape path) The constructor of `PathTransition`. Parameters duration:Duration The `duration` of this `PathTransition` path:Shape The `path` of this `PathTransition`

public PathTransition(Duration duration, Shape path)

The constructor of PathTransition.

Parameters

duration:Duration: The duration of this PathTransition
path:Shape: The path of this PathTransition

PathTransition	back to summary
public PathTransition() The constructor of `PathTransition`.

Method Detail

durationProperty	back to summary
public final ObjectProperty<Duration> durationProperty()

findSegment	back to summary
private int findSegment(int begin, int end, double length) Returns the index of the first segment having accumulated length from the path beginning, greater than `length`

getDuration	back to summary
public final Duration getDuration()

getNode	back to summary
public final Node getNode()

getOrientation	back to summary
public final PathTransition.OrientationType getOrientation()

getPath	back to summary
public final Shape getPath()

getTargetNode	back to summary
private Node getTargetNode()

interpolate back to summary

interpolate	back to summary
public void interpolate(double frac) Implements abstract javafx.animation.Transition.interpolate. Doc from javafx.animation.Transition.interpolate. 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. Parameters frac:double The relative position Annotations @Override

public void interpolate(double frac)

Implements abstract javafx.animation.Transition.interpolate.

Doc from javafx.animation.Transition.interpolate.

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.

Parameters

frac:double: The relative position

Annotations

@Override

interpolate	back to summary
private static double interpolate(double fromAngle, double toAngle, double ratio) Interpolates angle according to rate, with correct 0->360 and 360->0 transitions

nodeProperty	back to summary
public final ObjectProperty<Node> nodeProperty()

normalize	back to summary
private static double normalize(double angle) Converts angle to range 0-360

orientationProperty	back to summary
public final ObjectProperty<PathTransition.OrientationType> orientationProperty()

pathProperty	back to summary
public final ObjectProperty<Shape> pathProperty()

recomputeSegments	back to summary
private void recomputeSegments()

setDuration	back to summary
public final void setDuration(Duration value)

setNode	back to summary
public final void setNode(Node value)

setOrientation	back to summary
public final void setOrientation(PathTransition.OrientationType value)

setPath	back to summary
public final void setPath(Shape value)

startable	back to summary
pack-priv boolean startable(boolean forceSync) Overrides javafx.animation.Transition.startable. Annotations @Override

startable

back to summary

pack-priv boolean startable(boolean forceSync)

Overrides javafx.animation.Transition.startable.

Annotations

@Override

sync	back to summary
pack-priv void sync(boolean forceSync) Overrides javafx.animation.Transition.sync. Annotations @Override

sync

back to summary

pack-priv void sync(boolean forceSync)

Overrides javafx.animation.Transition.sync.

Annotations

@Override

javafx.animation back to summary

public final Enum PathTransition.OrientationType

Class Inheritance

extends Enum<PathTransition.OrientationType>

java.lang.Object
java.lang.Enum
javafx.animation.PathTransition.OrientationType

Specifies the upright orientation of node along the path.

Since: JavaFX 2.0

Field Summary

Modifier and Type	Field and Description
public static final PathTransition.OrientationType	NONE The targeted `node`'s rotation matrix stays unchanged along the geometric path.
public static final PathTransition.OrientationType	ORTHOGONAL_TO_TANGENT The targeted node's rotation matrix is set to keep `node` perpendicular to the path's tangent along the geometric path.

Constructor Summary

Access	Constructor and Description
private	OrientationType()

Method Summary

Modifier and Type	Method and Description
public static PathTransition.OrientationType	valueOf(String name)
public static PathTransition.OrientationType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NONE	back to summary
public static final PathTransition.OrientationType NONE The targeted `node`'s rotation matrix stays unchanged along the geometric path.

ORTHOGONAL_TO_TANGENT	back to summary
public static final PathTransition.OrientationType ORTHOGONAL_TO_TANGENT The targeted node's rotation matrix is set to keep `node` perpendicular to the path's tangent along the geometric path.

Constructor Detail

OrientationType	back to summary
private OrientationType()

Method Detail

valueOf	back to summary
public static PathTransition.OrientationType valueOf(String name)

values	back to summary
public static PathTransition.OrientationType[] values()

javafx.animation back to summary

private Class PathTransition.Segment

Class Inheritance

extends Object

java.lang.Object
javafx.animation.PathTransition.Segment

Field Summary

Modifier and Type	Field and Description
pack-priv double	accumLength
pack-priv boolean	isMoveTo
pack-priv double	length
pack-priv PathTransition.Segment	nextSeg
pack-priv PathTransition.Segment	prevSeg
pack-priv double	rotateAngle
pack-priv double	toX
pack-priv double	toY
private static final PathTransition.Segment	zeroSegment

Constructor Summary

Access	Constructor and Description
private	Segment(boolean isMoveTo, double toX, double toY, double length, double lengthBefore, double rotateAngle)

Method Summary

Modifier and Type	Method and Description
public void	convertToClosePath(PathTransition.Segment moveToSeg)
public static PathTransition.Segment	getZeroSegment()
public static PathTransition.Segment	newClosePath(PathTransition.Segment fromSeg, PathTransition.Segment moveToSeg)
public static PathTransition.Segment	newLineTo(PathTransition.Segment fromSeg, double toX, double toY)
public static PathTransition.Segment	newMoveTo(double toX, double toY, double accumLength)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

accumLength	back to summary
pack-priv double accumLength

isMoveTo	back to summary
pack-priv boolean isMoveTo

length	back to summary
pack-priv double length

nextSeg	back to summary
pack-priv PathTransition.Segment nextSeg

prevSeg	back to summary
pack-priv PathTransition.Segment prevSeg

rotateAngle	back to summary
pack-priv double rotateAngle

toX	back to summary
pack-priv double toX

toY	back to summary
pack-priv double toY

zeroSegment	back to summary
private static final PathTransition.Segment zeroSegment

Constructor Detail

Segment	back to summary
private Segment(boolean isMoveTo, double toX, double toY, double length, double lengthBefore, double rotateAngle)

Method Detail

convertToClosePath	back to summary
public void convertToClosePath(PathTransition.Segment moveToSeg)

getZeroSegment	back to summary
public static PathTransition.Segment getZeroSegment()

newClosePath	back to summary
public static PathTransition.Segment newClosePath(PathTransition.Segment fromSeg, PathTransition.Segment moveToSeg)

newLineTo	back to summary
public static PathTransition.Segment newLineTo(PathTransition.Segment fromSeg, double toX, double toY)

newMoveTo	back to summary
public static PathTransition.Segment newMoveTo(double toX, double toY, double accumLength)

public final Class PathTransition

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PathTransition.OrientationType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PathTransition.Segment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail