Class OverlayObject

Defined in File overlay_utils.hpp

Class Documentation

class OverlayObject

Helper class for realizing an overlay object on top of the rviz 3D panel.

This class is supposed to be instantiated in the onInitalize method of the rviz_common::Display class.

Public Types

using SharedPtr = std::shared_ptr<OverlayObject>

Public Functions

OverlayObject(const std::string &name)

virtual ~OverlayObject()

virtual std::string getName() const

virtual void hide()

virtual void show()

virtual bool isTextureReady() const

virtual void updateTextureSize(unsigned int width, unsigned int height)

virtual ScopedPixelBuffer getBuffer()

virtual void setPosition(double hor_dist, double ver_dist, HorizontalAlignment hor_alignment = HorizontalAlignment::LEFT, VerticalAlignment ver_alignment = VerticalAlignment::TOP)

virtual void setDimensions(double width, double height)

virtual bool isVisible() const

virtual unsigned int getTextureWidth() const

virtual unsigned int getTextureHeight() const

Protected Attributes

const std::string name_

Ogre::Overlay *overlay_

Ogre::PanelOverlayElement *panel_

Ogre::MaterialPtr panel_material_

Ogre::TexturePtr texture_