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

DtFixedWingFlyIntoController is a controller that models flying into the ground for fixed-wing entities. More...

Inheritance diagram for DtFixedWingFlyIntoController:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtFixedWingFlyIntoController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingFlyIntoController ()
 destructor
virtual DtString type () const
 Calculate new control values.
virtual void setComponentDescriptor (DtComponentDescriptor *desc)
 Called by init.
virtual void registerTaskMsgCallbacks ()
 Overrides this so it can register its interest in CrashInto commands.
virtual void processCrashInto (DtSimMessage *msg)
 Process a crashInto task message.
virtual void doFlying ()
 Overridden from the parent class to: -Not reset the ordered altitude.
virtual void processWaypointChanged (DtVrfObject *obj)
 Overridden from DtFixedWingMoveToController to not set waypoint altitude when the target point moves.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
static void crashIntoCallback (DtSimMessage *msg, void *usr)
 Static callback for crashInto task messages.

Protected Attributes

DtFixedWingFlyIntoControllerDescriptormyDescriptor

Private Member Functions

 DtFixedWingFlyIntoController ()
 Not implemented.
 DtFixedWingFlyIntoController (const DtFixedWingFlyIntoController &orig)
 Not implemented.
DtFixedWingFlyIntoControlleroperator= (const DtFixedWingFlyIntoController &orig)
 Not implemented.

Detailed Description

DtFixedWingFlyIntoController is a controller that models flying into the ground for fixed-wing entities.

End User Description: It registers for Crash-Into tasks, and when activated, it attempts to fly its parent entity directly into the point specified in the task. It is assumed that this is a ground point, or at least that it should be approaching the point from above. The difference between this and a move-to controller is that this controller maintains the altitude at the time the task was given until it is within a specified range or elevation-angle of the target position. Once within this range/angle, it flies directly toward the target position. This task does not complete. Since it is a suicidal task, it is assumed to be the last task this entity will perform.

Uses Descriptor Type: DtFixedWingFlyIntoControllerDescriptor

DtFixedWingFlyIntoController model description


Constructor & Destructor Documentation

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

(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

Not implemented.

Not implemented.


Member Function Documentation

virtual DtString DtFixedWingFlyIntoController::type ( ) const [virtual]

Calculate new control values.

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:
DtFixedWingFlyIntoControllerType

Reimplemented from DtFixedWingMoveToController.

Called by init.

Cast descriptor to the DtFixedWingFlyIntoControllerDescriptor and keep a pointer to it for use as we run.

Reimplemented from DtSimComponent.

Overrides this so it can register its interest in CrashInto commands.

Reimplemented from DtFixedWingMoveToController.

static DtSimComponent* DtFixedWingFlyIntoController::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.

static void DtFixedWingFlyIntoController::crashIntoCallback ( DtSimMessage msg,
void *  usr 
) [static]

Static callback for crashInto task messages.

Process a crashInto task message.

The actual altitude of the entity at this time is used as the ordered altitude.

virtual void DtFixedWingFlyIntoController::doFlying ( ) [virtual]

Overridden from the parent class to: -Not reset the ordered altitude.

Ordered altitude is left as the actual altitude at the time the task was activated. -Once the entity is within the direct-fly-distance or within the direct-fly-elevation-angle, switches to using flyDirect() in place of the standard fly() method of the pilot controller.

Reimplemented from DtFixedWingMoveToController.

Overridden from DtFixedWingMoveToController to not set waypoint altitude when the target point moves.

Cruise missiles maintain ordered altitude when moving toward the target.

Reimplemented from DtFixedWingMoveToController.

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

Not implemented.


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)