io.github.palexdev.materialfx.effects.ConsumerTransition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of materialfx Show documentation
Material Desgin components for JavaFX
The newest version!
/*
 * Copyright (C) 2022 Parisi Alessandro
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX).
 *
 * MaterialFX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX.  If not, see .
 */

package io.github.palexdev.materialfx.effects;

import javafx.animation.Interpolator;
import javafx.animation.Transition;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.util.Duration;

import java.util.function.Consumer;

/**
 * A simple implementation of {@link Transition} that allows to specify
 * what to do when the {@link #interpolate(double)} method is called by using
 * a {@link Consumer}.
 */
public class ConsumerTransition extends Transition {
	//================================================================================
	// Properties
	//================================================================================
	private Consumer interpolateConsumer;

	//================================================================================
	// Methods
	//================================================================================

	/**
	 * Sets the transition duration.
	 */
	public ConsumerTransition setDuration(Duration duration) {
		this.setCycleDuration(duration);
		return this;
	}

	/**
	 * Sets the transition duration in milliseconds.
	 */
	public ConsumerTransition setDuration(double millis) {
		this.setCycleDuration(Duration.millis(millis));
		return this;
	}

	/**
	 * Sets the consumer used by the {@link #interpolate(double)} method.
	 */
	public ConsumerTransition setInterpolateConsumer(Consumer interpolateConsumer) {
		this.interpolateConsumer = interpolateConsumer;
		return this;
	}

	/**
	 * Sets the transition's interpolator.
	 */
	public ConsumerTransition setInterpolatorFluent(Interpolator interpolator) {
		this.setInterpolator(interpolator);
		return this;
	}

	public ConsumerTransition setInterpolatorFluent(Interpolators interpolator) {
		return setInterpolatorFluent(interpolator.toInterpolator());
	}

	/**
	 * Sets the transition's delay.
	 */
	public ConsumerTransition setDelayFluent(Duration duration) {
		this.setDelay(duration);
		return this;
	}

	public ConsumerTransition setOnFinishedFluent(EventHandler handler) {
		setOnFinished(handler);
		return this;
	}

	/**
	 * Calls {@link #setInterpolateConsumer(Consumer)} and then starts the animation.
	 */
	public void playWithConsumer(Consumer interpolateConsumer) {
		setInterpolateConsumer(interpolateConsumer);
		this.play();
	}

	//================================================================================
	// Overridden Methods
	//================================================================================

	/**
	 * {@inheritDoc}
	 * 
	 * Implementation to make use of a {@link Consumer}.
	 */
	@Override
	protected void interpolate(double frac) {
		this.interpolateConsumer.accept(frac);
	}

	//================================================================================
	// Static Methods
	//================================================================================

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer);
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer and duration.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, Duration duration) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration);
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer and duration in milliseconds.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, double duration) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration);
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer, duration and interpolator.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, Duration duration, Interpolator interpolator) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration).setInterpolatorFluent(interpolator);
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer, duration in milliseconds and interpolator.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, double duration, Interpolator interpolator) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration).setInterpolatorFluent(interpolator);
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer, duration and interpolator.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, Duration duration, Interpolators interpolator) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration).setInterpolatorFluent(interpolator.toInterpolator());
	}

	/**
	 * Creates a new {@code ConsumerTransition} with the given consumer, duration in milliseconds and interpolator.
	 */
	public static ConsumerTransition of(Consumer interpolateConsumer, double duration, Interpolators interpolator) {
		return (new ConsumerTransition()).setInterpolateConsumer(interpolateConsumer).setDuration(duration).setInterpolatorFluent(interpolator.toInterpolator());
	}
}