Displays a nav_2d_msgs::Path2D message in Rviz. More...

#include <path_display.h>

Inheritance diagram for robot_nav_rviz_plugins::PathDisplay:

[legend]

Public Member Functions
	PathDisplay ()

void	reset () override

virtual	~PathDisplay ()

Public Member Functions inherited from rviz::MessageFilterDisplay< nav_2d_msgs::Path2D >
	MessageFilterDisplay ()

void	onInitialize () override

void	reset () override

void	setTopic (const QString &topic, const QString &) override

	~MessageFilterDisplay () override

Public Member Functions inherited from rviz::_RosTopicDisplay
	_RosTopicDisplay ()

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

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)

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

Protected Member Functions
void	onInitialize () override

void	processMessage (const nav_2d_msgs::Path2D::ConstPtr &msg) override

Protected Member Functions inherited from rviz::MessageFilterDisplay< nav_2d_msgs::Path2D >
void	fixedFrameChanged () override

void	incomingMessage (const typename MessageType::ConstPtr &msg)

void	onDisable () override

void	onEnable () override

virtual void	processMessage (const typename MessageType::ConstPtr &msg)=0

void	processTypeErasedMessage (boost::shared_ptr< const void > type_erased_msg) override

virtual void	subscribe ()

virtual void	unsubscribe ()

void	updateQueueSize () override

void	updateTopic () override

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

bool	initialized () const

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

Private Types
enum	LineStyle { LineStyle::LINES, LineStyle::BILLBOARDS }

enum	PoseStyle { PoseStyle::NONE, PoseStyle::AXES, PoseStyle::ARROWS }

Private Slots
void	updateBufferLength ()

void	updateLineWidth ()

void	updateOffset ()

void	updatePoseArrowColor ()

void	updatePoseArrowGeometry ()

void	updatePoseAxisGeometry ()

void	updatePoseStyle ()

void	updateStyle ()

Private Member Functions
void	allocateArrowVector (std::vector< rviz::Arrow * > &arrow_vect, int num)

void	allocateAxesVector (std::vector< rviz::Axes * > &axes_vect, int num)

void	destroyObjects ()

LineStyle	getLineStyle () const

PoseStyle	getPoseStyle () const

Private Attributes
rviz::FloatProperty *	alpha_property_

std::vector< std::vector< rviz::Arrow * > >	arrow_chain_

std::vector< std::vector< rviz::Axes * > >	axes_chain_

std::vector< rviz::BillboardLine * >	billboard_lines_

rviz::IntProperty *	buffer_length_property_

rviz::ColorProperty *	color_property_

rviz::FloatProperty *	line_width_property_

std::vector< Ogre::ManualObject * >	manual_objects_

rviz::VectorProperty *	offset_property_

rviz::ColorProperty *	pose_arrow_color_property_

rviz::FloatProperty *	pose_arrow_head_diameter_property_

rviz::FloatProperty *	pose_arrow_head_length_property_

rviz::FloatProperty *	pose_arrow_shaft_diameter_property_

rviz::FloatProperty *	pose_arrow_shaft_length_property_

rviz::FloatProperty *	pose_axes_length_property_

rviz::FloatProperty *	pose_axes_radius_property_

rviz::EnumProperty *	pose_style_property_

rviz::EnumProperty *	style_property_

Additional Inherited Members
Public Types inherited from rviz::MessageFilterDisplay< nav_2d_msgs::Path2D >
typedef MessageFilterDisplay< MessageType >	MFDClass

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 inherited from rviz::Display
void	timeSignal (ros::Time time, QPrivateSignal)

Signals inherited from rviz::Property
void	aboutToChange ()

void	changed ()

void	childListChanged (Property *this_property)

Protected Slots inherited from rviz::_RosTopicDisplay
Protected Attributes inherited from rviz::MessageFilterDisplay< nav_2d_msgs::Path2D >
uint32_t	messages_received_

message_filters::Subscriber< MessageType >	sub_

tf2_ros::MessageFilter< MessageType > *	tf_filter_

Protected Attributes inherited from rviz::_RosTopicDisplay
IntProperty *	queue_size_property_

RosTopicProperty *	topic_property_

BoolProperty *	unreliable_property_

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

Displays a nav_2d_msgs::Path2D message in Rviz.

Note: this is refactored from rviz/PathDisplay

Definition at line 54 of file path_display.h.

Member Enumeration Documentation

◆ LineStyle

enum robot_nav_rviz_plugins::PathDisplay::LineStyle

strongprivate

Enumerator
LINES
BILLBOARDS

Definition at line 78 of file path_display.h.

◆ PoseStyle

enum robot_nav_rviz_plugins::PathDisplay::PoseStyle

strongprivate

Enumerator
NONE
AXES
ARROWS

Definition at line 79 of file path_display.h.

Constructor & Destructor Documentation

◆ PathDisplay()

robot_nav_rviz_plugins::PathDisplay::PathDisplay ( )

Definition at line 44 of file path_display.cpp.

◆ ~PathDisplay()

robot_nav_rviz_plugins::PathDisplay::~PathDisplay ( )

virtual

Definition at line 95 of file path_display.cpp.

Member Function Documentation

◆ allocateArrowVector()

void robot_nav_rviz_plugins::PathDisplay::allocateArrowVector	(	std::vector< rviz::Arrow * > &	arrow_vect,
		int	num
	)

private

Definition at line 135 of file path_display.cpp.

◆ allocateAxesVector()

void robot_nav_rviz_plugins::PathDisplay::allocateAxesVector	(	std::vector< rviz::Axes * > &	axes_vect,
		int	num
	)

private

Definition at line 112 of file path_display.cpp.

◆ destroyObjects()

void robot_nav_rviz_plugins::PathDisplay::destroyObjects ( )

private

Definition at line 269 of file path_display.cpp.

◆ getLineStyle()

LineStyle robot_nav_rviz_plugins::PathDisplay::getLineStyle ( ) const

inlineprivate

Definition at line 80 of file path_display.h.

◆ getPoseStyle()

PoseStyle robot_nav_rviz_plugins::PathDisplay::getPoseStyle ( ) const

inlineprivate

Definition at line 81 of file path_display.h.

◆ onInitialize()

void robot_nav_rviz_plugins::PathDisplay::onInitialize ( )

overrideprotectedvirtual

Reimplemented from rviz::Display.

Definition at line 100 of file path_display.cpp.

◆ processMessage()

void robot_nav_rviz_plugins::PathDisplay::processMessage ( const nav_2d_msgs::Path2D::ConstPtr & msg )

overrideprotected

Definition at line 339 of file path_display.cpp.

◆ reset()

void robot_nav_rviz_plugins::PathDisplay::reset ( )

overridevirtual

Reimplemented from rviz::Display.

Definition at line 106 of file path_display.cpp.

◆ updateBufferLength

void robot_nav_rviz_plugins::PathDisplay::updateBufferLength ( )

privateslot

Definition at line 306 of file path_display.cpp.

◆ updateLineWidth

void robot_nav_rviz_plugins::PathDisplay::updateLineWidth ( )

privateslot

Definition at line 173 of file path_display.cpp.

◆ updateOffset

void robot_nav_rviz_plugins::PathDisplay::updateOffset ( )

privateslot

Definition at line 187 of file path_display.cpp.

◆ updatePoseArrowColor

void robot_nav_rviz_plugins::PathDisplay::updatePoseArrowColor ( )

privateslot

Definition at line 240 of file path_display.cpp.

◆ updatePoseArrowGeometry

void robot_nav_rviz_plugins::PathDisplay::updatePoseArrowGeometry ( )

privateslot

Definition at line 254 of file path_display.cpp.

◆ updatePoseAxisGeometry

void robot_nav_rviz_plugins::PathDisplay::updatePoseAxisGeometry ( )

privateslot

Definition at line 227 of file path_display.cpp.

◆ updatePoseStyle

void robot_nav_rviz_plugins::PathDisplay::updatePoseStyle ( )

privateslot

Definition at line 193 of file path_display.cpp.

◆ updateStyle

void robot_nav_rviz_plugins::PathDisplay::updateStyle ( )

privateslot

Definition at line 156 of file path_display.cpp.

Member Data Documentation

◆ alpha_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::alpha_property_

private

Definition at line 94 of file path_display.h.

◆ arrow_chain_

std::vector<std::vector<rviz::Arrow*> > robot_nav_rviz_plugins::PathDisplay::arrow_chain_

private

Definition at line 90 of file path_display.h.

◆ axes_chain_

std::vector<std::vector<rviz::Axes*> > robot_nav_rviz_plugins::PathDisplay::axes_chain_

private

Definition at line 89 of file path_display.h.

◆ billboard_lines_

std::vector<rviz::BillboardLine*> robot_nav_rviz_plugins::PathDisplay::billboard_lines_

private

Definition at line 88 of file path_display.h.

◆ buffer_length_property_

rviz::IntProperty* robot_nav_rviz_plugins::PathDisplay::buffer_length_property_

private

Definition at line 96 of file path_display.h.

◆ color_property_

rviz::ColorProperty* robot_nav_rviz_plugins::PathDisplay::color_property_

private

Definition at line 93 of file path_display.h.

◆ line_width_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::line_width_property_

private

Definition at line 95 of file path_display.h.

◆ manual_objects_

std::vector<Ogre::ManualObject*> robot_nav_rviz_plugins::PathDisplay::manual_objects_

private

Definition at line 87 of file path_display.h.

◆ offset_property_

rviz::VectorProperty* robot_nav_rviz_plugins::PathDisplay::offset_property_

private

Definition at line 97 of file path_display.h.

◆ pose_arrow_color_property_

rviz::ColorProperty* robot_nav_rviz_plugins::PathDisplay::pose_arrow_color_property_

private

Definition at line 103 of file path_display.h.

◆ pose_arrow_head_diameter_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_arrow_head_diameter_property_

private

Definition at line 107 of file path_display.h.

◆ pose_arrow_head_length_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_arrow_head_length_property_

private

Definition at line 105 of file path_display.h.

◆ pose_arrow_shaft_diameter_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_arrow_shaft_diameter_property_

private

Definition at line 106 of file path_display.h.

◆ pose_arrow_shaft_length_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_arrow_shaft_length_property_

private

Definition at line 104 of file path_display.h.

◆ pose_axes_length_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_axes_length_property_

private

Definition at line 101 of file path_display.h.

◆ pose_axes_radius_property_

rviz::FloatProperty* robot_nav_rviz_plugins::PathDisplay::pose_axes_radius_property_

private

Definition at line 102 of file path_display.h.

◆ pose_style_property_

rviz::EnumProperty* robot_nav_rviz_plugins::PathDisplay::pose_style_property_

private

Definition at line 100 of file path_display.h.

◆ style_property_

rviz::EnumProperty* robot_nav_rviz_plugins::PathDisplay::style_property_

private

Definition at line 92 of file path_display.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LineStyle

◆ PoseStyle

Constructor & Destructor Documentation

◆ PathDisplay()

◆ ~PathDisplay()

Member Function Documentation

◆ allocateArrowVector()

◆ allocateAxesVector()

◆ destroyObjects()

◆ getLineStyle()

◆ getPoseStyle()

◆ onInitialize()

◆ processMessage()

◆ reset()

◆ updateBufferLength

◆ updateLineWidth

◆ updateOffset

◆ updatePoseArrowColor

◆ updatePoseArrowGeometry

◆ updatePoseAxisGeometry

◆ updatePoseStyle

◆ updateStyle

Member Data Documentation

◆ alpha_property_

◆ arrow_chain_

◆ axes_chain_

◆ billboard_lines_

◆ buffer_length_property_

◆ color_property_

◆ line_width_property_

◆ manual_objects_

◆ offset_property_

◆ pose_arrow_color_property_

◆ pose_arrow_head_diameter_property_

◆ pose_arrow_head_length_property_

◆ pose_arrow_shaft_diameter_property_

◆ pose_arrow_shaft_length_property_

◆ pose_axes_length_property_

◆ pose_axes_radius_property_

◆ pose_style_property_

◆ style_property_