Module MaterialFX

Package io.github.palexdev.materialfx.effects

Class ConsumerTransition

java.lang.Object

javafx.animation.Animation

javafx.animation.Transition

io.github.palexdev.materialfx.effects.ConsumerTransition

public class ConsumerTransition
extends Transition

A simple implementation of Transition that allows to specify what to do when the interpolate(double) method is called by using a Consumer.

Property Summary

Properties inherited from class javafx.animation.Transition

interpolator

Properties inherited from class javafx.animation.Animation

autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration

Nested Class Summary

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

Method Summary

Modifier and Type	Method	Description
protected void	interpolate(double frac)
static ConsumerTransition	of(Consumer<Double> interpolateConsumer)	Creates a new ConsumerTransition with the given consumer.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, double duration)	Creates a new ConsumerTransition with the given consumer and duration in milliseconds.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, double duration, Interpolators interpolator)	Creates a new ConsumerTransition with the given consumer, duration in milliseconds and interpolator.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, double duration, Interpolator interpolator)	Creates a new ConsumerTransition with the given consumer, duration in milliseconds and interpolator.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, Duration duration)	Creates a new ConsumerTransition with the given consumer and duration.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, Duration duration, Interpolators interpolator)	Creates a new ConsumerTransition with the given consumer, duration and interpolator.
static ConsumerTransition	of(Consumer<Double> interpolateConsumer, Duration duration, Interpolator interpolator)	Creates a new ConsumerTransition with the given consumer, duration and interpolator.
void	playWithConsumer(Consumer<Double> interpolateConsumer)	Calls setInterpolateConsumer(Consumer) and then starts the animation.
ConsumerTransition	setDelayFluent(Duration duration)	Sets the transition's delay.
ConsumerTransition	setDuration(double millis)	Sets the transition duration in milliseconds.
ConsumerTransition	setDuration(Duration duration)	Sets the transition duration.
ConsumerTransition	setInterpolateConsumer(Consumer<Double> interpolateConsumer)	Sets the consumer used by the interpolate(double) method.
ConsumerTransition	setInterpolatorFluent(Interpolators interpolator)
ConsumerTransition	setInterpolatorFluent(Interpolator interpolator)	Sets the transition's interpolator.
ConsumerTransition	setOnFinishedFluent(EventHandler<ActionEvent> handler)

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 Details

ConsumerTransition

public ConsumerTransition()

Method Details

setDuration

public ConsumerTransition setDuration(Duration duration)

Sets the transition duration.

setDuration

public ConsumerTransition setDuration(double millis)

Sets the transition duration in milliseconds.

setInterpolateConsumer

public ConsumerTransition setInterpolateConsumer(Consumer<Double> interpolateConsumer)

Sets the consumer used by the interpolate(double) method.

setInterpolatorFluent

public ConsumerTransition setInterpolatorFluent(Interpolator interpolator)

Sets the transition's interpolator.

setInterpolatorFluent

public ConsumerTransition setInterpolatorFluent(Interpolators interpolator)

setDelayFluent

public ConsumerTransition setDelayFluent(Duration duration)

Sets the transition's delay.

setOnFinishedFluent

public ConsumerTransition setOnFinishedFluent(EventHandler<ActionEvent> handler)

playWithConsumer

public void playWithConsumer(Consumer<Double> interpolateConsumer)

Calls setInterpolateConsumer(Consumer) and then starts the animation.

interpolate

protected void interpolate(double frac)

Implementation to make use of a Consumer.

Specified by:

interpolate in class Transition

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer)

Creates a new ConsumerTransition with the given consumer.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 Duration duration)

Creates a new ConsumerTransition with the given consumer and duration.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 double duration)

Creates a new ConsumerTransition with the given consumer and duration in milliseconds.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 Duration duration,
 Interpolator interpolator)

Creates a new ConsumerTransition with the given consumer, duration and interpolator.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 double duration,
 Interpolator interpolator)

Creates a new ConsumerTransition with the given consumer, duration in milliseconds and interpolator.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 Duration duration,
 Interpolators interpolator)

Creates a new ConsumerTransition with the given consumer, duration and interpolator.

of

public static ConsumerTransition of(Consumer<Double> interpolateConsumer,
 double duration,
 Interpolators interpolator)

Creates a new ConsumerTransition with the given consumer, duration in milliseconds and interpolator.