DtOsgRenderer.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/vrvOsg.h>
#include <vrvOsg/DtSceneRoot.h>
#include <vrvOsg/DtOsgGlobalShaderComponent.h>
#include <vrvOsg/DtMultiViewData.h>

#include <vrvCore/DtRenderer.h>

#include <osg/OperationThread>
#include <osgUtil/RenderBin>
#include <osgViewer/Viewer>

#include <vector>
#include <string>

namespace osg
{
   class Group;
   class Node;
   class Camera;
}

namespace osgViewer
{
   class CompositeViewer;
}

namespace osgShadow
{
   class ShadowedScene;
}

namespace osgEarth
{
   class MapNode;
}

namespace makVrv
{
   class DtStatsSet;
   class DtChannel;
   class DtOsgChannel;
   class DtEffectManager;
   class DtFontManager;
   class DtOsgWindowManager;
   class DtOsgProfilerOverlay;
   class DtOsgPerformanceStatsOverlay;
   class DtFastMatrixTransform;
   class DtSceneGraph;
   class DtOsgGlobalShaderComponent;
   class DtOsgCullVisitor;
   class DtShadowSettingsObject;
   class DtTaxiwaySignManager;
   class DtRunwayMarkingManager;
   class DtLightIndicatorManager;
   class DtMainThreadJobsManager;
   class DtImGuiLoaderStatsData;
   class DtImguiHelper;
   
   class DT_DLL_VRVOSG DtOsgProfiledGroup : public osg::Group
   {
   public:
      DtOsgProfiledGroup(const char * stat_group_name, const char * profile_name);
      virtual void traverse(osg::NodeVisitor& nv);
   protected:
      const char* myStatGroupName;
      const char* myTraverseName;
   };


   class DT_DLL_VRVOSG DtOsgRenderer : public DtRenderer
   {
   public:
      friend class DtSceneGraph;
      friend class DtOsgRendererCreator;
      friend class DtSceneGraphTreeLogic;

      //Render bin definitions.
      const static int SKY_RENDERBIN = -10;
      const static int DEFAULT_RENDERBIN = 0;
      const static int DEPTH_ONLY_RENDERBIN = 5;
      const static int OCEAN_RENDERBIN = 6;
      const static int LIGHTPOINT_RENDERBIN = 7;
      const static int CLOUD_RENDERBIN = 8;
      const static int OCCLUSION_RENDERBIN = 9;
      const static int DEFAULT_TRANSPARENT_RENDERBIN = 10; // this has to be 10 otherwise everything goes south, the rest are more flexible
      const static int COCKPIT_RENDERBIN = 25;

      //Render bin names
      static const std::string AlphaToCoverageBin;
      static const std::string SkyBin;
      static const std::string DepthOnlyBin;
      static const std::string OceanBin;
      static const std::string LightPointBin;
      static const std::string CloudBin;
      static const std::string OcclusionRenderBin;
      static const std::string CockpitBin;

      static DtOsgRenderer* findInstance(DtDe& de);

      virtual ~DtOsgRenderer();

      virtual void cleanup() override;

      virtual void update();

      virtual void render();

      virtual bool viewExists() const;

      virtual void resetSceneGraph();

      virtual void removeChannelRoot(DtChannel* channel);

      virtual bool isSceneRootEmpty(const DtSceneRoot& sr);

      virtual void addNodeToRoot(osg::Node* node, const DtSceneRoot& sr, bool createOnAccess = true);

      virtual void addSceneRootToRoot(const DtSceneRoot& childRoot, const DtSceneRoot& parentRoot, bool createOnAccess = true);

      virtual void removeNodeFromRoot(osg::Node* node, const DtSceneRoot& sr);

      virtual void removeSceneRootFromRoot(const DtSceneRoot& childRoot, const DtSceneRoot& parentRoot);

      virtual void traverseRoot(osg::NodeVisitor& nv, const DtSceneRoot& sr);

      virtual void setSceneRootNodeMask(const DtSceneRoot& sr,
         osg::Node::NodeMask nodemask);

      virtual osg::Node::NodeMask sceneRootNodeMask(const DtSceneRoot& sr);

      virtual osg::BoundingSphere sceneRootBound(const DtSceneRoot& sr);

      virtual osg::BoundingSphere sceneRootListBound(const DtSceneRootList& srList);

      virtual void addChannelToModelSetRoot(int modelSetId,
         DtChannel* channel);

      virtual void removeChannelFromModelSetRoot(int modelSetId,
         DtChannel* channel);

      virtual void addChannelToVisualizerRoot(int modelSetId,
         int visualizerType, DtChannel* channel);

      virtual void removeChannelFromVisualizerRoot(int modelSetId,
         int visualizerType, DtChannel* channel);

      virtual void setSceneDataToRenderRoot(osgViewer::View& view);

      virtual void addSceneToCamera(osg::Camera* camera);

      virtual void addSceneRootToNode(const DtSceneRoot& sr,
         osg::Group* node, bool createOnAccess = true);

      virtual osg::Group* findSceneRootChildByName(const DtSceneRoot& parent,
         const std::string& rootName);

      virtual bool matchesSceneRoot(const DtSceneRoot& sr, osg::Group* group);

      virtual void releaseResources()
      {
         releaseResources(0);
      }

      virtual void releaseResources(osg::State* state);

      void setRootNode(osg::Group*, bool copyChildrenFromOldRoot);

      void resetRoot();

      void registerPagedLODs(osg::Node* node);

      void clearPagedLODs();

      virtual void setWireframeRendering(bool enabled);

      virtual void setDdsFlip(bool flip);

      virtual bool wireframeRendering() const;

      virtual void setShadowState(bool enabled);

      virtual bool shadowsEnabled() const;

      // ! Get global multiview vr mode
      virtual bool multiViewVrEnabled() const;

      // ! Set global multiview vr mode, doesn't actually enable it, just indicates it is enabled
      virtual void setMultiViewVrEnabled(bool enabled);

      // ! Get reference to  multiview data for specific camera
      virtual DtMultiViewData& getOrCreateMultiViewData(osg::Camera* camera);

      void setTerrainScalingEnabled(bool enabled);

      void setTerrainScaleFactor(double scaleFactor);

      virtual bool makeContextCurrent();

      DtFontManager& fontManager();
      const DtFontManager& fontManager() const;

      DtEffectManager& effectManager();
      const DtEffectManager& effectManager() const;

      boost::signalslib::signal< void(int modelSet, int visualType) > signal_visualizerRootAdded;
      boost::signalslib::signal< void(DtChannel*) > signal_channelRootAdded;

      boost::signalslib::signal< void(bool active) > signal_treeProfilingChanged;
      boost::signalslib::signal< void(bool active) > signal_diguyProfilingChanged;

      boost::signalslib::signal< void() > signal_shadowsRemoved;

      virtual void debugDrawBox(const osg::Vec3& center, const osg::Vec3& extents);

      virtual void debugDrawBox(const osg::Vec3& center, const osg::Vec3& extents, const osg::Quat& orientation);

      virtual void setChannelShadowState(DtOsgChannel* osgChannel, bool enable);

      virtual bool channelShadowSettings(DtOsgChannel* osgChannel, DtShadowSettingsObject** shadowSettingObject, bool* isPlanView) const;

      virtual bool channelCloudShadowMap(DtOsgChannel* osgChannel, unsigned int* textureIndex, osg::Matrix* textureViewProjMatrix,
         unsigned int* textureIndex2, osg::Matrix* textureViewProjMatrix2) const;

      virtual bool cameraCloudShadowMap(osg::Camera* camera, unsigned int* textureIndex, osg::Matrix* textureViewProjMatrix,
         unsigned int* textureIndex2, osg::Matrix* textureViewProjMatrix2) const;

      osg::StateSet* sgRenderRootStateSet();

      // structure to expedite culling. We need to clear any memory
      // that this structure caches to decrement reference count of 
      // StateSets (and hence drawables, textures, etc) when scene
      // changes completely (e.g. on post processor turned off/on)
      // so that memory can be reclaimed
      // This helper function accomplishes that
      void clearStateGraphForAllChannels(void);

      virtual void addMainThreadPersistantJob(osg::Operation * opp);

      virtual void removeMainThreadPersistantJob(osg::Operation * opp);

      virtual void addMainThreadPreDrawJob(osg::Operation * opp);

      virtual void addParallelThreadCullJob(osg::Operation * opp);

      virtual void removeParallelThreadCullJob(osg::Operation* opp);
      
      virtual void addParallelThreadSwapBufferJob(osg::Operation * opp);

      virtual bool addMainThreadTransientJob(osg::Operation * operation, bool requiredThisFrame);

      virtual void launchPreCullTasks(DtOsgCullVisitor* cv);

      virtual void launchSwapBufferTasks();

      virtual DtMainThreadJobsManager * createJobsManager();

      virtual int alphaToCoverageRenderBin();

   public:
      //@ {
      static DtSceneRoot renderRoot();
      static DtSceneRoot environmentRoot(); 
      static DtSceneRoot terrainRoot();
      static DtSceneRoot minimapTerrainRoot();
      static DtSceneRoot minimapFallbackTerrainRoot();
      static DtSceneRoot propRoot();
      static DtSceneRoot intersectOnlyPropRoot();
      static DtSceneRoot oceanRoot();
      static DtSceneRoot intersectOnlyRoot(int modelSet)
      {
         return DtSceneRoot(DtSceneRoot::IntersectOnlyModelSetSpecific, modelSet);
      }
      static DtSceneRoot normalizedOverlayRoot();
      static DtSceneRoot modelSetRoot(int modelSet)
      {
         return DtSceneRoot(modelSet);
      }
      static DtSceneRoot visualizerTypeRoot(int modelSet, int visualizerType)
      {
         return DtSceneRoot(modelSet, visualizerType);
      }
      static DtSceneRoot channelRoot(int modelSet, DtChannel* channel)
      {
         return DtSceneRoot(modelSet, channel);
      }
      //@ }

      static const std::string& shadowedSceneName(void)
      {
          return theShadowedSceneName;
      }


      osg::Group* sgRenderRoot();

      osg::Group* sgEnvironmentRoot();

      osg::Group* sgPropsRoot();

      osg::Group* sgIntersectoOnlyPropsRoot();

      osg::Group* sgTerrainRoot();

      osg::Group* sgScaledTerrainRoot();

      osg::Group* sgScaledPropsRoot();

      osg::Group* sgMinimapTerrainRoot();

      osg::Group* sgMinimapFallbackTerrainRoot(bool createOnAccess);

      osg::Group* sgNormalizedOverlayRoot();

      osg::Group* sgStatic3dDebugRoot();

      osg::Group* sgOceanRoot();
      
      virtual osg::Group* modelSetSpecificShadowRoot(int modelSet);
      
      virtual osgShadow::ShadowedScene*
          modelSetSpecificShadowScene(int modelSet);

      osg::Group* sgIntersectOnlyRoot(int modelSet);

      virtual osgViewer::ViewerBase& viewer();

      // Use for the DtMainThreadJobsManager to tell the DtOsgRenderer that
      // is has been destructed
      virtual void clearMainThreadJobsManager();

      virtual DtImGuiLoaderStatsData* getLoaderStatsData();

      DtMainThreadJobsManager* mainThreadJobsManager();

      virtual void addIntStat(const std::string& name, int value);
      virtual void addFloatStat(const std::string& name, float value);

      virtual void addIntStat(const std::string& subsystem, const std::string& name, int value);
      virtual void addFloatStat(const std::string& subsystem, const std::string& name, float value);

      virtual DtImguiHelper* imGuiHelper() { return myImGuiHelper; }

      virtual unsigned int numActiveThreads();

      void advanceTime();

   protected:

      virtual void moveRootToShadowRoot(const DtSceneRoot& targetRoot,
         osg::Group* shadowRoot, osg::Group* modelSetRoot);


      DtOsgRenderer(DtDe& de);


      osg::Group* sgModelSetRoot(int modelSet);

      osg::Group* sgVisualizerRoot(int modelSet, int visualizerType,
         bool createOnAccess = true);

      osg::Group* sgChannelRoot(int modelSet,
         DtChannel* channel, bool createOnAccess = true);

      void slot_onViewCreated();

      void slot_onViewToBeDestroyed();

      void slot_onWireframeModeChanged(bool mode);

      void slot_onDdsFlipChanged(bool flip);

      void slot_onOcclusionCullingChanged(bool enabled);

      void slot_onShadowStateChanged(bool shadowMode);

      void slot_onTerrainScalingEnabledChanged(bool enabled);

      void slot_onTerrainScaleFactorChanged(double scaleFactor);

      void slot_onCoordinateSystemChanged(const std::string& coordinateSystemType);

      void updateSceneGraph();

      void clearEmptyWindows();

      void clearFrameBufferIfChannelChanged();

      virtual void removeShadows();

      virtual void createShadowRoots();

      virtual bool exportTerrainAndProps(const std::string&);

      virtual osg::Group* createModelSetRoot(int modelSet);
      virtual osg::Group* createVisualizerRoot(int modelSet,
         int visualizer);

      virtual osg::Group* createChannelRoot(int modelSet, DtChannel*);

      virtual osgShadow::ShadowedScene*
         createModelSetSpecificShadowRootAndScene(int modelSet);

      virtual void updateTerrainScaling();

      virtual void initAerodromeManagers();
      virtual void updateAerodrome();

      // replace currentChild in all its parents with newChild
      void swapChildren(osg::Node* currentChild, osg::Node* newChild);

      void postInitialize();

      void setupAtcVirtualProgram();

      virtual void processBackgroundLoaderIcoTasks();

      virtual void runMainThreadJobs(double timeBudget);

   protected:
      static int numDatabasePagerThreads(osgViewer::CompositeViewer& viewer);

      static void plotHistogram(float frame_duration, int paging_threads, int mipthreads);


   protected:
      DtSceneGraph* mySceneGraph;

      DtFontManager*  myFontManager;
      DtEffectManager* myEffectManager;

      DtOsgWindowManager* myOsgWindowManager;

      osg::ref_ptr<osgViewer::Viewer> myDefaultViewer;

      // This the top of the render graph
      osg::ref_ptr<osg::Group> myRenderRoot;

      osg::ref_ptr<osg::Group> myDebugRoot;

      osg::ref_ptr<osg::Group> myNormalizedOverlayRoot;

     osg::ref_ptr<osg::Group> myStatic3dDebugRoot;

      osg::ref_ptr<osg::Geode> myDebugBox;

      // This goes directly below the root, and sets the environment (such as sky)
      osg::ref_ptr<osg::Group> myEnvironmentRoot;

      // attached under each modelset root except the minimap modelset root, terrains are placed here
      osg::ref_ptr<osg::Group> myTerrainRoot;

      // attached under each minimap modelset root, minimap terrains are placed here
      osg::ref_ptr<osg::Group> myMinimapTerrainRoot;

      // attached under each minimap terrain root, terrain/props/ocean root is placed her for when
      // a minimap terrain patch isn't included in a terrain definition
      osg::ref_ptr<osg::Group> myMinimapFallbackTerrainRoot;

      // attached under each modelset root,  props are placed here
      osg::ref_ptr<osg::Group> myPropsRoot;

      //root for props that should only be intersected and not rendered (indirected)
      osg::ref_ptr<osg::Group> myIntersectOnlyPropsRoot;

      // root for triton
      osg::ref_ptr<osg::Group> myOceanRoot;

      // when terrain scaling is enabled, this is placed above the
      // terrain root
      osg::ref_ptr<DtFastMatrixTransform> myScaledTerrainRoot;

      // when terrain scaling is enabled, this is placed above the
      // props root
      osg::ref_ptr<DtFastMatrixTransform> myScaledPropsRoot;

      osg::Matrix myScaleMatrix;

      // shadows and visual type roots are done one per model set
      typedef boost::unordered_map<int, osg::ref_ptr<osg::Group> > RootMap;
      typedef boost::unordered_map<int, osg::ref_ptr<osgShadow::ShadowedScene> > ShadowedSceneMap;

      typedef int ModelSet;
      typedef int VisualizerType;

      // There is one group for each model set, which is either an osg::Group
      // or a DtChannelSpecificGroup
      typedef boost::unordered_map < ModelSet, osg::ref_ptr<osg::Group> >
         ModelSetRootMap;

      typedef boost::unordered_map < VisualizerType, osg::ref_ptr<osg::Group> >
         VisualizerTypeRootMap;

      typedef boost::unordered_map < ModelSet, VisualizerTypeRootMap >
         ModelSetVisualizerTypeRootMap;


      // This is a map of the model set  roots.  CWhen a channel uses a model set 
      // (or more correctly, when a channel's observer uses a model set) the
      // channel subscribes to the appropriate one of these
      ModelSetRootMap myModelSetMap;

      //Map to roots that are intersect only on a per model set basis
      ModelSetRootMap myIntersectOnlyRootMap;


      // Under each model set root is a root for each visualizer type.  This map
      // provides another map, by model set, of the roots for each visual type
      ModelSetVisualizerTypeRootMap myVisualizerRootMap;

      // This is a map of channel roots by model set.  Each channel root is a unique
      typedef boost::unordered_map < DtChannel*, ModelSetRootMap >
         ChannelRootMap;

      ChannelRootMap myChannelRootMap;
      ShadowedSceneMap myShadowedSceneMap;
      RootMap myShadowRootMap;

      osg::ref_ptr<osgUtil::RenderBin> myAlphaToCoverageBin;
      osg::ref_ptr<osgUtil::RenderBin> mySkyBin;
      osg::ref_ptr<osgUtil::RenderBin> myDepthOnlyBin;
      osg::ref_ptr<osgUtil::RenderBin> myOceanBin;
      osg::ref_ptr<osgUtil::RenderBin> myLightPointBin;
      osg::ref_ptr<osgUtil::RenderBin> myCloudBin;
      osg::ref_ptr<osgUtil::RenderBin> myCockpitBin;
      osg::ref_ptr<osgUtil::RenderBin> myOcclusionNodeBin;

      bool myWireframeOn;
      bool myShadowsEnabled;

      bool myMultiViewVrEnabled;
      std::map<osg::Camera*, DtMultiViewData*> myMultiViewData;

      DtTaxiwaySignManager* myTaxiwaySignManager;
      DtRunwayMarkingManager* myRunwayMarkingManager;
      DtLightIndicatorManager* myLightIndicatorManager;

      double myTerrainScaleFactor;
      bool myTerrainScaleFactorChanged;
      bool myTerrainScalingEnabled;
      bool myTerrainScalingEnabledChanged;
      bool myResourcesReleased;

      int myAlphaToCoverageRenderBin;

      DtMainThreadJobsManager * myMainThreadJobsManager;
      bool myReaddJobSystem;

      bool myInitializedInRender;
      unsigned int myActiveThreads;

 protected:
      static DtSceneRoot theRenderRoot;
      static DtSceneRoot theEnvironmentRoot;
      static DtSceneRoot theTerrainRoot;
      static DtSceneRoot theMinimapTerrainRoot;
      static DtSceneRoot theMinimapFallbackTerrainRoot;
      static DtSceneRoot thePropRoot;
      static DtSceneRoot theOceanRoot;
      static DtSceneRoot theIntersectOnlyPropRoot;
      static DtSceneRoot theNormalizedOverlayRoot;
      
      static std::string theShadowedSceneName;

      class DtImguiHelper* myImGuiHelper;

      osg::ref_ptr<DtOsgGlobalShaderComponent> myGlobalShaderComponent;

      typedef osg::ref_ptr<osg::Operation> OperationRef;
      typedef std::vector<OperationRef> OperationVector;

      OperationVector myParallelCullJobs;
      OperationVector myParallelSwapBufferJobs;
   };

   class DT_DLL_VRVOSG DtOsgRendererCreator : public DtRendererCreator
   {
   public:

      virtual DtRenderer* create(DtDe& de);
   };
}