$search

rviz::AxesDisplay Class Reference

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

#include <axes_display.h>

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

List of all members.

Public Member Functions

 AxesDisplay (const std::string &name, VisualizationManager *manager)
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.
const std::string & getFrame ()
float getLength ()
float getRadius ()
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 targetFrameChanged ()
 Called from within setTargetFrame, notifying child classes that the target frame has changed.
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

ogre_tools::Axesaxes_
 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 ( const std::string &  name,
VisualizationManager manager 
)

Definition at line 33 of file axes_display.cpp.

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

Definition at line 45 of file axes_display.cpp.


Member Function Documentation

void rviz::AxesDisplay::create (  )  [protected]

Create the axes with the current parameters.

Definition at line 60 of file axes_display.cpp.

void rviz::AxesDisplay::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 126 of file axes_display.cpp.

virtual void rviz::AxesDisplay::fixedFrameChanged (  )  [inline, virtual]

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

Implements rviz::Display.

Definition at line 73 of file axes_display.h.

const std::string& rviz::AxesDisplay::getFrame (  )  [inline]

Definition at line 67 of file axes_display.h.

float rviz::AxesDisplay::getLength (  )  [inline]

Definition at line 63 of file axes_display.h.

float rviz::AxesDisplay::getRadius (  )  [inline]

Definition at line 65 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 55 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 50 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 67 of file axes_display.cpp.

void rviz::AxesDisplay::setFrame ( const std::string &  frame  ) 

Definition at line 78 of file axes_display.cpp.

void rviz::AxesDisplay::setLength ( float  length  ) 

Definition at line 84 of file axes_display.cpp.

void rviz::AxesDisplay::setRadius ( float  radius  ) 

Definition at line 89 of file axes_display.cpp.

virtual void rviz::AxesDisplay::targetFrameChanged (  )  [inline, virtual]

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

Implements rviz::Display.

Definition at line 72 of file axes_display.h.

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 94 of file axes_display.cpp.


Member Data Documentation

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Josh Faust, Dave Hershberger
autogenerated on Sat Mar 2 14:17:34 2013