com.github.gwtd3.api.ease

Class Easing

java.lang.Object

com.github.gwtd3.api.ease.Easing

public class Easing
extends Object

Creates an easing function.

The following easing types are supported:

• linear - the identity function, t.
• poly(k) - raises t to the specified power k (e.g., 3).
• quad - equivalent to poly(2).
• cubic - equivalent to poly(3).
• sin - applies the trigonometric function sin.
• exp - raises 2 to a power based on t.
• circle - the quarter circle.
• elastic(a, p) - simulates an elastic band; may extend slightly beyond 0 and 1.
• back(s) - simulates backing into a parking space.
• bounce - simulates a bouncy collision.

These built-in types may be extended using a variety of Mode.

The default easing function is "cubic-in-out" which provides suitable slow-in slow-out animation.

Author:

Anthony Schiochet

Constructor Summary

Constructors

Constructor and Description
Easing()

Method Summary

Methods

Modifier and Type	Method and Description
static EasingFunction	back(double s) Simulates backing into a parking space.
static EasingFunction	back(Mode mode, double s) Simulates backing into a parking space.
static EasingFunction	bounce() Simulates a bouncy collision.
static EasingFunction	bounce(Mode mode) Simulates a bouncy collision.
static EasingFunction	circle() The quarter circle.
static EasingFunction	circle(Mode mode) The quarter circle
static EasingFunction	cubic() Equivalent to poly(3).
static EasingFunction	cubic(Mode mode) Equivalent to poly(3).
static EasingFunction	elastic(double a, double p) Simulates an elastic band; may extend slightly beyond 0 and 1.
static EasingFunction	elastic(Mode mode, double a, double p) Simulates an elastic band; may extend slightly beyond 0 and 1.
static EasingFunction	exp() Raises 2 to a power based on t.
static EasingFunction	exp(Mode mode) Raises 2 to a power based on t.
static EasingFunction	linear() The identity function
static EasingFunction	linear(Mode mode) The identity function
static EasingFunction	poly(int k) Raises t to the specified power k (e.g., 3).
static EasingFunction	poly(Mode mode, int k) Raises t to the specified power k (e.g., 3).
static EasingFunction	quad() Equivalent to poly(2).
static EasingFunction	quad(Mode mode) Equivalent to poly(2).
static EasingFunction	sin() Applies the trigonometric function sin.
static EasingFunction	sin(Mode mode) Applies the trigonometric function sin.

Methods inherited from class java.lang.Object

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

Constructor Detail

Easing

public Easing()

Method Detail

linear

public static final EasingFunction linear()

The identity function

Returns:

the function

linear

public static final EasingFunction linear(Mode mode)

The identity function

Parameters:

mode - the mode

Returns:

the function

poly

public static final EasingFunction poly(int k)

Raises t to the specified power k (e.g., 3).

Parameters:

k - the power for raising t

Returns:

the function

poly

public static final EasingFunction poly(Mode mode,
                  int k)

Raises t to the specified power k (e.g., 3).

Parameters:

mode - the mode

k - the power

Returns:

the function

quad

public static final EasingFunction quad()

Equivalent to poly(2).

Returns:

the function

quad

public static final EasingFunction quad(Mode mode)

Equivalent to poly(2).

Parameters:

mode - the mode

Returns:

the function

cubic

public static final EasingFunction cubic()

Equivalent to poly(3).

Returns:

the function

cubic

public static final EasingFunction cubic(Mode mode)

Equivalent to poly(3).

Parameters:

mode - the mode

Returns:

the function

sin

public static final EasingFunction sin()

Applies the trigonometric function sin.

Returns:

the function

sin

public static final EasingFunction sin(Mode mode)

Applies the trigonometric function sin.

Parameters:

mode - the mode

Returns:

the function

exp

public static final EasingFunction exp()

Raises 2 to a power based on t.

Returns:

the function

exp

public static final EasingFunction exp(Mode mode)

Raises 2 to a power based on t.

Parameters:

mode - the mode

Returns:

the function

circle

public static final EasingFunction circle()

The quarter circle.

Returns:

the function

circle

public static final EasingFunction circle(Mode mode)

The quarter circle

Parameters:

mode - the mode

Returns:

the function

elastic

public static final EasingFunction elastic(double a,
                     double p)

Simulates an elastic band; may extend slightly beyond 0 and 1.

Parameters:

a - the amplitude

p - the period

Returns:

the function

elastic

public static final EasingFunction elastic(Mode mode,
                     double a,
                     double p)

Simulates an elastic band; may extend slightly beyond 0 and 1.

Parameters:

mode - the mode

a - the amplitude

p - the period

Returns:

the function

back

public static final EasingFunction back(double s)

Simulates backing into a parking space.

Parameters:

s - the overshoot

Returns:

the function

back

public static final EasingFunction back(Mode mode,
                  double s)

Simulates backing into a parking space.

Parameters:

mode - the mode

s - the overshoot

Returns:

the function

bounce

public static final EasingFunction bounce()

Simulates a bouncy collision.

Returns:

the function

bounce

public static final EasingFunction bounce(Mode mode)

Simulates a bouncy collision.

Parameters:

mode - the mode

Returns:

the function