retreatCtrl.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2000 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

//
//class DtRetreatController
//
//The retreating behavior of this controller was not intended to be
//intelligent; it is meant to be an example of a controller invoked by a 
//DtUserTask. Because the currentTarget is used to determine which way to
//flee, the behavior is best demonstrated tank vs. tank. Vehicles which do not 
//target other vehicles, such as utility vehicles, will simply flee towards 
//their current heading. Tanks will not flee from entities which they do
//not target, such as helicopters.
//
//The retreat DtUserTask takes one argument from the "Argument 1" box
//of the DtUserTask dialog. If it is set to "hold ground", entities set to
//retreat will not start moving untill their underFire flag is set.
//
//To enable an entity to retreat, there must be an entry for
//"retreat-controller" in its controller list in the object parameters
//database. The following sample can be used:
//
//       (controllers
//          ...
//          (retreat
//             (component-descriptor-type "component-descriptor")
//             (component-type  "retreat-controller")
//          )
//           ...
//       )
//
//     (connections
//        ....
//        (connect retreat:automotive-control powertrain:automotive-control)
//        ...
//     )
//

#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfmodel/groundAutoControllerComponent.h"

//String which uniquely identifies this controller
const char TestRetreatControllerType[] = "retreat-controller";

class DtRetreatController : public DtGroundAutoControllerComponent
{
public:
   //constructor
   DtRetreatController(const DtString & name, DtLocalObject* owner, 
      DtSimulationServices * simManager, DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry * parentRegistry = 0);

   //destructor
   virtual ~DtRetreatController() override;

   //copy constructor
   DtRetreatController(const DtRetreatController& orig);

   //assignment operator
   DtRetreatController& operator=(const DtRetreatController& orig);

   //This returns the string TestRetreatControllerType (defined above),
   //used to uniquely identify the type of component.
   virtual const char* type() const override;

   //Register a callback for notification of DtUserTask tasks.
   virtual void registerTaskMsgCallbacks() override;

   //Callback function (registered in registerTaskMsgCallbacks()) for
   //DtRetreat task messages. Calls processRetreatTask() to actually handle
   //the task.
   static void retreatTaskCallback(DtSimMessage * msg, void * usr);

   //Callback function (registered in registerTaskMsgCallbacks()) for
   //DtUserTask messages. Calls processUserTask() to actually handle
   //the task.
   static void userTaskCallback(DtSimMessage * msg, void * usr);

   //Called by retreatTaskCallback() when a new DtRetreatTask message is
   //received.
   virtual void processRetreatTask(DtSimMessage * msg);

   //Called by userTaskCallback() when a new DtRetreatTask message is
   //received.
   virtual void processUserTask(DtSimMessage * msg);

   //Update control values
   virtual void tick() override;

   //This is called by the factory
   static DtSimComponent* creator(const DtString & name, DtLocalObject* owner,
      DtSimulationServices * simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry * parentRegistry);

   //Determine which way to flee based on the current target
   virtual double getHeading();

   //Returns the amount of fuel left.  If no fuel left, can no longer retreat
   virtual double fuelLeft() const;

protected:
   DtReal myCurrentHeading;
   //determined by DtUserTask arg1, see above
   bool myHoldGround;
};