DtOverlaySpiderWebModel.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtModel.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtSharedDisplayUnitsSettings.h>
#include <vrvCore/DtTextProxyInterface.h>
#include <vrvCore/DtSegmentedLineInterface.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <makArchives/DtAltitudeBasedScaleConfigurationRecord.h>

#include <matrix/vlDcm.h>

namespace makVrv
{

   class DtDe;

   class DT_DLL_VRVCORE DtOverlaySpiderWebModel : public DtModel
   {
   public:

      enum class DtListenToDisplayUnitSettingIndex
      {
         North,
         Orientation,
         Distance
      };

   public:

      DtOverlaySpiderWebModel(DtDe& de, DtUniqueID id);

      DtOverlaySpiderWebModel() = delete;

      DtOverlaySpiderWebModel(const DtOverlaySpiderWebModel&) = delete;

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

      virtual ~DtOverlaySpiderWebModel();

   public:
      virtual void setModelDefinition(const std::string& str);


      // @{
      virtual void setPosition(const DtVector& position);
      virtual DtVector position() const;

      virtual void setPosition(int vtx, const DtVector& position) override;
      // @}

      // @{
      virtual void setOrientation(const DtTaitBryan& orientation);
      virtual DtTaitBryan orientation() const;
      // @}

      // @{
      virtual void setHeading(float heading);
      virtual float heading() const;
      // @}

      // @{
      virtual void setMaxAngleSegment(double angleSegmentMax);
      virtual double maxAngleSegment() const;
      // @}

      // @{
      virtual void setRadius(double x);
      virtual double radius() const;
      // @}

      // @{
      virtual void setScale(float scale);
      virtual float scale() const;
      // @}

      // @{
      virtual void setVisible(bool isVisible);
      virtual bool isVisible() const;
      // @}

      // @{
      virtual void setNumberOfSpokes(unsigned int numSpokes);
      virtual unsigned int numberOfSpokes() const;
      // @}

      // @{
      virtual void setNumberOfRings(unsigned int numRings);
      virtual unsigned int numberOfRings() const;
      // @}

      // @{
      virtual void setIsInnerRingFilled(bool filled);
      virtual bool isInnerRingFilled() const;
      // @}

      // @{
      virtual void setRingIntervalDistance(double interval);
      virtual double ringIntervalDistance() const;
      // @}

      // @{
      virtual void setLineStipplePattern(unsigned int stipplePattern);
      virtual unsigned int lineStipplePattern() const;
      // @}

      // @{
      virtual void setLineWidth(float width);
      virtual float lineWidth() const;
      // @}

      // @{
      virtual void setColor(float r, float g, float b, float a);
      virtual bool getColor(float& r, float& g, float& b, float& a) const;
      // @}

      // @{
      virtual void setOpacity(float opacity);
      virtual float opacity() const;
      // @}

      // @{
      virtual void setEventsEnabled(bool enabled);
      virtual bool eventsEnabled() const;
      // @}

      // @{
      virtual void setListenToNorthDisplayUnitSettings(bool listenToNorthUnitToUse);
      virtual bool listenToNorthDisplayUnitSettings() const;
      // @}

      // @{
      virtual void setListenToOrientationDisplayUnitSettings(bool listenToOrientationUnitToUse);
      virtual bool listenToOrientationDisplayUnitSettings() const;
      // @}

      // @{
      virtual void setListenToDistanceDisplayUnitSettings(bool listenToDistanceUnitToUse);
      virtual bool listenToDistanceDisplayUnitSettings() const;
      // @}

      // @{
      virtual void setGroup(int groupNum);
      virtual int group() const;
      // @}

      // @{
      virtual void setIsDecorated(bool isDecorated);
      virtual bool isDecorated() const;
      // @}

      // @{
      virtual void setFontFile(std::string fontFile);
      virtual std::string fontFile() const;
      // @}

      // @{
      virtual void setFontPointSize(float pointSize);
      virtual float fontPointSize() const;
      // @}

      // @{
      virtual void setFontColor(float r, float g, float b, float a);
      virtual bool getFontColor(float& r, float& g, float& b, float& a) const;
      // @}

      // @{
      virtual void setDistanceUnit(DtSharedDisplayUnitsSettings::DistanceUnits unit);
      virtual DtSharedDisplayUnitsSettings::DistanceUnits distanceUnit() const;
      // @}

      // @{
      virtual void setDistanceDecimals(unsigned int decimals);
      virtual unsigned int distanceDecimals() const;
      // @}

      // @{
      virtual void setOrientationUnit(DtSharedDisplayUnitsSettings::OrientationUnits unit);
      virtual DtSharedDisplayUnitsSettings::OrientationUnits orientationUnit() const;
      // @}

      // @{
      virtual void setOrientationDecimals(unsigned int decimals);
      virtual unsigned int orientationDecimals() const;
      // @}

      // @{
      virtual void setNorthUnit(DtSharedDisplayUnitsSettings::NorthUnits unit);
      virtual DtSharedDisplayUnitsSettings::NorthUnits northUnit() const;
      // @}

      virtual void setAltitudeBasedConfigurations(
         const makArchives::DtAltitudeBasedScaleConfigurationRecordCollection& configs);

      virtual void clearAltitudeBasedConfigurations();

      virtual void setLodOutAltitude(double lodOutAltitude);

      virtual void setIsLodOutAltitudeEnabled(bool isLodOutAltitudeEnabled);


   protected:

      // @name Inherited DtModel methods
      // @{

      virtual void addToScene(const DtUniqueID& sceneObjectId, DtModelSetId modelSet, int visualizerType);

      virtual void removeFromScene();

      virtual void setIsSupportModel(bool isSupport);

      // @}

      virtual bool listenToDisplayUnitSignals() const;

      virtual void setOverlay(unsigned int overlayId);

      virtual void update();

      // Update the spider web vertices based on attributes
      virtual void render();

      virtual void recreateSpiderWeb();

      virtual void createSpiderWebIfNecessary();

      virtual void deleteSpiderWeb();

      virtual void updateColors();

      virtual void updateAltitudeBasedConfigurationsForLabels();

      virtual void set3DPositionAux(double x, double y, double z, float tempPackedCoords[4]);

      virtual void setSpokeVertexPosition(unsigned int spokeIndex, unsigned int vertexIndex, double x, double y, double z);

      virtual void setRingVertexPosition(unsigned int ringIndex, unsigned int vertexIndex, double x, double y, double z);

      virtual void setLabelPosition(unsigned int labelIndex, double x, double y, double z);

      virtual void slot_displayUnitUnitChanged(const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName, unsigned int newUnit, unsigned int oldUnit);

      virtual void slot_displayUnitDecimalsChanged(const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName, unsigned int newDecimals, unsigned int oldDecimals);

      virtual void slot_coordinateSystemChanged();

   protected:
      unsigned int myOverlay;

      bool myEventsEnabled;
      unsigned long long myUserData;

      DtVector myPosition;
      DtDcm myOrientationDcm;
      DtTaitBryan myOrientationTaitBryan; // needed for orientation accessor
      double myRadius;

      unsigned int myNumberOfSpokes;
      unsigned int myNumberOfRings;

      double myRingIntervalDistance;
      bool myIsRingIntervalSet;

      bool myIsInnerRingFilled;

      bool myIsDecorated;

      bool myVisible;
      float myScale;
      float myColor[4];
      float myLineWidth;
      unsigned int myLineStipplePattern;

      std::string myFontFile;
      float myFontPointSize;
      float myFontColor[4];

      double myMaxAngleSegment;

      DtSharedDisplayUnitsSettings::OrientationUnits myOrientationUnitToUse;
      DtUnicode myOrientationNotation;
      unsigned int myOrientationDecimalsToUse;

      DtSharedDisplayUnitsSettings::DistanceUnits myDistanceUnitToUse;
      DtUnicode myDistanceNotation;
      unsigned int myDistanceDecimalsToUse;

      int myGroup;

      std::vector<DtSegmentedLineInterface*> mySpokes;
      std::vector<DtSegmentedLineInterface*> myRings;
      std::vector<DtTextProxyInterface*> myLabels;

      makArchives::DtAltitudeBasedScaleConfigurationRecordCollection myFontScaleFromMinimumAltitudeVector;

      bool myIsLodOutAltitudeEnabled;
      double myLodOutAltitude;

      double myOffsetAngle;

      std::map<DtListenToDisplayUnitSettingIndex,bool> myListenToDisplayUnitSettings;

      DtSharedDisplayUnitsSettings::NorthUnits myNorthToUse;
      float myHeading;

      bool myNeedsUpdate;

      DtSignalConnectionManager myConnections;
      DtSignalConnectionManager myDisplayUnitConnections;

      DtCoordinateSystem* myCoordinateSystem = nullptr;
   };

}