MIRA
LineStripObject.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
49 #ifndef _MIRA_LINESTRIPOBJECT_H_
50 #define _MIRA_LINESTRIPOBJECT_H_
51 
52 #ifndef Q_MOC_RUN
53 #include <OGRE/OgreMaterial.h>
54 #endif
55 
57 
59 
60 namespace Ogre {
61  class BillboardChain;
62 }
63 
64 namespace mira {
65 
67 
81 {
82 public:
83  LineStripObject(Ogre::SceneManager* sceneManager, Ogre::SceneNode* parent = NULL);
84  virtual ~LineStripObject();
85 
87  virtual void setColor(const Ogre::ColourValue& color);
88 
89  virtual void setVisible(bool visible, bool cascade = true);
90  bool isVisible() const { return mIsVisible; }
91 
93  void enableAlphaBlending(bool useAlpha=true);
94 
99  void setLineWidth(float width);
100 
101 public:
102 
104  void clear();
105 
107  void begin();
108 
110  void end();
111 
113  void point(const Ogre::Vector3& point);
114 
116  void point(const Ogre::Vector3& point, const Ogre::ColourValue& color);
117 
118 
124  void add(const Ogre::Vector3& point);
125 
131  void add(const Ogre::Vector3& point, const Ogre::ColourValue& color);
132 
134  void addLine(const Ogre::Vector3& p1,const Ogre::Vector3& p2);
135 
137  void addLine(const Ogre::Vector3& p1,const Ogre::Vector3& p2, const Ogre::ColourValue& color);
138 
139 private:
140 
141  struct Point
142  {
143  Point() {}
144  Point(const Ogre::Vector3& iP, const Ogre::ColourValue& iC) :
145  p(iP), c(iC) {}
146 
147  Ogre::Vector3 p;
148  Ogre::ColourValue c;
149  };
150 
151  struct Strip
152  {
153  Strip() : pixelLineSection(-1) {}
154  std::list<Point> pts;
155  int pixelLineSection;
156  };
157 
158 private:
159 
160  void regenerateStrip(std::size_t idx);
161  void regenerateAll();
162  void manageVisibility();
163 
164 private:
165 
166  std::vector<boost::shared_ptr<Strip>> mStrips;
167  boost::shared_ptr<Strip> mActiveStrip;
168 
169  Ogre::BillboardChain* mBillboardLines; // for width >0
170  Ogre::ManualObject* mPixelLines; // for width <=0
171 
172  Ogre::MaterialPtr mMaterial;
173  float mWidth;
174  Ogre::ColourValue mColor;
175 
176  bool mIsVisible;
177 };
178 
180 
181 } // namespace
182 
183 #endif
Declaration of VisualizationObject.
General point class template.
Definition: Point.h:133
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
Definition: VisualizationObject.h:71
Renders one or more line strips.
Definition: LineStripObject.h:80
bool isVisible() const
Definition: LineStripObject.h:90
#define MIRA_GUI_VISUALIZATION_EXPORT
Definition: GuiVisualizationExports.h:61
Definition: ImageObject.h:60