DtWidgetLabel.h

Go to the documentation of this file.

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


#pragma once

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

#include <vrvUtil/DtUnicode.h>

#include <limits>

#include <makArchives/DtEntitySettingsRecord.h>

namespace makVrv
{

   class DT_DLL_VRVCORE DtWidgetLabel : public DtWidget
   {
   public:

      enum HorizontalAlignment
      {
         AlignLeft,              // Aligns text left
         AlignCenter,            // Aligns text center
         AlignRight,             // Aligns text right
         AlignJustify            // Fully justifies text
      };

      enum GlyphCenterPolicy
      {
         CenterNone,             // Does not center text in box
         CenterHorizontal,       // Centers text in box horizontally
         CenterVertical,         // Centers text in box vertically
         CenterBoth,             // Centers both horizontally and vertically
         AlignToTextHeight       // Places text at bottom of box
      };

      enum SizeConstraints
      {
         ConstrainToText,        // Constrains to width/height of text
         ConstrainToBounds       // Constrains to width/height set in setSize
      };

   public:

      DtWidgetLabel( DtDe& de, DtUniqueID id );

      virtual ~DtWidgetLabel();

      DtWidgetLabel() = 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 setTextAlignment(HorizontalAlignment ha) = 0;

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

      virtual void setSizeConstraints(SizeConstraints) = 0;
      
      virtual void setFontScale(float scale) = 0;

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

      virtual void setAltitudeBasedConfigurations(
         const makArchives::DtDynamicScaleConfigurationCollection& 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 void setBoundsLength(int len) = 0;

      virtual void setGlyphCenterPolicy( GlyphCenterPolicy gcp) = 0;

      virtual void setRotation( float angle ) = 0;

      virtual double getRotation() const = 0;

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

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

}