DtLineSegmentInterface.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <matrix/vlMath.h>

#include <limits>
#include <vector>

namespace makVrv
{
   class DT_DLL_VRVCORE DtLineSegmentInterface
   {
   public:
      class DtLineSegmentAltitudeBasedConfiguration
      {
      public:
         DtLineSegmentAltitudeBasedConfiguration()
            : myBaseMSLAltitude(std::numeric_limits<double>::min())
            , myPointOneScale(1.0)
            , myPointTwoScale(1.0)
         {
            // intentional noop
         }

         DtLineSegmentAltitudeBasedConfiguration(double altitude, double pointOneScale, double pointTwoScale)
            : myBaseMSLAltitude(altitude)
            , myPointOneScale(pointOneScale)
            , myPointTwoScale(pointTwoScale)
         {
            // intentional noop
         }

         ~DtLineSegmentAltitudeBasedConfiguration()
         {
            // intentional noop
         }

         DtLineSegmentAltitudeBasedConfiguration(
            const DtLineSegmentAltitudeBasedConfiguration& other) = default;

         DtLineSegmentAltitudeBasedConfiguration& operator=(
            const DtLineSegmentAltitudeBasedConfiguration& other) = default;

         DtLineSegmentAltitudeBasedConfiguration(DtLineSegmentAltitudeBasedConfiguration&&) = default;

      public:

         bool operator==(const DtLineSegmentAltitudeBasedConfiguration& config) const
         {
            return DtEq(myBaseMSLAltitude, config.myBaseMSLAltitude, DtEMilli)
               && DtEq(myPointOneScale, config.myPointOneScale, DtEMilli)
               && DtEq(myPointTwoScale, config.myPointTwoScale, DtEMilli);
         }

         double myBaseMSLAltitude;
         double myPointOneScale;
         double myPointTwoScale;
      };

      typedef std::vector<DtLineSegmentAltitudeBasedConfiguration> DtLineSegmentAltitudeBasedConfigurationCollection;

   public:
      DtLineSegmentInterface();

      virtual ~DtLineSegmentInterface();

   public:
      virtual void setAltitudeBasedConfigurations(
         const DtLineSegmentInterface::DtLineSegmentAltitudeBasedConfigurationCollection& configs) = 0;

      virtual void clearAltitudeBasedConfigurations() = 0;

      virtual void setIsUseForcedAltitudeEnabled(bool enabled) = 0;

      virtual void setForcedAltitudeToUse(double minimumAltitudeForUse) = 0;

      virtual void setLodOutAltitude(double lodOutAltitude) = 0;

      virtual void setIsLodOutAltitudeEnabled(bool isLodOutAltitudeEnabled) = 0;

      virtual void setGroup(float group) = 0;

      virtual int group() const = 0;

      virtual void set2DPositions(float x1, float y1,float x2, float y2) = 0;

      virtual void set2DPosition(unsigned int index0or1, float x, float y) = 0;

      //Set the position of the vertex.
      virtual void get2DPosition(unsigned int index0or1, float& x, float& y ) const = 0;

      virtual void setColors(float r1, float g1, float b1, float a1,
         float r2, float g2, float b2, float a2) = 0;

      virtual void set3DPosition(int index0or1,float dx, float dy, float z, float w) = 0;

      //Get the 3D position of the line.
      virtual void get3DPosition(int index0or1,float& dx, float& dy, float& z, float& w) const = 0;

      virtual void set3DDirection(unsigned int index0or1, float x, float y, float z) = 0;

      virtual void get3DDirection(unsigned int index0or1, float& x, float& y, float& z) const = 0;

      virtual void setDirection2DLength(unsigned int index0or1, float length) = 0;

      virtual float direction2DLength(unsigned int index0or1) const = 0;

      //Set the vertex color.
      virtual void setColor(unsigned int index0or1,float r, float g, float b, float a) = 0;

      //Get the vertex color.
      virtual void getColor(unsigned int index0or1,float& r, float& g, float& b, float& a) const = 0;

      //Set the line color.
      virtual void setColor(float r, float g, float b, float a);

      virtual void setWidth(float w) = 0;

      virtual float width() const = 0;

      virtual void setStippleParameters(unsigned int scale,unsigned short pattern) = 0;

      virtual void getStippleParameters(unsigned int& scale, unsigned short& pattern) const = 0;
   };

}