DtDiGuyController Class Reference

Controls appearances and animations for an entity that is represented by a DI-Guy 3D visual representation. More...

Inheritance diagram for DtDiGuyController:

Public Member Functions
	DtDiGuyController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDiGuyController ()
	destructor
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Initialize the component.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	preFirstTickInit ()
	Sets up myCharacterData, myCurrentAnimation, myTaskedAnimation, myDefaultAnimation, myDdefaultAnimationPosture, myTimeElapsed, myAnimationDuration, myAmRotating and myDirectionOfMovement.
virtual void	tick ()
	Calculate new control values.
virtual void	taskedTick (DtTime &dT)
	Called if we are tasked to perform an animation.
virtual bool	intrinsicOverride ()
	Checks if there's some intrinsic behavior like collision avoidance or shooting the enemy that needs to break in and happen during a tasked animation.
virtual bool	intrinsicTick (DtLifeformStaticPosture post, double speed, DtWeaponState weapon, DtString &demeanor)
	When the entity is not tasked to perform an animation, this controller looks at the entity's current posture, speed, weapon state( if any), and demeanor( dead, aiming, sick...) to determine the best animation for the entity.
virtual bool	tickWhileDestroyed () const
virtual void	setCurrentAnimation (DtDiGuyAnimation *animation, bool overridePosture=false)
	Added an override posture for cases where the diguy animation's posture doesn't accurately reflect the entity's real posture–I.e.
virtual void	sendSetPosture (DtLifeformState post)
	Sends out our animation's posture when we're finished performing the animation so the actuator knows what the ending posture was and doesn't revert to an old posture.
virtual void	processSetCharacterCharacteristics (DtSimMessage *msg)
virtual void	processSetCharacterAppearance (DtSimMessage *msg)
virtual void	processSetCharacterHandItem (DtSimMessage *msg)
virtual void	processSetCharacterHead (DtSimMessage *msg)
virtual void	processSetRestore (DtSimMessage *msg)
virtual void	processAnimationTask (DtSimMessage *msg)
virtual void	clearTask ()
	Both call reset to clear out the tasked animation, set the posture correctly and release control of movement and posture to the other movement components.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual void	updateAnimationState (DtLifeformStaticPosture post, double speed, DtWeaponState weapon, const DtString &demeanor)
	Updates the animation in the underlying local state repository, and also.
virtual DtDiGuyDirectionType	directionStringToEnum (const DtString &direction)
	Given a DI-Guy direction string return the enum that goes with it.
virtual void	bindLuaFunctions (lua_State *L)
	Binds method for this class to the lua state.
virtual void	bindLuaGlobals (lua_State *L)
	Override to bind lua globals.
bool	isAnimationAvailable (const std::string &animation) const
	Methods accessible via Lua extensions.
bool	isAppearanceAvailable (const std::string &appearance) const
	Returns true if the specified appearance is available for this entity.
bool	isHandItemAvailable (const std::string &item) const
	Returns true if the specified hand item is available for this entity.
bool	isHeadAvailable (const std::string &head) const
	Returns true if the specified head is available for this entity and its current body appearance.
bool	isGestureAvailable (const std::string &gesture) const
	Returns true if the specified gesture is available for this entity.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	suspendTask ()
	This method is called when the currently running task is being suspended.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	registerTaskMsgCallbacks ()
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component.
virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe.
virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe.
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.
Public Member Functions inherited from DtBindableLuaComponent< DtDiGuyController >
	DtBindableLuaComponent (const DtVrfObject *entity, const DtString &componentName, const DtString &componentType)
virtual	~DtBindableLuaComponent ()
bool	shouldBind (lua_State *L) const
Public Member Functions inherited from DtBindableLuaComponentInterface
	DtBindableLuaComponentInterface (const DtVrfObject *entity, const DtString &componentName, const DtString &componentType)
	CTOR.
virtual	~DtBindableLuaComponentInterface ()
	DTOR.
virtual void	bind (DtVrfObject *, const DtString &scriptId, lua_State *)
	Starts the binding process.
virtual DtString	bindableName (const DtString &) const
	Returns a name suitable for binding. Replaces spaces and - with _.

Static Public Member Functions
static void	setCharacteristicsCallback (DtSimMessage *msg, void *usr)
	Processes a command to set the DI-Guy characteristics.
static void	setAppearanceCallback (DtSimMessage *msg, void *usr)
	Processes a command to set the DI-Guy appearance.
static void	setHandItemCallback (DtSimMessage *msg, void *usr)
	Processes a command to set the DI-Guy hand item.
static void	setHeadCallback (DtSimMessage *msg, void *usr)
	Processes a command to set the DI-Guy head.
static void	setRestoreCallback (DtSimMessage *msg, void *usrData)
static void	animationTaskCallback (DtSimMessage *msg, void *usrData)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual void	registerRadioMessageCallbacks ()
	Registers for setCharacterAppearanceDataRequest from the local entity's radio.
virtual void	registerDiGuyTasks ()
	Registers for animation tasks. Called from preFirstTickInit.
virtual void	determineInitialHandItem ()
	Attempts to correct the initial hand item.
virtual DtVector	groundClamp (double heading, const DtVector &location) const
	DtDiGuyController ()
	Not implemented.
	DtDiGuyController (const DtDiGuyController &orig)
	Not implemented.
const DtDiGuyController &	operator= (const DtDiGuyController &orig)
	Not implemented.
virtual bool	createPortGroups ()
	Overridden to create local port groups.
virtual bool	createPorts ()
	Overridden to create the local ports.
virtual bool	createCollisionPort ()
	These are called in init to create the ports used to communicate with the controller.
virtual bool	createAimDirectionPort ()
virtual bool	createOrderedAnimationPort ()
virtual bool	determineDemeanor (DtWeaponState weapon, DtLifeformStaticPosture post, DtString &demeanor)
virtual void	determineDirection ()
	Work out the value of myDirectionOfMovement (see below)
virtual DtString	chooseRandomAppearance ()
virtual void	updatePosition (const DtTime &dT, DtTaitBryan &localOrientation)
	Only relevant during a tasked animation.
virtual DtString	selectDamageAnimation (const DtRwNLengthStringVector &animations)
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.
virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller.
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables.
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
const DtDiGuyControllerDescriptor *	myDiGuyDescriptor
std::vector< DtString >	myStunnedAnimationList
	Possible animations to use if in non healthy damage state.
std::vector< DtString >	myProneAnimationList
std::vector< DtString >	myDeadAnimationList
DtDiGuyCharacterData *	myCharacterData
DtVrfMovingObjectStateRepository *	myLocalState
DtDiGuyAnimation *	myDefaultAnimation
DtLifeformStaticPosture	myDefaultAnimationPosture
bool	myTaskInterrupted
DtDiGuyAnimation *	myTaskedAnimation
DtTaitBryan	myTaskedOrientation
DtDiGuyAnimation *	myCurrentAnimation
DtWeaponState	myCurrentAnimationWeaponState
DtLifeformStaticPosture	myCurrentAnimationPosture
double	myCurrentAnimationSpeed
double	myAnimationDuration
	These values are stored in the PSR Do we want this animation to be performed only once? Indefinitely? Or for a specified period of time? some number in seconds;.
DtTime	myTimeElapsed
bool	myAmRotating
double	myDirectionOfMovement
	This is an angle, in radians, relative to the current heading (a value of PI represents "backwards").
DtDiGuyControllerPSR *	myProcessState
	Container for state data associated with this component.
DtBooleanInputPort *	myCollisionPort
	Input Port Name: collision Input Port Description: Checks to see if we're avoiding a collision.
DtAnalogInputPort *	myAimDirectionPort
	Input Port Name: aim-direction Input Port Description: Specifies the heading in which the entity should aim its weapon.
DtStringInputPort *	myOrderedAnimationPort
	Input Port Name: ordered-animation Input Port Description: Specifies an animation to be used as long as the entity is not currently tasked to perform another animation.
DtUpdateRepositoryOutputPortGroup *	myUpdateRepositoryOutputPortGroup
	Used to update repository with any movement data.
bool	myTickWhileDead
bool	myNeedUpdate
bool	myAmOrdered
int	myLastPosition

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

Controls appearances and animations for an entity that is represented by a DI-Guy 3D visual representation.

End User Description: This controller is used on entities that have a DI-Guy driven 3D visual representation. This controller enables Set tasks for DI-Guy appearances and animations, and handles set/task messages by sending out special DI-Guy control messages to the visual system. In the case of DI-Guy animations, this controller will suppress movement by a normal actuator and move the the entity directly in line with the selected animation. Uses Descriptor Type: DtComponentDescriptor

Further notes: Controls a DtHumanStateRepository (DtVrfMovingObjectStateRepository) instance. This is a "local" state repository.

Constructor & Destructor Documentation

DtDiGuyController::DtDiGuyController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtDiGuyController::~DtDiGuyController ( )

virtual

destructor

DtDiGuyController::DtDiGuyController ( )

protected

Not implemented.

DtDiGuyController::DtDiGuyController ( const DtDiGuyController &  orig )

protected

Not implemented.

Member Function Documentation

virtual const char* DtDiGuyController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns

DtDiGuyControllerType

Implements DtTaskControllerComponent.

virtual bool DtDiGuyController::init ( )

virtual

Initialize the component.

Calls registerRadioMessageCallbacks()

Reimplemented from DtControllerComponent.

virtual bool DtDiGuyController::createPSR ( )

virtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual void DtDiGuyController::preFirstTickInit ( )

virtual

Sets up myCharacterData, myCurrentAnimation, myTaskedAnimation, myDefaultAnimation, myDdefaultAnimationPosture, myTimeElapsed, myAnimationDuration, myAmRotating and myDirectionOfMovement.

Reimplemented from DtSimComponent.

virtual void DtDiGuyController::tick ( )

virtual

Calculate new control values.

Reimplemented from DtSimComponent.

virtual void DtDiGuyController::taskedTick ( DtTime &  dT )

virtual

Called if we are tasked to perform an animation.

Disables the movement actuator so that position and velocity settings are controlled from this controller. Updates the position and velocity each tick.

virtual bool DtDiGuyController::intrinsicOverride ( )

virtual

Checks if there's some intrinsic behavior like collision avoidance or shooting the enemy that needs to break in and happen during a tasked animation.

virtual bool DtDiGuyController::intrinsicTick ( DtLifeformStaticPosture  post, double  speed, DtWeaponState  weapon, DtString &  demeanor  )

virtual

When the entity is not tasked to perform an animation, this controller looks at the entity's current posture, speed, weapon state( if any), and demeanor( dead, aiming, sick...) to determine the best animation for the entity.

virtual bool DtDiGuyController::tickWhileDestroyed ( ) const

virtual

Returns

true.

Reimplemented from DtSimComponent.

virtual void DtDiGuyController::setCurrentAnimation ( DtDiGuyAnimation *  animation, bool  overridePosture = false  )

virtual

Added an override posture for cases where the diguy animation's posture doesn't accurately reflect the entity's real posture–I.e.

parachuting and fast roping.

virtual void DtDiGuyController::sendSetPosture ( DtLifeformState  post )

virtual

Sends out our animation's posture when we're finished performing the animation so the actuator knows what the ending posture was and doesn't revert to an old posture.

static void DtDiGuyController::setCharacteristicsCallback ( DtSimMessage *  msg, void *  usr  )

static

Processes a command to set the DI-Guy characteristics.

virtual void DtDiGuyController::processSetCharacterCharacteristics ( DtSimMessage *  msg )

virtual

static void DtDiGuyController::setAppearanceCallback ( DtSimMessage *  msg, void *  usr  )

static

Processes a command to set the DI-Guy appearance.

virtual void DtDiGuyController::processSetCharacterAppearance ( DtSimMessage *  msg )

virtual

static void DtDiGuyController::setHandItemCallback ( DtSimMessage *  msg, void *  usr  )

static

Processes a command to set the DI-Guy hand item.

virtual void DtDiGuyController::processSetCharacterHandItem ( DtSimMessage *  msg )

virtual

static void DtDiGuyController::setHeadCallback ( DtSimMessage *  msg, void *  usr  )

static

Processes a command to set the DI-Guy head.

virtual void DtDiGuyController::processSetCharacterHead ( DtSimMessage *  msg )

virtual

static void DtDiGuyController::setRestoreCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtDiGuyController::processSetRestore ( DtSimMessage *  msg )

virtual

static void DtDiGuyController::animationTaskCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtDiGuyController::processAnimationTask ( DtSimMessage *  msg )

virtual

virtual void DtDiGuyController::clearTask ( )

virtual

Both call reset to clear out the tasked animation, set the posture correctly and release control of movement and posture to the other movement components.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtDiGuyController::taskComplete ( bool  success = true )

virtual

If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.

To indicate that the task has failed (and is being abandoned) call this method with success set to false.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtDiGuyController::reset ( )

virtual

For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtDiGuyController::updateAnimationState ( DtLifeformStaticPosture  post, double  speed, DtWeaponState  weapon, const DtString &  demeanor  )

virtual

Updates the animation in the underlying local state repository, and also.

virtual DtDiGuyDirectionType DtDiGuyController::directionStringToEnum ( const DtString &  direction )

virtual

Given a DI-Guy direction string return the enum that goes with it.

bool DtDiGuyController::isAnimationAvailable

(

const std::string &

animation

)

const

Methods accessible via Lua extensions.

These are deprecated but remain for backwards compatibility. It is recommended you use the DtScriptVrfObject functions for these purposes. Returns true if the specified animation is available for this entity.

bool DtDiGuyController::isAppearanceAvailable

(

const std::string &

appearance

)

const

Returns true if the specified appearance is available for this entity.

bool DtDiGuyController::isHandItemAvailable

(

const std::string &

item

)

const

Returns true if the specified hand item is available for this entity.

bool DtDiGuyController::isHeadAvailable

(

const std::string &

head

)

const

Returns true if the specified head is available for this entity and its current body appearance.

bool DtDiGuyController::isGestureAvailable

(

const std::string &

gesture

)

const

Returns true if the specified gesture is available for this entity.

virtual void DtDiGuyController::bindLuaFunctions ( lua_State *  L )

virtual

Binds method for this class to the lua state.

This simple method will send an object console message to the entity that implements this task

Implements DtBindableLuaComponentInterface.

virtual void DtDiGuyController::bindLuaGlobals ( lua_State *  )

virtual

Override to bind lua globals.

Implements DtBindableLuaComponentInterface.

static DtSimComponent* DtDiGuyController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

virtual void DtDiGuyController::registerRadioMessageCallbacks ( )

protectedvirtual

Registers for setCharacterAppearanceDataRequest from the local entity's radio.

virtual void DtDiGuyController::registerDiGuyTasks ( )

protectedvirtual

Registers for animation tasks. Called from preFirstTickInit.

virtual void DtDiGuyController::determineInitialHandItem ( )

protectedvirtual

Attempts to correct the initial hand item.

Can be an issue when loading older scenarios where hand item was saved as part of the appearance.

virtual DtVector DtDiGuyController::groundClamp ( double  heading, const DtVector &  location  ) const

protectedvirtual

const DtDiGuyController& DtDiGuyController::operator= ( const DtDiGuyController &  orig )

protected

Not implemented.

virtual bool DtDiGuyController::createPortGroups ( )

protectedvirtual

Overridden to create local port groups.

Reimplemented from DtSimComponent.

virtual bool DtDiGuyController::createPorts ( )

protectedvirtual

Overridden to create the local ports.

Reimplemented from DtSimComponent.

virtual bool DtDiGuyController::createCollisionPort ( )

protectedvirtual

These are called in init to create the ports used to communicate with the controller.

virtual bool DtDiGuyController::createAimDirectionPort ( )

protectedvirtual

virtual bool DtDiGuyController::createOrderedAnimationPort ( )

protectedvirtual

virtual bool DtDiGuyController::determineDemeanor ( DtWeaponState  weapon, DtLifeformStaticPosture  post, DtString &  demeanor  )

protectedvirtual

virtual void DtDiGuyController::determineDirection ( )

protectedvirtual

Work out the value of myDirectionOfMovement (see below)

virtual DtString DtDiGuyController::chooseRandomAppearance ( )

protectedvirtual

virtual void DtDiGuyController::updatePosition ( const DtTime &  dT, DtTaitBryan &  localOrientation  )

protectedvirtual

Only relevant during a tasked animation.

virtual DtString DtDiGuyController::selectDamageAnimation ( const DtRwNLengthStringVector &  animations )

protectedvirtual

Member Data Documentation

const DtDiGuyControllerDescriptor* DtDiGuyController::myDiGuyDescriptor

protected

std::vector<DtString> DtDiGuyController::myStunnedAnimationList

protected

Possible animations to use if in non healthy damage state.

std::vector<DtString> DtDiGuyController::myProneAnimationList

protected

std::vector<DtString> DtDiGuyController::myDeadAnimationList

protected

DtDiGuyCharacterData* DtDiGuyController::myCharacterData

protected

DtVrfMovingObjectStateRepository* DtDiGuyController::myLocalState

protected

DtDiGuyAnimation* DtDiGuyController::myDefaultAnimation

protected

DtLifeformStaticPosture DtDiGuyController::myDefaultAnimationPosture

protected

bool DtDiGuyController::myTaskInterrupted

protected

DtDiGuyAnimation* DtDiGuyController::myTaskedAnimation

protected

DtTaitBryan DtDiGuyController::myTaskedOrientation

protected

DtDiGuyAnimation* DtDiGuyController::myCurrentAnimation

protected

DtWeaponState DtDiGuyController::myCurrentAnimationWeaponState

protected

DtLifeformStaticPosture DtDiGuyController::myCurrentAnimationPosture

protected

double DtDiGuyController::myCurrentAnimationSpeed

protected

double DtDiGuyController::myAnimationDuration

protected

These values are stored in the PSR Do we want this animation to be performed only once? Indefinitely? Or for a specified period of time? some number in seconds;.

DtTime DtDiGuyController::myTimeElapsed

protected

bool DtDiGuyController::myAmRotating

protected

double DtDiGuyController::myDirectionOfMovement

protected

This is an angle, in radians, relative to the current heading (a value of PI represents "backwards").

If the character is moving, but not rotating, this value is used to determine its velocity. If the character is rotating, it represents a target to get to.

DtDiGuyControllerPSR* DtDiGuyController::myProcessState

protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

DtBooleanInputPort* DtDiGuyController::myCollisionPort

protected

Input Port Name: collision
Input Port Description: Checks to see if we're avoiding a collision.

Overrides DI-Guy tasked animations. Need to avoid collisions first.
Input Port Range:
Input Port Default Value:
Input Group Parent:

DtAnalogInputPort* DtDiGuyController::myAimDirectionPort

protected

Input Port Name: aim-direction
Input Port Description: Specifies the heading in which the entity should aim its weapon.

This information will override DI-Guy Tasked animations.
Input Port Range: Heading value in radians.
Input Port Default Value: N/A
Input Group Parent:

DtStringInputPort* DtDiGuyController::myOrderedAnimationPort

protected

Input Port Name: ordered-animation
Input Port Description: Specifies an animation to be used as long as the entity is not currently tasked to perform another animation.

Input Port Default Value:

DtUpdateRepositoryOutputPortGroup* DtDiGuyController::myUpdateRepositoryOutputPortGroup

protected

Used to update repository with any movement data.

As long as this controller has control of this port group no other controllers/actuators will be allowed to write to it

bool DtDiGuyController::myTickWhileDead

protected

bool DtDiGuyController::myNeedUpdate

protected

bool DtDiGuyController::myAmOrdered

protected

int DtDiGuyController::myLastPosition

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/diGuyController.h