VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
DtHumanTurnToController Class Reference

This controller implements the DtTurnToHeading task for the human movement model. More...

Inheritance diagram for DtHumanTurnToController:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtHumanTurnToController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Constructor.
virtual ~DtHumanTurnToController ()
 Destructor.
virtual bool init ()
 Init. Call immediately after construction.
virtual DtString type () const
virtual void tick ()
 This components simulation tick.
virtual void processTurnToHeadingTask (DtSimMessage *msg)
virtual void registerTaskMsgCallbacks ()
 Overridden to register interest in turn to messages.
virtual bool createPortGroups ()
 Creates and initializes port groups.
virtual void clearTask ()
 Overridden to deactivate the output port group when the task is cleared.

Static Public Member Functions

static void turnToHeadingCallback (DtSimMessage *msg, void *usr)
 Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of move-to tasks.
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Static creator function for factory registration.

Protected Member Functions

virtual double headingToFace ()

Protected Attributes

Ports and Port Groups
DtHumanMovementControlOutputPortGroupmyHumanMovementControlOutputPortGroup
 Output Group Name: movement-control
.

Private Member Functions

 DtHumanTurnToController ()
 Not Implemented.
 DtHumanTurnToController (const DtHumanTurnToController &orig)
 Not Implemented.
DtHumanTurnToControlleroperator= (const DtHumanTurnToController &orig)
 Not Implemented.

Detailed Description

This controller implements the DtTurnToHeading task for the human movement model.

It simply stops the entity and turns to the specified heading. Task completes once the entity is stopped and facing the specified direction. Component OPD Name: "human-turn-to-controller" Uses Descriptor Type: DtComponentDescriptor


Constructor & Destructor Documentation

Not Implemented.

Not Implemented.

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

Constructor.

Destructor.


Member Function Documentation

DtHumanTurnToController& DtHumanTurnToController::operator= ( const DtHumanTurnToController orig) [private]

Not Implemented.

virtual bool DtHumanTurnToController::init ( ) [virtual]

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual DtString DtHumanTurnToController::type ( ) const [virtual]
Returns:
DtHumanTurnToControllerType

Implements DtTaskControllerComponent.

virtual void DtHumanTurnToController::tick ( ) [virtual]

This components simulation tick.

Reimplemented from DtSimComponent.

static void DtHumanTurnToController::turnToHeadingCallback ( DtSimMessage msg,
void *  usr 
) [static]

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of move-to tasks.

Overridden to register interest in turn to messages.

Reimplemented from DtTaskControllerComponent.

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

Static creator function for factory registration.

Creates and initializes port groups.

Reimplemented from DtSimComponent.

virtual void DtHumanTurnToController::clearTask ( ) [virtual]

Overridden to deactivate the output port group when the task is cleared.

Reimplemented from DtSingleTaskControllerComponent.

virtual double DtHumanTurnToController::headingToFace ( ) [protected, virtual]
Returns:
The heading that was specified in the turn-to task.

Member Data Documentation

Output Group Name: movement-control
.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)