wallettemplate.utils.easing

Class ElasticInterpolator

java.lang.Object

javafx.animation.Interpolator

wallettemplate.utils.easing.EasingInterpolator

wallettemplate.utils.easing.ElasticInterpolator

public class ElasticInterpolator
extends EasingInterpolator

This interpolator simulates an elastic behavior.

The following curve illustrates the interpolation.

The math in this class is taken from http://www.robertpenner.com/easing/.

Author:

Christian Schudt

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	amplitude The amplitude.
javafx.beans.property.DoubleProperty	oscillations The oscillations property.

Properties inherited from class wallettemplate.utils.easing.EasingInterpolator

easingModeProperty

Field Summary

Fields inherited from class javafx.animation.Interpolator

DISCRETE, EASE_BOTH, EASE_IN, EASE_OUT, LINEAR

Constructor Summary

Constructors

Constructor and Description
ElasticInterpolator() Default constructor.
ElasticInterpolator(EasingMode easingMode) Constructs the interpolator with a specific easing mode.
ElasticInterpolator(EasingMode easingMode, double amplitude, double oscillations) Sets the easing mode.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.DoubleProperty	amplitudeProperty() The amplitude.
protected double	baseCurve(double v) Defines the base curve for the interpolator.
double	getAmplitude() Gets the amplitude.
double	getOscillations() Gets the number of oscillations.
javafx.beans.property.DoubleProperty	oscillationsProperty() The oscillations property.
void	setAmplitude(double amplitude) Sets the amplitude.
void	setOscillations(double oscillations) Sets the number of oscillations.

Methods inherited from class wallettemplate.utils.easing.EasingInterpolator

curve, easingModeProperty, getEasingMode, setEasingMode

Methods inherited from class javafx.animation.Interpolator

interpolate, interpolate, interpolate, interpolate, interpolate, SPLINE, TANGENT, TANGENT

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

oscillations

public javafx.beans.property.DoubleProperty oscillationsProperty

The oscillations property. Defines number of oscillations.

Returns:

The property.

See Also:

getOscillations(), setOscillations(double)

amplitude

public javafx.beans.property.DoubleProperty amplitudeProperty

The amplitude. The minimum value is 1. If this value is < 1 it will be set to 1 during animation.

Returns:

The property.

See Also:

getAmplitude(), setAmplitude(double)

Constructor Detail

ElasticInterpolator

public ElasticInterpolator()

Default constructor. Initializes the interpolator with ease out mode.

ElasticInterpolator

public ElasticInterpolator(EasingMode easingMode)

Constructs the interpolator with a specific easing mode.

Parameters:

easingMode - The easing mode.

ElasticInterpolator

public ElasticInterpolator(EasingMode easingMode,
                           double amplitude,
                           double oscillations)

Sets the easing mode.

Parameters:

easingMode - The easing mode.

See Also:

EasingInterpolator.easingModeProperty()

Method Detail

oscillationsProperty

public javafx.beans.property.DoubleProperty oscillationsProperty()

The oscillations property. Defines number of oscillations.

Returns:

The property.

See Also:

getOscillations(), setOscillations(double)

amplitudeProperty

public javafx.beans.property.DoubleProperty amplitudeProperty()

The amplitude. The minimum value is 1. If this value is < 1 it will be set to 1 during animation.

Returns:

The property.

See Also:

getAmplitude(), setAmplitude(double)

getAmplitude

public double getAmplitude()

Gets the amplitude.

Returns:

The amplitude.

See Also:

amplitudeProperty()

setAmplitude

public void setAmplitude(double amplitude)

Sets the amplitude.

Parameters:

amplitude - The amplitude.

See Also:

amplitudeProperty()

getOscillations

public double getOscillations()

Gets the number of oscillations.

Returns:

The oscillations.

See Also:

oscillationsProperty()

setOscillations

public void setOscillations(double oscillations)

Sets the number of oscillations.

Parameters:

oscillations - The oscillations.

See Also:

oscillationsProperty()

baseCurve

protected double baseCurve(double v)

Description copied from class: EasingInterpolator

Defines the base curve for the interpolator. The base curve is then transformed into an easing-in, easing-out easing-both curve.

Specified by:

baseCurve in class EasingInterpolator

Parameters:

v - The normalized value/time/progress of the interpolation (between 0 and 1).

Returns:

The resulting value of the function, should return a value between 0 and 1.

See Also:

Interpolator.curve(double)