Dragengine.Scenery.ECComposeAnimator.Playback Class Reference

Playback support for elements. More...

Inheritance diagram for Dragengine.Scenery.ECComposeAnimator.Playback:

Public Member Functions
void	apply ()
	Apply animation.
AnimatorController	getController ()
	Playback controller or null if not available.
AnimatorInstance	getInstance ()
	Animator instance or null if not available.
bool	getLooping ()
	Is looping.
bool	getPlaying ()
	Is playing back.
float	getPlaySpeed ()
	Playback speed.
float	getTime ()
	Playback time.
float	getTimeRelative ()
	Relative playback time in the range from 0 to 1.
bool	isAtBegin ()
	Playback is at beginning.
bool	isAtEnd ()
	Playback is at end.
Playback	new (AnimatorInstance instance, String playbackController)
	Create playback.
void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read element from file.
void	rewind ()
	Rewind.
void	setControllerIndex (int index)
	Set playback controller from index if valid.
void	setControllerNamed (String name)
	Set playback controller by name if valid.
void	setLooping (bool looping)
	Set if looping.
void	setPlaying (bool playing)
	Set if playing back.
void	setPlaySpeed (float playSpeed)
	Set playback speed.
void	setTime (float time)
	Set playback time.
void	setTimeRelative (float time)
	Set relative playback time in the range from 0 to 1.
void	update (float elapsed)
	Update animator.
void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write element to file.

Public Attributes
AnimatorController	pController
AnimatorInstance	pInstance
bool	pPlaying
float	pPlaySpeed

Detailed Description

Playback support for elements.

Member Function Documentation

apply()

void Dragengine.Scenery.ECComposeAnimator.Playback.apply

(

)

Apply animation.

getController()

AnimatorController Dragengine.Scenery.ECComposeAnimator.Playback.getController

(

)

Playback controller or null if not available.

getInstance()

AnimatorInstance Dragengine.Scenery.ECComposeAnimator.Playback.getInstance

(

)

Animator instance or null if not available.

getLooping()

bool Dragengine.Scenery.ECComposeAnimator.Playback.getLooping

(

)

Is looping.

getPlaying()

bool Dragengine.Scenery.ECComposeAnimator.Playback.getPlaying

(

)

Is playing back.

getPlaySpeed()

float Dragengine.Scenery.ECComposeAnimator.Playback.getPlaySpeed

(

)

Playback speed.

getTime()

float Dragengine.Scenery.ECComposeAnimator.Playback.getTime

(

)

Playback time.

getTimeRelative()

float Dragengine.Scenery.ECComposeAnimator.Playback.getTimeRelative

(

)

Relative playback time in the range from 0 to 1.

Version

1.26

isAtBegin()

bool Dragengine.Scenery.ECComposeAnimator.Playback.isAtBegin

(

)

Playback is at beginning.

isAtEnd()

bool Dragengine.Scenery.ECComposeAnimator.Playback.isAtEnd

(

)

Playback is at end.

new()

Playback Dragengine.Scenery.ECComposeAnimator.Playback.new	(	AnimatorInstance	instance,
		String	playbackController
	)

Create playback.

readFromFile()

void Dragengine.Scenery.ECComposeAnimator.Playback.readFromFile	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Read element from file.

rewind()

void Dragengine.Scenery.ECComposeAnimator.Playback.rewind

(

)

Rewind.

setControllerIndex()

void Dragengine.Scenery.ECComposeAnimator.Playback.setControllerIndex

(

int

index

)

Set playback controller from index if valid.

setControllerNamed()

void Dragengine.Scenery.ECComposeAnimator.Playback.setControllerNamed

(

String

name

)

Set playback controller by name if valid.

setLooping()

void Dragengine.Scenery.ECComposeAnimator.Playback.setLooping

(

bool

looping

)

Set if looping.

setPlaying()

void Dragengine.Scenery.ECComposeAnimator.Playback.setPlaying

(

bool

playing

)

Set if playing back.

setPlaySpeed()

void Dragengine.Scenery.ECComposeAnimator.Playback.setPlaySpeed

(

float

playSpeed

)

Set playback speed.

setTime()

void Dragengine.Scenery.ECComposeAnimator.Playback.setTime

(

float

time

)

Set playback time.

setTimeRelative()

void Dragengine.Scenery.ECComposeAnimator.Playback.setTimeRelative

(

float

time

)

Set relative playback time in the range from 0 to 1.

Version

1.26

update()

void Dragengine.Scenery.ECComposeAnimator.Playback.update

(

float

elapsed

)

Update animator.

Advances the controller by the elapsed time multiplied by the play speeed and calls AnimatorInstance.apply().

writeToFile()

void Dragengine.Scenery.ECComposeAnimator.Playback.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write element to file.

Member Data Documentation

pController

AnimatorController Dragengine.Scenery.ECComposeAnimator.Playback.pController

pInstance

AnimatorInstance Dragengine.Scenery.ECComposeAnimator.Playback.pInstance

pPlaying

bool Dragengine.Scenery.ECComposeAnimator.Playback.pPlaying

pPlaySpeed

float Dragengine.Scenery.ECComposeAnimator.Playback.pPlaySpeed

---

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

• ECComposeAnimator.ds