rviz::TFDisplay Class Reference

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

#include <tf_display.h>

Inheritance diagram for rviz::TFDisplay:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void createProperties ()
virtual void fixedFrameChanged ()
 Called by setFixedFrame(). Override to respond to changes to fixed_frame_.
bool getAllEnabled ()
float getFrameTimeout ()
float getScale ()
bool getShowArrows ()
bool getShowAxes ()
bool getShowNames ()
float getUpdateRate ()
virtual void onInitialize ()
 Override this function to do subclass-specific initialization.
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)
 TFDisplay ()
virtual void update (float wall_dt, float ros_dt)
 Called periodically by the visualization manager.
virtual ~TFDisplay ()

Protected Types

typedef std::map< std::string,
FrameInfo * > 
M_FrameInfo

Protected Member Functions

void clear ()
FrameInfocreateFrame (const std::string &frame)
void deleteFrame (FrameInfo *frame, bool delete_properties)
FrameInfogetFrameInfo (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_
Propertyall_enabled_property_
Ogre::SceneNode * arrows_node_
Ogre::SceneNode * axes_node_
float frame_timeout_
FloatPropertyframe_timeout_property_
M_FrameInfo frames_
Propertyframes_category_
Ogre::SceneNode * names_node_
Ogre::SceneNode * root_node_
float scale_
FloatPropertyscale_property_
bool show_arrows_
Propertyshow_arrows_property_
bool show_axes_
Propertyshow_axes_property_
bool show_names_
Propertyshow_names_property_
Propertytree_category_
float update_rate_
FloatPropertyupdate_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 127 of file tf_display.h.


Constructor & Destructor Documentation

rviz::TFDisplay::TFDisplay (  ) 

Definition at line 191 of file tf_display.cpp.

rviz::TFDisplay::~TFDisplay (  )  [virtual]

Definition at line 204 of file tf_display.cpp.


Member Function Documentation

void rviz::TFDisplay::clear (  )  [protected]

Definition at line 221 of file tf_display.cpp.

FrameInfo * rviz::TFDisplay::createFrame ( const std::string &  frame  )  [protected]

Definition at line 435 of file tf_display.cpp.

void rviz::TFDisplay::createProperties (  )  [virtual]

Definition at line 669 of file tf_display.cpp.

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

Definition at line 649 of file tf_display.cpp.

void rviz::TFDisplay::fixedFrameChanged (  )  [virtual]

Called by setFixedFrame(). Override to respond to changes to fixed_frame_.

Reimplemented from rviz::Display.

Definition at line 712 of file tf_display.cpp.

bool rviz::TFDisplay::getAllEnabled (  )  [inline]

Definition at line 91 of file tf_display.h.

FrameInfo * rviz::TFDisplay::getFrameInfo ( const std::string &  frame  )  [protected]

Definition at line 363 of file tf_display.cpp.

float rviz::TFDisplay::getFrameTimeout (  )  [inline]

Definition at line 94 of file tf_display.h.

float rviz::TFDisplay::getScale (  )  [inline]

Definition at line 97 of file tf_display.h.

bool rviz::TFDisplay::getShowArrows (  )  [inline]

Definition at line 85 of file tf_display.h.

bool rviz::TFDisplay::getShowAxes (  )  [inline]

Definition at line 82 of file tf_display.h.

bool rviz::TFDisplay::getShowNames (  )  [inline]

Definition at line 79 of file tf_display.h.

float rviz::TFDisplay::getUpdateRate (  )  [inline]

Definition at line 88 of file tf_display.h.

void rviz::TFDisplay::onDisable (  )  [protected, virtual]

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

Reimplemented from rviz::Display.

Definition at line 257 of file tf_display.cpp.

void rviz::TFDisplay::onEnable (  )  [protected, virtual]

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

Reimplemented from rviz::Display.

Definition at line 248 of file tf_display.cpp.

void rviz::TFDisplay::onInitialize (  )  [virtual]

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set, and before load() or setEnabled().

setName() may or may not have been called before this.

Reimplemented from rviz::Display.

Definition at line 212 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 717 of file tf_display.cpp.

void rviz::TFDisplay::setAllEnabled ( bool  enabled  ) 

Definition at line 317 of file tf_display.cpp.

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

Definition at line 110 of file tf_display.cpp.

void rviz::TFDisplay::setFrameTimeout ( float  timeout  ) 

Definition at line 333 of file tf_display.cpp.

void rviz::TFDisplay::setScale ( float  scale  ) 

Definition at line 339 of file tf_display.cpp.

void rviz::TFDisplay::setShowArrows ( bool  show  ) 

Definition at line 299 of file tf_display.cpp.

void rviz::TFDisplay::setShowAxes ( bool  show  ) 

Definition at line 281 of file tf_display.cpp.

void rviz::TFDisplay::setShowNames ( bool  show  ) 

Definition at line 263 of file tf_display.cpp.

void rviz::TFDisplay::setUpdateRate ( float  rate  ) 

Definition at line 345 of file tf_display.cpp.

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

Called periodically by the visualization manager.

Parameters:
wall_dt Wall-clock time, in seconds, since the last time the update list was run through.
ros_dt ROS time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 352 of file tf_display.cpp.

void rviz::TFDisplay::updateFrame ( FrameInfo frame  )  [protected]

Definition at line 487 of file tf_display.cpp.

void rviz::TFDisplay::updateFrames (  )  [protected]

Definition at line 374 of file tf_display.cpp.


Member Data Documentation

Definition at line 137 of file tf_display.h.

Definition at line 146 of file tf_display.h.

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

Definition at line 124 of file tf_display.h.

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

Definition at line 125 of file tf_display.h.

Definition at line 136 of file tf_display.h.

Definition at line 145 of file tf_display.h.

Definition at line 128 of file tf_display.h.

Definition at line 150 of file tf_display.h.

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

Definition at line 123 of file tf_display.h.

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

Definition at line 122 of file tf_display.h.

float rviz::TFDisplay::scale_ [protected]

Definition at line 139 of file tf_display.h.

Definition at line 148 of file tf_display.h.

Definition at line 134 of file tf_display.h.

Definition at line 142 of file tf_display.h.

bool rviz::TFDisplay::show_axes_ [protected]

Definition at line 135 of file tf_display.h.

Definition at line 143 of file tf_display.h.

bool rviz::TFDisplay::show_names_ [protected]

Definition at line 133 of file tf_display.h.

Definition at line 141 of file tf_display.h.

Definition at line 151 of file tf_display.h.

float rviz::TFDisplay::update_rate_ [protected]

Definition at line 131 of file tf_display.h.

Definition at line 144 of file tf_display.h.

float rviz::TFDisplay::update_timer_ [protected]

Definition at line 130 of file tf_display.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012