polygon_parts.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2020, Locus Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef ROBOT_NAV_RVIZ_PLUGINS_POLYGON_PARTS_H
36 #define ROBOT_NAV_RVIZ_PLUGINS_POLYGON_PARTS_H
37 
38 #include <nav_2d_msgs/Polygon2D.h>
39 #include <nav_2d_msgs/ComplexPolygon2D.h>
40 #include <OgreManualObject.h>
41 #include <OgreSceneManager.h>
45 #include <std_msgs/ColorRGBA.h>
46 #include <string>
47 
51 namespace robot_nav_rviz_plugins
52 {
60 std_msgs::ColorRGBA getColor(rviz::ColorProperty* color_property, rviz::FloatProperty* alpha_property = nullptr);
61 
66 {
67 public:
68  PolygonOutline(Ogre::SceneManager& scene_manager, Ogre::SceneNode& scene_node);
69  virtual ~PolygonOutline();
70 
71  void reset();
72 
79  void setPolygon(const nav_2d_msgs::Polygon2D& polygon, const Ogre::ColourValue& color, double z_offset);
80 
81 protected:
82  Ogre::ManualObject* manual_object_;
83 
84  Ogre::SceneManager& scene_manager_;
85  Ogre::SceneNode& scene_node_;
86 };
87 
92 {
93 public:
94  PolygonFill(Ogre::SceneManager& scene_manager, Ogre::SceneNode& scene_node, const std::string& material_name);
95  virtual ~PolygonFill();
96 
97  void reset();
98 
105  void setPolygon(const nav_2d_msgs::Polygon2D& polygon, const std_msgs::ColorRGBA& color, double z_offset);
106 
113  void setPolygon(const nav_2d_msgs::ComplexPolygon2D& polygon, const std_msgs::ColorRGBA& color, double z_offset);
114 protected:
115  Ogre::ManualObject* manual_object_;
116  unsigned int last_vertex_count_ { 0 };
117 
118  Ogre::SceneManager& scene_manager_;
119  Ogre::SceneNode& scene_node_;
120  std::string material_name_;
121 };
122 
127 {
128 public:
129  PolygonMaterial();
130  virtual ~PolygonMaterial();
131  const std::string& getName() const { return name_; }
132 protected:
133  std::string name_;
134  Ogre::MaterialPtr material_;
135 };
136 
141 {
142 public:
143  explicit PolygonDisplayModeProperty(rviz::Property* parent, const char *changed_slot = 0);
144 
145  bool shouldDrawOutlines() const { return getDisplayMode() != DisplayMode::FILLED; }
146  bool shouldDrawFiller() const { return getDisplayMode() != DisplayMode::OUTLINE; }
147 protected:
148  enum struct DisplayMode {OUTLINE, FILLED, FILLED_OUTLINE};
149  DisplayMode getDisplayMode() const { return static_cast<DisplayMode>(property_->getOptionInt()); }
151 };
152 
153 } // namespace robot_nav_rviz_plugins
154 
155 #endif // ROBOT_NAV_RVIZ_PLUGINS_POLYGON_PARTS_H
void setPolygon(const nav_2d_msgs::Polygon2D &polygon, const Ogre::ColourValue &color, double z_offset)
Set the object to display the outline of the given polygon, in a specific color, possibly offset in z...
Ogre::SceneManager & scene_manager_
Constructs a manual ogre object to display the polygon area as a triangle mesh.
Definition: polygon_parts.h:91
PolygonOutline(Ogre::SceneManager &scene_manager, Ogre::SceneNode &scene_node)
Constructs a manual ogre object to display the polygon outline as a line strip.
Definition: polygon_parts.h:65
std_msgs::ColorRGBA getColor(rviz::ColorProperty *color_property, rviz::FloatProperty *alpha_property=nullptr)
Given a Color Property and an optional Float property, return a ROS Color message.
const std::string & getName() const
Ogre::ManualObject * manual_object_
Several reusable pieces for displaying polygons.
Wrapper that creates a flat semi-transparent Ogre material and gives it a name.
Wrapper for EnumProperty + enum for whether to display the outline, area, or both.


robot_nav_rviz_plugins
Author(s):
autogenerated on Sun Jan 10 2021 04:08:58