JavaFX 27 · javafx.animation.Transition · APIdia, the JavaDoc alternative

An abstract class that contains the basic functionalities required by all Transition based animations, such as PathTransition and RotateTransition.

This class offers a simple framework to define animation. It provides all the basic functionality defined in Animation. Transition requires the implementation of a method interpolate(double) which is the called in each frame, while the Transition is running.

In addition, an extending class needs to set the duration of a single cycle with Animation#setCycleDuration(javafx.util.Duration). This duration is usually set by the user via a duration property (as in duration) for example. But it can also be calculated by the extending class as is done in ParallelTransition and FadeTransition.

Below is a simple example. It creates a small animation that updates the text property of a javafx.scene.text.Text node. It starts with an empty String and adds gradually letter by letter until the full String was set when the animation finishes.

 final String content = "Lorem ipsum";
final Text text = new Text(10, 20, "");

final Animation animation = new Transition() {
    {
        setCycleDuration(Duration.millis(2000));
    }

    protected void interpolate(double frac) {
        final int length = content.length();
        final int n = Math.round(length * (float) frac);
        text.setText(content.substring(0, n));
    }

};

animation.play();

Field Summary

Modifier and Type	Field and Description
private Interpolator	cachedInterpolator
private static final Interpolator	DEFAULT_INTERPOLATOR
private ObjectProperty<Interpolator>	interpolator Controls the timing for acceleration and deceleration at each `Transition` cycle.

Inherited from javafx.animation.Animation:: clipEnvelope INDEFINITE parent pulseReceiver

Constructor Summary

Access	Constructor and Description
public	Transition(double The custom target frame rate for this `Transition` targetFramerate) The constructor of `Transition`.
public	Transition() The constructor of `Transition`.
pack-priv	Transition(AbstractPrimaryTimer timer)

Method Summary

Modifier and Type	Method and Description
private double	calculateFraction(long currentTicks, long cycleTicks)
pack-priv void	doJumpTo(long currentTicks, long cycleTicks, boolean forceJump) Implements abstract javafx.animation.Animation.doJumpTo.
pack-priv void	doPlayTo(long currentTicks, long cycleTicks) Implements abstract javafx.animation.Animation.doPlayTo.
protected Interpolator	Returns: the `Interpolator` that was set when this `Transition` was started getCachedInterpolator() Returns the `Interpolator`, that was set when the `Transition` was started.
public final Interpolator	getInterpolator()
protected Node	Returns: the target `Node` getParentTargetNode() Returns the first non-`null` target `Node` in the parent hierarchy of this `Transition`, or `null` if such a node is not found.
protected abstract void	interpolate(double The relative position frac) The method `interpolate()` has to be provided by implementations of `Transition`.
public final ObjectProperty<Interpolator>	interpolatorProperty()
public final void	setInterpolator(Interpolator value)
pack-priv boolean	startable(boolean forceSync) Overrides javafx.animation.Animation.startable.
pack-priv void	sync(boolean forceSync) Overrides javafx.animation.Animation.sync.

Field Detail

cachedInterpolator	back to summary
private Interpolator cachedInterpolator

DEFAULT_INTERPOLATOR	back to summary
private static final Interpolator DEFAULT_INTERPOLATOR

interpolator back to summary

interpolator	back to summary
private ObjectProperty<Interpolator> interpolator Controls the timing for acceleration and deceleration at each `Transition` cycle. This may only be changed prior to starting the transition or after the transition has ended. If the value of `interpolator` is changed for a running `Transition`, the animation has to be stopped and started again to pick up the new value. Default interpolator is set to `Interpolator#EASE_BOTH`. Default Value EASE_BOTH

private ObjectProperty<Interpolator> interpolator

Controls the timing for acceleration and deceleration at each Transition cycle.

This may only be changed prior to starting the transition or after the transition has ended. If the value of interpolator is changed for a running Transition, the animation has to be stopped and started again to pick up the new value.

Default interpolator is set to Interpolator#EASE_BOTH.

Default Value: EASE_BOTH

Constructor Detail

Transition back to summary

Transition	back to summary
public Transition(double targetFramerate) The constructor of `Transition`. This constructor allows to define a `target framerate`. Parameters targetFramerate:double The custom target frame rate for this `Transition`

public Transition(double targetFramerate)

The constructor of Transition. This constructor allows to define a target framerate.

Parameters

targetFramerate:double: The custom target frame rate for this Transition

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

Transition	back to summary
pack-priv Transition(AbstractPrimaryTimer timer)

Method Detail

calculateFraction	back to summary
private double calculateFraction(long currentTicks, long cycleTicks)

doJumpTo	back to summary
pack-priv void doJumpTo(long currentTicks, long cycleTicks, boolean forceJump) Implements abstract javafx.animation.Animation.doJumpTo. Annotations @Override

doJumpTo

back to summary

pack-priv void doJumpTo(long currentTicks, long cycleTicks, boolean forceJump)

Implements abstract javafx.animation.Animation.doJumpTo.

Annotations

@Override

doPlayTo	back to summary
pack-priv void doPlayTo(long currentTicks, long cycleTicks) Implements abstract javafx.animation.Animation.doPlayTo. Annotations @Override

doPlayTo

back to summary

pack-priv void doPlayTo(long currentTicks, long cycleTicks)

Implements abstract javafx.animation.Animation.doPlayTo.

Annotations

@Override

getCachedInterpolator back to summary

getCachedInterpolator	back to summary
protected Interpolator getCachedInterpolator() Returns the `Interpolator`, that was set when the `Transition` was started. Changing the `interpolator` of a running `Transition` should have no immediate effect. Instead the running `Transition` should continue to use the original `Interpolator` until it is stopped and started again. Returns:Interpolator the `Interpolator` that was set when this `Transition` was started

protected Interpolator getCachedInterpolator()

Returns the Interpolator, that was set when the Transition was started. Changing the interpolator of a running Transition should have no immediate effect. Instead the running Transition should continue to use the original Interpolator until it is stopped and started again.

Returns:Interpolator: the Interpolator that was set when this Transition was started

getInterpolator	back to summary
public final Interpolator getInterpolator()

getParentTargetNode back to summary

getParentTargetNode	back to summary
protected Node getParentTargetNode() Returns the first non-`null` target `Node` in the parent hierarchy of this `Transition`, or `null` if such a node is not found. A parent animation is one that can have child animations. Examples are `SequentialTransition` and `ParallelTransition`. A parent animation can also be a child of another parent animation. Note that if this `Transition` has a target node set and is not a parent animation, it will be ignored during the call as this method only queries parent animations. Returns:Node the target `Node`

protected Node getParentTargetNode()

Returns the first non-null target Node in the parent hierarchy of this Transition, or null if such a node is not found.

A parent animation is one that can have child animations. Examples are SequentialTransition and ParallelTransition. A parent animation can also be a child of another parent animation.

Note that if this Transition has a target node set and is not a parent animation, it will be ignored during the call as this method only queries parent animations.

Returns:Node: the target Node

interpolate back to summary

interpolate	back to summary
protected abstract 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. Parameters frac:double The relative position

protected abstract 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.

Parameters

frac:double: The relative position

interpolatorProperty	back to summary
public final ObjectProperty<Interpolator> interpolatorProperty()

setInterpolator	back to summary
public final void setInterpolator(Interpolator value)

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

startable

back to summary

pack-priv boolean startable(boolean forceSync)

Overrides javafx.animation.Animation.startable.

Annotations

@Override

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

sync

back to summary

pack-priv void sync(boolean forceSync)

Overrides javafx.animation.Animation.sync.

Annotations

@Override

public abstract Class Transition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail