display_group_visibility_property.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009, 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_DISPLAY_GROUP_VISIBILITY_PROPERTY_H_
31 #define RVIZ_DISPLAY_GROUP_VISIBILITY_PROPERTY_H_
32 
34 
35 #include <stdint.h>
36 
37 #include <map>
38 #include <string>
39 
40 #include <QObject>
41 #include <QString>
42 
43 namespace rviz
44 {
45 class DisplayContext;
46 class Property;
47 class BoolProperty;
48 class DisplayGroup;
49 class BoolProperty;
50 class DisplayVisibilityProperty;
51 
52 
53 /*
54  * Manages the visibility of all displays in a display group
55  * by switching one bit in Ogre's visibility mask.
56  */
58 {
59  Q_OBJECT
60 public:
61  /* @param parent Parent display (will not get a visibility property)
62  * @param context The display context
63  * @param root_property Where to attach new properties to
64  */
65  DisplayGroupVisibilityProperty(uint32_t vis_bit,
66  DisplayGroup* display_group,
67  Display* parent_display,
68  const QString& name = QString(),
69  bool default_value = false,
70  const QString& description = QString(),
71  Property* parent = nullptr,
72  const char* changed_slot = nullptr,
73  QObject* receiver = nullptr);
75 
76  // @brief Update visibility masks of all objects in the Ogre scene
77  void update() override;
78 
79 public Q_SLOTS:
80 
81  void onDisplayAdded(rviz::Display* display);
82  void onDisplayRemoved(rviz::Display* display);
83 
84 private:
85  // sort the properties in the same way as in the
86  // root display group
87  void sortDisplayList();
88 
90  std::map<rviz::Display*, DisplayVisibilityProperty*> disp_vis_props_;
92 };
93 
94 
95 } // namespace rviz
96 
97 #endif /* DISPLAY_VISIBILITY_MANAGER_H_ */
A single element of a property tree, with a name, value, description, and possibly children...
Definition: property.h:100
def default_value(type_)
DisplayGroupVisibilityProperty(uint32_t vis_bit, DisplayGroup *display_group, Display *parent_display, const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
std::map< rviz::Display *, DisplayVisibilityProperty * > disp_vis_props_
description
A Display object which stores other Displays as children.
Definition: display_group.h:47


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:16