A Display object which stores other Displays as children. More...

#include <display_group.h>

Inheritance diagram for rviz::DisplayGroup:

Public Slots
void	onEnableChanged () override

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
void	displayAdded (rviz::Display *display)

void	displayRemoved (rviz::Display *display)

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

Public Member Functions
void	addChild (Property *child, int index=-1) override
	Add a child Property or Display. More...

virtual void	addDisplay (Display *child)
	Add a child Display to the end of the list of Displays. More...

Property *	childAtUnchecked (int index) const override
	Return the child with the given index, without checking whether the index is within bounds. More...

Display *	createDisplay (const QString &class_id)

	DisplayGroup ()

virtual Display *	getDisplayAt (int index) const
	Return the index-th Display in this group, or NULL if the index is invalid. More...

virtual DisplayGroup *	getGroupAt (int index) const
	Find the index-th child Display in this group. If the child is itself a DisplayGroup, return the pointer to it. If it is not, return NULL. More...

Qt::ItemFlags	getViewFlags (int column) const override
	Return item flags appropriate for the given column (0 or 1) for this DisplayGroup. More...

void	load (const Config &config) override
	Load subproperties and the list of displays in this group from the given Config node, which must be a map. More...

int	numChildren () const override
	Return the number of child objects (Property and Display). More...

virtual int	numDisplays () const
	Return the number of child Displays. More...

virtual void	removeAllDisplays ()
	Remove and destroy all child Displays, but preserve any non-Display children. More...

void	reset () override
	Reset this and all child Displays. More...

void	save (Config config) const override
	Save subproperties and the list of displays in this group to the given Config node. More...

Property *	takeChildAt (int index) override
	Take a child out of the child list, but don't destroy it. More...

virtual Display *	takeDisplay (Display *child)
	Remove a child Display from the the list of Displays, but don't destroy it. More...

void	update (float wall_dt, float ros_dt) override
	Call update() on all child Displays. More...

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

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

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

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

	~Property () override
	Destructor. Removes this property from its parent's list of children. More...

Protected Member Functions
virtual void	addDisplayWithoutSignallingModel (Display *child)
	Add a child Display to the end of the list of Displays, but without telling the model. More...

void	fixedFrameChanged () override
	Update the fixed frame in all contained displays. 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...

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

Private Attributes
QList< Display * >	displays_

Additional Inherited Members
Protected Attributes inherited from rviz::Display
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...

Detailed Description

A Display object which stores other Displays as children.

A DisplayGroup can have non-Display child properties as well as Display children, but they are kept separate. Non-display properties come first, and Display children come after. The Property superclass stores the non-Display properties and this class stores the Display objects in a separate list. The separation is enforced in addChild().

Definition at line 47 of file display_group.h.

Constructor & Destructor Documentation

◆ DisplayGroup()

rviz::DisplayGroup::DisplayGroup ( )

Definition at line 43 of file display_group.cpp.

◆ ~DisplayGroup()

rviz::DisplayGroup::~DisplayGroup ( )

override

Definition at line 47 of file display_group.cpp.

Member Function Documentation

◆ addChild()

void rviz::DisplayGroup::addChild	(	Property *	child,
		int	index = `-1`
	)

overridevirtual

Add a child Property or Display.

Parameters

child	The child to add.
index	[optional] The index at which to add the child. If less than 0 or greater than the number of child properties, the child will be added at the end.

This notifies the model about the addition.

This is overridden from Property to keep non-Display child Properties in Property's list of children and Display children in DisplayGroup's list of child Displays.

Reimplemented from rviz::Property.

Definition at line 280 of file display_group.cpp.

◆ addDisplay()

void rviz::DisplayGroup::addDisplay ( Display * child )

virtual

Add a child Display to the end of the list of Displays.

This also tells the model that we are adding a child, so it can update widgets.

Note: This does not remove child from its parent. That must be done first to avoid problems.

Definition at line 266 of file display_group.cpp.

◆ addDisplayWithoutSignallingModel()

void rviz::DisplayGroup::addDisplayWithoutSignallingModel ( Display * child )

protectedvirtual

Add a child Display to the end of the list of Displays, but without telling the model.

Definition at line 256 of file display_group.cpp.

◆ childAtUnchecked()

Property * rviz::DisplayGroup::childAtUnchecked ( int index ) const

overridevirtual

Return the child with the given index, without checking whether the index is within bounds.

Overridden from Property to include Display children.

Reimplemented from rviz::Property.

Definition at line 350 of file display_group.cpp.

◆ createDisplay()

Display * rviz::DisplayGroup::createDisplay ( const QString & class_id )

Definition at line 119 of file display_group.cpp.

◆ displayAdded

void rviz::DisplayGroup::displayAdded ( rviz::Display * display )

signal

◆ displayRemoved

void rviz::DisplayGroup::displayRemoved ( rviz::Display * display )

signal

◆ fixedFrameChanged()

void rviz::DisplayGroup::fixedFrameChanged ( )

overrideprotectedvirtual

Update the fixed frame in all contained displays.

Reimplemented from rviz::Display.

Definition at line 223 of file display_group.cpp.

◆ getDisplayAt()

Display * rviz::DisplayGroup::getDisplayAt ( int index ) const

virtual

Return the index-th Display in this group, or NULL if the index is invalid.

Definition at line 209 of file display_group.cpp.

◆ getGroupAt()

DisplayGroup * rviz::DisplayGroup::getGroupAt ( int index ) const

virtual

Find the index-th child Display in this group. If the child is itself a DisplayGroup, return the pointer to it. If it is not, return NULL.

Definition at line 218 of file display_group.cpp.

◆ getViewFlags()

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

overridevirtual

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

Reimplemented from rviz::Display.

Definition at line 52 of file display_group.cpp.

◆ load()

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

overridevirtual

Load subproperties and the list of displays in this group from the given Config node, which must be a map.

Reimplemented from rviz::Display.

Definition at line 57 of file display_group.cpp.

◆ numChildren()

int rviz::DisplayGroup::numChildren ( ) const

overridevirtual

Return the number of child objects (Property and Display).

Overridden from Property to include the number of child Displays.

Reimplemented from rviz::Property.

Definition at line 345 of file display_group.cpp.

◆ numDisplays()

int rviz::DisplayGroup::numDisplays ( ) const

virtual

Return the number of child Displays.

Definition at line 340 of file display_group.cpp.

◆ onEnableChanged

void rviz::DisplayGroup::onEnableChanged ( )

overrideslot

Definition at line 131 of file display_group.cpp.

◆ removeAllDisplays()

void rviz::DisplayGroup::removeAllDisplays ( )

virtual

Remove and destroy all child Displays, but preserve any non-Display children.

Definition at line 154 of file display_group.cpp.

◆ reset()

void rviz::DisplayGroup::reset ( )

overridevirtual

Reset this and all child Displays.

Reimplemented from rviz::Display.

Definition at line 245 of file display_group.cpp.

◆ save()

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

overridevirtual

Save subproperties and the list of displays in this group to the given Config node.

Reimplemented from rviz::Display.

Definition at line 140 of file display_group.cpp.

◆ takeChildAt()

Property * rviz::DisplayGroup::takeChildAt ( int index )

overridevirtual

Take a child out of the child list, but don't destroy it.

Returns: Returns the child property at the given index, or NULL if the index is out of bounds.

This notifies the model about the removal.

This is overridden from Property to include Display children.

Reimplemented from rviz::Property.

Definition at line 315 of file display_group.cpp.

◆ takeDisplay()

Display * rviz::DisplayGroup::takeDisplay ( Display * child )

virtual

Remove a child Display from the the list of Displays, but don't destroy it.

Returns: Returns child if it is found, or NULL if child is not found.

This also tells the model that we are removing a child, so it can update widgets.

Definition at line 181 of file display_group.cpp.

◆ update()

void rviz::DisplayGroup::update	(	float	wall_dt,
		float	ros_dt
	)

overridevirtual

Call update() on all child Displays.

Reimplemented from rviz::Display.

Definition at line 232 of file display_group.cpp.

Member Data Documentation

◆ displays_

QList<Display*> rviz::DisplayGroup::displays_

private

Definition at line 156 of file display_group.h.

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DisplayGroup()

◆ ~DisplayGroup()

Member Function Documentation

◆ addChild()

◆ addDisplay()

◆ addDisplayWithoutSignallingModel()

◆ childAtUnchecked()

◆ createDisplay()

◆ displayAdded

◆ displayRemoved

◆ fixedFrameChanged()

◆ getDisplayAt()

◆ getGroupAt()

◆ getViewFlags()

◆ load()

◆ numChildren()

◆ numDisplays()

◆ onEnableChanged

◆ removeAllDisplays()

◆ reset()

◆ save()

◆ takeChildAt()

◆ takeDisplay()

◆ update()

Member Data Documentation

◆ displays_