rviz::TFDisplay Class Reference

Displays a visual representation of the TF hierarchy. More...

#include <tf_display.h>

Inheritance diagram for rviz::TFDisplay:

[legend]

List of all members.

Public Member Functions
virtual void	createProperties ()
	Called from setPropertyManager, gives the display a chance to create some properties immediately.
virtual void	fixedFrameChanged ()
	Called from within setFixedFrame, notifying child classes that the fixed frame has changed.
bool	getAllEnabled ()
float	getFrameTimeout ()
float	getScale ()
bool	getShowArrows ()
bool	getShowAxes ()
bool	getShowNames ()
float	getUpdateRate ()
virtual void	reset ()
	Called to tell the display to clear its state.
void	setAllEnabled (bool enabled)
void	setFrameEnabled (FrameInfo *frame, bool enabled)
void	setFrameTimeout (float timeout)
void	setScale (float scale)
void	setShowArrows (bool show)
void	setShowAxes (bool show)
void	setShowNames (bool show)
void	setUpdateRate (float rate)
virtual void	targetFrameChanged ()
	Called from within setTargetFrame, notifying child classes that the target frame has changed.
	TFDisplay (const std::string &name, VisualizationManager *manager)
virtual void	update (float wall_dt, float ros_dt)
	Called periodically by the visualization panel.
virtual	~TFDisplay ()
Protected Types
typedef std::map< std::string, FrameInfo * >	M_FrameInfo
Protected Member Functions
void	clear ()
FrameInfo *	createFrame (const std::string &frame)
void	deleteFrame (FrameInfo *frame, bool delete_properties)
FrameInfo *	getFrameInfo (const std::string &frame)
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.
void	updateFrame (FrameInfo *frame)
void	updateFrames ()
Protected Attributes
bool	all_enabled_
BoolPropertyWPtr	all_enabled_property_
Ogre::SceneNode *	arrows_node_
Ogre::SceneNode *	axes_node_
float	frame_timeout_
FloatPropertyWPtr	frame_timeout_property_
M_FrameInfo	frames_
CategoryPropertyWPtr	frames_category_
Ogre::SceneNode *	names_node_
Ogre::SceneNode *	root_node_
float	scale_
FloatPropertyWPtr	scale_property_
bool	show_arrows_
BoolPropertyWPtr	show_arrows_property_
bool	show_axes_
BoolPropertyWPtr	show_axes_property_
bool	show_names_
BoolPropertyWPtr	show_names_property_
CategoryPropertyWPtr	tree_category_
float	update_rate_
FloatPropertyWPtr	update_rate_property_
float	update_timer_

---

Detailed Description

Displays a visual representation of the TF hierarchy.

Definition at line 71 of file tf_display.h.

---

Member Typedef Documentation

typedef std::map<std::string, FrameInfo*> rviz::TFDisplay::M_FrameInfo [protected]

Definition at line 126 of file tf_display.h.

---

Constructor & Destructor Documentation

rviz::TFDisplay::TFDisplay	(	const std::string &	name,
		VisualizationManager *	manager
	)

Definition at line 190 of file tf_display.cpp.

rviz::TFDisplay::~TFDisplay

(

)

[virtual]

Definition at line 208 of file tf_display.cpp.

---

Member Function Documentation

void rviz::TFDisplay::clear

(

)

[protected]

Definition at line 216 of file tf_display.cpp.

FrameInfo * rviz::TFDisplay::createFrame

(

const std::string &

frame

)

[protected]

Definition at line 430 of file tf_display.cpp.

void rviz::TFDisplay::createProperties

(

)

[virtual]

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

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

Reimplemented from rviz::Display.

Definition at line 659 of file tf_display.cpp.

void rviz::TFDisplay::deleteFrame	(	FrameInfo *	frame,
		bool	delete_properties
	)			[protected]

Definition at line 639 of file tf_display.cpp.

virtual void rviz::TFDisplay::fixedFrameChanged

(

)

[inline, virtual]

Called from within setFixedFrame, notifying child classes that the fixed frame has changed.

Implements rviz::Display.

Definition at line 103 of file tf_display.h.

bool rviz::TFDisplay::getAllEnabled

(

)

[inline]

Definition at line 89 of file tf_display.h.

FrameInfo * rviz::TFDisplay::getFrameInfo

(

const std::string &

frame

)

[protected]

Definition at line 358 of file tf_display.cpp.

float rviz::TFDisplay::getFrameTimeout

(

)

[inline]

Definition at line 92 of file tf_display.h.

float rviz::TFDisplay::getScale

(

)

[inline]

Definition at line 95 of file tf_display.h.

bool rviz::TFDisplay::getShowArrows

(

)

[inline]

Definition at line 83 of file tf_display.h.

bool rviz::TFDisplay::getShowAxes

(

)

[inline]

Definition at line 80 of file tf_display.h.

bool rviz::TFDisplay::getShowNames

(

)

[inline]

Definition at line 77 of file tf_display.h.

float rviz::TFDisplay::getUpdateRate

(

)

[inline]

Definition at line 86 of file tf_display.h.

void rviz::TFDisplay::onDisable

(

)

[protected, virtual]

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

Implements rviz::Display.

Definition at line 252 of file tf_display.cpp.

void rviz::TFDisplay::onEnable

(

)

[protected, virtual]

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

Implements rviz::Display.

Definition at line 243 of file tf_display.cpp.

void rviz::TFDisplay::reset

(

)

[virtual]

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 707 of file tf_display.cpp.

void rviz::TFDisplay::setAllEnabled

(

bool

enabled

)

Definition at line 312 of file tf_display.cpp.

void rviz::TFDisplay::setFrameEnabled	(	FrameInfo *	frame,
		bool	enabled
	)

Definition at line 109 of file tf_display.cpp.

void rviz::TFDisplay::setFrameTimeout

(

float

timeout

)

Definition at line 328 of file tf_display.cpp.

void rviz::TFDisplay::setScale

(

float

scale

)

Definition at line 334 of file tf_display.cpp.

void rviz::TFDisplay::setShowArrows

(

bool

show

)

Definition at line 294 of file tf_display.cpp.

void rviz::TFDisplay::setShowAxes

(

bool

show

)

Definition at line 276 of file tf_display.cpp.

void rviz::TFDisplay::setShowNames

(

bool

show

)

Definition at line 258 of file tf_display.cpp.

void rviz::TFDisplay::setUpdateRate

(

float

rate

)

Definition at line 340 of file tf_display.cpp.

void rviz::TFDisplay::targetFrameChanged

(

)

[virtual]

Called from within setTargetFrame, notifying child classes that the target frame has changed.

Implements rviz::Display.

Definition at line 702 of file tf_display.cpp.

void rviz::TFDisplay::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 347 of file tf_display.cpp.

void rviz::TFDisplay::updateFrame

(

FrameInfo *

frame

)

[protected]

Definition at line 477 of file tf_display.cpp.

void rviz::TFDisplay::updateFrames

(

)

[protected]

Definition at line 369 of file tf_display.cpp.

---

Member Data Documentation

bool rviz::TFDisplay::all_enabled_ [protected]

Definition at line 136 of file tf_display.h.

BoolPropertyWPtr rviz::TFDisplay::all_enabled_property_ [protected]

Definition at line 145 of file tf_display.h.

Ogre::SceneNode* rviz::TFDisplay::arrows_node_ [protected]

Definition at line 123 of file tf_display.h.

Ogre::SceneNode* rviz::TFDisplay::axes_node_ [protected]

Definition at line 124 of file tf_display.h.

float rviz::TFDisplay::frame_timeout_ [protected]

Definition at line 135 of file tf_display.h.

FloatPropertyWPtr rviz::TFDisplay::frame_timeout_property_ [protected]

Definition at line 144 of file tf_display.h.

M_FrameInfo rviz::TFDisplay::frames_ [protected]

Definition at line 127 of file tf_display.h.

CategoryPropertyWPtr rviz::TFDisplay::frames_category_ [protected]

Definition at line 149 of file tf_display.h.

Ogre::SceneNode* rviz::TFDisplay::names_node_ [protected]

Definition at line 122 of file tf_display.h.

Ogre::SceneNode* rviz::TFDisplay::root_node_ [protected]

Definition at line 121 of file tf_display.h.

float rviz::TFDisplay::scale_ [protected]

Definition at line 138 of file tf_display.h.

FloatPropertyWPtr rviz::TFDisplay::scale_property_ [protected]

Definition at line 147 of file tf_display.h.

bool rviz::TFDisplay::show_arrows_ [protected]

Definition at line 133 of file tf_display.h.

BoolPropertyWPtr rviz::TFDisplay::show_arrows_property_ [protected]

Definition at line 141 of file tf_display.h.

bool rviz::TFDisplay::show_axes_ [protected]

Definition at line 134 of file tf_display.h.

BoolPropertyWPtr rviz::TFDisplay::show_axes_property_ [protected]

Definition at line 142 of file tf_display.h.

bool rviz::TFDisplay::show_names_ [protected]

Definition at line 132 of file tf_display.h.

BoolPropertyWPtr rviz::TFDisplay::show_names_property_ [protected]

Definition at line 140 of file tf_display.h.

CategoryPropertyWPtr rviz::TFDisplay::tree_category_ [protected]

Definition at line 150 of file tf_display.h.

float rviz::TFDisplay::update_rate_ [protected]

Definition at line 130 of file tf_display.h.

FloatPropertyWPtr rviz::TFDisplay::update_rate_property_ [protected]

Definition at line 143 of file tf_display.h.

float rviz::TFDisplay::update_timer_ [protected]

Definition at line 129 of file tf_display.h.

---

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

• tf_display.h
• tf_display.cpp