DtWidget.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <string>
#include <vector>
#include <limits>

namespace makVrv
{

   class DtDe;
   class DtWidgetUpdater;

   class DT_DLL_VRVCORE DtWidget
   {
   public:
      class DT_DLL_VRVCORE DtDynamicSizeConfiguration
      {
      public:
         DtDynamicSizeConfiguration(double altitude, float sizeX, float sizeY)
            : myAltitude(altitude)
            , mySizeX(sizeX)
            , mySizeY(sizeY)
            , myOffsetX(0.0)
            , myOffsetY(0.0)
         { }

         DtDynamicSizeConfiguration( double altitude, float sizeX, float sizeY,
            float offsetX, float offsetY )
            : myAltitude( altitude )
            , mySizeX( sizeX )
            , mySizeY( sizeY )
            , myOffsetX( offsetX )
            , myOffsetY( offsetY )
         {
         }

         DtDynamicSizeConfiguration()
            : myAltitude(std::numeric_limits<double>::min())
            , mySizeX(0.0f)
            , mySizeY(0.0f)
            , myOffsetX( 0.0f )
            , myOffsetY( 0.0f )
         { }

         ~DtDynamicSizeConfiguration() = default;
         DtDynamicSizeConfiguration(
            const DtDynamicSizeConfiguration &other) = default;
         DtDynamicSizeConfiguration &operator=(
            const DtDynamicSizeConfiguration &other) = default;

         double myAltitude;
         float mySizeX;
         float mySizeY;
         float myOffsetX;
         float myOffsetY;
      };

      typedef std::vector<DtDynamicSizeConfiguration> DtDynamicSizeConfigurationCollection;

   public:
      DtWidget(DtDe& de, DtUniqueID id);

      virtual ~DtWidget();

      DtWidget( const DtWidget& other ) = delete;

      DtWidget& operator=( const DtWidget& other ) = delete;

      DtWidget( const DtWidget&& other ) = delete;

      DtWidget& operator=( const DtWidget&& other ) = delete;

   public:

      virtual void setOverlay(unsigned int overlay) = 0;

      virtual unsigned int overlay() const = 0;

      virtual void setOrderGroup(unsigned int group) = 0;

      virtual void setRotation( float ) = 0;

      virtual unsigned int orderGroup() const = 0;

      virtual void setParentId( DtUniqueID id);

      virtual void setPosition(float x,float y,float z,float w = 0) = 0;

      virtual void setBackgroundImage(const std::string& filename) = 0;

      virtual void setColor(float r,float g,float b, float a) = 0;

      virtual void setOriginOffset( int xOffset, int yOffset ) = 0;

      virtual void setSize(float w, float h) = 0;

      virtual void setAltitudeSpecificSizes(
         const DtWidget::DtDynamicSizeConfigurationCollection& configs);

      virtual void clearAltitudeSpecificSizes();

      virtual void setIsForcedSizeByAltitudeEnabled(bool enabled);

      virtual void setAltitudeForForcedSize(double minimumAltitudeForUse);

      virtual void setLodOutAltitude(double lodOutAltitude) = 0;

      virtual void setIsLodOutAltitudeEnabled(bool isLodOutAltitudeEnabled) = 0;

      virtual void setPadding(float paddingX, float paddingY) = 0;

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

      virtual void setEventsEnabled(bool enabled) = 0;

      virtual void setVisible(bool visible) = 0;

      virtual DtUniqueID id() const;

      virtual DtUniqueID parentId() const;

      virtual void registerUpdater(DtWidgetUpdater* updater);

      virtual void unregisterUpdater(DtWidgetUpdater* updater);

      virtual DtWidgetUpdater* updater();

   protected:
      virtual void updateEventSignals() = 0;
   protected:
      DtDe& myDe;
      DtUniqueID myId;
      DtUniqueID myParentId;
      DtSignalConnectionManager mySignalConnectionManager;
      DtWidgetUpdater* myUpdater;
   };
}