DtWidgetLabel.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/DtWidget.h>

#include <vrvUtil/DtUnicode.h>

#include <makArchives/DtAltitudeBasedScaleConfigurationRecord.h>

#include <limits>

namespace makVrv
{
   class DT_DLL_VRVCORE DtWidgetLabel : public DtWidget
   {
   public:
      enum class TextHorizontalAlignmentPolicy
      {
         AlignLeft,              // Aligns text left
         AlignCenter,            // Aligns text center
         AlignRight,             // Aligns text right
         AlignJustify            // Fully justifies text
      };

      enum class OriginPlacementPolicy
      {
         BottomLeft,                      // Bottom left corner of label.
         BottomRight,                     // Bottom right corner of label.
         BottomMiddle,                    // Middle of the bottom edge of the label.
         LeftMiddle,                      // Middle of the left edge of the label.
         RightMiddle,                     // Middle of the left edge of the label.
         Center,                          // Center, both horizontally and vertically, of the label.
         BelowBottomLeftByLineHeight,     // (BottomLeft.x, BottomLeft.y - lineHeight)
         BelowBottomLeftByHalfLineHeight, // (BottomLeft.x, BottomLeft.y - lineHeight / 2)
         BelowBottomRightByLineHeight,    // (BottomRight.x, BottomRight.y - lineHeight)
         BelowBottomRightByHalfLineHeight,// (BottomRight.x, BottomRight.y - lineHeight / 2)
         OffsetFromBottomLeftByBounds,    // (BottomLeft.x - lineWidth, BottomLeft.y - lineHeight)
         OffsetFromBottomRightByBounds    // (BottomRight.x + lineWidth, BottomRight.y - lineHeight)
      };

      enum class TextBoundsPolicy
      {
         ConstrainToLine,     // Use bounds that include the line height.
         ConstrainToBounds,   // Use bounds set in setSize.
         ConstrainToText,     // Use minimal bounds for text (don't include line height).
         ConstrainToNone      // Don't use bounds.
      };

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

      virtual ~DtWidgetLabel();

      DtWidgetLabel() = delete;

      DtWidgetLabel( const DtWidgetLabel &other) = delete;

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

      DtWidgetLabel( const DtWidgetLabel&& other ) = delete;

      DtWidgetLabel& operator=( const DtWidgetLabel&& other ) = delete;
   public:
      virtual void setText(const DtUnicode& string) = 0;

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

      virtual void setTextHorizontalAlignmentPolicy(TextHorizontalAlignmentPolicy ha) = 0;

      virtual void setFont(const std::string& fontFace, float size) = 0;

      virtual void setTextBoundsPolicy(TextBoundsPolicy) = 0;
      
      virtual void setFontScale(float scale) = 0;

      virtual float fontScale(double minimumAltitudeForUse
         = std::numeric_limits<double>::min()) const = 0;

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

      virtual void clearAltitudeBasedConfigurations() = 0;

      virtual void setIsForcedAltitudeBasedFontScaleEnabled(bool enabled) = 0;

      virtual void setBaseAltitudeToUseForForcedFontScale(double baseAltitude) = 0;
      
      virtual void setLodOutAltitude(double lodOutAltitude) = 0;

      virtual void setIsLodOutAltitudeEnabled(bool isLodOutAltitudeEnabled) = 0;
      virtual bool isLodOutAltitudeEnabled() const = 0;

      virtual void setBoundsLength(int len) = 0;

      virtual void setOriginPlacementPolicy( OriginPlacementPolicy gcp) = 0;

      virtual void setRotation( float angle ) = 0;

      virtual double getRotation() const = 0;

      virtual void setIsRotationInScreenSpace(bool isRotationInScreenSpace) = 0;

      virtual bool isRotationInScreenSpace() const = 0;

      virtual void setMaximumWorldHeight(double worldHeightInMeters) = 0;

      virtual double maximumWorldHeight() const = 0;

      virtual void setMaximumWorldWidth(double worldWidthInMeters) = 0;

      virtual double maximumWorldWidth() const = 0;

      virtual void setSize(float width, float height) = 0;

      virtual void getSize(float& width, float& height) = 0;
   };
}