Drag[en]gine Script Module DragonScript  1.23
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose Class Reference

Face pose. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose:

Public Member Functions

void addPose (Array controllers, ConversationStrip strip)
 Add face pose. More...
 
Animator getAnimator ()
 Animator. More...
 
AnimatorInstance getAnimatorInstance ()
 Animator instance. More...
 
String getControllerNameSpeaking ()
 Name of controller to set if actor is speaking. More...
 
Array getControllers ()
 Array of FacePoseController. More...
 
float getElapsed ()
 Elapsed time. More...
 
float getMaximumBlinkInterval ()
 Maximum random eye blinking interval in seconds. More...
 
float getMinimumBlinkInterval ()
 Minimum random eye blinking interval in seconds. More...
 
SpeechAnimationPlayback getSpeechAnimationPlayback ()
 Speech animation to use to update speaking controller or null. More...
 
ConversationStrip getStrip ()
 Strip. More...
 
FacePose new ()
 Create face pose playback. More...
 
FacePose new (Array controllers, ConversationStrip strip)
 Create face pose. More...
 
void removeAllPoses ()
 Remove all face poses. More...
 
void setAnimator (Animator animator)
 Set animator. More...
 
void setControllerNameSpeaking (String name)
 Set name of controller to set if actor is speaking. More...
 
void setMaximumBlinkInterval (float interval)
 Set maximum random eye blinking interval in seconds. More...
 
void setMinimumBlinkInterval (float interval)
 Set minimum random eye blinking interval in seconds. More...
 
void setSpeechAnimationPlayback (SpeechAnimationPlayback playback)
 Set speech animation to use to update speaking controller or null. More...
 
void update (float elapsed)
 Update playback. More...
 
void writeToFile (FileWriter writer)
 Write to file. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Writes to file. More...
 

Static Public Member Functions

static Array readControllersFromFile (FileReader reader)
 Read controllers from file. More...
 
static FacePose readFromFile (FileReader reader)
 Read from file. More...
 
static void writeControllersToFile (FileWriter writer, Array controllers)
 Write controllers to file. More...
 

Public Attributes

Animator pAnimator
 
AnimatorInstance pAnimatorInstance
 
float pBlinkElapsed
 
float pBlinkIntervalMax
 
float pBlinkIntervalMin
 
float pBlinkNext
 
String pControllerNameSpeaking
 
Array pControllers
 
AnimatorController pControllerSpeaking
 
Array pCurPose
 
float pElapsed
 
Array pLastPose
 
Array pPoses
 
int pPosition
 
bool pRequiresApply
 
bool pRunning
 
SpeechAnimationPlayback pSpeechAnimationPlayback
 
ConversationStrip pStrip
 

Detailed Description

Face pose.

Member Function Documentation

◆ addPose()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.addPose ( Array  controllers,
ConversationStrip  strip 
)

Add face pose.

Parameters
controllersArray of FacePoseController.
stripStrip to play.

◆ getAnimator()

Animator Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getAnimator ( )

Animator.

◆ getAnimatorInstance()

AnimatorInstance Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getAnimatorInstance ( )

Animator instance.

◆ getControllerNameSpeaking()

String Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getControllerNameSpeaking ( )

Name of controller to set if actor is speaking.

Version
1.21

Value of controller is set to 0 if no speech animation playback viseme is playing back otherwise the value is set to 1.

Default controller name is "speaking".

◆ getControllers()

Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getControllers ( )

Array of FacePoseController.

◆ getElapsed()

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getElapsed ( )

Elapsed time.

◆ getMaximumBlinkInterval()

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getMaximumBlinkInterval ( )

Maximum random eye blinking interval in seconds.

Version
1.21

◆ getMinimumBlinkInterval()

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getMinimumBlinkInterval ( )

Minimum random eye blinking interval in seconds.

Version
1.21

◆ getSpeechAnimationPlayback()

SpeechAnimationPlayback Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getSpeechAnimationPlayback ( )

Speech animation to use to update speaking controller or null.

Version
1.21

◆ getStrip()

ConversationStrip Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.getStrip ( )

Strip.

◆ new() [1/2]

FacePose Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.new ( )

Create face pose playback.

◆ new() [2/2]

FacePose Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.new ( Array  controllers,
ConversationStrip  strip 
)

Create face pose.

◆ readControllersFromFile()

static Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.readControllersFromFile ( FileReader  reader)
static

Read controllers from file.

◆ readFromFile()

static FacePose Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.readFromFile ( FileReader  reader)
static

Read from file.

◆ removeAllPoses()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.removeAllPoses ( )

Remove all face poses.

◆ setAnimator()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.setAnimator ( Animator  animator)

Set animator.

◆ setControllerNameSpeaking()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.setControllerNameSpeaking ( String  name)

Set name of controller to set if actor is speaking.

Version
1.21

Value of controller is set to 0 if no speech animation playback viseme is playing back otherwise the value is set to 1.

Default controller name is "speaking".

◆ setMaximumBlinkInterval()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.setMaximumBlinkInterval ( float  interval)

Set maximum random eye blinking interval in seconds.

Version
1.21

◆ setMinimumBlinkInterval()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.setMinimumBlinkInterval ( float  interval)

Set minimum random eye blinking interval in seconds.

Version
1.21

◆ setSpeechAnimationPlayback()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.setSpeechAnimationPlayback ( SpeechAnimationPlayback  playback)

Set speech animation to use to update speaking controller or null.

Version
1.21

◆ update()

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.update ( float  elapsed)

Update playback.

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

◆ writeControllersToFile()

static void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.writeControllersToFile ( FileWriter  writer,
Array  controllers 
)
static

Write controllers to file.

◆ writeToFile() [1/2]

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.writeToFile ( FileWriter  writer)

Write to file.

◆ writeToFile() [2/2]

void Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Writes to file.

Animator and AnimatorInstance are not stored. They have to be set by the ConversationActor.

Member Data Documentation

◆ pAnimator

Animator Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pAnimator

◆ pAnimatorInstance

AnimatorInstance Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pAnimatorInstance

◆ pBlinkElapsed

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pBlinkElapsed

◆ pBlinkIntervalMax

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pBlinkIntervalMax

◆ pBlinkIntervalMin

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pBlinkIntervalMin

◆ pBlinkNext

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pBlinkNext

◆ pControllerNameSpeaking

String Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pControllerNameSpeaking

◆ pControllers

Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pControllers

◆ pControllerSpeaking

AnimatorController Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pControllerSpeaking

◆ pCurPose

Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pCurPose

◆ pElapsed

float Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pElapsed

◆ pLastPose

Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pLastPose

◆ pPoses

Array Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pPoses

◆ pPosition

int Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pPosition

◆ pRequiresApply

bool Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pRequiresApply

◆ pRunning

bool Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pRunning

◆ pSpeechAnimationPlayback

SpeechAnimationPlayback Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pSpeechAnimationPlayback

◆ pStrip

ConversationStrip Dragengine.ConversationSystem.ConversationFacePosePlayback.FacePose.pStrip
The documentation for this class was generated from the following file: