spawnController.h

Go to the documentation of this file.

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


#pragma once

#include <vrfmodel/vrfmodelDefines.h>
#include <vrfcore/vrfSimSettingsManager.h>
#include <vrfcore/createObjectHandle.h>
#include <vrfmsgs/rwSpawnData.h>
#include <vrfobjcore/controllerComponent.h>
#include <vrfobjcore/tacticalGraphicLocalObjectFacade.h>

#include <makSettingsManager/settingsObject.h>
#include <makSettingsManager/boolSetting.h>

#include <tbb/mutex.h>

class DtString;
class DtSimulationServices;
class DtVrfObjectMessage;
class DtRwEntityTypeInfo;
class DtSimMessage;
class DtCollisionDetector;

class DtSpawnControllerDescriptor;
class DtSpawnControllerPSR;
class DtVrfOverlayObjectStateRepository;
class DtVrfLocalObjectCreateInformation;

class DT_DLL_vrfmodel DtSpawnController : public DtControllerComponent
{
public:

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

   virtual ~DtSpawnController() override;

   virtual const char* type() const override;

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

   const DtString& templateName() const;

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


   virtual void registerTaskMsgCallbacks();

   virtual void unregisterTaskMsgCallbacks();

   virtual bool init() override;
   virtual void refreshSpawnTemplateData();

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

   virtual DtSpawnControllerPSR* createPSR();

   virtual DtCollisionDetector* createCollisionDetector();

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

   static void setTemplateUUIDCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSetTemplateUUIDCallback(const DtVrfObjectMessage * msg);

   virtual void processSimObjectDeleted(DtSimObjectReference ref);

   virtual void embarkIfSpawnAttached(DtVrfLocalObjectCreateInformation& info);

//****************************************************************************
//****************************************************************************
public:
   virtual void preFirstTickInit() override;

   virtual void tick() override;

protected:

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

   virtual bool canCreateNow(DtTime timeNow, DtRwSpawnData* spawnData) const;

   virtual DtUUID findSinkPoint();

   virtual DtTime nextCreationTime(DtTime timeNow, DtRwSpawnData* spawnData);

   virtual DtCreateObjectHandle createObject(const DtUUID& spawnObjectUUID, const DtSimObject* sinkPoint, const DtRwSpawnData* spawnData,
       bool& dataAvailable, const DtPlan& entityPlan);
   virtual DtVector creationLocationAndOrientation(double& heading,
      const DtSimObject* sinkPoint, const DtRwSpawnData* spawnData, bool& dataAvailable);

   virtual DtPlan createDefaultPlan(const DtUUID& objectUUID, const DtUUID& sinkPoint, DtRwSpawnData* spawnData);

   virtual double trafficSpeed(DtRwSpawnData* spawnData);

   virtual bool trafficObjectType(DtRwEntityTypeInfo& objType, const DtRwSpawnData* spawnData);

   void findClosestRoadSpawnPoints();

   static void clearTemplatesCallback(void* user);
   virtual void processClearTemplates();

   static void refreshSpawnTemplateDataCallback(void* user);
   virtual void processRefreshSpawnTemplateData();

   virtual bool startLocationTaken(const DtSimObject*, const DtVector& geocentricLocation);
   virtual bool startLocationTaken(const DtEntityType&, const DtVector& geocentricLocation);

protected:

   virtual DtRwSpawnData* lookupSpawnTemplateData();

private:
   DtSpawnController();

   DtSpawnController(const DtSpawnController& orig);

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


protected:

   DtSpawnControllerPSR* myProcessState;
   const DtSpawnControllerDescriptor* myTrafficSourceDescriptor;
   bool myDrivingOnLeftEnabled;
   DtReal mySinkPointRadiusSq;
   
   DtPoint myCachedLocation;
   bool myFoundRoadPoints;
   DtPoint myClosestRoadPoint;
   DtPoint myClosestRoadEdgeA;
   DtPoint myClosestRoadEdgeB;

   bool myShowRoadDistanceWarning;
   bool myDataReady;

   int myAwaitingToBeCreated;
   bool myWarnedOnce;
   bool myWarnedSinkOnce;
   //DtRwSpawnData* mySpawnTemplateData;

   DtVrfOverlayObjectStateRepository* myStateRepository;
   DtCollisionDetector* myCollisionDetector;

   float myScaleFactor;

   boost::signals2::scoped_connection mySimObjectDeletedConnection;
   DtTacticalGraphicLocalObjectFacade myTacticalGraphicLocalObjectFacade;
   tbb::mutex myRemovalMutex;
};