DtOsgEarthDynamicFidManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/DtDynamicFidManager.h>
#include <vrvOsg/DtOsgEarthFeatureDataBroker.h>

#include <vrvCore/DtTickable.h>

#include <vrvUtil/DtVirtualBaseClassCreator.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <matrix/vlVector.h>
#include <map>
#include <deque>
#include <boost/bind/bind.hpp>

namespace makVrv
{
   class DtProp;
   class DtIntersector;
   class DtTerrainPatchObject;
   class DtOsgEarthDynamicFidManager;
   class DtOsgEarthDynamicFidManagerCallback;
   class DtOsgEarthDynamicFidManagerTickable;

   // Subclass of DtDynamicFidManager to operate within VRV.
   class DT_DLL_VRVOSG DtOsgEarthDynamicFidManager : public DtDynamicFidManager
   {
   protected:
      // Subclass of DtDynamicFidEntry which adds storage for the debris model created as a DtProp.
      class DtOsgEarthDynamicFidEntry : public makVrv::DtDynamicFidEntry
      {
      public:
         DtOsgEarthDynamicFidEntry(makVrv::DtFid fid);
         virtual ~DtOsgEarthDynamicFidEntry() {};

         // Set the debris model.  Setting a nullptr will clear the debris.
         void setDebris(DtProp* debris);
         DtProp* debris();
      protected:
         DtProp* myDebrisProp;
      };

   public:
      typedef std::function< DtProp* (const std::string& modelDefinition, const DtVector& center, double orientation) > DtAddPropFcn;

   public:
      DtOsgEarthDynamicFidManager( osgEarth::MapNode* mapNode, DtDe& de );

      // Default CTOR - Not Allowed
      DtOsgEarthDynamicFidManager() = delete;

      // Copy CTOR - Not Allowed
      DtOsgEarthDynamicFidManager( DtOsgEarthDynamicFidManager& ) = delete;

      // Move CTOR - Not Allowed
      DtOsgEarthDynamicFidManager( DtOsgEarthDynamicFidManager&& ) = delete;

      // Copy Assignment - Not Allowed
      DtOsgEarthDynamicFidManager& operator=( DtOsgEarthDynamicFidManager& ) = delete;

      // Move Assignment - Not Allowed
      DtOsgEarthDynamicFidManager& operator=( DtOsgEarthDynamicFidManager&& ) = delete;

      virtual ~DtOsgEarthDynamicFidManager();

   public:
      // Adds a change to the system potentially hiding buildings and replacing them with debris.
      // Uses the DtOsgUtils::COMMAND_UID property of the changeCommand to index and track it for removal.
      virtual void addChangeRequest(const makVrv::DtDynamicTerrainChange& changeCommand);
      // Removes a previously added change to the system.
      // Uses the DtOsgUtils::COMMAND_UID to locate the previouslly added change.
      virtual void removeChange(const makVrv::DtDynamicTerrainChange& changeCommand);

      // Sets the function to use to add props to the system.  Must be set after initializing 
      // for the debris models to be added when buildings are destroyed.
      virtual void setAddPropFcn(DtAddPropFcn fcn);

      virtual void reapplyChangesIfRequired() override;
   protected:
      // Called whenever a fid entry changes to the destroyed state.
      virtual void destroyFids(const std::vector<DtDynamicFidEntry*>& fidEntries) override;
      // Called whenever a fid entry is restored from the destroyed state to the normal state.
      virtual void resotreFids(const std::vector<DtDynamicFidEntry*>& fidEntries) override;

      virtual osgEarth::MapNode* mapNode() override;

      // Create and return DtOsgEarthDynamicFidEntry
      virtual makVrv::DtDynamicFidEntry* createDynamicFidEntry(makVrv::DtFid fid) override;

      std::string getCommandId(const DtDynamicTerrainChange& changeCommand);

      void installCallbackOnTerrainPatchIfNeeded(DtTerrainPatchObject&);

      osgEarth::MapNode* myMapNode;
      DtDe& myDe;
      DtAddPropFcn myAddPropFcn;
      std::map<std::string, DtDynamicFidChangeId> myCommandId2ChangeIdMap;
      DtIntersector* myIntersector;

      mutable tbb::spin_mutex myMutex;

      DtSignalConnectionManager myConnections;

      osg::ref_ptr<DtOsgEarthDynamicFidManagerCallback> myPagingCallback;
      DtOsgEarthDynamicFidManagerTickable* myReapplyChangesTickable;
   };
}