VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

Public Member Functions

 DtDiGuyController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtDiGuyController ()
 destructor More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual bool init ()
 Initialize the component. More...
 
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager. More...
 
virtual void preFirstTickInit ()
 Sets up myCharacterData, myCurrentAnimation, myTaskedAnimation, myDefaultAnimation, myDdefaultAnimationPosture, myTimeElapsed, myAnimationDuration, myAmRotating and myDirectionOfMovement. More...
 
virtual void tick ()
 Calculate new control values. More...
 
virtual void taskedTick (DtTime &dT)
 Called if we are tasked to perform an animation. More...
 
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. More...
 
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. More...
 
virtual bool tickWhileDestroyed () const
 
virtual void setCurrentAnimation (const 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. More...
 
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. More...
 
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 processSetAdjustDemeanor (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. More...
 
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. More...
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual void updateAnimationState (DtLifeformStaticPosture post, double speed, DtWeaponState weapon, const DtString &demeanor)
 Updates the animation in the underlying local state repository, and also. More...
 
virtual DtDiGuyDirectionType directionStringToEnum (const DtString &direction)
 Given a DI-Guy direction string return the enum that goes with it. More...
 
virtual void bindLuaFunctions (lua_State *L)
 Binds method for this class to the lua state. More...
 
virtual void bindLuaGlobals (lua_State *L)
 Override to bind lua globals. More...
 
bool isAnimationAvailable (const std::string &animation) const
 Methods accessible via Lua extensions. More...
 
bool isAppearanceAvailable (const std::string &appearance) const
 Returns true if the specified appearance is available for this entity. More...
 
bool isHandItemAvailable (const std::string &item) const
 Returns true if the specified hand item is available for this entity. More...
 
bool isHeadAvailable (const std::string &head) const
 Returns true if the specified head is available for this entity and its current body appearance. More...
 
bool isGestureAvailable (const std::string &gesture) const
 Returns true if the specified gesture is available for this entity. More...
 
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSingleTaskControllerComponent ()
 destructor More...
 
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)). More...
 
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task. More...
 
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. More...
 
virtual void suspendTask ()
 This method is called when the currently running task is being suspended. More...
 
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself. More...
 
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...
 
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks. More...
 
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks. More...
 
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked. More...
 
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component. More...
 
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks. More...
 
virtual std::vector< intcurrentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller. More...
 
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id. More...
 
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity. More...
 
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. More...
 
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true. More...
 
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared. More...
 
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type. More...
 
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller. More...
 
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller. More...
 
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
 
virtual DtSuspendedTaskInfosuspendSubtaskById (int taskId, int subtaskId)
 
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
virtual void disable ()
 Overridden to allow tasks controllers that can be disabled to call task complete. More...
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtTaskControllerComponent ()
 destructor More...
 
virtual bool showCurrentTaskInGui () const
 
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks. More...
 
virtual void registerTaskMsgCallbacks ()
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type. More...
 
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback. More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback(). More...
 
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback. More...
 
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks(). More...
 
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message. More...
 
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component. More...
 
virtual void setTasked (bool tasked)
 The current tasked state of this controller. More...
 
virtual bool tasked () const
 
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtControllerComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 The radio this component is listening to. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager. More...
 
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values. More...
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived. More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at. More...
 
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. More...
 
virtual DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
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. More...
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
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. More...
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
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. More...
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
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. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
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. More...
 
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. More...
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component. More...
 
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe. More...
 
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. More...
 
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 DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
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. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
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. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
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. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
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. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
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. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
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. More...
 
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. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 
- 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. More...
 
virtual ~DtBindableLuaComponentInterface ()
 DTOR. More...
 
virtual void bind (DtVrfObject *, const DtString &scriptId, lua_State *)
 Starts the binding process. More...
 
virtual DtString bindableName (const DtString &) const
 Returns a name suitable for binding. Replaces spaces and - with _. More...
 

Static Public Member Functions

static void setCharacteristicsCallback (DtSimMessage *msg, void *usr)
 Processes a command to set the DI-Guy characteristics. More...
 
static void setAppearanceCallback (DtSimMessage *msg, void *usr)
 Processes a command to set the DI-Guy appearance. More...
 
static void setHandItemCallback (DtSimMessage *msg, void *usr)
 Processes a command to set the DI-Guy hand item. More...
 
static void setHeadCallback (DtSimMessage *msg, void *usr)
 Processes a command to set the DI-Guy head. More...
 
static void setRestoreCallback (DtSimMessage *msg, void *usrData)
 
static void setAdjustDemeanorCallback (DtSimMessage *msg, void *usrData)
 Processes a command to adjust the demeanor. More...
 
static void animationTaskCallback (DtSimMessage *msg, void *usrData)
 
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtTaskControllerComponent
static void deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
 Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

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

Protected Attributes

const DtDiGuyControllerDescriptormyDiGuyDescriptor
 
const DtDiGuyCharacterDatamyCharacterData
 
DtVrfMovingObjectStateRepositorymyLocalState
 
const DtDiGuyAnimationmyDefaultAnimation
 
DtLifeformStaticPosture myDefaultAnimationPosture
 
bool myTaskInterrupted
 
const DtDiGuyAnimationmyTaskedAnimation
 
DtTaitBryan myTaskedOrientation
 
const DtDiGuyAnimationmyCurrentAnimation
 
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;. More...
 
DtTime myTimeElapsed
 
bool myAmRotating
 
double myDirectionOfMovement
 This is an angle, in radians, relative to the current heading (a value of PI represents "backwards"). More...
 
DtDiGuyControllerPSRmyProcessState
 Container for state data associated with this component. More...
 
DtBooleanInputPortmyCollisionPort
 Input Port Name: collision
Input Port Description: Checks to see if we're avoiding a collision. More...
 
DtAnalogInputPortmyAimDirectionPort
 Input Port Name: aim-direction
Input Port Description: Specifies the heading in which the entity should aim its weapon. More...
 
DtStringInputPortmyOrderedAnimationPort
 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. More...
 
DtStringInputPortmyOrderedHandItemPort
 Input Port Name: ordered-hand-item
Input Port Description: Specifies a hand item to be used. More...
 
DtBooleanOutputPortmyIsChangingPosturePort
 Output Port Name: is-changing-posture
Output Port Description: Indicated that the DI Guy character is currently changing posture. More...
 
bool myAmTransitioningPosture
 Local flag for we know we're changing posture. More...
 
double myTransitionTime
 The remaining time for the current posture transition. Gets decremented in tick() More...
 
double myCurrentHeading
 The last heading for the entity. Will be used when setting animation for rotating on the spot. More...
 
DtUpdateRepositoryOutputPortGroupmyUpdateRepositoryOutputPortGroup
 Used to update repository with any movement data. More...
 
bool myTickWhileDead
 
bool myNeedUpdate
 
bool myAmOrdered
 
int myLastPosition
 
DtDemeanorToRankMap myDemeanorRankMap
 
- Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap myTaskCallbackMap
 
std::list
< DtTaskProcessorCallbackInfo * > 
myTaskProcessorCallbackInfoList
 This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...
 
bool myTaskIsRunning
 
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myMinTickPeriod
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
double myDT
 
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 
- Protected Attributes inherited from DtBindableLuaComponentInterface
const DtVrfObjectmyBoundEntity
 
lua_State * myBoundForState
 
DtString myType
 

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. More...
 
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
 
- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
 
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
 
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
 
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

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 
)

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
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 ( const 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::setAdjustDemeanorCallback ( DtSimMessage msg,
void *  usrData 
)
static

Processes a command to adjust the demeanor.

virtual void DtDiGuyController::processSetAdjustDemeanor ( 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

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
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::createOrderedHandItemPort ( )
protectedvirtual
virtual DtString DtDiGuyController::determineDemeanor ( DtWeaponState  weaponState,
DtLifeformStaticPosture  posture 
)
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
virtual void DtDiGuyController::initializeAdjustedDemeanorMap ( )
protectedvirtual
virtual double DtDiGuyController::diGuyHeading ( ) const
protectedvirtual

Returns heading of DI-Guy depending on whether or not embarked.

Member Data Documentation

const DtDiGuyControllerDescriptor* DtDiGuyController::myDiGuyDescriptor
protected
const DtDiGuyCharacterData* DtDiGuyController::myCharacterData
protected
DtVrfMovingObjectStateRepository* DtDiGuyController::myLocalState
protected
const DtDiGuyAnimation* DtDiGuyController::myDefaultAnimation
protected
DtLifeformStaticPosture DtDiGuyController::myDefaultAnimationPosture
protected
bool DtDiGuyController::myTaskInterrupted
protected
const DtDiGuyAnimation* DtDiGuyController::myTaskedAnimation
protected
DtTaitBryan DtDiGuyController::myTaskedOrientation
protected
const 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:

DtStringInputPort* DtDiGuyController::myOrderedHandItemPort
protected

Input Port Name: ordered-hand-item
Input Port Description: Specifies a hand item to be used.


Input Port Default Value:

DtBooleanOutputPort* DtDiGuyController::myIsChangingPosturePort
protected

Output Port Name: is-changing-posture
Output Port Description: Indicated that the DI Guy character is currently changing posture.


Output Port Range: true or false
Output Port Default Value: false

bool DtDiGuyController::myAmTransitioningPosture
protected

Local flag for we know we're changing posture.

double DtDiGuyController::myTransitionTime
protected

The remaining time for the current posture transition. Gets decremented in tick()

double DtDiGuyController::myCurrentHeading
protected

The last heading for the entity. Will be used when setting animation for rotating on the spot.

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
DtDemeanorToRankMap DtDiGuyController::myDemeanorRankMap
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)