facing_visualizer.h

Go to the documentation of this file.

// -*- mode: c++ -*-
/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2014, JSK Lab
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the JSK Lab nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/


#ifndef JSK_RVIZ_PLUGIN_FACING_VISUALIZER_H_
#define JSK_RVIZ_PLUGIN_FACING_VISUALIZER_H_

#include <OGRE/OgreTexture.h>
#include <OGRE/OgreSceneManager.h>
#include <OGRE/OgreSceneNode.h>
#include <OGRE/OgreTexture.h>
#include <OGRE/OgreMaterial.h>
#include <OGRE/OgreManualObject.h>
#include <rviz/display_context.h>
#include <ros/time.h>
#include <rviz/ogre_helpers/billboard_line.h>
#include <rviz/ogre_helpers/movable_text.h>
#include "overlay_utils.h"

namespace jsk_rviz_plugins
{

  // outer radius
  // inner radius
  class SquareObject
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<SquareObject> Ptr;
#else
    typedef boost::shared_ptr<SquareObject> Ptr;
#endif
    SquareObject(Ogre::SceneManager* manager,
                 double outer_radius,
                 double inner_radius,
                 std::string name);
    enum PolygonType
    {
      CIRCLE, SQUARE
    };
    
    virtual ~SquareObject();
    virtual Ogre::ManualObject* getManualObject();
    virtual void setOuterRadius(double outer_radius);
    virtual void setInnerRadius(double inner_radius);
    virtual void rebuildPolygon();
    virtual void setPolygonType(PolygonType type);
  protected:
    Ogre::ManualObject* manual_;
    Ogre::SceneManager* manager_;
    double outer_radius_;
    double inner_radius_;
    std::string name_;
    PolygonType polygon_type_;
  private:
  };

  class TextureObject           // utility class for texture
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<TextureObject> Ptr;
#else
    typedef boost::shared_ptr<TextureObject> Ptr;
#endif
    TextureObject(const int width, const int height, const std::string name);
    virtual ~TextureObject();
    virtual int getWidth() { return width_; };
    virtual int getHeight() { return height_; };
    virtual ScopedPixelBuffer getBuffer();
    virtual std::string getMaterialName();
  protected:
    Ogre::TexturePtr texture_;
    Ogre::MaterialPtr material_;
    const int width_;
    const int height_;
    const std::string name_;
  private:
    
  };

  class FacingObject
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<FacingObject> Ptr;
#else
    typedef boost::shared_ptr<FacingObject> Ptr;
#endif
    FacingObject(Ogre::SceneManager* manager,
                 Ogre::SceneNode* parent,
                 double size);
    virtual ~FacingObject();
    virtual void setPosition(Ogre::Vector3& pos);
    virtual void setOrientation(rviz::DisplayContext* context);
    virtual void setOrientation(Ogre::Quaternion& rot); // non facing API
    virtual void update(float wall_dt, float ros_dt) = 0;
    virtual void setSize(double size);
    virtual void setEnable(bool enable);
    virtual void setColor(QColor color);
    virtual void setColor(Ogre::ColourValue color);
    virtual void setText(std::string text);
    virtual void setAlpha(double alpha);
  protected:
    virtual void updateColor() = 0;
    virtual void updateText() = 0;
    Ogre::SceneManager* scene_manager_;
    Ogre::SceneNode* node_;
    Ogre::ColourValue color_;
    double size_;
    bool enable_;
    std::string text_;
  private:
    
  };

  class SimpleCircleFacingVisualizer: public FacingObject
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<SimpleCircleFacingVisualizer> Ptr;
#else
    typedef boost::shared_ptr<SimpleCircleFacingVisualizer> Ptr;
#endif
    SimpleCircleFacingVisualizer(Ogre::SceneManager* manager,
                                 Ogre::SceneNode* parent,
                                 rviz::DisplayContext* context,
                                 double size,
                                 std::string text = "");
    virtual ~SimpleCircleFacingVisualizer();
    virtual void update(float wall_dt, float ros_dt);
    virtual void reset();
    
    virtual void setSize(double size);
    virtual void setEnable(bool enable);
    virtual void setText(std::string text);
  protected:
    virtual void updateArrowsObjects(Ogre::ColourValue color);
    virtual void createArrows(rviz::DisplayContext* context);
    virtual void updateLine();
    virtual void updateTextUnderLine();
    virtual void updateText();
    virtual void updateColor();
    rviz::BillboardLine* line_;
    rviz::BillboardLine* text_under_line_;
    Ogre::ManualObject* upper_arrow_;
    Ogre::ManualObject* lower_arrow_;
    Ogre::ManualObject* left_arrow_;
    Ogre::ManualObject* right_arrow_;
    Ogre::SceneNode* upper_arrow_node_;
    Ogre::SceneNode* lower_arrow_node_;
    Ogre::SceneNode* left_arrow_node_;
    Ogre::SceneNode* right_arrow_node_;
    Ogre::MaterialPtr upper_material_;
    Ogre::MaterialPtr lower_material_;
    Ogre::MaterialPtr left_material_;
    Ogre::MaterialPtr right_material_;
    std::string upper_material_name_;
    std::string left_material_name_;
    std::string lower_material_name_;
    std::string right_material_name_;
    rviz::MovableText* msg_;
    Ogre::SceneNode* target_text_node_;
  private:
    
  };
  
  class FacingTexturedObject: public FacingObject
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<FacingTexturedObject> Ptr;
#else
    typedef boost::shared_ptr<FacingTexturedObject> Ptr;
#endif
    FacingTexturedObject(Ogre::SceneManager* manager,
                         Ogre::SceneNode* parent,
                         double size);
    virtual void setSize(double size);
  protected:
    SquareObject::Ptr square_object_;
    TextureObject::Ptr texture_object_;

  private:
    
  };
  
  class GISCircleVisualizer: public FacingTexturedObject
  {
  public:
#if ROS_VERSION_MINIMUM(1,12,0)
    typedef std::shared_ptr<GISCircleVisualizer> Ptr;
#else
    typedef boost::shared_ptr<GISCircleVisualizer> Ptr;
#endif
    GISCircleVisualizer(Ogre::SceneManager* manager,
                        Ogre::SceneNode* parent,
                        double size,
                        std::string text = "");
    virtual void setText(std::string text) { text_ = text; }
    virtual void update(float wall_dt, float ros_dt);
    virtual void setAnonymous(bool anonymous);
  protected:
    virtual void updateColor() {}
    virtual void updateText() {}
    virtual void setSize(double size);
    bool anonymous_;
    std::string text_;
  private:
  };
  
}

#endif