Bandidos
Classes | Static Public Member Functions | Static Public Attributes | List of all members
com.mygdx.game.engine.tweening.EngineTweener Class Reference

Static Public Member Functions

static EngineTween startTween (Tween tween, int channel)
 
static Timeline startTimeline (Timeline timeLine, int channel)
 
static TweenManager getTweenManager (int channel)
 
static void updateTweenEngine (float unScaledDeltaTime, float timeScale)
 

Static Public Attributes

static final int GAME_TIME_CHANNEL = 0
 
static final int REAL_TIME_CHANNEL = 1
 

Detailed Description

This class keeps track of all the different kinds of TweenManager classes which are needed in the project. It generates the TweenManager channels which are not active. It also creates EngineTween instances for tweens and puts them on the given channel. Note: The TweenManagers must be manually updated!

Author
Ramses Di Perna

Member Function Documentation

◆ getTweenManager()

static TweenManager com.mygdx.game.engine.tweening.EngineTweener.getTweenManager ( int  channel)
static

Gets a TweenManager which represetns the given channel. If there is no TweenManager which represents the channel, then the TweenManger is automatically created.

Parameters
channelto get a TweenManager for
Returns
TweenManager which represetns the given channel

◆ startTimeline()

static Timeline com.mygdx.game.engine.tweening.EngineTweener.startTimeline ( Timeline  timeLine,
int  channel 
)
static

Starts a Timeline on the given channel and returns it.

Parameters
timelineto start through the Engine.
channelto start the timeline on
Returns
The timeline instance given to the method.

◆ startTween()

static EngineTween com.mygdx.game.engine.tweening.EngineTweener.startTween ( Tween  tween,
int  channel 
)
static

Starts a Tween on the given channel and returns an EngineTween which represents the started tween.

Parameters
tweento start through the Engine and to create an EngineTween for
channelto start the tween on
Returns
The EngineTween instance which represents the Tween started.

◆ updateTweenEngine()

static void com.mygdx.game.engine.tweening.EngineTweener.updateTweenEngine ( float  unScaledDeltaTime,
float  timeScale 
)
static

Updates the tween engine including all the tween channels. NOTE: This must be called every frame in order for the EngineTweener to work!

Parameters
unScaledDeltaTimeis the value of the delta time without any time scale affecting it.
timeScaleis the time scale which should be affecting the Delta Time

Member Data Documentation

◆ GAME_TIME_CHANNEL

final int com.mygdx.game.engine.tweening.EngineTweener.GAME_TIME_CHANNEL = 0
static

◆ REAL_TIME_CHANNEL

final int com.mygdx.game.engine.tweening.EngineTweener.REAL_TIME_CHANNEL = 1
static

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