MovableText.hh

/*
 * Copyright 2011 Nate Koenig & Andrew Howard
 *
 * 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.
 *
*/
/* Desc: Middleman between OGRE and Gazebo
 * Author: indepedentCreations@gmail.com
 * Date: 13 Feb 2006
 */

#ifndef MOVABLETEXT_HH
#define MOVABLETEXT_HH

// TODO: remove this line
#include <OGRE/OgreMovableObject.h>
#include <OGRE/OgreRenderable.h>

#include <string>

#include "common/CommonTypes.hh"
#include "common/Color.hh"
#include "math/MathTypes.hh"

namespace boost
{
  class recursive_mutex;
}

namespace gazebo
{
    namespace rendering
  {
 
    class 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 = "Arial", 
                        float _charHeight = 1.0,
                        const common::Color &_color = common::Color::White);
    
      public: void SetFontName(const std::string &font);
              
      public: const std::string &GetFont() const;
    
      public: void SetText(const std::string & caption);
    
      public: const std::string &GetText() const;
    
      public: void SetColor(const common::Color &_color);
    
      public: const common::Color &GetColor() const; 
    
      public: void SetCharHeight(float height);
    
      public: float GetCharHeight() const;
    
      public:void SetSpaceWidth(float width);
    
      public: float GetSpaceWidth() const;
    
      public: void SetTextAlignment(const HorizAlign &hAlign, 
                                    const VertAlign &vAlign); 
    
      public: void SetBaseline(float height);
    
      public: float GetBaseline() const;
    
      public: void SetShowOnTop(bool show);
    
      public: bool GetShowOnTop() const;
    
      public: math::Box GetAABB();
   
      public: void Update();

      //         Renderable instances
      public: virtual void visitRenderables(Ogre::Renderable::Visitor* visitor,
                  bool debug = false );
  
      protected: void _setupGeometry();
    
      protected: void _updateColors();
    
      protected: void getWorldTransforms(Ogre::Matrix4 *xform) const;
    
      protected: float getBoundingRadius() const;
    
      protected: float getSquaredViewDepth(const Ogre::Camera *cam) const;
    
      private: std::string fontName;
      private: std::string text;
    
      private: common::Color color;
      private: Ogre::RenderOperation renderOp;
      private: Ogre::AxisAlignedBox *aabb;
      private: Ogre::LightList lightList;
    
      private: float charHeight;
    
      private: bool needUpdate;
    
      private: float radius;
    
      private: Ogre::Camera *camera;
      private: Ogre::RenderWindow *renderWindow;
      private: Ogre::Font *font;
      private: Ogre::MaterialPtr material;
      private: Ogre::MaterialPtr backgroundMaterial;
 
      private: float viewportAspectCoef;
      private: float spaceWidth;
      private: bool updateColors;
      private: VertAlign vertAlign;
      private: HorizAlign horizAlign;
      private: bool onTop;
      private: float baseline;
   
      private: const Ogre::Quaternion &getWorldOrientation(void) const;
      private: const Ogre::Vector3 &getWorldPosition(void) const;
      private: const Ogre::AxisAlignedBox &getBoundingBox(void) const;
      private: const Ogre::String &getMovableType() const;
    
      private: void _notifyCurrentCamera(Ogre::Camera *cam);
      private: void _updateRenderQueue(Ogre::RenderQueue* queue);
    
      protected: void getRenderOperation(Ogre::RenderOperation &op);
    
      protected: const Ogre::MaterialPtr &getMaterial(void) const;
    
      protected: const Ogre::LightList &getLights(void) const; 

      private: bool dirty;
  
      private: boost::recursive_mutex *mutex;
      private: Ogre::SimpleRenderable *renderable;
    };
  }

}
#endif