Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes
rviz::ImageDisplay Class Reference

#include <image_display.h>

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

List of all members.

Public Member Functions

virtual void createProperties ()
 Called from setPropertyManager, gives the display a chance to create some properties immediately.
int getQueueSize ()
const std::string & getTopic ()
const std::string & getTransport ()
 ImageDisplay ()
virtual void onInitialize ()
 Override this function to do subclass-specific initialization.
virtual void reset ()
 Called to tell the display to clear its state.
void setQueueSize (int size)
void setTopic (const std::string &topic)
void setTransport (const std::string &transport)
virtual void update (float wall_dt, float ros_dt)
 Called periodically by the visualization panel.
virtual ~ImageDisplay ()

Protected Slots

void setWrapperEnabled (bool enabled)

Protected Member Functions

void clear ()
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 onTransportEnumOptions (V_string &choices)
void subscribe ()
void unsubscribe ()
void updateStatus ()

Protected Attributes

Ogre::MaterialPtr material_
PanelDockWidgetpanel_container_
IntPropertyWPtr queue_size_property_
RenderPanelrender_panel_
Ogre::SceneManager * scene_manager_
 The scene manager we're associated with.
Ogre::SceneNode * scene_node_
Ogre::Rectangle2D * screen_rect_
ROSImageTexture texture_
std::string topic_
ROSTopicStringPropertyWPtr topic_property_
std::string transport_
EditEnumPropertyWPtr transport_property_

Detailed Description

Definition at line 64 of file image_display.h.


Constructor & Destructor Documentation

Definition at line 59 of file image_display.cpp.

Definition at line 129 of file image_display.cpp.


Member Function Documentation

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

Definition at line 259 of file image_display.cpp.

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 328 of file image_display.cpp.

Definition at line 233 of file image_display.cpp.

const std::string& rviz::ImageDisplay::getTopic ( ) [inline]

Definition at line 73 of file image_display.h.

const std::string& rviz::ImageDisplay::getTransport ( ) [inline]

Definition at line 76 of file image_display.h.

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

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

Implements rviz::Display.

Definition at line 177 of file image_display.cpp.

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

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

Implements rviz::Display.

Definition at line 161 of file image_display.cpp.

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 67 of file image_display.cpp.

void rviz::ImageDisplay::onTransportEnumOptions ( V_string choices) [protected]

Definition at line 323 of file image_display.cpp.

void rviz::ImageDisplay::reset ( ) [virtual]

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 348 of file image_display.cpp.

Set the incoming message queue size.

Definition at line 224 of file image_display.cpp.

void rviz::ImageDisplay::setTopic ( const std::string &  topic)

Definition at line 238 of file image_display.cpp.

void rviz::ImageDisplay::setTransport ( const std::string &  transport)

Definition at line 250 of file image_display.cpp.

void rviz::ImageDisplay::setWrapperEnabled ( bool  enabled) [protected, slot]

Enables or disables this display via its DisplayWrapper.

Definition at line 150 of file image_display.cpp.

void rviz::ImageDisplay::subscribe ( ) [protected]

Definition at line 201 of file image_display.cpp.

void rviz::ImageDisplay::unsubscribe ( ) [protected]

Definition at line 219 of file image_display.cpp.

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

Called periodically by the visualization panel.

Parameters:
dtWall-clock time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 285 of file image_display.cpp.

void rviz::ImageDisplay::updateStatus ( ) [protected]

Definition at line 271 of file image_display.cpp.


Member Data Documentation

Ogre::MaterialPtr rviz::ImageDisplay::material_ [protected]

Definition at line 108 of file image_display.h.

Definition at line 120 of file image_display.h.

IntPropertyWPtr rviz::ImageDisplay::queue_size_property_ [protected]

Definition at line 121 of file image_display.h.

Definition at line 118 of file image_display.h.

Ogre::SceneManager* rviz::ImageDisplay::scene_manager_ [protected]

The scene manager we're associated with.

Reimplemented from rviz::Display.

Definition at line 105 of file image_display.h.

Ogre::SceneNode* rviz::ImageDisplay::scene_node_ [protected]

Definition at line 106 of file image_display.h.

Ogre::Rectangle2D* rviz::ImageDisplay::screen_rect_ [protected]

Definition at line 107 of file image_display.h.

Definition at line 116 of file image_display.h.

std::string rviz::ImageDisplay::topic_ [protected]

Definition at line 110 of file image_display.h.

ROSTopicStringPropertyWPtr rviz::ImageDisplay::topic_property_ [protected]

Definition at line 113 of file image_display.h.

std::string rviz::ImageDisplay::transport_ [protected]

Definition at line 111 of file image_display.h.

EditEnumPropertyWPtr rviz::ImageDisplay::transport_property_ [protected]

Definition at line 114 of file image_display.h.


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


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Mon Jan 6 2014 11:54:33