Public Member Functions | Protected Types | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
rviz::DepthCloudDisplay Class Reference

#include <depth_cloud_display.h>

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

Public Member Functions

 DepthCloudDisplay ()
 
void onInitialize () override
 Override this function to do subclass-specific initialization. More...
 
void reset () override
 Called to tell the display to clear its state. More...
 
void setTopic (const QString &topic, const QString &datatype) override
 Set the ROS topic to listen to for this display. More...
 
void update (float wall_dt, float ros_dt) override
 Called periodically by the visualization manager. More...
 
 ~DepthCloudDisplay () override
 
- 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...
 
QVariant getViewData (int column, int role) const override
 Return data appropriate for the given column (0 or 1) and role for this Display. More...
 
Qt::ItemFlags getViewFlags (int column) const override
 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...
 
void load (const Config &config) override
 Load the settings for this display from the given Config node, which must be a map. More...
 
void save (Config config) const override
 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) override
 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)
 
 ~Display () override
 
- Public Member Functions inherited from rviz::BoolProperty
 BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 
virtual bool getBool () const
 
bool getDisableChildren () override
 If true, the children of this property should set their ItemIsEnabled flag to false. More...
 
bool getDisableChildrenIfFalse ()
 
void setDisableChildrenIfFalse (bool disable)
 
 ~BoolProperty () override
 
- 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...
 
void insertChildSorted (Property *child)
 Insert a child property, sorted by name. 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=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 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...
 
 ~Property () override
 Destructor. Removes this property from its parent's list of children. More...
 

Protected Types

typedef message_filters::Synchronizer< SyncPolicyDepthColorSynchronizerDepthColor
 
typedef ApproximateTime< sensor_msgs::Image, sensor_msgs::Image > SyncPolicyDepthColor
 
typedef std::vector< rviz::PointCloud::PointV_Point
 

Protected Slots

void fillTransportOptionList (EnumProperty *property)
 Fill list of available and working transport options. More...
 
virtual void updateAutoSizeFactor ()
 
virtual void updateOcclusionTimeOut ()
 
void updateQueueSize ()
 
virtual void updateTopic ()
 
virtual void updateTopicFilter ()
 
virtual void updateUseAutoSize ()
 
virtual void updateUseOcclusionCompensation ()
 

Protected Member Functions

void caminfoCallback (sensor_msgs::CameraInfo::ConstPtr msg)
 
void clear ()
 
void fixedFrameChanged () override
 Called by setFixedFrame(). Override to respond to changes to fixed_frame_. More...
 
void onDisable () override
 Derived classes override this to do the actual work of disabling themselves. More...
 
void onEnable () override
 Derived classes override this to do the actual work of enabling themselves. More...
 
virtual void processMessage (sensor_msgs::Image::ConstPtr msg)
 
virtual void processMessage (sensor_msgs::ImageConstPtr depth_msg, sensor_msgs::ImageConstPtr rgb_msg)
 
void scanForTransportSubscriberPlugins ()
 
void setStatusList ()
 
void subscribe ()
 
void unsubscribe ()
 
void updateStatus (StatusProperty::Level level, const QString &name, const QString &text)
 
- 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

float angular_thres_
 
FloatPropertyauto_size_factor_property_
 
sensor_msgs::CameraInfo::ConstPtr cam_info_
 
boost::mutex cam_info_mutex_
 
boost::shared_ptr< message_filters::Subscriber< sensor_msgs::CameraInfo > > cam_info_sub_
 
RosFilteredTopicPropertycolor_topic_property_
 
EnumPropertycolor_transport_property_
 
Ogre::Quaternion current_orientation_
 
Ogre::Vector3 current_position_
 
RosFilteredTopicPropertydepth_topic_property_
 
EnumPropertydepth_transport_property_
 
boost::scoped_ptr< image_transport::ImageTransportdepthmap_it_
 
boost::shared_ptr< image_transport::SubscriberFilterdepthmap_sub_
 
boost::shared_ptr< tf2_ros::MessageFilter< sensor_msgs::Image > > depthmap_tf_filter_
 
uint32_t messages_received_
 
MultiLayerDepthml_depth_data_
 
boost::mutex mutex_
 
FloatPropertyocclusion_shadow_timeout_property_
 
PointCloudCommonpointcloud_common_
 
uint32_t queue_size_
 
IntPropertyqueue_size_property_
 
boost::scoped_ptr< image_transport::ImageTransportrgb_it_
 
boost::shared_ptr< image_transport::SubscriberFilterrgb_sub_
 
boost::shared_ptr< SynchronizerDepthColorsync_depth_color_
 
Propertytopic_filter_property_
 
float trans_thres_
 
std::set< std::string > transport_plugin_types_
 
BoolPropertyuse_auto_size_property_
 
BoolPropertyuse_occlusion_compensation_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...
 

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...
 
void setIcon (const QIcon &icon) override
 Set the Display's icon. More...
 
- Public Slots inherited from rviz::BoolProperty
bool setBool (bool value)
 
- Signals inherited from rviz::Display
void timeSignal (ros::Time time, QPrivateSignal)
 
- 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...
 

Detailed Description

Definition at line 127 of file depth_cloud_display.h.

Member Typedef Documentation

◆ SynchronizerDepthColor

Definition at line 196 of file depth_cloud_display.h.

◆ SyncPolicyDepthColor

typedef ApproximateTime<sensor_msgs::Image, sensor_msgs::Image> rviz::DepthCloudDisplay::SyncPolicyDepthColor
protected

Definition at line 195 of file depth_cloud_display.h.

◆ V_Point

Definition at line 157 of file depth_cloud_display.h.

Constructor & Destructor Documentation

◆ DepthCloudDisplay()

rviz::DepthCloudDisplay::DepthCloudDisplay ( )

Definition at line 68 of file depth_cloud_display.cpp.

◆ ~DepthCloudDisplay()

rviz::DepthCloudDisplay::~DepthCloudDisplay ( )
override

Definition at line 169 of file depth_cloud_display.cpp.

Member Function Documentation

◆ caminfoCallback()

void rviz::DepthCloudDisplay::caminfoCallback ( sensor_msgs::CameraInfo::ConstPtr  msg)
protected

Definition at line 338 of file depth_cloud_display.cpp.

◆ clear()

void rviz::DepthCloudDisplay::clear ( )
protected

Definition at line 364 of file depth_cloud_display.cpp.

◆ fillTransportOptionList

void rviz::DepthCloudDisplay::fillTransportOptionList ( EnumProperty property)
protectedslot

Fill list of available and working transport options.

Definition at line 549 of file depth_cloud_display.cpp.

◆ fixedFrameChanged()

void rviz::DepthCloudDisplay::fixedFrameChanged ( )
overrideprotectedvirtual

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

Reimplemented from rviz::Display.

Definition at line 593 of file depth_cloud_display.cpp.

◆ onDisable()

void rviz::DepthCloudDisplay::onDisable ( )
overrideprotectedvirtual

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

Reimplemented from rviz::Display.

Definition at line 261 of file depth_cloud_display.cpp.

◆ onEnable()

void rviz::DepthCloudDisplay::onEnable ( )
overrideprotectedvirtual

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

Reimplemented from rviz::Display.

Definition at line 256 of file depth_cloud_display.cpp.

◆ onInitialize()

void rviz::DepthCloudDisplay::onInitialize ( )
overridevirtual

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 151 of file depth_cloud_display.cpp.

◆ processMessage() [1/2]

virtual void rviz::DepthCloudDisplay::processMessage ( sensor_msgs::Image::ConstPtr  msg)
protectedvirtual

◆ processMessage() [2/2]

void rviz::DepthCloudDisplay::processMessage ( sensor_msgs::ImageConstPtr  depth_msg,
sensor_msgs::ImageConstPtr  rgb_msg 
)
protectedvirtual

Definition at line 393 of file depth_cloud_display.cpp.

◆ reset()

void rviz::DepthCloudDisplay::reset ( )
overridevirtual

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 380 of file depth_cloud_display.cpp.

◆ scanForTransportSubscriberPlugins()

void rviz::DepthCloudDisplay::scanForTransportSubscriberPlugins ( )
protected

Definition at line 509 of file depth_cloud_display.cpp.

◆ setStatusList()

void rviz::DepthCloudDisplay::setStatusList ( )
protected

◆ setTopic()

void rviz::DepthCloudDisplay::setTopic ( const QString &  topic,
const QString &  datatype 
)
overridevirtual

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 183 of file depth_cloud_display.cpp.

◆ subscribe()

void rviz::DepthCloudDisplay::subscribe ( )
protected

Definition at line 270 of file depth_cloud_display.cpp.

◆ unsubscribe()

void rviz::DepthCloudDisplay::unsubscribe ( )
protected

Definition at line 344 of file depth_cloud_display.cpp.

◆ update()

void rviz::DepthCloudDisplay::update ( float  wall_dt,
float  ros_dt 
)
overridevirtual

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 372 of file depth_cloud_display.cpp.

◆ updateAutoSizeFactor

void rviz::DepthCloudDisplay::updateAutoSizeFactor ( )
protectedvirtualslot

Definition at line 222 of file depth_cloud_display.cpp.

◆ updateOcclusionTimeOut

void rviz::DepthCloudDisplay::updateOcclusionTimeOut ( )
protectedvirtualslot

Definition at line 250 of file depth_cloud_display.cpp.

◆ updateQueueSize

void rviz::DepthCloudDisplay::updateQueueSize ( )
protectedslot

Definition at line 207 of file depth_cloud_display.cpp.

◆ updateStatus()

void rviz::DepthCloudDisplay::updateStatus ( StatusProperty::Level  level,
const QString &  name,
const QString &  text 
)
protected

◆ updateTopic

void rviz::DepthCloudDisplay::updateTopic ( )
protectedvirtualslot

Definition at line 541 of file depth_cloud_display.cpp.

◆ updateTopicFilter

void rviz::DepthCloudDisplay::updateTopicFilter ( )
protectedvirtualslot

Definition at line 226 of file depth_cloud_display.cpp.

◆ updateUseAutoSize

void rviz::DepthCloudDisplay::updateUseAutoSize ( )
protectedvirtualslot

Definition at line 212 of file depth_cloud_display.cpp.

◆ updateUseOcclusionCompensation

void rviz::DepthCloudDisplay::updateUseOcclusionCompensation ( )
protectedvirtualslot

Definition at line 233 of file depth_cloud_display.cpp.

Member Data Documentation

◆ angular_thres_

float rviz::DepthCloudDisplay::angular_thres_
protected

Definition at line 218 of file depth_cloud_display.h.

◆ auto_size_factor_property_

FloatProperty* rviz::DepthCloudDisplay::auto_size_factor_property_
protected

Definition at line 204 of file depth_cloud_display.h.

◆ cam_info_

sensor_msgs::CameraInfo::ConstPtr rviz::DepthCloudDisplay::cam_info_
protected

Definition at line 192 of file depth_cloud_display.h.

◆ cam_info_mutex_

boost::mutex rviz::DepthCloudDisplay::cam_info_mutex_
protected

Definition at line 193 of file depth_cloud_display.h.

◆ cam_info_sub_

boost::shared_ptr<message_filters::Subscriber<sensor_msgs::CameraInfo> > rviz::DepthCloudDisplay::cam_info_sub_
protected

Definition at line 191 of file depth_cloud_display.h.

◆ color_topic_property_

RosFilteredTopicProperty* rviz::DepthCloudDisplay::color_topic_property_
protected

Definition at line 207 of file depth_cloud_display.h.

◆ color_transport_property_

EnumProperty* rviz::DepthCloudDisplay::color_transport_property_
protected

Definition at line 208 of file depth_cloud_display.h.

◆ current_orientation_

Ogre::Quaternion rviz::DepthCloudDisplay::current_orientation_
protected

Definition at line 216 of file depth_cloud_display.h.

◆ current_position_

Ogre::Vector3 rviz::DepthCloudDisplay::current_position_
protected

Definition at line 217 of file depth_cloud_display.h.

◆ depth_topic_property_

RosFilteredTopicProperty* rviz::DepthCloudDisplay::depth_topic_property_
protected

Definition at line 205 of file depth_cloud_display.h.

◆ depth_transport_property_

EnumProperty* rviz::DepthCloudDisplay::depth_transport_property_
protected

Definition at line 206 of file depth_cloud_display.h.

◆ depthmap_it_

boost::scoped_ptr<image_transport::ImageTransport> rviz::DepthCloudDisplay::depthmap_it_
protected

Definition at line 186 of file depth_cloud_display.h.

◆ depthmap_sub_

boost::shared_ptr<image_transport::SubscriberFilter> rviz::DepthCloudDisplay::depthmap_sub_
protected

Definition at line 187 of file depth_cloud_display.h.

◆ depthmap_tf_filter_

boost::shared_ptr<tf2_ros::MessageFilter<sensor_msgs::Image> > rviz::DepthCloudDisplay::depthmap_tf_filter_
protected

Definition at line 188 of file depth_cloud_display.h.

◆ messages_received_

uint32_t rviz::DepthCloudDisplay::messages_received_
protected

Definition at line 181 of file depth_cloud_display.h.

◆ ml_depth_data_

MultiLayerDepth* rviz::DepthCloudDisplay::ml_depth_data_
protected

Definition at line 214 of file depth_cloud_display.h.

◆ mutex_

boost::mutex rviz::DepthCloudDisplay::mutex_
protected

Definition at line 183 of file depth_cloud_display.h.

◆ occlusion_shadow_timeout_property_

FloatProperty* rviz::DepthCloudDisplay::occlusion_shadow_timeout_property_
protected

Definition at line 210 of file depth_cloud_display.h.

◆ pointcloud_common_

PointCloudCommon* rviz::DepthCloudDisplay::pointcloud_common_
protected

Definition at line 221 of file depth_cloud_display.h.

◆ queue_size_

uint32_t rviz::DepthCloudDisplay::queue_size_
protected

Definition at line 212 of file depth_cloud_display.h.

◆ queue_size_property_

IntProperty* rviz::DepthCloudDisplay::queue_size_property_
protected

Definition at line 202 of file depth_cloud_display.h.

◆ rgb_it_

boost::scoped_ptr<image_transport::ImageTransport> rviz::DepthCloudDisplay::rgb_it_
protected

Definition at line 189 of file depth_cloud_display.h.

◆ rgb_sub_

boost::shared_ptr<image_transport::SubscriberFilter> rviz::DepthCloudDisplay::rgb_sub_
protected

Definition at line 190 of file depth_cloud_display.h.

◆ sync_depth_color_

boost::shared_ptr<SynchronizerDepthColor> rviz::DepthCloudDisplay::sync_depth_color_
protected

Definition at line 198 of file depth_cloud_display.h.

◆ topic_filter_property_

Property* rviz::DepthCloudDisplay::topic_filter_property_
protected

Definition at line 201 of file depth_cloud_display.h.

◆ trans_thres_

float rviz::DepthCloudDisplay::trans_thres_
protected

Definition at line 219 of file depth_cloud_display.h.

◆ transport_plugin_types_

std::set<std::string> rviz::DepthCloudDisplay::transport_plugin_types_
protected

Definition at line 223 of file depth_cloud_display.h.

◆ use_auto_size_property_

BoolProperty* rviz::DepthCloudDisplay::use_auto_size_property_
protected

Definition at line 203 of file depth_cloud_display.h.

◆ use_occlusion_compensation_property_

BoolProperty* rviz::DepthCloudDisplay::use_occlusion_compensation_property_
protected

Definition at line 209 of file depth_cloud_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 May 27 2023 02:06:25