Display class for the map plugin. More...

#include <ClusterLabelDisplay.hpp>

Inheritance diagram for rviz_map_plugin::ClusterLabelDisplay:

[legend]

Public Slots
shared_ptr< Geometry >	getGeometry ()
	Getter for the current geometry. More...

void	notifyLabelTool ()
	Refreshes the tool's current visual. More...

void	setData (shared_ptr< Geometry > geometry, vector< Cluster > clusters)
	Setter for the geometry and cluster data. More...

Public Slots inherited from rviz::Display
virtual void	onEnableChanged ()

void	queueRender ()

void	setEnabled (bool enabled)

void	setIcon (const QIcon &icon) override

Public Slots inherited from rviz::BoolProperty
bool	setBool (bool value)

Signals
void	signalAddLabel (Cluster cluster)
	This signal is used for delegating new label data to the master display. More...

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

Signals inherited from rviz::Property
void	aboutToChange ()

void	changed ()

void	childListChanged (Property *this_property)

Public Member Functions
void	addLabel (string label, vector< uint32_t > faces)
	The tool will call this function and emit the signal below to the master display to create the label. More...

	ClusterLabelDisplay ()
	Constructor. More...

void	onDisable ()
	RViz callback on disable. More...

void	onEnable ()
	RViz callback on enable. More...

	~ClusterLabelDisplay ()
	Destructor. More...

Public Member Functions inherited from rviz::Display
virtual void	deleteStatus (const QString &name)

void	deleteStatusStd (const std::string &name)

	Display ()

void	emitTimeSignal (ros::Time time)

QWidget *	getAssociatedWidget () const

PanelDockWidget *	getAssociatedWidgetPanel ()

virtual QString	getClassId () const

Ogre::SceneNode *	getSceneNode () const

QVariant	getViewData (int column, int role) const override

Qt::ItemFlags	getViewFlags (int column) const override

uint32_t	getVisibilityBits ()

void	initialize (DisplayContext *context)

bool	isEnabled () const

void	load (const Config &config) override

virtual void	reset ()

void	save (Config config) const override

void	setAssociatedWidget (QWidget *widget)

virtual void	setClassId (const QString &class_id)

void	setFixedFrame (const QString &fixed_frame)

void	setName (const QString &name) override

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

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

virtual void	setTopic (const QString &topic, const QString &datatype)

void	setVisibilityBits (uint32_t bits)

void	unsetVisibilityBits (uint32_t bits)

virtual void	update (float wall_dt, float ros_dt)

	~Display () override

Public Member Functions inherited from rviz::BoolProperty
	BoolProperty (const QString &name, bool default_value, const QString &description, P *parent, Func &&changed_slot)

	BoolProperty (const QString &name, bool default_value, const QString &description, Property parent, Func &&changed_slot, const R receiver)

	BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr)

virtual bool	getBool () const

bool	getDisableChildren () override

bool	getDisableChildrenIfFalse ()

void	setDisableChildrenIfFalse (bool disable)

	~BoolProperty () override

Public Member Functions inherited from rviz::Property
virtual void	addChild (Property *child, int index=-1)

Property *	childAt (int index) const

virtual Property *	childAtUnchecked (int index) const

virtual void	collapse ()

std::enable_if<!QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (const QObject *context, Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)

QMetaObject::Connection	connect (const QObject receiver, const char slot, Qt::ConnectionType type=Qt::AutoConnection)

std::enable_if< QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (const R *receiver, Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)

std::enable_if<!QtPrivate::FunctionPointer< Func >::IsPointerToMemberFunction, QMetaObject::Connection >::type	connect (Func &&slot, Qt::ConnectionType type=Qt::AutoConnection)

bool	contains (Property *possible_child) const

virtual QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option)

virtual void	expand ()

virtual QString	getDescription () const

virtual bool	getHidden () const

virtual QIcon	getIcon () const

PropertyTreeModel *	getModel () const

virtual QString	getName () const

std::string	getNameStd () const

Property *	getParent () const

virtual bool	getReadOnly () const

virtual QVariant	getValue () const

void	hide ()

void	insertChildSorted (Property *child)

bool	isAncestorOf (Property *possible_child) const

virtual void	moveChild (int from_index, int to_index)

virtual int	numChildren () const

virtual bool	paint (QPainter *painter, const QStyleOptionViewItem &option) const

	Property (const QString &name, const QVariant &default_value, const QString &description, P *parent, Func &&changed_slot)

	Property (const QString &name, const QVariant &default_value, const QString &description, Property parent, Func &&changed_slot, const R receiver)

	Property (const QString &name=QString(), const QVariant &default_value=QVariant(), const QString &description=QString(), Property *parent=nullptr)

virtual void	removeChildren (int start_index=0, int count=-1)

int	rowNumberInParent () const

virtual void	setDescription (const QString &description)

virtual void	setHidden (bool hidden)

virtual void	setIcon (const QIcon &icon)

void	setModel (PropertyTreeModel *model)

void	setParent (Property *new_parent)

virtual void	setReadOnly (bool read_only)

void	setShouldBeSaved (bool save)

virtual bool	setValue (const QVariant &new_value)

bool	shouldBeSaved () const

void	show ()

virtual Property *	subProp (const QString &sub_name)

Property *	takeChild (Property *child)

virtual Property *	takeChildAt (int index)

	~Property () override

Private Slots
void	changeVisual ()
	Slot for changing the visual to the selected visual from the dropdown menu. More...

void	updateColors ()
	Updates the colors, based on newly loaded data since the last update. More...

void	updateMap ()
	Update the map, based on newly loaded data since the last update. More...

void	updatePhantomVisual ()
	Updates the phantom visual, based on newly loaded data since the last update. More...

void	updateSphereSize ()
	Updates the sphere size for the brush tool. More...

Private Member Functions
void	createPhantomVisual ()
	Creates a phantom visual. More...

void	createVisualsFromClusterList ()
	Create visuals for each cluster in the list. More...

void	fillPropertyOptions ()
	Dynamically fills the dropdown menus of those properties. More...

void	initializeLabelTool ()
	Programmatically create an instance of the label tool from this package. More...

void	onInitialize ()
	RViz callback on initialize. More...

Private Attributes
bool	has_data = false
	A variable that will be set to true, once the initial data has arrived. More...

uint32_t	m_activeVisualId = 0
	ID of the current active visual. More...

rviz::EnumProperty *	m_activeVisualProperty
	Property for the current active visual. More...

rviz::FloatProperty *	m_alphaProperty
	Property to set transparency. More...

vector< Cluster >	m_clusterList
	Cluster data. More...

std::vector< rviz::ColorProperty * >	m_colorProperties
	Properties for selecting colors (menu-items) More...

rviz::Property *	m_colorsProperty
	Property for selecting colors (menu) More...

shared_ptr< Geometry >	m_geometry
	Geometry. More...

int	m_labelToolVisualIndex = 0
	Index for the visuals. More...

unique_ptr< ClusterLabelVisual >	m_phantomVisual
	Additional visual to help with labeling without a TexturedMesh. More...

rviz::BoolProperty *	m_phantomVisualProperty
	Property to hide or show a phantom visual. More...

rviz::FloatProperty *	m_sphereSizeProperty
	Property to set the brushsize of the sphere brush of the label tool from this package. More...

ClusterLabelTool *	m_tool
	Label tool. More...

vector< shared_ptr< ClusterLabelVisual > >	m_visuals
	Visuals. More...

Additional Inherited Members
Protected Member Functions inherited from rviz::Display
virtual void	clearStatuses ()

virtual void	fixedFrameChanged ()

bool	initialized () const

Protected Member Functions inherited from rviz::Property
void	loadValue (const Config &config)

Protected Attributes inherited from rviz::Display
DisplayContext *	context_

QString	fixed_frame_

Ogre::SceneManager *	scene_manager_

Ogre::SceneNode *	scene_node_

ros::NodeHandle	threaded_nh_

ros::NodeHandle	update_nh_

Protected Attributes inherited from rviz::Property
bool	child_indexes_valid_

QIcon	icon_

PropertyTreeModel *	model_

QVariant	value_

Detailed Description

Display class for the map plugin.

Definition at line 136 of file ClusterLabelDisplay.hpp.

Constructor & Destructor Documentation

◆ ClusterLabelDisplay()

rviz_map_plugin::ClusterLabelDisplay::ClusterLabelDisplay ( )

Constructor.

Definition at line 92 of file ClusterLabelDisplay.cpp.

◆ ~ClusterLabelDisplay()

rviz_map_plugin::ClusterLabelDisplay::~ClusterLabelDisplay ( )

Destructor.

Definition at line 116 of file ClusterLabelDisplay.cpp.

Member Function Documentation

◆ addLabel()

void rviz_map_plugin::ClusterLabelDisplay::addLabel	(	string	label,
		vector< uint32_t >	faces
	)

The tool will call this function and emit the signal below to the master display to create the label.

Parameters

label	The label name
faces	The list of face IDs

Definition at line 345 of file ClusterLabelDisplay.cpp.

◆ changeVisual

void rviz_map_plugin::ClusterLabelDisplay::changeVisual ( )

privateslot

Slot for changing the visual to the selected visual from the dropdown menu.

Definition at line 179 of file ClusterLabelDisplay.cpp.

◆ createPhantomVisual()

void rviz_map_plugin::ClusterLabelDisplay::createPhantomVisual ( )

private

Creates a phantom visual.

Definition at line 303 of file ClusterLabelDisplay.cpp.

◆ createVisualsFromClusterList()

void rviz_map_plugin::ClusterLabelDisplay::createVisualsFromClusterList ( )

private

Create visuals for each cluster in the list.

Definition at line 280 of file ClusterLabelDisplay.cpp.

◆ fillPropertyOptions()

void rviz_map_plugin::ClusterLabelDisplay::fillPropertyOptions ( )

private

Dynamically fills the dropdown menus of those properties.

Definition at line 256 of file ClusterLabelDisplay.cpp.

◆ getGeometry

std::shared_ptr< Geometry > rviz_map_plugin::ClusterLabelDisplay::getGeometry ( )

slot

Getter for the current geometry.

Returns: The geometry

Definition at line 123 of file ClusterLabelDisplay.cpp.

◆ initializeLabelTool()

void rviz_map_plugin::ClusterLabelDisplay::initializeLabelTool ( )

private

Programmatically create an instance of the label tool from this package.

Definition at line 318 of file ClusterLabelDisplay.cpp.

◆ notifyLabelTool

void rviz_map_plugin::ClusterLabelDisplay::notifyLabelTool ( )

slot

Refreshes the tool's current visual.

Definition at line 340 of file ClusterLabelDisplay.cpp.

◆ onDisable()

void rviz_map_plugin::ClusterLabelDisplay::onDisable ( )

virtual

RViz callback on disable.

Reimplemented from rviz::Display.

Definition at line 169 of file ClusterLabelDisplay.cpp.

◆ onEnable()

void rviz_map_plugin::ClusterLabelDisplay::onEnable ( )

virtual

RViz callback on enable.

Reimplemented from rviz::Display.

Definition at line 164 of file ClusterLabelDisplay.cpp.

◆ onInitialize()

void rviz_map_plugin::ClusterLabelDisplay::onInitialize ( )

privatevirtual

RViz callback on initialize.

Reimplemented from rviz::Display.

Definition at line 158 of file ClusterLabelDisplay.cpp.

◆ setData

void rviz_map_plugin::ClusterLabelDisplay::setData	(	shared_ptr< Geometry >	geometry,
		vector< Cluster >	clusters
	)

slot

Setter for the geometry and cluster data.

Parameters

geometry	The geometry
clusters	The clusters

Definition at line 132 of file ClusterLabelDisplay.cpp.

◆ signalAddLabel

void rviz_map_plugin::ClusterLabelDisplay::signalAddLabel ( Cluster cluster )

signal

This signal is used for delegating new label data to the master display.

Parameters

cluster The cluster

◆ updateColors

void rviz_map_plugin::ClusterLabelDisplay::updateColors ( )

privateslot

Updates the colors, based on newly loaded data since the last update.

Definition at line 230 of file ClusterLabelDisplay.cpp.

◆ updateMap

void rviz_map_plugin::ClusterLabelDisplay::updateMap ( )

privateslot

Update the map, based on newly loaded data since the last update.

Definition at line 195 of file ClusterLabelDisplay.cpp.

◆ updatePhantomVisual

void rviz_map_plugin::ClusterLabelDisplay::updatePhantomVisual ( )

privateslot

Updates the phantom visual, based on newly loaded data since the last update.

Definition at line 244 of file ClusterLabelDisplay.cpp.

◆ updateSphereSize

void rviz_map_plugin::ClusterLabelDisplay::updateSphereSize ( )

privateslot

Updates the sphere size for the brush tool.

Definition at line 239 of file ClusterLabelDisplay.cpp.

Member Data Documentation

◆ has_data

bool rviz_map_plugin::ClusterLabelDisplay::has_data = false

private

A variable that will be set to true, once the initial data has arrived.

Definition at line 290 of file ClusterLabelDisplay.hpp.

◆ m_activeVisualId

uint32_t rviz_map_plugin::ClusterLabelDisplay::m_activeVisualId = 0

private

ID of the current active visual.

Definition at line 257 of file ClusterLabelDisplay.hpp.

◆ m_activeVisualProperty

rviz::EnumProperty* rviz_map_plugin::ClusterLabelDisplay::m_activeVisualProperty

private

Property for the current active visual.

Definition at line 269 of file ClusterLabelDisplay.hpp.

◆ m_alphaProperty

rviz::FloatProperty* rviz_map_plugin::ClusterLabelDisplay::m_alphaProperty

private

Property to set transparency.

Definition at line 272 of file ClusterLabelDisplay.hpp.

◆ m_clusterList

vector<Cluster> rviz_map_plugin::ClusterLabelDisplay::m_clusterList

private

Cluster data.

Definition at line 263 of file ClusterLabelDisplay.hpp.

◆ m_colorProperties

std::vector<rviz::ColorProperty*> rviz_map_plugin::ClusterLabelDisplay::m_colorProperties

private

Properties for selecting colors (menu-items)

Definition at line 278 of file ClusterLabelDisplay.hpp.

◆ m_colorsProperty

rviz::Property* rviz_map_plugin::ClusterLabelDisplay::m_colorsProperty

private

Property for selecting colors (menu)

Definition at line 275 of file ClusterLabelDisplay.hpp.

◆ m_geometry

shared_ptr<Geometry> rviz_map_plugin::ClusterLabelDisplay::m_geometry

private

Geometry.

Definition at line 251 of file ClusterLabelDisplay.hpp.

◆ m_labelToolVisualIndex

int rviz_map_plugin::ClusterLabelDisplay::m_labelToolVisualIndex = 0

private

Index for the visuals.

Definition at line 287 of file ClusterLabelDisplay.hpp.

◆ m_phantomVisual

unique_ptr<ClusterLabelVisual> rviz_map_plugin::ClusterLabelDisplay::m_phantomVisual

private

Additional visual to help with labeling without a TexturedMesh.

Definition at line 260 of file ClusterLabelDisplay.hpp.

◆ m_phantomVisualProperty

rviz::BoolProperty* rviz_map_plugin::ClusterLabelDisplay::m_phantomVisualProperty

private

Property to hide or show a phantom visual.

Definition at line 284 of file ClusterLabelDisplay.hpp.

◆ m_sphereSizeProperty

rviz::FloatProperty* rviz_map_plugin::ClusterLabelDisplay::m_sphereSizeProperty

private

Property to set the brushsize of the sphere brush of the label tool from this package.

Definition at line 281 of file ClusterLabelDisplay.hpp.

◆ m_tool

ClusterLabelTool* rviz_map_plugin::ClusterLabelDisplay::m_tool

private

Label tool.

Definition at line 266 of file ClusterLabelDisplay.hpp.

◆ m_visuals

vector<shared_ptr<ClusterLabelVisual> > rviz_map_plugin::ClusterLabelDisplay::m_visuals

private

Visuals.

Definition at line 254 of file ClusterLabelDisplay.hpp.

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

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClusterLabelDisplay()

◆ ~ClusterLabelDisplay()

Member Function Documentation

◆ addLabel()

◆ changeVisual

◆ createPhantomVisual()

◆ createVisualsFromClusterList()

◆ fillPropertyOptions()

◆ getGeometry

◆ initializeLabelTool()

◆ notifyLabelTool

◆ onDisable()

◆ onEnable()

◆ onInitialize()

◆ setData

◆ signalAddLabel

◆ updateColors

◆ updateMap

◆ updatePhantomVisual

◆ updateSphereSize

Member Data Documentation

◆ has_data

◆ m_activeVisualId

◆ m_activeVisualProperty

◆ m_alphaProperty

◆ m_clusterList

◆ m_colorProperties

◆ m_colorsProperty

◆ m_geometry

◆ m_labelToolVisualIndex

◆ m_phantomVisual

◆ m_phantomVisualProperty

◆ m_sphereSizeProperty

◆ m_tool

◆ m_visuals