DtStateVisualizer.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtObserverMode.h>
#include <vrvCore/DtShowHideContext.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtUnicode.h>
#include <boost/bind.hpp>


namespace makVrv
{
   class DtSceneObjectAgent;
   class DtBaseConnection;
   class DtStateListener;
   class DtVisualizerDefinition;
   class DtVisualizerSchema;

   class DT_DLL_VRVCORE DtStateVisualizer
   {

   public:
      enum Type
      {
         AllVisualizerTypes = 0,
         EntityVisualizerType = 1,
         EnvironmentalVisualizerType,
         InteractionVisualizerType,
         AggregateVisualizerType,
         IntervisibilityVisualizerType,
         TacticalSmokeVisualizerType,
         UserType = 10000
      };

      struct DT_DLL_VRVCORE TypeInfo
      {
         TypeInfo(const std::string& fname,
            const DtUnicode& sname, 
            DtStateVisualizer::Type type,
            const DtVisualizerSchema& s)
         : functionalTypeName(fname)
         , screenName(sname)
         , supportedVisualizerType(type)
         , schema(s)
         {
         }

         const std::string functionalTypeName;
         const DtUnicode screenName;
         const DtStateVisualizer::Type supportedVisualizerType;
         const DtVisualizerSchema& schema;
      };

   public:
      DtStateVisualizer(DtBaseConnection& connection, DtStateListener& listener,
         int modelSet);

      DtStateVisualizer( DtBaseConnection& connection, DtStateListener& listener,
         DtSceneObjectAgent* sceneObjectAgent, int modelSet );

      virtual ~DtStateVisualizer();

      virtual DtObserverMode::ModelSets modelSet();

      virtual void createModelAgents() = 0;

      virtual void destroyModelAgents() = 0;

      virtual const TypeInfo& typeInfo() const = 0;

      virtual void setParent(DtStateVisualizer*);

      virtual void setSceneObjectAgent( DtSceneObjectAgent* sceneObject );

      virtual const DtStateVisualizer* parent() const;

      void setModelDefinition(const std::string& definition);

      const std::string& modelDefinition() const;


      virtual void implementVisibility(bool visible);

      virtual void initialize();

      virtual void slot_setSelected(bool b) {}

      void setName(const std::string&);
      const std::string& name() const;

      virtual void setPickable(bool);
      virtual bool pickable() const;

      virtual void setSceneObjectID(DtUniqueID id);

      virtual DtUniqueID sceneObjectID() const
      {
         return mySceneObjectID;
      }

      int visualizerType() const
      {
         return myVisualizerType;
      }

      virtual void setVisualizerDefinition(const DtVisualizerDefinition&);

      //Get the listener for this visualizer.
      inline DtStateListener& listener()
      {
         return myListener;
      }

      inline const DtStateListener& listener() const
      {
         return myListener;
      }

      inline DtBaseConnection& simulation()
      {
         return mySimulation;
      }

      void setDistribute(bool b)
      {
         myDistributeFlag = b;
      }

      bool distribute() const
      {
         return myDistributeFlag;
      }

      virtual bool setVisualizerIsVisible(bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context);

      boost::signalslib::signal<void (DtStateVisualizer*, DtStateVisualizer*,
         DtStateVisualizer*)> signal_reparented;

   protected:

      virtual void setModelDefinitionForAgents() = 0;
      
      virtual void connectToListenerSignals();

      virtual void makeVisible();

      virtual bool isVisible() const;


      virtual void setInitialValuesFromVisualizerDefinition();

      template <typename T, typename C>
      void connectAndUpdate(boost::signalslib::signal<void (T)>& sig,void (C::*fp)(T),T val)
      {
         myConnections.manageConnection(sig.connect(boost::bind(fp, 
            static_cast<C*>(this), _1)));
         //Call this connection.
         ((C&)(*this).*fp)(val);
      }

   private:
      DtStateVisualizer() = delete;

      DtStateVisualizer( const DtStateVisualizer& ) = delete;

      DtStateVisualizer& operator=( const DtStateVisualizer& ) = delete;

   protected:
      
      DtBaseConnection& mySimulation;
      DtStateListener& myListener;

      bool myDistributeFlag;

      DtUniqueID mySceneObjectID;
      std::string myName;
      std::string myModelDefinition;
      DtSignalConnectionManager myConnections;
      int myModelSet;
      int myVisualizerType;
      bool myPickable;
      bool myVisible;          
      const DtVisualizerDefinition* myVisualizerDefinition;
      DtStateVisualizer* myParent;
      DtSceneObjectAgent* mySceneObjectAgent;      
      bool myInitialInitializeDone;
      typedef std::vector<DtVisualizerShowHideContext::VisualizerShowHideContext> ShowHideContextVector;
      ShowHideContextVector myVisualizerShowHideContexts;

   };

   class DT_DLL_VRVCORE DtStateVisualizerCreator
   {
   public:

      DtStateVisualizerCreator()
      {
      }

      virtual ~DtStateVisualizerCreator()
      {
      }

      virtual DtStateVisualizerCreator* clone() const = 0;

      virtual DtStateVisualizer* create(DtBaseConnection& simulation, 
         DtStateListener& listener, int modelSet) const = 0;

      virtual DtStateVisualizer* create( DtBaseConnection& simulation,
         DtStateListener& listener, DtSceneObjectAgent* sceneObjectAgent, int modelSet ) const
      {
         // Please override for updated visualizers
         // XXX not pure virtual yet XXX
         return nullptr;
      };

      virtual const DtStateVisualizer::TypeInfo& visualizerTypeInfo() const = 0;

      virtual const std::string& tag() = 0;

   };

   template <typename StateVisualizer>
   class DtStateVisualizerCreatorTemplate : public DtStateVisualizerCreator
   {
   public:

      DtStateVisualizerCreatorTemplate()
      {
      }

      virtual ~DtStateVisualizerCreatorTemplate()
      {
      }

      virtual DtStateVisualizerCreator* clone() const
      {
         return new DtStateVisualizerCreatorTemplate<StateVisualizer>();
      }

      virtual DtStateVisualizer* create(DtBaseConnection& simulation,
         DtStateListener& listener, int modelSet) const
      {
         return new StateVisualizer(simulation, listener, modelSet);
      }

      virtual DtStateVisualizer* create( DtBaseConnection& simulation,
         DtStateListener& listener, DtSceneObjectAgent* sceneObjectAgent, int modelSet ) const
      {
         return new StateVisualizer( simulation, listener, sceneObjectAgent, modelSet );
      }

      virtual const DtStateVisualizer::TypeInfo& visualizerTypeInfo() const
      {
         return StateVisualizer::theTypeInfo();
      }

      virtual const std::string& tag()
      {
#ifdef DtDIS
         const static std::string str("DIS");
#elif DtHLA_1516_EVOLVED
         const static std::string str("HLA1516e");
#elif DtHLA_1516
         const static std::string str("HLA1516");
#elif DtHLA
         const static std::string str("HLA13");
#else
         const static std::string str("");
#endif
         return str;
      }
   };

}