io.github.palexdev.mfxeffects.animations.AnimationFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation
Material Design/Modern components for JavaFX, now packed as a single Jar
There is a newer version: 11.26.0
/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * 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.mfxeffects.animations;

import io.github.palexdev.mfxeffects.animations.Animations.KeyFrames;
import io.github.palexdev.mfxeffects.animations.Animations.TimelineBuilder;
import javafx.animation.Interpolator;
import javafx.animation.Timeline;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.util.Duration;

/**
 * Convenience factory for various animations applied to {@code Nodes}.
 *
 * @see #extraOffset
 * @see Timeline
 */
public enum AnimationFactory {
	FADE_IN {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.opacityProperty(), 0.0))
				.add(KeyFrames.of(millis, node.opacityProperty(), 1.0, i))
				.getAnimation();
		}
	},
	FADE_OUT {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.opacityProperty(), 1.0))
				.add(KeyFrames.of(millis, node.opacityProperty(), 0.0, i))
				.getAnimation();
		}
	},
	SLIDE_IN_BOTTOM {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceBottom(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateYProperty(), distance))
				.add(KeyFrames.of(millis, node.translateYProperty(), 0, i))
				.getAnimation();
		}
	},
	SLIDE_OUT_BOTTOM {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceBottom(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateYProperty(), 0))
				.add(KeyFrames.of(millis, node.translateYProperty(), distance, i))
				.getAnimation();
		}
	},
	SLIDE_IN_LEFT {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceLeft(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateXProperty(), -distance))
				.add(KeyFrames.of(millis, node.translateXProperty(), 0, i))
				.getAnimation();
		}
	},
	SLIDE_OUT_LEFT {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceLeft(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateXProperty(), 0))
				.add(KeyFrames.of(millis, node.translateXProperty(), -distance, i))
				.getAnimation();
		}
	},
	SLIDE_IN_RIGHT {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceRight(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateXProperty(), distance))
				.add(KeyFrames.of(millis, node.translateXProperty(), 0, i))
				.getAnimation();
		}
	},
	SLIDE_OUT_RIGHT {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceRight(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateXProperty(), 0))
				.add(KeyFrames.of(millis, node.translateXProperty(), distance, i))
				.getAnimation();
		}
	},
	SLIDE_IN_TOP {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceTop(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateYProperty(), distance))
				.add(KeyFrames.of(millis, node.translateYProperty(), 0, i))
				.getAnimation();
		}
	},
	SLIDE_OUT_TOP {
		@Override
		public Timeline build(Node node, double millis, Interpolator i) {
			double distance = computeDistanceTop(node);
			return TimelineBuilder.build()
				.add(KeyFrames.of(0, node.translateYProperty(), 0))
				.add(KeyFrames.of(millis, node.translateYProperty(), distance, i))
				.getAnimation();
		}
	};

	public static final Interpolator INTERPOLATOR_V1 = Interpolator.SPLINE(0.25, 0.1, 0.25, 1);
	public static final Interpolator INTERPOLATOR_V2 = Interpolator.SPLINE(0.0825D, 0.3025D, 0.0875D, 0.9975D);

	/**
	 * This special variable is used in slide animations when the "travel distance" is computed.
	 * This extra offset is added to the computed value to ensure the node is outside the parent, for a smooth animation.
	 */
	@SuppressWarnings("NonFinalFieldInEnum")
	public static double extraOffset = 5.0;

	/**
	 * Computes the distance between the node and the left side of its parent by using its
	 * {@link Node#boundsInParentProperty()}. This distance ensures the node is going to be outside/inside the parent
	 * towards the animation's ending.
	 *
	 * @see #extraOffset
	 */
	public double computeDistanceLeft(Node node) {
		double w = node.getBoundsInParent().getWidth();
		return node.getBoundsInParent().getMinX() + w + extraOffset;
	}

	/**
	 * Computes the distance between the node and the right side of its parent. For this computation the
	 * {@link Node#parentProperty()} must not return a {@code null} value (the node must be child of some other node).
	 * 
	 * If the parent is {@code null} a 'fallback' value is returned, that is the width of the node plus the extra offset.
	 * 

	 * Otherwise, the value is computed like this:
	 * {@code parent.getLayoutBounds().getWidth() - node.getBoundsInParent().getMaxX() + node.getBoundsInParent().getWidth() + extraOffset}
	 *
	 * @see #extraOffset
	 */
	public double computeDistanceRight(Node node) {
		double w = node.getBoundsInParent().getWidth();
		Parent parent = node.getParent();
		if (parent == null) return w + extraOffset;
		return parent.getLayoutBounds().getWidth() - node.getBoundsInParent().getMaxX() + w + extraOffset;
	}

	/**
	 * Computes the distance between the node and the top side of its parent by using its
	 * {@link Node#boundsInParentProperty()}. This distance ensures the node is going to be outside/inside the parent
	 * towards the animation's ending.
	 *
	 * @see #extraOffset
	 */
	public double computeDistanceTop(Node node) {
		double h = node.getBoundsInParent().getHeight();
		return node.getBoundsInParent().getMinY() + h + extraOffset;
	}

	/**
	 * Computes the distance between the node and the bottom side of its parent. For this computation the
	 * {@link Node#parentProperty()} must not return a {@code null} value (the node must be child of some other node).
	 * 

	 * If the parent is {@code null} a 'fallback' value is returned, that is the height of the node plus the extra offset.
	 * 
	 * Otherwise, the value is computed like this:
	 * {@code parent.getLayoutBounds().getHeight() - node.getBoundsInParent().getMaxY() + node.getBoundsInParent().getHeight() + extraOffset}
	 *
	 * @see #extraOffset
	 */
	public double computeDistanceBottom(Node node) {
		double h = node.getBoundsInParent().getHeight();
		Parent parent = node.getParent();
		if (parent == null) return h + extraOffset;
		return parent.getLayoutBounds().getHeight() - node.getBoundsInParent().getMaxY() + h + extraOffset;
	}

	/**
	 * Calls {@link #build(Node, double, Interpolator)} with {@link #INTERPOLATOR_V1} as the default interpolator.
	 */
	public Timeline build(Node node, double millis) {
		return build(node, millis, INTERPOLATOR_V1);
	}

	/**
	 * Calls {@link #build(Node, double)} with the given duration converted to milliseconds.
	 */
	public Timeline build(Node node, Duration duration) {
		return build(node, duration.toMillis());
	}

	/**
	 * Calls {@link #build(Node, double, Interpolator)} with the given duration converted to milliseconds and the given
	 * interpolator.
	 */
	public Timeline build(Node node, Duration duration, Interpolator i) {
		return build(node, duration.toMillis(), i);
	}

	/**
	 * Each enum constant will produce a {@link Timeline} with the given parameters.
	 *
	 * @param node   the {@link Node} on which perform the animation
	 * @param millis the duration of the animation in milliseconds
	 * @param i      the {@link Interpolator} used by the animations
	 */
	public abstract Timeline build(Node node, double millis, Interpolator i);
}