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

DtFixedWingMoveToLocationController; models movement to a location for fixed-wing entities. More...

Inheritance diagram for DtFixedWingMoveToLocationController:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtFixedWingMoveToLocationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingMoveToLocationController ()
 destructor
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void processMoveToLocationTask (DtSimMessage *msg)
 Callback functions to execute when messages registered for are received.
virtual void processFlyToLocationTask (DtSimMessage *msg)
virtual void registerTaskMsgCallbacks ()
 Overrides this so it can register its interest in MoveTo commands and all other messages described in the above functions.

Static Public Member Functions

static void moveToLocationCallback (DtSimMessage *msg, void *usr)
 Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of the appropriate tasks and setDataRequests.
static void flyToLocationCallback (DtSimMessage *msg, void *usr)
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual bool setupControlPoint ()
 Sets up the current location to mvoe to.

Protected Attributes

DtVector myWorldAimingPoint
DtVector myLocalAimingPoint

Private Member Functions

 DtFixedWingMoveToLocationController ()
 default constructor - should not be called
 DtFixedWingMoveToLocationController (const DtFixedWingMoveToLocationController &orig)
 copy constructor
DtFixedWingMoveToLocationControlleroperator= (const DtFixedWingMoveToLocationController &orig)
 assignment operator

Detailed Description

DtFixedWingMoveToLocationController; models movement to a location for fixed-wing entities.

DtFixedWingMoveToLocationController is a controller used to model the movement of a fixed wing entity to a specific point.

Uses Descriptor Type: DtFixedWingPilotControllerDescriptor


Constructor & Destructor Documentation

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

destructor

default constructor - should not be called

copy constructor


Member Function Documentation

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.

Returns:
DtFixedWingMoveToLocationControllerType

Reimplemented from DtFixedWingMoveToController.

static void DtFixedWingMoveToLocationController::moveToLocationCallback ( DtSimMessage msg,
void *  usr 
) [static]

Instances of this component will register these callbacks with their own 'this' pointer as user data with the msg executive requesting notification of the appropriate tasks and setDataRequests.

static void DtFixedWingMoveToLocationController::flyToLocationCallback ( DtSimMessage msg,
void *  usr 
) [static]

Callback functions to execute when messages registered for are received.

Overrides this so it can register its interest in MoveTo commands and all other messages described in the above functions.

Reimplemented from DtFixedWingMoveToController.

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

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:
New instance of this class.

Reimplemented from DtFixedWingMoveToController.

Sets up the current location to mvoe to.

Reimplemented from DtFixedWingMoveToController.

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

assignment operator


Member Data Documentation


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)