entityFacadeCollection.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfObjectFacadeInterface.h>
#include <vrfGuiCore/entityStateListenerExtensions.h>

#include <vrvCore/DtBaseConnection.h>
#include <vrvCore/DtAggregateStateListener.h>
#include <vrvCore/DtSharedModelSetSettings.h>
#include <vrvCore/DtVisualizerSet.h>
#include <vrvUtil/DtUnicode.h>
#include <vrvCore/DtForceManager.h>
#include <vrvCore/DtEntityElement.h>

#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>

#include <string>
#include <map>

class DtEntityType;
class DtRwColor;

namespace makVrv
{

   class DtVisualDefinitionSet;
   class DtAgentManagerInterface;
   class DtDe;
   class DtStatePropertyDecorationVisualizer;
   class DtBaseConnection;
   class DtEntityElement;
}

namespace makVrf
{

   class DtBoundingVolumeSupportPointCalculator;

   class DT_DLL_VRFGUICORE DtExtAggregateStateListener : public makVrv::DtAggregateStateListener, public DtEntityStateListenerExtensions
   {
   public:
      DtExtAggregateStateListener(makVrv::DtUniqueID id, makVrv::DtBaseConnection& conn);
      virtual ~DtExtAggregateStateListener() {};

      void setIsAggregate(bool b);
      virtual void setAggregateColorizedModelColorType(makVrv::DtColorizedModelColorType colorType) override;
      virtual void updateForceColor() override;

   protected:
      bool myIsAggregate;
   };

   class DT_DLL_VRFGUICORE DtEntityFacadeCollection : public DtVrfObjectFacadeInterface
   {
   public:
      typedef std::map<int, makVrv::DtVisualizerSet*> ModelSetMap;

   public:
      DtEntityFacadeCollection(makVrv::DtDe&, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);
      virtual ~DtEntityFacadeCollection();

   public:

      virtual void visualize( const makVrv::DtUnicode& type,
         const makVrv::DtSharedModelSetSettings::ModelSetVisualizedMap& sets );

      makVrv::DtEntityElement* entityElement()
      {
         return myEntityElement;
      }

      DtExtAggregateStateListener* listener()
      {
         return myListener;
      }

      virtual bool isVisualized() const;

      virtual void setupNodeMaskFlags() const;

      virtual void setSetupNodeMaskFlags(bool);

      virtual std::map<int, std::vector<int> > modelStates(makVrv::DtModelSetId modelSet) const;

      virtual std::vector<int> artParts(makVrv::DtModelSetId modelSet) const;

      virtual void enableArtPart(makVrv::DtModelSetId modelSet, int artPart, bool enable, const DtVector& translationRate = DtVector::zero(),
         const DtVector& rotationalRate = DtVector::zero());

      virtual void enableArtPartTranslation(makVrv::DtModelSetId modelSet, int artPart, bool enable,
         const DtVector& translationRate = DtVector::zero(), const DtVector& minTranslation = DtVector::zero(),
         const DtVector& maxTranslation = DtVector::zero());

      virtual void enableArtPartRotation(makVrv::DtModelSetId modelSet, int artPart, bool enable,
         const DtVector& rotationRate = DtVector::zero(), const DtVector& minRotation = DtVector::zero(),
         const DtVector& maxRotation = DtVector::zero());

      virtual bool getArtPartInformation(makVrv::DtModelSetId modelSet, int artPart, DtVector& minRotation, DtVector& maxRotation, DtVector& minTranslation, DtVector& maxTranslation);
      virtual bool getArtPartBodyPosition(makVrv::DtModelSetId modelSet, int artPart, DtVector& bodyPosition);
      virtual bool getArtPartRestingHPR(makVrv::DtModelSetId modelSet, int artPart, DtTaitBryan& bodyPosition);

      virtual void setModelState(makVrv::DtModelSetId modelSet, int, int);

      virtual void setTopographicOrientation(const DtTaitBryan& orientation);

      virtual void setTopographicOffsetFromPrincipal(const DtVector&, bool resetLocation = true);

      virtual const std::string& decorationSet() const;

      virtual const std::string& unitCollection() const;

      virtual void setLocalOrientation(const DtTaitBryan& orientation);

      virtual void setOrigin(const DtVector& v);
      virtual void setOrigin(const DtGeodeticCoord& v);

      virtual void setOriginAndSeaLevel(const DtVector& v);
      virtual void setOriginAndSeaLevel(const DtGeodeticCoord& v);

      virtual void ignoreVisualTypeSwitch(int, bool);

      virtual bool hasOccupant() const;

      virtual void setDropShadow(bool b);
      virtual void setAltitudeOffsetFromPrincipal( double offset, bool resetLocation = true );

      virtual void setForceType(DtForceType);
      DtForceType forceType() const;
      virtual bool hasForceChange() const;

      virtual double initialAltitudeAboveTerrain() const;

      virtual makVrv::DtBaseConnection& baseConnection() const;

      void setHatLineVisible( bool visible );

      void setTrackHistoryVisible( bool visible );

      virtual void setVisible(bool, makVrv::DtShowHideContext::ShowHideContext context, bool updateOffsets = true) override;
      virtual bool isVisible() const override;

      virtual void setUseHighestTerrainLod(bool);

      virtual void setPickable(bool b);

      virtual void setSelected(bool b);

      virtual void setLabel(const std::string& label);
      virtual std::string label() const;
      virtual bool hasLabelChange() const;

      virtual void setupVisualMetaDataFor(bool skipVariants = false);

      virtual void setExtendedLabels(const std::map<int, DtString>& labels);
      virtual std::map<int, DtString> extendedLabels() const;
      virtual bool hasExtendedLabelsChange() const;

      virtual void setOverlayName(const std::string&);
      virtual std::string overlayName() const;

      virtual void setIndicatorVisible(bool b);

      virtual Dt3dBoundingVolume boundingVolume(makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Models3D) const;

      virtual void calculateSupportPoints(makVrv::DtModelSetId modelSet, DtVector& left, DtVector& right, DtVector& other) const;

      virtual void setAttachedTo(DtVrfObjectFacadeInterface*, const DtVector& offset, const DtTaitBryan&);
      virtual void detach();

      virtual makVrv::DtUniqueID uniqueID() const;
      virtual std::vector<makVrv::DtUniqueID> modelUniqueIDs() const;

      virtual void clearMarkingsModified();
      virtual bool markingsModified() const;

      virtual void setMarkingDecal(const std::string& annotation, const std::string& value);
      virtual std::string markingDecal(const std::string& annotation) const;
      const std::map<std::string, std::string>& markingDecalMap() const
      {
         return myMarkingDecals;
      }

      virtual void clearMarkingDecals();

      virtual bool hasMultipleLODs(makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Models3D) const;

      virtual void setWidgetEventsEnabled(bool b);

      virtual void setGroundClamping(bool b);
      virtual void setDeadReckoning(bool position, bool velocity, bool orientation);

      virtual void setSymbolDecorationOffset(double x, double y);

      virtual void setFixedIconScalingEnabled(bool);

      virtual void realizeFacades();

      virtual void unrealizeFacades(bool willRecreate = false);

      virtual void setDictionaryToDisplay(int);
      bool dictionaryToDisplay() const { return myDictionaryToDisplay; };

      virtual bool hasProjectedModel(makVrv::DtModelSetId modelSet) const;

      virtual void setElementDefinition(const makVrv::DtUnicode& elementName);

      virtual const makVrv::DtUnicode& elementDefinition() const;

      virtual void setElementDefinition(const DtEntityType&);

      void setSmoothingEnabled(bool enabled);

      void setMotionModel(const std::string&);

      virtual void setLabelIndicatorVisible(bool, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Icons2D);

      virtual void setHeadingIndicatorVisible(bool, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Icons2D);

      virtual void setHeadingIndicatorSize(float l);

      virtual bool isDiGuy() const { return myIsDiGuy; };

      virtual DtVector position() const;

      virtual makVrv::DtUniqueID uniqueIDForModelSet(makVrv::DtModelSetId set) const;

      virtual void setEffectsVisible(bool);

      virtual bool shouldEnableTrailEffects() const;

      virtual void enableTrailEffect(bool);

      virtual void setAltitudeAboveTerrain(double d);

      virtual void setAltitudeAboveSeaLevel(double d);

      virtual bool hasWakeModel(makVrv::DtModelSetId set);
      virtual void setWakeLOD(double);
      virtual void setShowWakes(bool b, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);

      virtual void setShowSmoke(bool b, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);
      virtual void setShowFlames(bool b, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);

      virtual void setShowOccupants(bool b);

      virtual const DtVector32& velocity() const;
      virtual void setVelocity(const DtVector32& v);

      template <typename T> bool hasVisualizer() const
      {
         std::vector<T> vis;
         return visualizers(vis);
      }

      template <typename T> bool visualizers(std::vector<T>& vis) const
      {
         if (!myEntityElement)
         {
            return false;
         }
         myEntityElement->findVisualizersByDynamicCast(vis);
         return (!vis.empty());
      }

      virtual void setIconScale(float);
      template <typename T> void setIconScale(float scale)
      {
         std::vector<T> visualizers;
         myEntityElement->findVisualizersByDynamicCast(visualizers);
         typename std::vector<T>::iterator i = visualizers.begin();
         typename std::vector<T>::iterator e = visualizers.end();
         for(;i != e; ++i)
         {
            if (*i)
            {
               (*i)->setIconScale(scale);
            }
         }
      }

      virtual void setExtendedData(const std::map<std::string, std::string>&);
      virtual std::map<std::string, std::string> extendedData() const;

      virtual void setEntityExtents(const DtVector& volume, const DtVector& offset);
      virtual void extents(DtVector& volume, DtVector& offset) const;

      virtual bool hasBoundingVolumes() const;

      virtual void setEntityExtentsVisible(bool, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);
      template <typename T> void setEntityExtentsVisible(bool b, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified)
      {
         std::vector<T> visualizers;
         myEntityElement->findVisualizersByDynamicCast(visualizers);
         typename std::vector<T>::iterator i = visualizers.begin();
         typename std::vector<T>::iterator e = visualizers.end();
         for(;i != e; ++i)
         {
            if (*i)
            {
               if ((modelSet == makVrv::DtModelSetId::Unspecified) || (modelSet == (*i)->modelSet()))
               {
                  (*i)->setShowExtentsEnabled(b);
               }
            }
         }
      }

      template <typename T> void setScale(float scale)
      {
         std::vector<T> visualizers;
         myEntityElement->findVisualizersByDynamicCast(visualizers);
         typename std::vector<T>::iterator i = visualizers.begin();
         typename std::vector<T>::iterator e = visualizers.end();
         for(;i != e; ++i)
         {
            if (*i)
            {
               (*i)->setScale(scale);
            }
         }
      }

      template <typename T> void setColor( makVrv::DtForceManager::RGBAColor color)
      {
         std::vector<T> visualizers;
         myEntityElement->findVisualizersByDynamicCast(visualizers);
         typename std::vector<T>::iterator i = visualizers.begin();
         typename std::vector<T>::iterator e = visualizers.end();
         for(;i != e; ++i)
         {
            if (*i)
            {
               (*i)->setColor(color.R, color.G, color.B, color.A);
            }
         }
      }

      virtual void setForceColor(const DtRwColor&);
      void setBoundingExtentColor(float r, float g, float b, float a);

      virtual std::string diGuyCharacter() const;

      virtual std::string diGuyAppearance() const;

      virtual std::string diGuyHandItem() const;
      virtual std::string diGuyHead() const;

      virtual void setAppearance(int);
      virtual DtAppearance appearance() const;

      virtual void setLifeFormState(unsigned int, bool paused = false);
      virtual void setCharacterWeaponAiming(bool aiming);
      virtual void setEnableAnimationSmoothing(bool);
      virtual void setCharacterAction(const std::string& animation, bool paused = false);
      virtual const std::string& characterAction() const;

      virtual void setCharacterModel(const std::string& animation);
      virtual std::string characterModel() const;

      virtual void setCharacterBodyWeight(double);
      virtual void setCharacterAlive(bool);

      virtual void setCharacterAppearance(const std::string& animation);
      virtual void setCharacterHandItem(const std::string& item);
      virtual void setCharacterHead(const std::string& head);

      virtual void setCharacterPrimaryUnit( const DtPatchIdentifier& patchId );
      virtual void setCharacterSecondaryUnit( const DtPatchIdentifier& patchId );
      virtual void setCharacterRank( const DtPatchIdentifier& patchId );
      virtual void setCharacterName( const DtString& patchId );

      virtual void setDecorationEnabled(const std::string& decorationId, bool);

      virtual void setDisplayName( const std::string& displayName );

      virtual void setSymbolNameVisible(bool, makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Icons2D);

      virtual void setStatePropertyDecorationsVisible(bool);

      virtual void setSymbolDecorationsVisible(bool);

      virtual bool isAggregate() const
      {
         return myIsAggregate;
      }

      virtual void finalizeSetup();

      virtual void updateSymbolRotation(const DtTaitBryan&);

      virtual void updateSymbolRotation(double);

      virtual void setRotateToHeading(bool);
      bool rotateToHeading() const
      {
         return myRotateToHeading;
      }

      virtual void slot_visualizerCreationDisabled( makVrv::DtModelSetId modelSet, int visualType );
      virtual void slot_visualizerCreationEnabled( makVrv::DtModelSetId modelSet, int visualType );

      boost::signals2::signal<void (DtEntityFacadeCollection*)> signal_orientationChanged;

      boost::signals2::signal<void (std::string, std::string)> signal_markingDecalSet;

      boost::signals2::signal<void ()> signal_startOfMarkingDecalSet;
      boost::signals2::signal<void ()> signal_endOfMarkingDecalSet;

   protected:
      makVrv::DtUnicode                      myElementDefinition;

      bool mySetupNodeMaskFlags;
      makVrv::DtBaseConnection* myConnection;

      DtExtAggregateStateListener*         myListener;
      makVrv::DtEntityElement* myEntityElement;

      std::string myOverlay;
      bool myIsAggregate;
      bool myHasLabelChange;
      bool myHasExtendedLabelsChange;
      bool myForceChanged;
      DtForceType myForceType;
      int myAppearance;

      std::string myDiGuyAppearance;
      std::string myDiGuyHandItem;
      std::string myDiGuyHead;
      DtPatchIdentifier myDiGuyPrimaryUnitPatch;
      DtPatchIdentifier myDiGuySecondaryUnitPatch;
      DtPatchIdentifier myDiGuyRankPatch;
      std::string myDiGuyCharacterName;
      std::string myCharacterAction;
      std::string myCharacterModel;
      double myDiGuyBodyWeight;
      bool myCharacterPaused;

      bool myIsDiGuy;
      bool myOriginSet;
      bool myNeedsRealization;
      bool myIndicatorVisible;
      bool myHatLinesVisible;
      bool myEnableAnimationSmoothing;
      bool myUseHighestTerrainLOD;
      std::map<int, bool> myHeadingIndicatorVisible;
      bool myTrackHistoryVisible;
      std::map<int, bool> mySymbolNameVisible;
      std::map<int, bool> myEntityExtentsVisible;
      int myDictionaryToDisplay;
      int myAttributeCompareValue;
      bool myMarkingsModified;

      typedef std::map<makVrv::DtModelSetId, std::map<int, int> > ActivatedStates;
      ActivatedStates myActivatedStates;

      mutable DtBoundingVolumeSupportPointCalculator* myBVSPCalculator;

      bool myRotateToHeading;

      makVrv::DtSignalConnectionManager myConnections;
      boost::signals2::connection myFinalizeConnection;

      std::map<std::string, std::string> myMarkingDecals;
      std::map<makVrv::DtModelSetId, std::map<int, bool> > myEffectsShown;

      std::set<int> myIgnoreVisualTypeSwitch;
      std::string myDecorationSet = "defaultTacticalGraphic";
      std::string myUnitCollection = "Default";
   };

   class DT_DLL_VRFGUICORE DtEntityFacadeCollectionCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtEntityFacadeCollectionCreator(makVrv::DtDe& de);
      virtual ~DtEntityFacadeCollectionCreator();

      static DtEntityFacadeCollectionCreator& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe&, DtEntityFacadeCollectionCreator*);

      virtual DtEntityFacadeCollection* create(makVrv::DtModelSetId modelSet = makVrv::DtModelSetId::Unspecified);

   protected:
      makVrv::DtDe& myDe;
   };
}