Public Member Functions | Protected Member Functions | Private Slots | Private Attributes
rviz::AxesDisplay Class Reference

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

#include <axes_display.h>

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

List of all members.

Public Member Functions

 AxesDisplay ()
void onInitialize ()
 Override this function to do subclass-specific initialization.
void set (float length, float radius)
 Set the parameters for the axes.
virtual void update (float dt, float ros_dt)
 Called periodically by the visualization manager.
virtual ~AxesDisplay ()

Protected Member Functions

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.

Private Slots

void updateShape ()
 Update the length and radius of the axes object from property values.

Private Attributes

Axesaxes_
 Handles actually drawing the axes.
TfFramePropertyframe_property_
FloatPropertylength_property_
FloatPropertyradius_property_

Detailed Description

Displays a set of XYZ axes at the origin of a chosen frame.

Definition at line 43 of file axes_display.h.


Constructor & Destructor Documentation

Definition at line 46 of file axes_display.cpp.

Definition at line 65 of file axes_display.cpp.


Member Function Documentation

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

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

Reimplemented from rviz::Display.

Definition at line 83 of file axes_display.cpp.

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

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

Reimplemented from rviz::Display.

Definition at line 78 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, and before load() or setEnabled().

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

Reimplemented from rviz::Display.

Definition at line 70 of file axes_display.cpp.

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

Set the parameters for the axes.

Parameters:
lengthLength of each axis
radiusRadius of each axis
void rviz::AxesDisplay::update ( float  wall_dt,
float  ros_dt 
) [virtual]

Called periodically by the visualization manager.

Parameters:
wall_dtWall-clock time, in seconds, since the last time the update list was run through.
ros_dtROS 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.

void rviz::AxesDisplay::updateShape ( ) [private, slot]

Update the length and radius of the axes object from property values.

Definition at line 88 of file axes_display.cpp.


Member Data Documentation

Handles actually drawing the axes.

Definition at line 72 of file axes_display.h.

Definition at line 76 of file axes_display.h.

Definition at line 74 of file axes_display.h.

Definition at line 75 of file axes_display.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Aug 27 2015 15:02:28