include/bhaveSim/spawnController.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/cntrlCmpnt.h"
#include <bhaveSim/bhaveSimDefines.h>

#include "vrfcore/vrfSimSettingsManager.h"
#include "makSettingsManager/settingsObject.h"
#include "makSettingsManager/boolSetting.h"
#include <vrfmsgs/rwSpawnData.h>
#include <vrfobjcore/vrfObjMgr.h>

class DtString;
class DtVrfObject;
class DtSimManager;
class DtVrfObjectMessage;
class DtRwObjectTypeInfo;

namespace BHAVE
{

const char DtSpawnControllerType[] = "spawn-controller";

class DtSpawnControllerDescriptor;
class DtSpawnControllerPSR;

class DT_DLL_bhaveSim DtSpawnController : public DtControllerComponent
{
public:

//****************************************************************************
//****************************************************************************
   DtSpawnController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSpawnController();

   virtual DtString type() const;

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

//****************************************************************************
//****************************************************************************
   static  void settingConsumerCallback(const DtSettingsObject* settingsObject,
      void* usr);


   virtual void registerTaskMsgCallbacks();

   virtual void unregisterTaskMsgCallbacks();

   virtual bool init();

protected:
   virtual void processSetting(const DtBoolSetting* setting);

   virtual DtSpawnControllerPSR* createPSR();


//****************************************************************************
//****************************************************************************
   static void updateSpawnInstanceCallback(const DtVrfObjectMessage * msg, 
      void* usr);
   virtual void processUpdateSpawnInstanceCallback(
      const DtVrfObjectMessage * msg);

   static void setTemplateNameCallback(const DtVrfObjectMessage * msg, 
      void* usr);
   virtual void processSetTemplateNameCallback(const DtVrfObjectMessage * msg);

   static void requestSpawnPtDataCallback(const DtVrfObjectMessage * msg, 
      void* usr);
   virtual void processRequestSpawnPtDataCallback(const DtVrfObjectMessage * msg);

   static void objectRemovedCallback(DtVrfObject* object, void* usr);
   virtual void processObjectRemoved(DtVrfObject *object);

   static void objectRenamedCallback(
      const DtVrfObjectNameChangedCallbackInfo& info,
      void* usr);
   virtual void processObjectRenamed(
      const DtVrfObjectNameChangedCallbackInfo& info);

//****************************************************************************
//****************************************************************************
public:
   virtual void tick();

   const DtRwSpawnData& spawnParameters() const;

   void setSpawnParameters(const DtRwSpawnData& params);

protected:

//****************************************************************************
//****************************************************************************
   virtual std::list<DtVrfObject*> testAndSinkTraffic();
   virtual bool shouldSinkObject(DtVrfObject* trafficObject, 
      DtVrfObject* sinkPoint);
   virtual void deleteObjects(const std::list<DtVrfObject*>& objectList);

   virtual bool canCreateNow(DtTime timeNow) const;

   virtual DtString findSinkPoint();

   virtual DtTime nextCreationTime(DtTime timeNow);

   virtual DtVrfObject* createObject(DtVrfObject* sinkPoint,
      DtVrfObject* objectToRecycle = 0);
   virtual DtVector creationLocationAndOrientation(double& heading,
      DtVrfObject* sinkPoint);

   virtual void createAndSendDefaultPlan(DtVrfObject* obj, const DtString& sinkName);
   virtual double trafficSpeed();

   virtual void sendEntityPlan(DtVrfObject *entity, const DtPlan& plan);

   virtual bool trafficObjectType(DtRwObjectTypeInfo& objType);

private:
   DtSpawnController();

   DtSpawnController(const DtSpawnController& orig);

   const DtSpawnController & operator=(const DtSpawnController & orig);


protected:

   bool myFirstTick;

   DtSpawnControllerPSR* myProcessState;
   const DtSpawnControllerDescriptor* myTrafficSourceDescriptor;
   bool myDrivingOnLeftEnabled;
   DtReal mySinkPointRadiusSq;
};
}