hmi.elckerlyc.faceengine.faceunit
Interface FaceUnit

All Superinterfaces:

KeyPositionManager

All Known Implementing Classes:

AUFU, BlinkModelChangeFU, FACSFU, GazePatternChangeFU, MorphFU, PlutchikFU

public interface FaceUnit
extends KeyPositionManager

A facial animation, typically with a peak-like structure. Contains a set of keys that map to 'world' time to animation time.

Author:

Dennis Reidsma

Method Summary

void	cleanup() Clean up the face - i.e. remove traces of this faceunit
FaceUnit	copy(FacePlayer p) Create a copy of this face unit and link it to the faceplayer
TimedFaceUnit	createTFU(BMLBlockPeg bbPeg, String i, String bmlId) Creates the TimedFaceUnit corresponding to this face unit
String	getParameterValue(String name)
double	getPreferedDuration()
String	getReplacementGroup() Get the faceunit replacement group (=typically the BML behavior) Used to determine the currently active persistent TFU for this group in the player Only one group is active at a time
boolean	hasValidParameters()
void	play(double t) Executes the face unit, typically by morphing the face or moving some FAPs
void	setParameterValue(String name, float value)
void	setParameterValue(String name, String value)

Methods inherited from interface hmi.elckerlyc.animationengine.KeyPositionManager

addKeyPosition, getKeyPosition, getKeyPositions, removeKeyPosition, setKeyPositions

Method Detail

setParameterValue

void setParameterValue(String name,
                       float value)

setParameterValue

void setParameterValue(String name,
                       String value)

getParameterValue

String getParameterValue(String name)

hasValidParameters

boolean hasValidParameters()

play

void play(double t)
          throws PlayException

Executes the face unit, typically by morphing the face or moving some FAPs

Parameters:

t - execution time, 0 < t < 1

Throws:

FUPlayException - if the play fails for some reason

PlayException

cleanup

void cleanup()

Clean up the face - i.e. remove traces of this faceunit

createTFU

TimedFaceUnit createTFU(BMLBlockPeg bbPeg,
                        String i,
                        String bmlId)

Creates the TimedFaceUnit corresponding to this face unit

Parameters:

i - behaviour id

bmlId - BML block id

Returns:

the TFU

getPreferedDuration

double getPreferedDuration()

Returns:

Prefered duration (in seconds) of this face unit, 0 means not determined/infinite

copy

FaceUnit copy(FacePlayer p)

Create a copy of this face unit and link it to the faceplayer

getReplacementGroup

String getReplacementGroup()

Get the faceunit replacement group (=typically the BML behavior) Used to determine the currently active persistent TFU for this group in the player Only one group is active at a time