DtOsgStatsHandler.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/vrvOsg.h>

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

#include <osgViewer/ViewerEventHandlers>
#include <osg/Matrix>

namespace osg
{
   class Switch;
   class Geode;
}

namespace osgViewer
{
   class View;
}

namespace osgText
{
   class Text;
}


namespace makVrv
{
   class DtDe;
   class DtBaseConnection;
   class DtProfileNode;
   class DtPerformanceStats;
   class DtOsgProfilerStats;

   class DT_DLL_VRVOSG DtOsgStatsHandler : public osgViewer::StatsHandler
   {
   public:       // public typedefs and enumerations  
      enum ProfilerStatsType
      {
         NO_PROFILER_STATS = 0,
         PERFORMANCE_STATS = 1,
         FUNCTION_STATS = 2,
         BOTH_STATS = 3,
         LAST_PROFILER_STATS = 4
      };


   public: // public constructors and destructors   
      DtOsgStatsHandler(DtDe& de);
   protected:
      virtual ~DtOsgStatsHandler();
   private:
      DtOsgStatsHandler(const DtOsgStatsHandler& other) = delete;
      DtOsgStatsHandler& operator=(const DtOsgStatsHandler& other) = delete;

   public:
      //set the key toggle the Profiler Stats, default is F3
      virtual void setKeyEventTogglesProfilerStats(int key);

      //get the key toggle the Profiler Stats, default is F3
      virtual int getKeyEventTogglesProfilerStats(void);

      virtual DtPerformanceStats* performanceStats();

      virtual int osgStatsType() const;

      virtual bool handle(const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& aa) override;
   protected:

      //turn off the osg stats
      virtual void turnOffOsgStats(osgViewer::View* view);

      //turn off the performance and profiler stats and stop profiling
      virtual void turnOffBothProfilerStats(bool sendSettingsToGui);

      //This will create a instance of DtOsgPerformanceStats and connect the necessary signals
      //only if the instance is 0,It will also start profiling
      virtual void createPerformanceStats();

      //This will delete the instance of DtOsgPerformanceStats and disconnect the necessary signals
      //It will also stop profilinng
      virtual void deletePerformanceStats();

      //Send the performance stats to update the GUI
      virtual void sendPerformanceStatsToGUI(unsigned int state);

      //turn off the performance stats
      virtual void turnOffPerformanceStats(bool sendSettingsToGui);

      //Send the profiler stats to update the GUI
      virtual void sendProfilerStatsToGUI(bool enabled);

      //toggle between the Performance stats and Function stats
      virtual void updateProfilerStats(bool sendSettingsToGui);

      virtual void setPerformanceStatsOverlayEnabled(bool show, bool sendSettingsToGui = true);

      virtual bool performanceStatsOverlayEnabled() const;

      virtual void setProfilerOverlayEnabled(bool show, bool sendSettingsToGui = true);

      virtual bool profilerOverlayEnabled() const;

      virtual void slot_onPerformanceStatsOverlayOnChanged(bool mode);

      virtual void slot_onProfilerOverlayOnChanged(bool mode);

   protected:
      osg::GraphicsContext* findValidContext(osg::GraphicsContext* context, osgViewer::View* view);

   protected:
      DtDe& myDe;

      int myKeyEventTogglesProfilerStats;
      int myProfilerStatsType;
      
      DtPerformanceStats* myPerformanceStats;

      bool myNeedEnableOsgPerformanceInStartup;
      bool myStatsActive;
      DtSignalConnectionManager myConnections;
   };
}