hmi.elckerlyc.faceengine
Class FacePlanner

java.lang.Object
  hmi.elckerlyc.AbstractPlanner
      hmi.elckerlyc.faceengine.FacePlanner

All Implemented Interfaces:

Planner

public class FacePlanner
extends AbstractPlanner

This planner will in the future support planning of face behaviors -- i.e. face expressions and such. In addition, the faceplanner allows for the possiblities to set visemes at certain TimePegs. This functionality is mostly accessed by the verbalplanner.

Field Summary

private FaceBinding	faceBinding
private static org.slf4j.Logger	logger
private FacePlayer	player
private VisemeBinding	visemeBinding

Constructor Summary

FacePlanner(FacePlayer p, FaceBinding fb, VisemeBinding vb)
key: "bmlid:id" of the speech unit

Method Summary

List<SyncAndTimePeg>	addBehaviour(BMLBlockPeg bbPeg, Behaviour b, List<TimePegAndConstraint> sacs, PlanUnit planElement) Creates a TimedFaceUnit that satisfies sacs and adds it to the face plan.
void	addExceptionListener(BMLExceptionListener war)
void	addVisemesForSpeechUnit(ArrayList<TimedFaceUnit> visemeFUs)
void	clearAll(double time) Removes all behaviors from the plan
FaceBinding	getFaceBinding()
FacePlayer	getFacePlayer() Addition to getPlayer to save on class casting
Set<String>	getInvalidBehaviours() Checks if the behavior plan is still consistent (e.g. after modifying the timing of some TimePegs).
Player	getPlayer() Returns the Player for this planner. useful for, e.g., resetting the player of any planner (see BMLRealizer.reset).
List<Class<? extends Behaviour>>	getSupportedBehaviours()
List<Class<? extends Behaviour>>	getSupportedDescriptionExtensions()
VisemeBinding	getVisemeBinding()
void	interruptBehaviour(String behaviourId, String BMLId, double globalTime) Interrupts the behavior, sending the appropiate feedback callbacks if the behavior was running, just removes it otherwise.
private void	linkSynchs(TimedFaceUnit tfu, List<TimePegAndConstraint> sacs)
void	removeAllExceptionListeners()
void	removeBehaviour(String behaviourId, String BMLId) Removes behavior with behaviourId and bmlId from the plan Callback behavior is unspecified
void	reset() Resets the player, that is: stops running behavior and returns the player to its startup state (default pose etc) This does not clear any behaviours from the plans.
void	resolveDefaultBMLKeyPositions(TimedFaceUnit tfu)
PlanUnit	resolveSynchs(BMLBlockPeg bbPeg, Behaviour b, List<TimePegAndConstraint> sac) Resolves TimePegs for behavior b, given some known time pegs and constraints
void	setParameterValue(String behId, String bmlId, String paramId, float value)
void	setParameterValue(String behId, String bmlId, String paramId, String value)

Methods inherited from class hmi.elckerlyc.AbstractPlanner

addFeedbackListener, getBehaviours, getEndTime, getFeedbackListeners, interruptBehaviourBlock, removeAllFeedbackListeners, removeFeedbackListener, setBMLBlockState, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static org.slf4j.Logger logger

player

private FacePlayer player

faceBinding

private FaceBinding faceBinding

visemeBinding

private VisemeBinding visemeBinding

Constructor Detail

FacePlanner

public FacePlanner(FacePlayer p,
                   FaceBinding fb,
                   VisemeBinding vb)

key: "bmlid:id" of the speech unit

Method Detail

getFacePlayer

public FacePlayer getFacePlayer()

Addition to getPlayer to save on class casting

getPlayer

public Player getPlayer()

Description copied from interface: Planner

Returns the Player for this planner. useful for, e.g., resetting the player of any planner (see BMLRealizer.reset).

getFaceBinding

public FaceBinding getFaceBinding()

getVisemeBinding

public VisemeBinding getVisemeBinding()

addBehaviour

public List<SyncAndTimePeg> addBehaviour(BMLBlockPeg bbPeg,
                                         Behaviour b,
                                         List<TimePegAndConstraint> sacs,
                                         PlanUnit planElement)
                                  throws BehaviourPlanningException

Creates a TimedFaceUnit that satisfies sacs and adds it to the face plan. All registered BMLFeedbackListener are linked to this TimedFaceUnit.

planElement - planElement obtained from resolveSynchs, null to create a new planElement

Returns:

a list of all syncs of the behavior and their linked TimePegs

Throws:

BehaviourPlanningException - if no behavior satisfying sac can be constructed

resolveDefaultBMLKeyPositions

public void resolveDefaultBMLKeyPositions(TimedFaceUnit tfu)

resolveSynchs

public PlanUnit resolveSynchs(BMLBlockPeg bbPeg,
                              Behaviour b,
                              List<TimePegAndConstraint> sac)
                       throws BehaviourPlanningException

Description copied from interface: Planner

Resolves TimePegs for behavior b, given some known time pegs and constraints

b - the behavior

sac - the provided time pegs and constraints, missing constraints are filled out by this method

Returns:

the object to be placed in the plan (a TimedMotionUnit, SpeechUnit, ...)

Throws:

BehaviourPlanningException - if no behavior satisfying sac can be constructed

clearAll

public void clearAll(double time)

Description copied from interface: Planner

Removes all behaviors from the plan

linkSynchs

private void linkSynchs(TimedFaceUnit tfu,
                        List<TimePegAndConstraint> sacs)

removeBehaviour

public void removeBehaviour(String behaviourId,
                            String BMLId)

Description copied from interface: Planner

Removes behavior with behaviourId and bmlId from the plan Callback behavior is unspecified

interruptBehaviour

public void interruptBehaviour(String behaviourId,
                               String BMLId,
                               double globalTime)

Description copied from interface: Planner

Interrupts the behavior, sending the appropiate feedback callbacks if the behavior was running, just removes it otherwise.

getInvalidBehaviours

public Set<String> getInvalidBehaviours()

Description copied from interface: Planner

Checks if the behavior plan is still consistent (e.g. after modifying the timing of some TimePegs). Returns id's of behaviors with invalid timing

addVisemesForSpeechUnit

public void addVisemesForSpeechUnit(ArrayList<TimedFaceUnit> visemeFUs)

addExceptionListener

public void addExceptionListener(BMLExceptionListener war)

removeAllExceptionListeners

public void removeAllExceptionListeners()

getSupportedBehaviours

public List<Class<? extends Behaviour>> getSupportedBehaviours()

getSupportedDescriptionExtensions

public List<Class<? extends Behaviour>> getSupportedDescriptionExtensions()

reset

public void reset()

Description copied from interface: Planner

Resets the player, that is: stops running behavior and returns the player to its startup state (default pose etc) This does not clear any behaviours from the plans.

setParameterValue

public void setParameterValue(String behId,
                              String bmlId,
                              String paramId,
                              float value)

setParameterValue

public void setParameterValue(String behId,
                              String bmlId,
                              String paramId,
                              String value)