io.github.palexdev.mfxeffects.animations.motion.ElasticOutCurve Maven / Gradle / Ivy

Go to download

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

/*
 * Copyright (C) 2023 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.motion;

import io.github.palexdev.mfxeffects.animations.base.Curve;

/**
 * An oscillating curve that shrinks in {@code magnitude} while overshooting its bounds.
 * 
 * Elastic Out Example
 * 
 * The above example is built with a {@code magnitude} of {@code 0.4}.
 */
public class ElasticOutCurve extends Curve {
	private final double period;

	public ElasticOutCurve() {
		this(0.4);
	}

	public ElasticOutCurve(double period) {
		this.period = period;
	}

	@Override
	public double curve(double t) {
		final double s = period / 4.0;
		return Math.pow(2.0, -10 * t) * Math.sin((t - s) * (Math.PI * 2.0) / period) + 1.0;
	}
}