axes_display.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008, 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 RVIZ_AXES_DISPLAY_H
31 #define RVIZ_AXES_DISPLAY_H
32 
33 #include <rviz/display.h>
34 
35 namespace Ogre
36 {
37 class RibbonTrail;
38 }
39 
40 namespace rviz
41 {
42 class Axes;
43 class FloatProperty;
44 class TfFrameProperty;
45 
47 class AxesDisplay : public Display
48 {
49  Q_OBJECT
50 public:
51  AxesDisplay();
52  ~AxesDisplay() override;
53 
54  void onInitialize() override;
55 
61  void set(float length, float radius);
62 
63  // Overrides from Display
64  void update(float dt, float ros_dt) override;
65 
66 protected:
67  // overrides from Display
68  void reset() override;
69  void onEnable() override;
70  void onDisable() override;
71 
72 private Q_SLOTS:
74  void updateShape();
76  void updateTrail();
77  void resetTrail(bool update = true);
78 
79 private:
81  Ogre::RibbonTrail* trail_;
82 
88 };
89 
90 } // namespace rviz
91 
92 #endif
Ogre
Definition: axes_display.h:35
rviz::AxesDisplay::~AxesDisplay
~AxesDisplay() override
Definition: axes_display.cpp:70
rviz::AxesDisplay::length_property_
FloatProperty * length_property_
Definition: axes_display.h:83
rviz::AxesDisplay::AxesDisplay
AxesDisplay()
Definition: axes_display.cpp:46
rviz::AxesDisplay
Displays a set of XYZ axes at the origin of a chosen frame.
Definition: axes_display.h:47
rviz::Display
Definition: display.h:63
rviz::FloatProperty
Property specialized to enforce floating point max/min.
Definition: float_property.h:37
rviz::Property
A single element of a property tree, with a name, value, description, and possibly children.
Definition: property.h:100
rviz::AxesDisplay::alpha_property_
FloatProperty * alpha_property_
Definition: axes_display.h:86
rviz
Definition: add_display_dialog.cpp:54
rviz::AxesDisplay::onInitialize
void onInitialize() override
Override this function to do subclass-specific initialization.
Definition: axes_display.cpp:80
rviz::AxesDisplay::onEnable
void onEnable() override
Derived classes override this to do the actual work of enabling themselves.
Definition: axes_display.cpp:105
rviz::AxesDisplay::updateTrail
void updateTrail()
Create or Destroy trail based on boolean property.
Definition: axes_display.cpp:125
rviz::AxesDisplay::updateShape
void updateShape()
Update the length and radius of the axes object from property values.
Definition: axes_display.cpp:119
rviz::AxesDisplay::update
void update(float dt, float ros_dt) override
Called periodically by the visualization manager.
Definition: axes_display.cpp:154
rviz::Axes
An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.
Definition: axes.h:57
rviz::AxesDisplay::trail_property_
Property * trail_property_
Definition: axes_display.h:85
rviz::TfFrameProperty
Definition: tf_frame_property.h:41
rviz::AxesDisplay::resetTrail
void resetTrail(bool update=true)
Definition: axes_display.cpp:95
display.h
length
TFSIMD_FORCE_INLINE tfScalar length(const Quaternion &q)
rviz::AxesDisplay::frame_property_
TfFrameProperty * frame_property_
Definition: axes_display.h:87
rviz::AxesDisplay::reset
void reset() override
Called to tell the display to clear its state.
Definition: axes_display.cpp:89
rviz::AxesDisplay::trail_
Ogre::RibbonTrail * trail_
Definition: axes_display.h:81
rviz::AxesDisplay::set
void set(float length, float radius)
Set the parameters for the axes.
rviz::AxesDisplay::onDisable
void onDisable() override
Derived classes override this to do the actual work of disabling themselves.
Definition: axes_display.cpp:112
rviz::AxesDisplay::axes_
Axes * axes_
Handles actually drawing the axes.
Definition: axes_display.h:80
rviz::AxesDisplay::radius_property_
FloatProperty * radius_property_
Definition: axes_display.h:84


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:09