Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Friends | List of all members
rviz::MapDisplay Class Reference

Displays a map along the XY plane. More...

#include <map_display.h>

Inheritance diagram for rviz::MapDisplay:
Inheritance graph
[legend]

Signals

void mapUpdated ()
 Emitted when a new map is received. More...
 
- Signals inherited from rviz::Display
void timeSignal (rviz::Display *display, ros::Time time)
 
- Signals inherited from rviz::Property
void aboutToChange ()
 Emitted by setValue() just before the value has changed. More...
 
void changed ()
 Emitted by setValue() just after the value has changed. More...
 
void childListChanged (Property *this_property)
 Emitted after insertions and deletions of child Properties. More...
 

Public Member Functions

virtual void fixedFrameChanged ()
 Called by setFixedFrame(). Override to respond to changes to fixed_frame_. More...
 
int getHeight ()
 
float getResolution ()
 
int getWidth ()
 
 MapDisplay ()
 
virtual void onInitialize ()
 Override this function to do subclass-specific initialization. More...
 
virtual void reset ()
 Called to tell the display to clear its state. More...
 
virtual void setTopic (const QString &topic, const QString &datatype)
 Set the ROS topic to listen to for this display. More...
 
virtual ~MapDisplay ()
 
- Public Member Functions inherited from rviz::Display
virtual void deleteStatus (const QString &name)
 Delete the status entry with the given name. This is thread-safe. More...
 
void deleteStatusStd (const std::string &name)
 Delete the status entry with the given std::string name. This is thread-safe. More...
 
 Display ()
 
void emitTimeSignal (ros::Time time)
 Emit a time signal that other Displays can synchronize to. More...
 
QWidget * getAssociatedWidget () const
 Return the current associated widget, or NULL if there is none. More...
 
PanelDockWidgetgetAssociatedWidgetPanel ()
 Return the panel containing the associated widget, or NULL if there is none. More...
 
virtual QString getClassId () const
 Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId(). More...
 
Ogre::SceneNode * getSceneNode () const
 Return the Ogre::SceneNode holding all 3D scene elements shown by this Display. More...
 
virtual QVariant getViewData (int column, int role) const
 Return data appropriate for the given column (0 or 1) and role for this Display. More...
 
virtual Qt::ItemFlags getViewFlags (int column) const
 Return item flags appropriate for the given column (0 or 1) for this Display. More...
 
uint32_t getVisibilityBits ()
 
void initialize (DisplayContext *context)
 Main initialization, called after constructor, before load() or setEnabled(). More...
 
bool isEnabled () const
 Return true if this Display is enabled, false if not. More...
 
virtual void load (const Config &config)
 Load the settings for this display from the given Config node, which must be a map. More...
 
virtual void save (Config config) const
 Write this display to the given Config node. More...
 
void setAssociatedWidget (QWidget *widget)
 Associate the given widget with this Display. More...
 
virtual void setClassId (const QString &class_id)
 Set the class identifier used to create this instance. Typically this will be set by the factory object which created it. More...
 
void setFixedFrame (const QString &fixed_frame)
 Set the fixed frame in this display. More...
 
void setName (const QString &name)
 Overridden from Property to set associated widget title to the new name. More...
 
virtual void setStatus (StatusProperty::Level level, const QString &name, const QString &text)
 Show status level and text. This is thread-safe. More...
 
void setStatusStd (StatusProperty::Level level, const std::string &name, const std::string &text)
 Show status level and text, using a std::string. Convenience function which converts std::string to QString and calls setStatus(). This is thread-safe. More...
 
void setVisibilityBits (uint32_t bits)
 
void unsetVisibilityBits (uint32_t bits)
 
virtual ~Display ()
 
- Public Member Functions inherited from rviz::BoolProperty
 BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
 
virtual bool getBool () const
 
virtual bool getDisableChildren ()
 If true, the children of this property should set their ItemIsEnabled flag to false. More...
 
bool getDisableChildrenIfFalse ()
 
void setDisableChildrenIfFalse (bool disable)
 
virtual ~BoolProperty ()
 
- Public Member Functions inherited from rviz::Property
virtual void addChild (Property *child, int index=-1)
 Add a child property. More...
 
PropertychildAt (int index) const
 Return the child Property with the given index, or NULL if the index is out of bounds or if the child at that index is not a Property. More...
 
virtual PropertychildAtUnchecked (int index) const
 Return the child Property with the given index, without checking whether the index is within bounds. More...
 
virtual void collapse ()
 Collapse (hide the children of) this Property. More...
 
bool contains (Property *possible_child) const
 Return true if the list of children includes possible_child, false if not. More...
 
virtual QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &option)
 Create an editor widget to edit the value of this property. More...
 
virtual void expand ()
 Expand (show the children of) this Property. More...
 
virtual QString getDescription () const
 Return the description. More...
 
virtual bool getHidden () const
 Return the hidden/shown state. True means hidden, false means visible. More...
 
virtual QIcon getIcon () const
 
PropertyTreeModelgetModel () const
 Return the model managing this Property and its childrent. More...
 
virtual QString getName () const
 Return the name of this Property as a QString. More...
 
std::string getNameStd () const
 Return the name of this Property as a std::string. More...
 
PropertygetParent () const
 Return the parent Property. More...
 
virtual bool getReadOnly ()
 Return the read-only-ness of this property. More...
 
virtual QVariant getValue () const
 Return the value of this Property as a QVariant. If the value has never been set, an invalid QVariant is returned. More...
 
void hide ()
 Hide this Property in any PropertyTreeWidgets. More...
 
bool isAncestorOf (Property *possible_child) const
 Returns true if this is an ancestor of possible_child, meaning is the parent or parent of parent etc. More...
 
virtual void moveChild (int from_index, int to_index)
 Move the child at from_index to to_index. More...
 
virtual int numChildren () const
 Return the number of child objects (Property or otherwise). More...
 
virtual bool paint (QPainter *painter, const QStyleOptionViewItem &option) const
 Hook to provide custom painting of the value data (right-hand column) in a subclass. More...
 
 Property (const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
 Constructor. More...
 
virtual void removeChildren (int start_index=0, int count=-1)
 Remove and delete some or all child Properties. Does not change the value of this Property. More...
 
int rowNumberInParent () const
 Return the row number of this property within its parent, or -1 if it has no parent. More...
 
virtual void setDescription (const QString &description)
 Set the description. More...
 
virtual void setHidden (bool hidden)
 Hide or show this property in any PropertyTreeWidget viewing its parent. More...
 
virtual void setIcon (const QIcon &icon)
 Set the icon to be displayed next to the property. More...
 
void setModel (PropertyTreeModel *model)
 Set the model managing this Property and all its child properties, recursively. More...
 
void setParent (Property *new_parent)
 Set parent property, without telling the parent. More...
 
virtual void setReadOnly (bool read_only)
 Prevent or allow users to edit this property from a PropertyTreeWidget. More...
 
void setShouldBeSaved (bool save)
 If save is true and getReadOnly() is false, shouldBeSaved will return true; otherwise false. Default is true. More...
 
virtual bool setValue (const QVariant &new_value)
 Set the new value for this property. Returns true if the new value is different from the old value, false if same. More...
 
bool shouldBeSaved () const
 Returns true if the property is not read-only AND has data worth saving. More...
 
void show ()
 Show this Property in any PropertyTreeWidgets. More...
 
virtual PropertysubProp (const QString &sub_name)
 Return the first child Property with the given name, or the FailureProperty if no child has the name. More...
 
PropertytakeChild (Property *child)
 Remove a given child object and return a pointer to it. More...
 
virtual PropertytakeChildAt (int index)
 Take a child out of the child list, but don't destroy it. More...
 
virtual ~Property ()
 Destructor. Removes this property from its parent's list of children. More...
 

Protected Slots

void showMap ()
 Show current_map_ in the scene. More...
 
void transformMap ()
 
void updateAlpha ()
 
void updateDrawUnder ()
 
void updatePalette ()
 
void updateTopic ()
 

Protected Member Functions

void clear ()
 
void createSwatches ()
 
void incomingMap (const nav_msgs::OccupancyGrid::ConstPtr &msg)
 Copy msg into current_map_ and call showMap(). More...
 
void incomingUpdate (const map_msgs::OccupancyGridUpdate::ConstPtr &update)
 Copy update's data into current_map_ and call showMap(). More...
 
virtual void onDisable ()
 Derived classes override this to do the actual work of disabling themselves. More...
 
virtual void onEnable ()
 Derived classes override this to do the actual work of enabling themselves. More...
 
virtual void subscribe ()
 
virtual void unsubscribe ()
 
virtual void update (float wall_dt, float ros_dt)
 Called periodically by the visualization manager. More...
 
- Protected Member Functions inherited from rviz::Display
virtual void clearStatuses ()
 Delete all status children. This is thread-safe. More...
 
bool initialized () const
 Returns true if the display has been initialized. More...
 
- Protected Member Functions inherited from rviz::Property
void loadValue (const Config &config)
 Load the value of this property specifically, not including children. More...
 

Protected Attributes

FloatPropertyalpha_property_
 
EnumPropertycolor_scheme_property_
 
std::vector< bool > color_scheme_transparency_
 
nav_msgs::OccupancyGrid current_map_
 
Propertydraw_under_property_
 
std::string frame_
 
int height_
 
IntPropertyheight_property_
 
bool loaded_
 
ros::Subscriber map_sub_
 
QuaternionPropertyorientation_property_
 
std::vector< Ogre::TexturePtr > palette_textures_
 
VectorPropertyposition_property_
 
float resolution_
 
FloatPropertyresolution_property_
 
std::vector< Swatch * > swatches
 
std::string topic_
 
RosTopicPropertytopic_property_
 
BoolPropertytransform_timestamp_property_
 
BoolPropertyunreliable_property_
 
ros::Subscriber update_sub_
 
int width_
 
IntPropertywidth_property_
 
- Protected Attributes inherited from rviz::Display
DisplayContextcontext_
 This DisplayContext pointer is the main connection a Display has into the rest of rviz. This is how the FrameManager is accessed, the SelectionManager, etc. When a Display subclass wants to signal that a new render should be done right away, call context_->queueRender(). More...
 
QString fixed_frame_
 A convenience variable equal to context_->getFixedFrame(). More...
 
Ogre::SceneManager * scene_manager_
 A convenience variable equal to context_->getSceneManager(). More...
 
Ogre::SceneNode * scene_node_
 The Ogre::SceneNode to hold all 3D scene elements shown by this Display. More...
 
ros::NodeHandle threaded_nh_
 A NodeHandle whose CallbackQueue is run from a different thread than the GUI. More...
 
ros::NodeHandle update_nh_
 A NodeHandle whose CallbackQueue is run from the main GUI thread (the "update" thread). More...
 
- Protected Attributes inherited from rviz::Property
bool child_indexes_valid_
 True if row_number_within_parent_ of all children is valid, false if not. More...
 
QIcon icon_
 
PropertyTreeModelmodel_
 Pointer to the PropertyTreeModel managing this property tree. More...
 
QVariant value_
 This is the central property value. If you set it directly in a subclass, do so with care because many things depend on the aboutToChange() and changed() events emitted by setValue(). More...
 

Friends

class Swatch
 

Additional Inherited Members

- Public Slots inherited from rviz::Display
virtual void onEnableChanged ()
 
void queueRender ()
 Convenience function which calls context_->queueRender(). More...
 
void setEnabled (bool enabled)
 Enable or disable this Display. More...
 
virtual void setIcon (const QIcon &icon)
 Set the Display's icon. More...
 
- Public Slots inherited from rviz::BoolProperty
bool setBool (bool value)
 

Detailed Description

Displays a map along the XY plane.

Definition at line 92 of file map_display.h.

Constructor & Destructor Documentation

rviz::MapDisplay::MapDisplay ( )

Definition at line 217 of file map_display.cpp.

rviz::MapDisplay::~MapDisplay ( )
virtual

Definition at line 281 of file map_display.cpp.

Member Function Documentation

void rviz::MapDisplay::clear ( )
protected

Definition at line 524 of file map_display.cpp.

void rviz::MapDisplay::createSwatches ( )
protected

Definition at line 593 of file map_display.cpp.

void rviz::MapDisplay::fixedFrameChanged ( )
virtual

Called by setFixedFrame(). Override to respond to changes to fixed_frame_.

Reimplemented from rviz::Display.

Definition at line 811 of file map_display.cpp.

int rviz::MapDisplay::getHeight ( )
inline

Definition at line 107 of file map_display.h.

float rviz::MapDisplay::getResolution ( )
inline

Definition at line 105 of file map_display.h.

int rviz::MapDisplay::getWidth ( )
inline

Definition at line 106 of file map_display.h.

void rviz::MapDisplay::incomingMap ( const nav_msgs::OccupancyGrid::ConstPtr &  msg)
protected

Copy msg into current_map_ and call showMap().

Definition at line 555 of file map_display.cpp.

void rviz::MapDisplay::incomingUpdate ( const map_msgs::OccupancyGridUpdate::ConstPtr &  update)
protected

Copy update's data into current_map_ and call showMap().

Definition at line 564 of file map_display.cpp.

void rviz::MapDisplay::mapUpdated ( )
signal

Emitted when a new map is received.

void rviz::MapDisplay::onDisable ( )
protectedvirtual

Derived classes override this to do the actual work of disabling themselves.

Reimplemented from rviz::Display.

Definition at line 428 of file map_display.cpp.

void rviz::MapDisplay::onEnable ( )
protectedvirtual

Derived classes override this to do the actual work of enabling themselves.

Reimplemented from rviz::Display.

Definition at line 423 of file map_display.cpp.

void rviz::MapDisplay::onInitialize ( )
virtual

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set, and before load() or setEnabled().

setName() may or may not have been called before this.

Reimplemented from rviz::Display.

Definition at line 412 of file map_display.cpp.

void rviz::MapDisplay::reset ( )
virtual

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 816 of file map_display.cpp.

void rviz::MapDisplay::setTopic ( const QString &  topic,
const QString &  datatype 
)
virtual

Set the ROS topic to listen to for this display.

By default, do nothing. Subclasses should override this method if they subscribe to a single ROS topic.

setTopic() is used by the "New display by topic" window; it is called with a user selected topic and its type.

Parameters
topicThe published topic to be visualized.
datatypeThe datatype of the topic.

Reimplemented from rviz::Display.

Definition at line 825 of file map_display.cpp.

void rviz::MapDisplay::showMap ( )
protectedslot

Show current_map_ in the scene.

Definition at line 646 of file map_display.cpp.

void rviz::MapDisplay::subscribe ( )
protectedvirtual

Definition at line 434 of file map_display.cpp.

void rviz::MapDisplay::transformMap ( )
protectedslot

Definition at line 777 of file map_display.cpp.

void rviz::MapDisplay::unsubscribe ( )
protectedvirtual

Definition at line 470 of file map_display.cpp.

void rviz::MapDisplay::update ( float  wall_dt,
float  ros_dt 
)
protectedvirtual

Called periodically by the visualization manager.

Parameters
wall_dtWall-clock time, in seconds, since the last time the update list was run through.
ros_dtROS time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 830 of file map_display.cpp.

void rviz::MapDisplay::updateAlpha ( )
protectedslot

Definition at line 476 of file map_display.cpp.

void rviz::MapDisplay::updateDrawUnder ( )
protectedslot

Definition at line 500 of file map_display.cpp.

void rviz::MapDisplay::updatePalette ( )
protectedslot

Definition at line 755 of file map_display.cpp.

void rviz::MapDisplay::updateTopic ( )
protectedslot

Definition at line 517 of file map_display.cpp.

Friends And Related Function Documentation

friend class Swatch
friend

Definition at line 94 of file map_display.h.

Member Data Documentation

FloatProperty* rviz::MapDisplay::alpha_property_
protected

Definition at line 164 of file map_display.h.

EnumProperty* rviz::MapDisplay::color_scheme_property_
protected

Definition at line 166 of file map_display.h.

std::vector<bool> rviz::MapDisplay::color_scheme_transparency_
protected

Definition at line 145 of file map_display.h.

nav_msgs::OccupancyGrid rviz::MapDisplay::current_map_
protected

Definition at line 153 of file map_display.h.

Property* rviz::MapDisplay::draw_under_property_
protected

Definition at line 165 of file map_display.h.

std::string rviz::MapDisplay::frame_
protected

Definition at line 152 of file map_display.h.

int rviz::MapDisplay::height_
protected

Definition at line 151 of file map_display.h.

IntProperty* rviz::MapDisplay::height_property_
protected

Definition at line 161 of file map_display.h.

bool rviz::MapDisplay::loaded_
protected

Definition at line 146 of file map_display.h.

ros::Subscriber rviz::MapDisplay::map_sub_
protected

Definition at line 155 of file map_display.h.

QuaternionProperty* rviz::MapDisplay::orientation_property_
protected

Definition at line 163 of file map_display.h.

std::vector<Ogre::TexturePtr> rviz::MapDisplay::palette_textures_
protected

Definition at line 144 of file map_display.h.

VectorProperty* rviz::MapDisplay::position_property_
protected

Definition at line 162 of file map_display.h.

float rviz::MapDisplay::resolution_
protected

Definition at line 149 of file map_display.h.

FloatProperty* rviz::MapDisplay::resolution_property_
protected

Definition at line 159 of file map_display.h.

std::vector<Swatch*> rviz::MapDisplay::swatches
protected

Definition at line 143 of file map_display.h.

std::string rviz::MapDisplay::topic_
protected

Definition at line 148 of file map_display.h.

RosTopicProperty* rviz::MapDisplay::topic_property_
protected

Definition at line 158 of file map_display.h.

BoolProperty* rviz::MapDisplay::transform_timestamp_property_
protected

Definition at line 169 of file map_display.h.

BoolProperty* rviz::MapDisplay::unreliable_property_
protected

Definition at line 168 of file map_display.h.

ros::Subscriber rviz::MapDisplay::update_sub_
protected

Definition at line 156 of file map_display.h.

int rviz::MapDisplay::width_
protected

Definition at line 150 of file map_display.h.

IntProperty* rviz::MapDisplay::width_property_
protected

Definition at line 160 of file map_display.h.


The documentation for this class was generated from the following files:


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Apr 27 2019 02:33:43