railPathController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/singleTaskControllerComponent.h"
#include <matrix/vlVector.h>
#include "vrftasks/setDataReq.h"
#include "vrfutil/railSegment.h"

class DtRailPathTask;
class DtRailPathControllerPSR;
class DtRailPathControllerDescriptor;
class DtAsyncJobToken;

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtRailPathController : public DtSingleTaskControllerComponent
{
private:
   DtRailPathController();
   DtRailPathController(const DtRailPathController& orig);
   DtRailPathController& operator=(const DtRailPathController& orig);

public:

   DtRailPathController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtRailPathController();

   virtual bool init();

   virtual bool createPSR();

   virtual void preFirstTickInit();

   virtual bool beginProcessingTask(const DtTaskMessage& msg, DtSimTaskStatePtr taskState);

   virtual DtString type() const;

   virtual void registerTaskMsgCallbacks();

   static void taskCompleteReportCallback(DtSimMessage* msg, void* usr);

   virtual void processTaskCompleteReport(DtSimMessage* msg);

   static void destinationChangedCallback(DtVrfObject* obj, void* usrData);

   virtual void processDestinationChanged(DtVrfObject* obj);


   static void objectAboutToBeRemovedCallback(DtVrfObject* obj, void* usr);
   virtual void processObjectAboutToBeRemoved(DtVrfObject* obj);


   static void setLocationCompleteCallback(DtVrfObject*, void* usr);
   virtual void processSetLocationComplete();

   virtual void tick();

protected:
   virtual void clearCurrentPath();
   virtual bool setupPathFromRailList(DtRailSegmentList*, bool testRange = true);
   virtual bool setupPathFromRoute(DtVrfObject* route, bool startClosestPoint, DtIteratorDirection traversalDirection);

   virtual bool isEntityCloseEnoughToRoad(
      DtRailSegment* railSegment, double distance, double& actualDistSq) const;

   double maxSearchRadius(const DtVector& start, const DtVector& end);

   virtual void registerDestinationChangedCallback();

   virtual void unregisterDestinationChangedCallback();

   virtual DtVrfObject* publishDebugPath(DtRailSegmentList*);

   virtual void removeDebugPath();

   virtual bool setupPathToDestination(const DtVector& start, const DtVector& end);

   virtual void clearTask();

public:

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

protected:
   DtAsyncJobToken* myPathJobToken;

   DtRailPathControllerPSR* myProcessState;

   const DtRailPathControllerDescriptor* myPathDescriptor;
   bool myDestinationChangedCallbackRegistered; 
};