#include <display.h>

Inheritance diagram for rviz::Display:

[legend]

Public Slots
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
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...

Public Member Functions
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...

PanelDockWidget *	getAssociatedWidgetPanel ()
	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...

virtual void	reset ()
	Called to tell the display to clear its state. 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...

virtual void	setTopic (const QString &topic, const QString &datatype)
	Set the ROS topic to listen to for this display. More...

void	setVisibilityBits (uint32_t bits)

void	unsetVisibilityBits (uint32_t bits)

virtual void	update (float wall_dt, float ros_dt)
	Called periodically by the visualization manager. More...

	~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...

Property *	childAt (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 Property *	childAtUnchecked (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

PropertyTreeModel *	getModel () 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...

Property *	getParent () 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 Property *	subProp (const QString &sub_name)
	Return the first child Property with the given name, or the FailureProperty if no child has the name. More...

Property *	takeChild (Property *child)
	Remove a given child object and return a pointer to it. More...

virtual Property *	takeChildAt (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 Member Functions
virtual void	clearStatuses ()
	Delete all status children. This is thread-safe. More...

virtual void	fixedFrameChanged ()
	Called by setFixedFrame(). Override to respond to changes to fixed_frame_. More...

bool	initialized () const
	Returns true if the display has been initialized. 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	onInitialize ()
	Override this function to do subclass-specific initialization. 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
DisplayContext *	context_
	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_

PropertyTreeModel *	model_
	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...

Private Slots
void	associatedPanelVisibilityChange (bool visible)

void	clearStatusesInternal ()

void	deleteStatusInternal (const QString &name)

void	disable ()

void	setStatusInternal (int level, const QString &name, const QString &text)

Private Attributes
QWidget *	associated_widget_

PanelDockWidget *	associated_widget_panel_

QString	class_id_

bool	initialized_

StatusList *	status_

uint32_t	visibility_bits_

Detailed Description

Definition at line 63 of file display.h.

Constructor & Destructor Documentation

◆ Display()

rviz::Display::Display ( )

Definition at line 55 of file display.cpp.

◆ ~Display()

rviz::Display::~Display ( )

override

Definition at line 75 of file display.cpp.

Member Function Documentation

◆ associatedPanelVisibilityChange

void rviz::Display::associatedPanelVisibilityChange ( bool visible )

privateslot

Definition at line 395 of file display.cpp.

◆ clearStatuses()

void rviz::Display::clearStatuses ( )

protectedvirtual

Delete all status children. This is thread-safe.

This removes all status children and updates the top-level status.

Definition at line 210 of file display.cpp.

◆ clearStatusesInternal

void rviz::Display::clearStatusesInternal ( )

privateslot

Definition at line 215 of file display.cpp.

◆ deleteStatus()

void rviz::Display::deleteStatus ( const QString & name )

virtual

Delete the status entry with the given name. This is thread-safe.

Definition at line 197 of file display.cpp.

◆ deleteStatusInternal

void rviz::Display::deleteStatusInternal ( const QString & name )

privateslot

Definition at line 202 of file display.cpp.

◆ deleteStatusStd()

void rviz::Display::deleteStatusStd ( const std::string & name )

inline

Delete the status entry with the given std::string name. This is thread-safe.

Definition at line 172 of file display.h.

◆ disable

void rviz::Display::disable ( )

privateslot

Definition at line 263 of file display.cpp.

◆ emitTimeSignal()

void rviz::Display::emitTimeSignal ( ros::Time time )

Emit a time signal that other Displays can synchronize to.

Definition at line 282 of file display.cpp.

◆ fixedFrameChanged()

virtual void rviz::Display::fixedFrameChanged ( )

inlineprotectedvirtual

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

Definition at line 270 of file display.h.

◆ getAssociatedWidget()

QWidget* rviz::Display::getAssociatedWidget ( ) const

inline

Return the current associated widget, or NULL if there is none.

See also: setAssociatedWidget()

Definition at line 208 of file display.h.

◆ getAssociatedWidgetPanel()

PanelDockWidget* rviz::Display::getAssociatedWidgetPanel ( )

inline

Return the panel containing the associated widget, or NULL if there is none.

See also: setAssociatedWidget()

Definition at line 215 of file display.h.

◆ getClassId()

virtual QString rviz::Display::getClassId ( ) const

inlinevirtual

Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId().

Definition at line 85 of file display.h.

◆ getSceneNode()

Ogre::SceneNode* rviz::Display::getSceneNode ( ) const

inline

Return the Ogre::SceneNode holding all 3D scene elements shown by this Display.

Definition at line 186 of file display.h.

◆ getViewData()

QVariant rviz::Display::getViewData	(	int	column,
		int	role
	)		const

overridevirtual

Return data appropriate for the given column (0 or 1) and role for this Display.

Reimplemented from rviz::Property.

Reimplemented in rviz::FailedDisplay.

Definition at line 106 of file display.cpp.

◆ getViewFlags()

Qt::ItemFlags rviz::Display::getViewFlags ( int column ) const

overridevirtual

Return item flags appropriate for the given column (0 or 1) for this Display.

Reimplemented from rviz::Property.

Reimplemented in rviz::DisplayGroup.

Definition at line 170 of file display.cpp.

◆ getVisibilityBits()

uint32_t rviz::Display::getVisibilityBits ( )

inline

Definition at line 180 of file display.h.

◆ initialize()

void rviz::Display::initialize ( DisplayContext * context )

Main initialization, called after constructor, before load() or setEnabled().

Definition at line 83 of file display.cpp.

◆ initialized()

bool rviz::Display::initialized ( ) const

inlineprotected

Returns true if the display has been initialized.

Definition at line 275 of file display.h.

◆ isEnabled()

bool rviz::Display::isEnabled ( ) const

Return true if this Display is enabled, false if not.

Definition at line 268 of file display.cpp.

◆ load()

void rviz::Display::load ( const Config & config )

overridevirtual

Load the settings for this display from the given Config node, which must be a map.

Overridden from Property::load() to load the Display's name and enabled state, then call Property::load().

load() is called after initialize().

Reimplemented from rviz::Property.

Reimplemented in rviz::DisplayGroup, and rviz::FailedDisplay.

Definition at line 228 of file display.cpp.

◆ onDisable()

virtual void rviz::Display::onDisable ( )

inlineprotectedvirtual

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

Definition at line 260 of file display.h.

◆ onEnable()

virtual void rviz::Display::onEnable ( )

inlineprotectedvirtual

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

Definition at line 255 of file display.h.

◆ onEnableChanged

void rviz::Display::onEnableChanged ( )

virtualslot

Definition at line 303 of file display.cpp.

◆ onInitialize()

virtual void rviz::Display::onInitialize ( )

inlineprotectedvirtual

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.

Definition at line 250 of file display.h.

◆ queueRender

void rviz::Display::queueRender ( )

slot

Convenience function which calls context_->queueRender().

Definition at line 98 of file display.cpp.

◆ reset()

void rviz::Display::reset ( )

virtual

Called to tell the display to clear its state.

Definition at line 287 of file display.cpp.

◆ save()

void rviz::Display::save ( Config config ) const

overridevirtual

Write this display to the given Config node.

Overridden from Property::save().

Reimplemented from rviz::Property.

Reimplemented in rviz::DisplayGroup, and rviz::FailedDisplay.

Definition at line 246 of file display.cpp.

◆ setAssociatedWidget()

void rviz::Display::setAssociatedWidget ( QWidget * widget )

Associate the given widget with this Display.

Each Display can have one QWidget which is shown when the Display is enabled and hidden when the Display is disabled. If there is a WindowManagerInterface registered with the VisualizationManager, like if you are using a VisualizationFrame, this also adds widget as a pane within it (with WindowManagerInterface::addPane() ).

Since there is only one slot for such a widget, this dis-associates any previously associated widget.

Call this with NULL to disassociate the current associated widget.

Definition at line 361 of file display.cpp.

◆ setClassId()

virtual void rviz::Display::setClassId ( const QString & class_id )

inlinevirtual

Set the class identifier used to create this instance. Typically this will be set by the factory object which created it.

Definition at line 92 of file display.h.

◆ setEnabled

void rviz::Display::setEnabled ( bool enabled )

slot

Enable or disable this Display.

SetEnabled is called after initialize() and at the end of load(), if the Display settings are being loaded from a file.

Definition at line 256 of file display.cpp.

◆ setFixedFrame()

void rviz::Display::setFixedFrame ( const QString & fixed_frame )

Set the fixed frame in this display.

Definition at line 273 of file display.cpp.

◆ setIcon

void rviz::Display::setIcon ( const QIcon & icon )

overrideslot

Set the Display's icon.

Definition at line 404 of file display.cpp.

◆ setName()

void rviz::Display::setName ( const QString & name )

overridevirtual

Overridden from Property to set associated widget title to the new name.

Reimplemented from rviz::Property.

Definition at line 413 of file display.cpp.

◆ setStatus()

void rviz::Display::setStatus	(	StatusProperty::Level	level,
		const QString &	name,
		const QString &	text
	)

virtual

Show status level and text. This is thread-safe.

Parameters

level	One of StatusProperty::Ok, StatusProperty::Warn, or StatusProperty::Error.
name	The name of the child entry to set.
text	Description of the child's state.

Every Display has a StatusList to indicate how it is doing. The StatusList has StatusPropertychildren indicating the status of various subcomponents of the Display. Each child of the status has a level, a name, and descriptive text. The top-level StatusList has a level which is set to the worst of all the children's levels.

Definition at line 175 of file display.cpp.

◆ setStatusInternal

void rviz::Display::setStatusInternal	(	int	level,
		const QString &	name,
		const QString &	text
	)

privateslot

Definition at line 181 of file display.cpp.

◆ setStatusStd()

void rviz::Display::setStatusStd	(	StatusProperty::Level	level,
		const std::string &	name,
		const std::string &	text
	)

inline

Show status level and text, using a std::string. Convenience function which converts std::string to QString and calls setStatus(). This is thread-safe.

Definition at line 163 of file display.h.

◆ setTopic()

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

inlinevirtual

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

topic	The published topic to be visualized.
datatype	The datatype of the topic.

Definition at line 122 of file display.h.

◆ setVisibilityBits()

void rviz::Display::setVisibilityBits ( uint32_t bits )

Default is all bits ON.

Definition at line 349 of file display.cpp.

◆ timeSignal

void rviz::Display::timeSignal	(	ros::Time	time,
		QPrivateSignal
	)

signal

◆ unsetVisibilityBits()

void rviz::Display::unsetVisibilityBits ( uint32_t bits )

Definition at line 355 of file display.cpp.

◆ update()

virtual void rviz::Display::update	(	float	wall_dt,
		float	ros_dt
	)

inlinevirtual

Called periodically by the visualization manager.

Parameters

wall_dt	Wall-clock time, in seconds, since the last time the update list was run through.
ros_dt	ROS time, in seconds, since the last time the update list was run through.

Reimplemented in rviz::MapDisplay, rviz::DepthCloudDisplay, rviz::DisplayGroup, rviz::CameraDisplay, rviz::MarkerDisplay, rviz::OdometryDisplay, rviz::InteractiveMarkerDisplay, rviz::TFDisplay, rviz::ImageDisplay, rviz::RobotModelDisplay, rviz::GridDisplay, rviz::PointCloudDisplay, rviz::PointCloud2Display, rviz::AxesDisplay, rviz::FluidPressureDisplay, rviz::IlluminanceDisplay, rviz::LaserScanDisplay, rviz::RelativeHumidityDisplay, and rviz::TemperatureDisplay.

Definition at line 137 of file display.h.

Member Data Documentation

◆ associated_widget_

QWidget* rviz::Display::associated_widget_

private

Definition at line 329 of file display.h.

◆ associated_widget_panel_

PanelDockWidget* rviz::Display::associated_widget_panel_

private

Definition at line 330 of file display.h.

◆ class_id_

QString rviz::Display::class_id_

private

Definition at line 326 of file display.h.

◆ context_

DisplayContext* rviz::Display::context_

protected

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().

This is set after the constructor and before onInitialize() is called.

Definition at line 287 of file display.h.

◆ fixed_frame_

QString rviz::Display::fixed_frame_

protected

A convenience variable equal to context_->getFixedFrame().

This is set after the constructor and before onInitialize() is called. Every time it is updated (via setFixedFrame()), fixedFrameChanged() is called.

Definition at line 312 of file display.h.

◆ initialized_

bool rviz::Display::initialized_

private

Definition at line 327 of file display.h.

◆ scene_manager_

Ogre::SceneManager* rviz::Display::scene_manager_

protected

A convenience variable equal to context_->getSceneManager().

This is set after the constructor and before onInitialize() is called.

Definition at line 292 of file display.h.

◆ scene_node_

Ogre::SceneNode* rviz::Display::scene_node_

protected

The Ogre::SceneNode to hold all 3D scene elements shown by this Display.

Definition at line 295 of file display.h.

◆ status_

StatusList* rviz::Display::status_

private

Definition at line 325 of file display.h.

◆ threaded_nh_

ros::NodeHandle rviz::Display::threaded_nh_

protected

A NodeHandle whose CallbackQueue is run from a different thread than the GUI.

This is configured after the constructor and before onInitialize() is called.

Definition at line 305 of file display.h.

◆ update_nh_

ros::NodeHandle rviz::Display::update_nh_

protected

A NodeHandle whose CallbackQueue is run from the main GUI thread (the "update" thread).

This is configured after the constructor and before onInitialize() is called.

Definition at line 300 of file display.h.

◆ visibility_bits_

uint32_t rviz::Display::visibility_bits_

private

Definition at line 328 of file display.h.

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Private Slots

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Display()

◆ ~Display()

Member Function Documentation

◆ associatedPanelVisibilityChange

◆ clearStatuses()

◆ clearStatusesInternal

◆ deleteStatus()

◆ deleteStatusInternal

◆ deleteStatusStd()

◆ disable

◆ emitTimeSignal()

◆ fixedFrameChanged()

◆ getAssociatedWidget()

◆ getAssociatedWidgetPanel()

◆ getClassId()

◆ getSceneNode()

◆ getViewData()

◆ getViewFlags()

◆ getVisibilityBits()

◆ initialize()

◆ initialized()

◆ isEnabled()

◆ load()

◆ onDisable()

◆ onEnable()

◆ onEnableChanged

◆ onInitialize()

◆ queueRender

◆ reset()

◆ save()

◆ setAssociatedWidget()

◆ setClassId()

◆ setEnabled

◆ setFixedFrame()

◆ setIcon

◆ setName()

◆ setStatus()

◆ setStatusInternal

◆ setStatusStd()

◆ setTopic()

◆ setVisibilityBits()

◆ timeSignal

◆ unsetVisibilityBits()

◆ update()

Member Data Documentation

◆ associated_widget_

◆ associated_widget_panel_

◆ class_id_

◆ context_

◆ fixed_frame_

◆ initialized_

◆ scene_manager_

◆ scene_node_

◆ status_

◆ threaded_nh_

◆ update_nh_

◆ visibility_bits_