DtAddTerrainPatchManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtHeaderParser.h>

#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>
#include <vrvUtil/DtUnicode.h>

namespace makVrv
{
   class DtSetVisibilityInterface;
   class DtTerrainPatchObject;

   class DT_DLL_VRVCORE DtAddTerrainPatchManager
      : public DtVirtualBaseClass
   {
   public:

      enum class AlphaToCoverageState
      {
         USE_GLOBAL, // use the global setting
         FORCE_OFF,  // force alpha to coverage off
         FORCE_ON    // force alpha to coverage on for this model
      };

      enum class TerrainCoordinateSystemEnum
      {
         None,
         Geocentric,
         UTM,
         Lambert,
         FlatEarth,
         Cartesian
      };

      enum class AddTerrainPatchStatus
      {
         NoError,
         LimitedSupportFileType,
         UnsupportedFileType,
         ProcessHeaderFailed,
         MoreThanOneOsgEarthTerrainPatch
      };

      class TerrainPatchFile
      {
      public:
         TerrainPatchFile()
            : myStatus(AddTerrainPatchStatus::NoError)
         {
            // intentional no-op
         }

         AddTerrainPatchStatus myStatus;
         DtHeaderParser::TerrainPatchRecords myTerrainPatchRecords;
      };

   public:
      virtual void addFilePaths(const std::vector<std::string>& filePaths);

      virtual bool terrainPatchAddStatus(const std::string filePath, AddTerrainPatchStatus& status) const;

      virtual void removeFilePaths(const std::vector<std::string>& filePaths);

      virtual void removeAllFilePaths();

      virtual std::vector<std::string> filePathsToAdd() const;

      virtual void setDdsFlip(const std::string& filePath, bool ddsFlip);

      virtual void setAlphaToCoverage(const std::string& filePath, AlphaToCoverageState a2cState);

      virtual void setIndirectEnabled(const std::string& filePath, bool enabled);

      virtual void addTerrainPatches();

      boost::signalslib::signal<void(std::map<std::string, TerrainPatchFile> filesToAdd)> signal_terrainPatchesToAddUpdated;
      boost::signalslib::signal<void(const std::string& filePath, bool flipDds)> signal_ddsFlipEnabledUpdated;
      boost::signalslib::signal<void(const std::string& filePath, bool indirectEnabled)> signal_indirectRenderingEnabledUpdated;
      boost::signalslib::signal<void(const std::string& filePath, AlphaToCoverageState a2cState)> signal_alphaToCoverageStateUpdated;
      boost::signalslib::signal<void(const std::string& coordSysType, const std::string& coordSysParams)> signal_coordinateSystemUpdated;

   public:
      static DtAddTerrainPatchManager& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtAddTerrainPatchManager* instance);

      static DtAddTerrainPatchManager::TerrainCoordinateSystemEnum coordSysStrToEnum(const std::string& coordSys);

      static DtUnicode statusDisplayText(AddTerrainPatchStatus addStatus);

   protected:

      DtAddTerrainPatchManager(DtDe& de);

      virtual bool isOsgEarthTerrain(const std::string& fileName);

      virtual bool processTerrainPatchHeader(const std::string& filePath,
         AddTerrainPatchStatus& msg);

      virtual void slot_terrainPatchCreated(DtTerrainPatchObject& terrainPatchObject);
      
      virtual void slot_terrainPatchAboutToBeDeleted(DtTerrainPatchObject& terrainPatchObject);

      virtual void enforceOnlyOneOsgEarthTerrainPatchConstraint();

   protected:
      DtDe& myDe;

      DtSignalConnectionManager myConnections;

      bool myOsgEarthTerrainPatchToBeAdded;
      bool myTerrainHasOsgEarthTerrainPatch;

      std::map<std::string, TerrainPatchFile> myFilesToAdd;
   };

}