Dragengine.SpeechAnimations.SpeechAnimationPlayback Class Reference

Inheritance diagram for Dragengine.SpeechAnimations.SpeechAnimationPlayback:

Classes
class	Phoneme

Public Member Functions
void	addPhoneme (SpeechAnimationPhoneme phoneme, float duration)
AnimatorInstance	getAnimatorInstance ()
float	getDuration ()
float	getElapsed ()
float	getSpeakBlend ()
	Speak blending factor.
bool	getSpeaking ()
SpeechAnimation	getSpeechAnimation ()
SpeechAnimationPlayback	new ()
void	readFromFile (PersistencyEnvironment env, FileReader reader)
void	removeAllPhonemes ()
void	setSpeechAnimation (SpeechAnimation speechAnimation)
void	update (float elapsed)
	Updates the speech animation.
void	writeToFile (PersistencyEnvironment env, FileWriter writer)

Public Attributes
AnimatorInstance	pAnimatorInstance
Array	pControllers
float	pDuration
float	pElapsed
Array	pPhonemes
int	pPosition
bool	pRequiresApply
float	pSpeakBlend
bool	pSpeaking
SpeechAnimation	pSpeechAnimation

Detailed Description

Speech animation Playback.

Member Function Documentation

addPhoneme()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.addPhoneme	(	SpeechAnimationPhoneme	phoneme,
		float	duration
	)

Adds a speak phoneme.

getAnimatorInstance()

AnimatorInstance Dragengine.SpeechAnimations.SpeechAnimationPlayback.getAnimatorInstance

(

)

Retrieves the animator instance.

getDuration()

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.getDuration

(

)

Retrieves the duration of the speaking.

getElapsed()

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.getElapsed

(

)

Retrieves the elapsed time.

getSpeakBlend()

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.getSpeakBlend

(

)

Speak blending factor.

Version

1.21

If speaking this is 1 if a viseme is playing or 0 if not. Values in between represent blending in and out of speaking. Can be used to avoid animators affecting speech animation driven bones or vertex position sets while speaking.

getSpeaking()

bool Dragengine.SpeechAnimations.SpeechAnimationPlayback.getSpeaking

(

)

Determines if the playback is still running.

getSpeechAnimation()

SpeechAnimation Dragengine.SpeechAnimations.SpeechAnimationPlayback.getSpeechAnimation

(

)

Retrieves the speech animation or null if not assigned.

new()

SpeechAnimationPlayback Dragengine.SpeechAnimations.SpeechAnimationPlayback.new

(

)

Creates a new speech animation playback.

readFromFile()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.readFromFile	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Reads the element from a file.

removeAllPhonemes()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.removeAllPhonemes

(

)

Remove all phonemes.

setSpeechAnimation()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.setSpeechAnimation

(

SpeechAnimation

speechAnimation

)

Sets the speech animation or null if not assigned.

update()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.update

(

float

elapsed

)

Updates the speech animation.

This updates the playback and updates animator instances if required. This does not apply the animation yet to allow proper use of state capturing.

writeToFile()

void Dragengine.SpeechAnimations.SpeechAnimationPlayback.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Writes the element to a file.

Member Data Documentation

pAnimatorInstance

AnimatorInstance Dragengine.SpeechAnimations.SpeechAnimationPlayback.pAnimatorInstance

pControllers

Array Dragengine.SpeechAnimations.SpeechAnimationPlayback.pControllers

pDuration

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.pDuration

pElapsed

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.pElapsed

pPhonemes

Array Dragengine.SpeechAnimations.SpeechAnimationPlayback.pPhonemes

pPosition

int Dragengine.SpeechAnimations.SpeechAnimationPlayback.pPosition

pRequiresApply

bool Dragengine.SpeechAnimations.SpeechAnimationPlayback.pRequiresApply

pSpeakBlend

float Dragengine.SpeechAnimations.SpeechAnimationPlayback.pSpeakBlend

pSpeaking

bool Dragengine.SpeechAnimations.SpeechAnimationPlayback.pSpeaking

pSpeechAnimation

SpeechAnimation Dragengine.SpeechAnimations.SpeechAnimationPlayback.pSpeechAnimation

---

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

• SpeechAnimationPlayback.ds