Drag[en]gine Script Module DragonScript  1.23
Dragengine.ConversationSystem.ConversationHeadLookAtPlayback Class Reference

Conversation Look-At Playback manipulating locomotion parameters. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationHeadLookAtPlayback:
Dragengine.ConversationSystem.ConversationLookAtPlayback

Public Member Functions

void clearLookAtState ()
 Clear current look-at state allowing the actor to take over control. More...
 
String getBoneRotator ()
 Name of rotator bone or null if not used. More...
 
DMatrix getInverseMatrix (ConversationActor actor)
 Calculate the inverse matrix. More...
 
Locomotion getLocomotion ()
 Locomotion to update. More...
 
DMatrix getRotatorMatrix ()
 Rotator matrix. More...
 
ConversationHeadLookAtPlayback new ()
 Create playback. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void setBoneRotator (String boneName)
 Set name of rotator bone or null if not used. More...
 
void setLocomotion (Locomotion locomotion)
 Set locomotion to update. More...
 
void setRotatorMatrix (DMatrix matrix)
 Set rotator matrix. More...
 
void updateActorLookAt (ConversationActor actor, float blendFactor)
 Update actor look-at. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write element to file. More...
 
- Public Member Functions inherited from Dragengine.ConversationSystem.ConversationLookAtPlayback
void addFadeOutLookAt (float transitionTime)
 Add fade out look-at. More...
 
void addLookAt (ConversationPlaybackLookAt lookAt, ConversationStrip strip)
 Add strip. More...
 
void applyAnimation ()
 Apply animation. More...
 
void forEachLookAts (Block ablock)
 Visit look-ats to playback using block with argument LookAt. More...
 
ConversationPlaybackLookAt getCurrentLookAt ()
 Current look-at to blend with or null if not set. More...
 
DVector getCurrentLookAtPosition ()
 Current look-at position to blend with or null if not set. More...
 
float getElapsed ()
 Elapsed time. More...
 
ConversationPlaybackLookAt getLastLookAt ()
 Last look-at to blend from or null if not set. More...
 
DVector getLastLookAtPosition ()
 Last look-at position to blend from or null if not set. More...
 
LookAt getLookAtAt (int index)
 Look-at to play back at index. More...
 
int getLookAtCount ()
 Count of look-ats to play back. More...
 
int getPosition ()
 Playback position as index of look-at currently being played back. More...
 
bool getRunning ()
 A strip is running. More...
 
void playbackRestoreObjectLinks (ConversationPlayback playback)
 Restore linked objects after loading. More...
 
void removeAllLookAts ()
 Remove all look-ats. More...
 
void setCurrentLookAt (ConversationPlaybackLookAt lookAt)
 Set current look-at to blend with or null if not set. More...
 
void setCurrentLookAtPosition (DVector position)
 Set current look-at position to blend with or null if not set. More...
 
void setLastLookAt (ConversationPlaybackLookAt lookAt)
 Set last look-at to blend from or null if not set. More...
 
void setLastLookAtPosition (DVector position)
 Set last look-at position to blend from or null if not set. More...
 
void update (ConversationActor actor, float elapsed)
 Update playback. More...
 

Detailed Description

Conversation Look-At Playback manipulating locomotion parameters.

Updates the look left-right and up-down parameters of an locomotion. This is typically used to make actors turn their head to look at specific positions during conversation.

To calculate the appropriate parameters this class it is recommanded to use a rotator bone. This is a particular bone in the actor rig which is placed at a location the head rotates about roughly. If such a bone is not used the actor itself is used.

Look-at targets are required to be placed on the same height as the reference point used in this class to calculate the angles.

Optionally a rotator matrix can be set. This helps to fine tune the rotation calculation in case the target is not located at the same height as the reference point used. This is for example the case if the target is placed at eye level while the rotator bone is located at the head base.

Member Function Documentation

◆ clearLookAtState()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.clearLookAtState ( )

Clear current look-at state allowing the actor to take over control.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.

◆ getBoneRotator()

String Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.getBoneRotator ( )

Name of rotator bone or null if not used.

◆ getInverseMatrix()

DMatrix Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.getInverseMatrix ( ConversationActor  actor)

Calculate the inverse matrix.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.

◆ getLocomotion()

Locomotion Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.getLocomotion ( )

Locomotion to update.

◆ getRotatorMatrix()

DMatrix Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.getRotatorMatrix ( )

Rotator matrix.

◆ new()

ConversationHeadLookAtPlayback Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.new ( )

Create playback.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.

◆ readFromFile()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.

◆ setBoneRotator()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.setBoneRotator ( String  boneName)

Set name of rotator bone or null if not used.

◆ setLocomotion()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.setLocomotion ( Locomotion  locomotion)

Set locomotion to update.

◆ setRotatorMatrix()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.setRotatorMatrix ( DMatrix  matrix)

Set rotator matrix.

◆ updateActorLookAt()

void Dragengine.ConversationSystem.ConversationHeadLookAtPlayback.updateActorLookAt ( ConversationActor  actor,
float  blendFactor 
)

Update actor look-at.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.

◆ writeToFile()

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

Write element to file.

Reimplemented from Dragengine.ConversationSystem.ConversationLookAtPlayback.


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