DtOverlayManeuverByFireModel.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 <vrvMath/DtVector2.h>
#include <vrvMath/DtVector3.h>
#include <vrvMath/DtVector4.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <matrix/vlDcm.h>

namespace makVrv
{
   class DtDe;
   class DtSegmentedLineInterface;
   class DtCoordinateSystem;

   class DT_DLL_VRVCORE DtOverlayManeuverByFireModel : public DtModel
   {
   public:


      struct ManeuverArrow
      {
         DtSegmentedLineInterface* myArrowShaft = nullptr;
         DtSegmentedLineInterface* myArrowTip = nullptr;
      };

      enum class ManeuverMode
      {
        NONE,
        ATTACK,
        SUPPORT
      };

      DtOverlayManeuverByFireModel(DtDe& de, DtUniqueID id);

      virtual ~DtOverlayManeuverByFireModel();


      // @{
      virtual void setOrigin(const DtVector& position);
      virtual DtVector origin() const;
      // @}

      virtual void setOrientation(const DtTaitBryan& orientation);

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

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

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

      // @{
      virtual void setLineWidth(float);
      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 setEventsEnabled(bool enabled);
      virtual bool eventsEnabled() const;
      // @}

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

      virtual void setManeuverMode(DtOverlayManeuverByFireModel::ManeuverMode mode);
      virtual DtOverlayManeuverByFireModel::ManeuverMode maneuverMode();

      
      // @name Inherited DtModel methods
      // @{

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

      virtual void setOrientation(int vtx, const DtTaitBryan& orientation) override;

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

      // @}

   protected:

      // @name Inherited DtModel methods
      // @{

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

      virtual void removeFromScene() override;

      virtual void setIsSupportModel(bool isSupport) override;

      // @}

      virtual void needsUpdate();

      virtual void update();

      virtual void createManeuverByFireIfNecessary();

      virtual void clearGeometry();

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

      // Position the maneuver by fire position arrow
      virtual void setManeuverByFirePositions();

      virtual void updateColors();

      virtual void updateLineColor(DtSegmentedLineInterface* seg, float r, float g, float b, float a);

      virtual void updateLineWidth(DtSegmentedLineInterface* seg, float width);

      virtual void setEventsEnabledLine(DtSegmentedLineInterface* seg, bool b, unsigned long long userData);

      virtual void updateLineStipple(DtSegmentedLineInterface* seg, unsigned int stipple);

      virtual void updateArrowTip(DtSegmentedLineInterface* arrowTip, const DtVector& start, const DtVector& end);

      virtual void updateBaseLine(DtSegmentedLineInterface* baseLine, const DtVector& start, const DtVector& end);

      virtual DtDcm calcOrientationDcm(const DtTaitBryan& orientation);

      virtual void set3DPositionAuxDcm(DtDcm dcmOri, DtVector posOffset,
         double x, double y, double z, float packedCoords[4]);

      virtual void slot_coordinateSystemChanged();

      virtual void updateVertices();

      virtual void setDimensions(float x, float y);
      virtual bool getDimensions(float& x, float& y) const;

      void setPositionOfVertex(int vtx, const DtVector& position);

   protected:
      std::vector<DtVector> myDefinedVertices;

      bool myNeedsUpdate;

      boost::signalslib::connection mySignalPostUpdateConnection;

      DtModelSetId myModelSet;
      DtDcm myOrientationDcm;
      DtTaitBryan myOrientationTaitBryan;

      DtVector4<double> myColor;
      DtVector2<double> myDimensions;
      float myScale;

      float myLineWidth;
      bool myEventsEnabled;
      unsigned long long myUserData;

      bool myVisible;
      unsigned int myLineStipplePattern;
      int myGroup;

      int myOverlayId;

      // The base line (3 segments)
      DtSegmentedLineInterface* myBaseLine;

      // 2 arrows if mode is support by fire position
      // 1 arrow if mode is attack by fire position
      std::vector<ManeuverArrow> myArrows;

      // The vertices representing the maneuver by fire tactical graphic
      std::vector<DtVector> myVertices;
      // An overall position
      DtVector myOrigin;

      // Based on the maneuver mode, there will be 1 or 2 arrows
      // If the mode = "Attack" by fire position there is 1 line from the
      // center of the base line with myArrow index 0
      // If the mode = "Support" by fire position there are 2 lines with
      // myArrow index 0 as the left and 1 as the right
      ManeuverMode myManeuverMode;

      // local clone of the system wide coordinate system.
      // for thread safety.
      DtSignalConnectionManager myConnections;
      DtCoordinateSystem* myCoordinateSystem;
   private:

      DtOverlayManeuverByFireModel() = delete;

      DtOverlayManeuverByFireModel(const DtOverlayManeuverByFireModel &) = delete;

      DtOverlayManeuverByFireModel& operator=(const DtOverlayManeuverByFireModel &) = delete;
   };

}