rviz::AxesDisplay Class Reference

Displays a set of XYZ axes at the origin. More...

#include <axes_display.h>

Inheritance diagram for rviz::AxesDisplay:

List of all members.

Public Member Functions
	AxesDisplay ()
virtual void	createProperties ()
	Called from setPropertyManager, gives the display a chance to create some properties immediately.
const std::string &	getFrame ()
float	getLength ()
float	getRadius ()
void	onInitialize ()
	Override this function to do subclass-specific initialization.
void	set (float length, float radius)
	Set the parameters for the axes.
void	setFrame (const std::string &frame)
void	setLength (float length)
void	setRadius (float radius)
virtual void	update (float dt, float ros_dt)
	Called periodically by the visualization panel.
virtual	~AxesDisplay ()
Protected Member Functions
void	create ()
	Create the axes with the current parameters.
virtual void	onDisable ()
	Derived classes override this to do the actual work of disabling themselves.
virtual void	onEnable ()
	Derived classes override this to do the actual work of enabling themselves.
Protected Attributes
Axes *	axes_
	Handles actually drawing the axes.
std::string	frame_
TFFramePropertyWPtr	frame_property_
float	length_
	Length of each axis.
FloatPropertyWPtr	length_property_
float	radius_
	Radius of each axis.
FloatPropertyWPtr	radius_property_

---

Detailed Description

Displays a set of XYZ axes at the origin.

Definition at line 49 of file axes_display.h.

---

Constructor & Destructor Documentation

rviz::AxesDisplay::AxesDisplay

(

)

Definition at line 46 of file axes_display.cpp.

rviz::AxesDisplay::~AxesDisplay

(

)

[virtual]

Definition at line 54 of file axes_display.cpp.

---

Member Function Documentation

void rviz::AxesDisplay::create

(

)

[protected]

Create the axes with the current parameters.

Definition at line 78 of file axes_display.cpp.

void rviz::AxesDisplay::createProperties

(

)

[virtual]

Called from setPropertyManager, gives the display a chance to create some properties immediately.

When this function is called, the property_manager_ member is valid and will stay valid

Reimplemented from rviz::Display.

Definition at line 144 of file axes_display.cpp.

const std::string& rviz::AxesDisplay::getFrame

(

)

[inline]

Definition at line 69 of file axes_display.h.

float rviz::AxesDisplay::getLength

(

)

[inline]

Definition at line 65 of file axes_display.h.

float rviz::AxesDisplay::getRadius

(

)

[inline]

Definition at line 67 of file axes_display.h.

void rviz::AxesDisplay::onDisable

(

)

[protected, virtual]

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

Implements rviz::Display.

Definition at line 73 of file axes_display.cpp.

void rviz::AxesDisplay::onEnable

(

)

[protected, virtual]

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

Implements rviz::Display.

Definition at line 68 of file axes_display.cpp.

void rviz::AxesDisplay::onInitialize

(

)

[virtual]

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set.

Reimplemented from rviz::Display.

Definition at line 59 of file axes_display.cpp.

void rviz::AxesDisplay::set	(	float	length,
		float	radius
	)

Set the parameters for the axes.

Parameters:

length	Length of each axis
radius	Radius of each axis

Definition at line 85 of file axes_display.cpp.

void rviz::AxesDisplay::setFrame

(

const std::string &

frame

)

Definition at line 96 of file axes_display.cpp.

void rviz::AxesDisplay::setLength

(

float

length

)

Definition at line 102 of file axes_display.cpp.

void rviz::AxesDisplay::setRadius

(

float

radius

)

Definition at line 107 of file axes_display.cpp.

void rviz::AxesDisplay::update	(	float	wall_dt,
		float	ros_dt
	)		[virtual]

Called periodically by the visualization panel.

Parameters:

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

Reimplemented from rviz::Display.

Definition at line 112 of file axes_display.cpp.

---

Member Data Documentation

Axes* rviz::AxesDisplay::axes_ [protected]

Handles actually drawing the axes.

Definition at line 90 of file axes_display.h.

std::string rviz::AxesDisplay::frame_ [protected]

Definition at line 87 of file axes_display.h.

TFFramePropertyWPtr rviz::AxesDisplay::frame_property_ [protected]

Definition at line 94 of file axes_display.h.

float rviz::AxesDisplay::length_ [protected]

Length of each axis.

Definition at line 88 of file axes_display.h.

FloatPropertyWPtr rviz::AxesDisplay::length_property_ [protected]

Definition at line 92 of file axes_display.h.

float rviz::AxesDisplay::radius_ [protected]

Radius of each axis.

Definition at line 89 of file axes_display.h.

FloatPropertyWPtr rviz::AxesDisplay::radius_property_ [protected]

Definition at line 93 of file axes_display.h.

---

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

• axes_display.h
• axes_display.cpp