surfaceEntityPatrolBetweenController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfmodel/surfaceEntityMoveToController.h"

#include <vlutil/vlString.h>

class DtSimulationServices;
class DtSimMessage;


#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtSurfaceEntityPatrolBetweenController : 
   public DtSurfaceEntityMoveToController
{
public:

   DtSurfaceEntityPatrolBetweenController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSurfaceEntityPatrolBetweenController();

   static DtSimComponent * creator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual const char* type() const;

   static void patrolBetweenCallback(DtSimMessage * msg, void * usrData);

   virtual void processPatrolBetweenTask(DtSimMessage * msg);

   virtual void tick();

   virtual DtUUID firstWaypoint() const;
   virtual void setFirstWaypoint(const DtUUID& waypoint);

   virtual DtUUID secondWaypoint() const;
   virtual void setSecondWaypoint(const DtUUID& waypoint);

   virtual bool atGoal();

   virtual bool passedGoal();

   virtual void controlMovement();

protected:
   virtual void registerTaskMsgCallbacks();

   DtSurfaceEntityPatrolBetweenController();

   DtSurfaceEntityPatrolBetweenController
      (const DtSurfaceEntityPatrolBetweenController & orig);

   const DtSurfaceEntityPatrolBetweenController & operator=
      (const DtSurfaceEntityPatrolBetweenController & orig);
};