MovableText.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 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 GAZEBO_RENDERING_MOVABLETEXT_HH_
#define GAZEBO_RENDERING_MOVABLETEXT_HH_

#include <memory>
#include <string>

#include <ignition/math/Box.hh>
#include <ignition/math/Color.hh>

// TODO: remove this line
#include "gazebo/rendering/ogre_gazebo.h"

#include "gazebo/common/Color.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace rendering
  {
    class MovableTextPrivate;


    class GZ_RENDERING_VISIBLE MovableText
      : public Ogre::MovableObject, public Ogre::Renderable
    {
      public: enum HorizAlign {
                H_LEFT,
                H_CENTER
              };

      public: enum VertAlign {
                V_BELOW,
                V_ABOVE
              };

      public: MovableText();

      public: virtual ~MovableText();

      public: void Load(const std::string &_name,
                        const std::string &_text,
                        const std::string &_fontName,
                        float _charHeight,
                        const common::Color &_color)
                        GAZEBO_DEPRECATED(9.0);

      public: void Load(const std::string &_name,
                        const std::string &_text,
                        const std::string &_fontName = "Arial",
                        float _charHeight = 1.0,
                        const ignition::math::Color &_color =
                              ignition::math::Color::White);

      public: void SetFontName(const std::string &_font);

      public: const std::string &GetFont() const GAZEBO_DEPRECATED(9.0);

      public: const std::string &FontName() const;

      public: void SetText(const std::string &_text);

      public: const std::string &GetText() const GAZEBO_DEPRECATED(9.0);

      public: const std::string &Text() const;

      public: void SetColor(const common::Color &_color) GAZEBO_DEPRECATED(9.0);

      public: void SetColor(const ignition::math::Color &_color);

      public: const common::Color GetColor() const GAZEBO_DEPRECATED(9.0);

      public: const ignition::math::Color &Color() const;

      public: void SetCharHeight(const float _height);

      public: float GetCharHeight() const GAZEBO_DEPRECATED(9.0);

      public: float CharHeight() const;

      public: void SetSpaceWidth(const float _width);

      public: float GetSpaceWidth() const GAZEBO_DEPRECATED(9.0);

      public: float SpaceWidth() const;

      public: void SetTextAlignment(const HorizAlign &_hAlign,
                                    const VertAlign &_vAlign);

      public: void SetBaseline(const float _height);

      public: float GetBaseline() const GAZEBO_DEPRECATED(9.0);

      public: float Baseline() const;

      public: void SetShowOnTop(const bool _show);

      public: bool GetShowOnTop() const GAZEBO_DEPRECATED(9.0);

      public: bool ShowOnTop() const;

      public: ignition::math::Box AABB();

      public: void Update();

      public: virtual void visitRenderables(Ogre::Renderable::Visitor *_visitor,
          bool _debug = false) override;

      protected: void _setupGeometry() GAZEBO_DEPRECATED(9.0);

      protected: void SetupGeometry();

      protected: void _updateColors() GAZEBO_DEPRECATED(9.0);

      protected: void UpdateColors();

      protected: void getWorldTransforms(Ogre::Matrix4 *_xform) const override;

      protected: float getBoundingRadius() const override;

      protected: float getSquaredViewDepth(const Ogre::Camera *_cam) const
          override;

      protected: void getRenderOperation(Ogre::RenderOperation &_op) override;

      protected: const Ogre::MaterialPtr &getMaterial() const override;

      protected: const Ogre::LightList &getLights() const override;

      private: const Ogre::AxisAlignedBox &getBoundingBox() const override;

      private: const Ogre::String &getMovableType() const override;

      private: void _notifyCurrentCamera(Ogre::Camera *_cam) override;

      private: void _updateRenderQueue(Ogre::RenderQueue *_queue) override;

      private: std::unique_ptr<MovableTextPrivate> dataPtr;
    };
  }
}
#endif