gz/rendering/Text.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_RENDERING_TEXT_HH_
#define GZ_RENDERING_TEXT_HH_
 
#include <string>
 
#include <gz/math/AxisAlignedBox.hh>
#include <gz/math/Color.hh>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/Geometry.hh"
#include "gz/rendering/Object.hh"
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    enum class TextHorizontalAlign
    {
      LEFT = 0,
      CENTER = 1,
      RIGHT = 2
    };
 
    enum class TextVerticalAlign
    {
      BOTTOM = 0,
      CENTER = 1,
      TOP = 2
    };
 
    class GZ_RENDERING_VISIBLE Text :
      public virtual Geometry
    {
      public: Text() = default;
 
      public: virtual ~Text();
 
      public: virtual void SetFontName(const std::string &_font) = 0;
 
      public: virtual std::string FontName() const = 0;
 
      public: virtual void SetTextString(const std::string &_text) = 0;
 
      public: virtual std::string TextString() const = 0;
 
      public: virtual void SetColor(const gz::math::Color &_color) = 0;
 
      public: virtual gz::math::Color Color() const = 0;
 
      public: virtual void SetCharHeight(const float _height) = 0;
 
      public: virtual float CharHeight() const = 0;
 
      public: virtual void SetSpaceWidth(const float _width) = 0;
 
      public: virtual float SpaceWidth() const = 0;
 
      public: virtual void SetTextAlignment(const TextHorizontalAlign &_hAlign,
                  const TextVerticalAlign &_vAlign) = 0;
 
      public: virtual TextHorizontalAlign HorizontalAlignment() const = 0;
 
      public: virtual TextVerticalAlign VerticalAlignment() const = 0;
 
      public: virtual void SetBaseline(const float _baseline) = 0;
 
      public: virtual float Baseline() const = 0;
 
      public: virtual void SetShowOnTop(const bool _onTop) = 0;
 
      public: virtual bool ShowOnTop() const = 0;
 
      public: virtual gz::math::AxisAlignedBox AABB() const = 0;
    };
    }
  }
}
 
#endif