line.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef LINE_H_
31 #define LINE_H_
32 
33 #include "object.h"
34 
35 #include <OgreSceneNode.h>
36 #include <OgreMaterial.h>
37 #include <OgreSharedPtr.h>
38 
39 namespace Ogre
40 {
41 class Any;
42 } // namespace Ogre
43 
44 namespace rviz
45 {
46 /* Represents a straight wireframe line between two points. */
47 class Line : public Object
48 {
49 public:
56  Line(Ogre::SceneManager* manager, Ogre::SceneNode* parent_node = nullptr);
57 
58  ~Line() override;
59 
65  void setPoints(Ogre::Vector3 start, Ogre::Vector3 end);
66 
67  void setVisible(bool visible);
68 
73  void setPosition(const Ogre::Vector3& position) override;
74 
79  void setOrientation(const Ogre::Quaternion& orientation) override;
80 
85  void setScale(const Ogre::Vector3& scale) override;
86 
93  void setColor(float r, float g, float b, float a) override;
94 
100  virtual void setColor(const Ogre::ColourValue& c);
101 
106  const Ogre::Vector3& getPosition() override;
111  const Ogre::Quaternion& getOrientation() override;
112 
117  void setUserData(const Ogre::Any& data) override;
118 
119 protected:
120  Ogre::SceneNode* scene_node_;
121  Ogre::ManualObject* manual_object_;
122  Ogre::MaterialPtr manual_object_material_;
123 };
124 
125 } // namespace rviz
126 
127 #endif /* LINE_H_ */
Ogre
Definition: axes_display.h:35
rviz::Line::setPoints
void setPoints(Ogre::Vector3 start, Ogre::Vector3 end)
Set the start and end point of the line.
Definition: line.cpp:79
rviz::Line::~Line
~Line() override
Definition: line.cpp:68
rviz::Line
Definition: line.h:47
rviz::Line::setUserData
void setUserData(const Ogre::Any &data) override
Set the user data on this object.
Definition: line.cpp:146
rviz::Line::Line
Line(Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=nullptr)
Constructor.
Definition: line.cpp:42
rviz::Line::setVisible
void setVisible(bool visible)
Definition: line.cpp:89
rviz::Line::setOrientation
void setOrientation(const Ogre::Quaternion &orientation) override
Set the orientation of the object.
Definition: line.cpp:100
rviz::Line::setPosition
void setPosition(const Ogre::Vector3 &position) override
Set the position of this object.
Definition: line.cpp:95
rviz
Definition: add_display_dialog.cpp:54
rviz::Line::setColor
void setColor(float r, float g, float b, float a) override
Set the color of the object. Values are in the range [0, 1].
Definition: line.cpp:129
rviz::Line::getOrientation
const Ogre::Quaternion & getOrientation() override
Get the local orientation of this object.
Definition: line.cpp:141
rviz::Line::manual_object_
Ogre::ManualObject * manual_object_
Definition: line.h:121
rviz::Line::manual_object_material_
Ogre::MaterialPtr manual_object_material_
Definition: line.h:122
rviz::Line::getPosition
const Ogre::Vector3 & getPosition() override
Get the local position of this object.
Definition: line.cpp:136
start
ROSCPP_DECL void start()
rviz::Line::setScale
void setScale(const Ogre::Vector3 &scale) override
Set the scale of the object. Always relative to the identity orientation of the object.
Definition: line.cpp:105
rviz::Object
Base class for visible objects, providing a minimal generic interface.
Definition: object.h:47
rviz::Line::scene_node_
Ogre::SceneNode * scene_node_
Definition: line.h:120
object.h


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Sat Jun 1 2024 02:31:53