de.verygame.surface.util.modifier

Class SingleValueModifier

java.lang.Object

de.verygame.surface.util.modifier.base.AbstractModifier

de.verygame.surface.util.modifier.SingleValueModifier

All Implemented Interfaces:

Modifier

public class SingleValueModifier
extends AbstractModifier

Implements an Modifier.

It should be used when you want to modify exactly one value (stepwise).

Field Summary

Fields

Modifier and Type	Field and Description
protected EaseFunction	easeFunction EaseFunction
protected float	fromValue Starting value
protected float	toValue Ending value which always will be the last value the modifier will set

Fields inherited from class de.verygame.surface.util.modifier.base.AbstractModifier

currentDuration, duration, finished, finishListenerList, target

Constructor Summary

Constructors

Constructor and Description
SingleValueModifier(float duration, float fromValue, float toValue, EaseFunction easeFunction, ModifierCallback target) Constructs SingleValueEntityModifier.
SingleValueModifier(float duration, float fromValue, float toValue, ModifierCallback target) Constructs SingleValueEntityModifier using LinearEaseFunction.

Method Summary

Modifier and Type	Method and Description
void	onFinish() Describes what happens on finish (last tick)
void	onInit() Describes what happens on initialization (before first tick).
void	tick() Describes what happens when an update occurs

Methods inherited from class de.verygame.surface.util.modifier.base.AbstractModifier

addFinishListener, hasFinished, kill, reset, update

Methods inherited from class java.lang.Object

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

Field Detail

fromValue

protected final float fromValue

Starting value

toValue

protected final float toValue

Ending value which always will be the last value the modifier will set

easeFunction

protected final EaseFunction easeFunction

EaseFunction

Constructor Detail

SingleValueModifier

public SingleValueModifier(float duration,
                           float fromValue,
                           float toValue,
                           ModifierCallback target)

Constructs SingleValueEntityModifier using LinearEaseFunction.

Parameters:

target - target

duration - estimated duration

fromValue - starting value

toValue - ending value

SingleValueModifier

public SingleValueModifier(float duration,
                           float fromValue,
                           float toValue,
                           EaseFunction easeFunction,
                           ModifierCallback target)

Constructs SingleValueEntityModifier.

Parameters:

target - target

duration - estimated duration

fromValue - starting value

toValue - ending value

easeFunction - EaseFunction

Method Detail

tick

public void tick()

Description copied from interface: Modifier

Describes what happens when an update occurs

onFinish

public void onFinish()

Description copied from interface: Modifier

Describes what happens on finish (last tick)

Specified by:

onFinish in interface Modifier

Overrides:

onFinish in class AbstractModifier

onInit

public void onInit()

Description copied from interface: Modifier

Describes what happens on initialization (before first tick).