vrfVrvExtensions.h

Go to the documentation of this file.

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



#pragma once

#include <vrfVrlSharedSource/vrfProtocol.h>

#include <vrvVrl/DtVrlinkConnection.h>


class DtDIGuyObjectStateRepository;

#include <vrvCore/DtSharedEntityDisplaySettings.h>
#include <vrvCore/DtEntityKinStateVisualizer.h>
#include <vl/diGuyObjectStateRepository.h>
#include <vrvVrl/DtEntityStateInterceptor.h>
#include <vrvVrl/DtEntityKinStateListener.h>
#include <vrvVrl/DtVrlinkEntityStateListener.h>
#include <vrvVrl/DtVrlinkAggregateStateListener.h>
#include <vrvVrl/DtVrlinkTacticalGraphicStateListener.h>
#include <vrvVrl/DtEntityExistenceListener.h>
#include <vrvVrl/DtAggregateExistenceListener.h>
#include <vrvVrl/DtEntityStateInterceptorCreator.h>
#include <vrvVrl/DtAggregateStateInterceptorCreator.h>
#include <vrvVrl/DtEntityStateInterceptorCreator.h>
#include <vrvVrl/DtCloudLayerStateListener.h>

#include <vrvVrl/DtVrlinkAppearanceVisualizerInterface.h>
#include <vrvVrl/DtVrlinkTacticalGraphicMilStdIconVisualizer.h>
#include <vrvVrl/DtVrlink3DAggregateExtentVisualizer.h>
#include <vrvVrl/DtVrlink2DAggregateExtentVisualizer.h>
#include <vrvVrl/DtVrlinkEntityMilStdIconVisualizer.h>
//#include <vrvVrl/DtVrlink2DAggregateMilStdIconVisualizer.inl>
#include <vrvVrl/DtVrlink2DAggregateMilStdIconVisualizer.h>


#include <vrfGuiCore/vrfTacticalGraphicImageSymbolVisualizer.h>
#include <vrfGuiCore/entityStateListenerExtensions.h>
#include <vrfGuiCore/tacticalGraphicListenerExtensions.h>

#include <vrvCore/DtEntityState.h>
#include <vrvCore/DtAgentManagerInterface.h>
#include <vrfExtObjects/reflectedExtEntity.h>
#include <vrfExtObjects/reflectedExtEntityList.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrfutil/rwUUID.h>

#include <vlpi/entityType.h>
#include <matrix/vlVector.h>

#if DtHLA
#include <vrfExtObjects/stateRepositoryWithExtendedAttributesHLA.h>
#else
#include <vrfExtObjects/stateRepositoryWithExtendedAttributesDIS.h>
#endif
#include "vrfutil/rwColor.h"
#include "vrvCore/DtEntityMilStdIconVisualizer.h"

#include <vrvVrl/DtVrlinkEntityOffsetDIGuyStateVisualizer.h>

namespace makVrv
{
   class DtVrlinkElement;
   class DtEmbarkationUpdaterAgent;

   namespace DT_PROTOCOL_NAMESPACE
   {
      class DtEntitySimDataProcessor;
      class DtVrlinkAggregateElement;
      class DtVrlinkTacticalGraphicStateListener;
      class DtVrlinkEntityStateListener;
   }
}

namespace makVrf 
{
   namespace VRF_PROTOCOL_NAMESPACE
   {
      class VRF_PROTOCOL_EXPORT DtVrfAggregateStateInterceptorCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateStateInterceptorCreator
      {
      public:
         static DtAggregateStateInterceptorCreator& instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual ~DtVrfAggregateStateInterceptorCreator();

         virtual DtAggregateStateRepository* create(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateStateListener* listener);

         DtVrfAggregateStateInterceptorCreator();
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkTacticalGraphicImageSymbolVisualizer 
      : public DtVrfTacticalGraphicImageSymbolVisualizer
      {
      public:

         DtVrfVrlinkTacticalGraphicImageSymbolVisualizer(makVrv::DtBaseConnection& connection, 
            makVrv::DtStateListener& listener, int modelSet);

         virtual ~DtVrfVrlinkTacticalGraphicImageSymbolVisualizer();

      protected:

         virtual void modelDefinitionCreated(const std::string&);

         virtual void forceSet(int);
      };

      typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlinkTacticalGraphicImageSymbolVisualizer> 
         DtVrfVrlinkTacticalGraphicImageSymbolVisualizerCreator;

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkEntityStateListener : public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener,
         public DtEntityStateListenerExtensions
      {
      public:
         DtVrfVrlinkEntityStateListener(makVrv::DtUniqueID id, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn);

         virtual ~DtVrfVrlinkEntityStateListener();

         bool animationChangeBlocked() const
         {
            return myBlockAnimationChange;
         }

         bool gestureChangeBlocked() const
         {
            return myBlockGestureChange;
         }

         virtual void setBlockAnimationChange(bool b, double speed = 0.);
         virtual void setBlockGestureChange(bool b);
         virtual void setFrozen(bool);

         virtual void reflectedEntityPostUpdate();

         bool blockAnimationChange(bool b, double speed = 0.)
         {
            bool old = myBlockAnimationChange;

            setBlockAnimationChange(b, speed);

            return old;
         }

         virtual void setCharacterAction( const std::string& action, bool paused, float speed, bool usePositioning, 
            const DtVector&, int autoChooseTransitionBehavior, float transitionSpeed );
         virtual void executeCharacterAction(const std::string&);
         virtual void setAppearanceBits( unsigned int mask, unsigned int newValue, bool force = false );
          virtual void executeSetColor(DtRwColor color);
          virtual void executeGesture(const std::string& gestureName, int reps, float overallDuration, float channel_A_weight);

         boost::signals2::signal<void(DtRwColor)> signal_setIconColor;

      protected:
         bool myBlockAnimationChange;
         double myTime;
         unsigned int myNewAppearance;
         unsigned int myNewAppearanceMask;
         bool myResetToFrozen;
         bool myBlockGestureChange;
         std::string myGesture;
      };

      class VRF_PROTOCOL_EXPORT DtVrfEntityKinStateListener : public makVrv::DT_PROTOCOL_NAMESPACE::DtEntityKinStateListener
      {
      public:
         DtVrfEntityKinStateListener(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener&, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& conn);

         virtual ~DtVrfEntityKinStateListener();

         virtual void setNetVelocity(const DtVector32&, double pduTime);
         virtual void setUseTemporaryVelocity(bool b, double speed);

      protected:
         DtVector32 myCurrentVelocity;
         UpdateStruct32 myCopyVelocityValue;
         bool myUseTemporaryVelocity;
         DtVector32 myTemporaryVelocity;
      };

      class VRF_PROTOCOL_EXPORT DtVrfEntityKinStateListenerCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtEntityKinStateListenerCreator
      {
      public:
         DtVrfEntityKinStateListenerCreator(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& connection)
         : makVrv::DT_PROTOCOL_NAMESPACE::DtEntityKinStateListenerCreator(connection)
         {
         }

         //functionality.
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtEntityKinStateListener* create( 
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener& stateListener ) const
         {
            return new DtVrfEntityKinStateListener(stateListener, myConnection);
         }
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkTacticalGraphicStateListener : public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicStateListener,
         public DtTacticalGraphicListenerExtensions
      {
      public:
         DtVrfVrlinkTacticalGraphicStateListener(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& connection, makVrv::DtUniqueID id)
            : DtVrlinkTacticalGraphicStateListener(connection, id),
            DtTacticalGraphicListenerExtensions(id) {}

         virtual ~DtVrfVrlinkTacticalGraphicStateListener() {}

      protected:
         virtual void postUpdate(DtReflectedControlObject* cObj);
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkEntityStateListenerCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListenerCreator
      {
      public:

         static DtVrfVrlinkEntityStateListenerCreator& instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual ~DtVrfVrlinkEntityStateListenerCreator();

   #ifdef DtHLA
         //functionality.
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener* create(DtHlaObject* object);
   #endif

   #ifdef DtDIS
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener* create(const DtEntityIdentifier& id, 
            const DtEntityType& type);
   #endif

         DtVrfVrlinkEntityStateListenerCreator(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection&);
      };
      

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkAggregateStateListener : public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateStateListener,
         public DtEntityStateListenerExtensions
      {
      public:
         DtVrfVrlinkAggregateStateListener(makVrv::DtUniqueID id, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection&);

         virtual ~DtVrfVrlinkAggregateStateListener();

         virtual void updateSubordinates();

       virtual void executeSetColor(DtRwColor color);
       boost::signals2::signal<void(DtRwColor)> signal_setIconColor;

      protected:
         virtual void slot_subordinateAdded(const DtUUID&, const DtUUID&);
         virtual void slot_subordinateRemoved(const DtUUID&, const DtUUID&);
         virtual const DtUUID& uuid();

      protected:
         std::set<std::string> myOrbatOnlySubordinates;
         makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& mySimulation;
         makVrv::DtSignalConnectionManager myConnections;
         DtUUID myUUID;
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkAggregateStateListenerCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateStateListenerCreator
      {
      public:

         static DtVrfVrlinkAggregateStateListenerCreator& instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual ~DtVrfVrlinkAggregateStateListenerCreator();

   #ifdef DtHLA
         //functionality.
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateStateListener* create(DtHlaObject* object);
   #endif

   #ifdef DtDIS
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateStateListener* create(const DtEntityIdentifier& id, 
            const DtEntityType& type);
   #endif

         DtVrfVrlinkAggregateStateListenerCreator(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection&);
      };

      class VRF_PROTOCOL_EXPORT DtVrfAggregateReflectedListCreator :
         public makVrv::DT_PROTOCOL_NAMESPACE::DtVrvAggregateReflectedListCreator
      {
      public:

         static makVrv::DT_PROTOCOL_NAMESPACE::DtVrvAggregateReflectedListCreator&
            instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual DtReflectedExtAggregateList* create(makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateExistenceListener&);

      #if DtHLA
         virtual DtReflectedExtAggregateList* create(makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateExistenceListener&, const DtDDMRegionSet*);
      #endif

      protected:
         DtVrfAggregateReflectedListCreator(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlinkTacticalGraphicStateListenerCreator
      : public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicStateListenerCreator
      {
      public:

         DtVrfVrlinkTacticalGraphicStateListenerCreator(
            makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& c) : DtVrlinkTacticalGraphicStateListenerCreator(c) {};

         virtual ~DtVrfVrlinkTacticalGraphicStateListenerCreator() {};

   #ifdef DtHLA
         //functionality.
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* create(DtHlaObject* object)
         {
            return new DtVrfVrlinkTacticalGraphicStateListener(mySim, mySim.sceneInterface().createNewUniqueId());
         }
   #endif

   #if DtDIS
         virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* create(
            const DtEntityIdentifier& id, const DtEntityType& type)
         {
            return new DtVrfVrlinkTacticalGraphicStateListener(mySim, mySim.sceneInterface().createNewUniqueId());
         }
   #endif
      };

     class VRF_PROTOCOL_EXPORT DtVrfVrvExtReflectedEntityList : public DtReflectedExtEntityList
      {
      public:
         DtVrfVrvExtReflectedEntityList(makVrv::DT_PROTOCOL_NAMESPACE::DtEntityExistenceListener& listener);

   #if DtHLA
         DtVrfVrvExtReflectedEntityList(makVrv::DT_PROTOCOL_NAMESPACE::DtEntityExistenceListener& listener, 
            const DtDDMRegionSet& regionsToUse);
   #endif

         virtual ~DtVrfVrvExtReflectedEntityList();
#if DtHLA
         virtual DtReflectedEntity* newReflectedObject(DtHlaObject* obj) const;

         virtual void removeAndDelete(DtReflectedObject* entity, char* msg = NULL);
         virtual void resolveOrphans();
#endif

   #if DtDIS

         //Hacked class which allows setting the esr of an newly created reflected
         //Entity
         class DtVrfVrvReflectedEntity : public DtReflectedExtEntity
         {
         public:
            DtVrfVrvReflectedEntity(DtExerciseConn* conn,
               const DtEntityIdentifier& id,
               const DtEntityType& type,
               DtEntityStateRepository* esr)
               : DtReflectedExtEntity(conn,id,type)
            {
               delete myEntityStateRep;
               myEntityStateRep = esr;
               myEntityStateRep->setClock(conn->clock());
               myEntityStateRep->setGlobalId(id);
               myEntityStateRep->setDisObjectManager( conn->disObjectManager() );
            }

         };

         virtual DtReflectedEntity* newReflectedEntity( 
            const DtEntityIdentifier& id,
            const DtEntityType& type) const;

         virtual void removeAndDelete(DtReflectedObject* obj, char* msg = NULL);
   #endif

         //Whenever an entity is added.
         virtual void objectAdded(DtReflectedObject* ent);

      protected:

         typedef std::map<DtReflectedExtEntity*,makVrv::DtEntityStateListener*> 
            ReflectedEntityListenerMap;


         makVrv::DT_PROTOCOL_NAMESPACE::DtEntityExistenceListener& myListener;
         mutable ReflectedEntityListenerMap myReflectedEntityListenerMap;
      };

      class VRF_PROTOCOL_EXPORT DtVrfVrlink3DAggregateExtentVisualizer : 
         public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DAggregateExtentVisualizer
      {
      public:
         DtVrfVrlink3DAggregateExtentVisualizer(makVrv::DtBaseConnection& simulation, 
            makVrv::DtStateListener& listener, int modelSet);

         virtual ~DtVrfVrlink3DAggregateExtentVisualizer();

         virtual void createModelAgents();

      protected:
         virtual bool hasPhysicalFootprint();
      };

      typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlink3DAggregateExtentVisualizer>
         DtVrfVrlink3DAggregateExtentVisualizerCreator;

      class VRF_PROTOCOL_EXPORT DtVrfVrlink2DAggregateExtentVisualizer : 
         public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAggregateExtentVisualizer
      {
      public:
         DtVrfVrlink2DAggregateExtentVisualizer(makVrv::DtBaseConnection& simulation, 
            makVrv::DtStateListener& listener, int modelSet);

         virtual ~DtVrfVrlink2DAggregateExtentVisualizer();

         virtual void createModelAgents();

      protected:
         virtual bool hasPhysicalFootprint();
      };

      typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlink2DAggregateExtentVisualizer>
         DtVrfVrlink2DAggregateExtentVisualizerCreator;

      class VRF_PROTOCOL_EXPORT DtVrfEntityStateInterceptorCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtEntityStateInterceptorCreator
      {
      public:
         static DtEntityStateInterceptorCreator& instance(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim);

         virtual ~DtVrfEntityStateInterceptorCreator();

         virtual DtEntityStateRepository* create(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityStateListener* listener);

         DtVrfEntityStateInterceptorCreator();
      };
   }

   class VRF_PROTOCOL_EXPORT DtVrfCloudLayerStateListener : public makVrv::DT_PROTOCOL_NAMESPACE::DtCloudLayerStateListener
   {
   public:
      DtVrfCloudLayerStateListener(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim, makVrv::DtUniqueID id)
         : makVrv::DT_PROTOCOL_NAMESPACE::DtCloudLayerStateListener(sim, id)
         , myLightningPresent(false)
         , myLightningPresentDirty(false)
      {
      }

      virtual ~DtVrfCloudLayerStateListener()
      {
      }

      virtual void setLightningPresent(bool present);

      virtual bool lightningPresent() const;

      virtual void setLightningPresentDirty(bool dirty);

      virtual bool lightningPresentDirty() const;

      virtual void update(const DtControlObjectRepository& cosr);

      virtual bool visualize() const { return true; }

   protected:
      bool myLightningPresent;
      bool myLightningPresentDirty;
   };

   class VRF_PROTOCOL_EXPORT DtVrfCloudLayerStateListenerCreator : public makVrv::DT_PROTOCOL_NAMESPACE::DtCloudLayerStateListenerCreator
   {
   public:
      DtVrfCloudLayerStateListenerCreator(makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection& sim)
      : makVrv::DT_PROTOCOL_NAMESPACE::DtCloudLayerStateListenerCreator(sim)
      {
      }

#ifdef DtHLA
      //functionality.
      virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* create(DtHlaObject* object)
      {
         return new DtVrfCloudLayerStateListener(mySim, mySim.sceneInterface().createNewUniqueId());
      }
#endif

#ifdef DtDIS
      virtual makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalStateListenerInterface* create(const DtEntityIdentifier& id, 
         const DtEntityType& type)
      {
         return new DtVrfCloudLayerStateListener(mySim, mySim.sceneInterface().createNewUniqueId());
      }
#endif
   };

   class VRF_PROTOCOL_EXPORT DtVrfVrlink2DEntityStateVisualizer :
      public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityMilStdIconVisualizer
   {
   public:
      DtVrfVrlink2DEntityStateVisualizer(makVrv::DtBaseConnection& connection, makVrv::DtStateListener& listener,
         int modelSet);

      virtual ~DtVrfVrlink2DEntityStateVisualizer();

      virtual void setColor(const DtRwColor& color);

      virtual void setForceColor(float r, float g, float b, float a);
      virtual void updateSymbol();

   protected:
      DtEntityType myEntityType;
      bool usingForceColor;

   };

   typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlink2DEntityStateVisualizer>
      DtVrfVrlink2DEntityStateVisualizerCreator;

   class VRF_PROTOCOL_EXPORT DtVrfVrlinkEntityOffsetDIGuyStateVisualizer :
      public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityOffsetDIGuyStateVisualizer
   {
   public:
      DtVrfVrlinkEntityOffsetDIGuyStateVisualizer(makVrv::DtBaseConnection& connection, makVrv::DtStateListener& listener,
         int modelSet);

      virtual ~DtVrfVrlinkEntityOffsetDIGuyStateVisualizer();

   protected:
      virtual void implementVisibility( bool visible );
   };

   typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlinkEntityOffsetDIGuyStateVisualizer>
      DtVrfVrlinkEntityOffsetDIGuyStateVisualizerCreator;

   class VRF_PROTOCOL_EXPORT DtVrfVrlink2DAggregateStateVisualizer :
      public makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAggregateMilStdIconVisualizer
   {
   public:
      DtVrfVrlink2DAggregateStateVisualizer(makVrv::DtBaseConnection& connection, makVrv::DtStateListener& listener,
         int modelSet);

      virtual ~DtVrfVrlink2DAggregateStateVisualizer();

      virtual void setColor(const DtRwColor& color);

      virtual void setForceColor(float r, float g, float b, float a);
      virtual void updateSymbol();

   protected:
      DtEntityType   myEntityType;
      bool usingForceColor;

   };

   typedef makVrv::DtStateVisualizerCreatorTemplate<DtVrfVrlink2DAggregateStateVisualizer>
      DtVrfVrlink2DAggregateStateVisualizerCreator;

}