com.mygdx.game.engine.tweening.EngineTween Class Reference

Inheritance diagram for com.mygdx.game.engine.tweening.EngineTween:

Public Member Functions
	EngineTween (Tween tween)
boolean	isCleaned ()
EngineTween	setCallbackMethod (IEngineTweenMethod method)
EngineTween	ease (EaseType tweenType)
EngineTween	ease (TweenEquation tweenEquation)
EngineTween	delay (float delay)
int	getTweenType ()
Tween	getTween ()
void	clean ()
Public Member Functions inherited from com.mygdx.game.engine.events.EventDispatcher
void	addEventListener (String type, IEventReceiver listeningClass)
void	dispatchEvent (Event event)
void	removeEventListener (String type, IEventReceiver listener)
boolean	hasEventListener (String type)
ArrayList< ListenerItem >	getAllListeners ()
void	destroyAllListeners ()
void	clean ()

Static Public Attributes
static final String	ENGINE_TWEEN_EVENT = "EngineTweenEvent"

Protected Member Functions
void	sendTweenEvent (int type)

Detailed Description

This class contains information on the Tween which is triggered by the 'EngineTweener' including the tween itself. You can add an eventlistener to this class to listen to the set events which are triggered by the event. You can also add your own callback by calling the 'setCallbackMethod' method

Author

Ramses Di Perna

Constructor & Destructor Documentation

EngineTween()

com.mygdx.game.engine.tweening.EngineTween.EngineTween

(

Tween

tween

)

Sets the EngineTween and sets a callback listener to it so it can listen to the different events. WARNING: Do not add your own callback to the Tween. If you need one, you can listen to the ENGINE_TWEEN_EVENT or add a callback with the 'setCallbackMethod'

Parameters

tween

which this EngineTween represents

Member Function Documentation

clean()

void com.mygdx.game.engine.tweening.EngineTween.clean

(

)

Cleans the class and makes it ready for garbage collection.

delay()

EngineTween com.mygdx.game.engine.tweening.EngineTween.delay

(

float

delay

)

This tween will wait the amount of seconds given as value until it starts.

Parameters

delay

in seconds to wait before starting tween.

Returns

This EngineTween

ease() [1/2]

EngineTween com.mygdx.game.engine.tweening.EngineTween.ease

(

EaseType

tweenType

)

Sets an ease to the Tween with the given TweenType

Parameters

tweenType

represents the Ease type which will set the motion of the tween.

Returns

This EngineTween

ease() [2/2]

EngineTween com.mygdx.game.engine.tweening.EngineTween.ease

(

TweenEquation

tweenEquation

)

Sets an ease to the Tween with the given TweenEquation

Parameters

tweenEquation

represents the Ease type which will set the motion of the tween.

Returns

This EngineTween

getTween()

Tween com.mygdx.game.engine.tweening.EngineTween.getTween

(

)

Returns the Tween which this EngineTween is linked to in its constructor.

Returns

The tween linked in the constructor.

getTweenType()

int com.mygdx.game.engine.tweening.EngineTween.getTweenType

(

)

Returns the Tween Type of the Accessor. For Example the POSITION type of the 'TransformAccessor'

Returns

The type of the tween accessor linked to the tween

isCleaned()

boolean com.mygdx.game.engine.tweening.EngineTween.isCleaned

(

)

Returns whether the class has been cleaned or not.

Returns

true when it has been cleaned, else false

sendTweenEvent()

void com.mygdx.game.engine.tweening.EngineTween.sendTweenEvent ( int  type )

protected

Triggeres the tweening method and event listeners which where given / linked to this EngineTween.

Parameters

type	of event occurred. This list is given in the 'TweenCallback' class. Default 'COMPLETED' type

setCallbackMethod()

EngineTween com.mygdx.game.engine.tweening.EngineTween.setCallbackMethod

(

IEngineTweenMethod

method

)

Sets a method which will be triggered on the different callback events which are set in the tween itself.

Parameters

method

container to trigger when an event occures.

Returns

This EngineTween

Member Data Documentation

ENGINE_TWEEN_EVENT

final String com.mygdx.game.engine.tweening.EngineTween.ENGINE_TWEEN_EVENT = "EngineTweenEvent"

static

---

The documentation for this class was generated from the following file:

• C:/Users/RamsesPC/Documents/LibGDXGames/PvB/core/src/com/mygdx/game/engine/tweening/EngineTween.java