Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rviz::MovableText Class Reference

#include <movable_text.h>

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

Public Types

enum  HorizontalAlignment { H_LEFT, H_CENTER }
 
enum  VerticalAlignment { V_BELOW, V_ABOVE, V_CENTER }
 

Public Member Functions

Ogre::AxisAlignedBox GetAABB ()
 
const Ogre::String & getCaption () const
 
Ogre::Real getCharacterHeight () const
 
const Ogre::ColourValue & getColor () const
 
const Ogre::String & getFontName () const
 
Ogre::Vector3 getGlobalTranslation () const
 
Ogre::Vector3 getLocalTranslation () const
 
const Ogre::MaterialPtr & getMaterial () const override
 
bool getShowOnTop () const
 
Ogre::Real getSpaceWidth () const
 
 MovableText (const Ogre::String &caption, const Ogre::String &fontName="Liberation Sans", Ogre::Real charHeight=1.0, const Ogre::ColourValue &color=Ogre::ColourValue::White)
 
void setCaption (const Ogre::String &caption)
 
void setCharacterHeight (Ogre::Real height)
 
void setColor (const Ogre::ColourValue &color)
 
void setFontName (const Ogre::String &fontName)
 
void setGlobalTranslation (Ogre::Vector3 trans)
 
void setLineSpacing (Ogre::Real height)
 
void setLocalTranslation (Ogre::Vector3 trans)
 
void setSpaceWidth (Ogre::Real width)
 
void setTextAlignment (const HorizontalAlignment &horizontalAlignment, const VerticalAlignment &verticalAlignment)
 
void showOnTop (bool show=true)
 
 ~MovableText () override
 

Protected Member Functions

void _notifyCurrentCamera (Ogre::Camera *cam) override
 
void _setupGeometry ()
 
void _updateColors ()
 
void _updateRenderQueue (Ogre::RenderQueue *queue) override
 
const Ogre::AxisAlignedBox & getBoundingBox () const override
 
Ogre::Real getBoundingRadius () const override
 
const Ogre::LightList & getLights () const override
 
const Ogre::String & getMovableType () const override
 
const Ogre::String & getName () const override
 
void getRenderOperation (Ogre::RenderOperation &op) override
 
Ogre::Real getSquaredViewDepth (const Ogre::Camera *) const override
 
const Ogre::Quaternion & getWorldOrientation () const
 
const Ogre::Vector3 & getWorldPosition () const
 
void getWorldTransforms (Ogre::Matrix4 *xform) const override
 

Protected Attributes

Ogre::AxisAlignedBox mAABB
 
Ogre::String mCaption
 
Ogre::Real mCharHeight
 
Ogre::ColourValue mColor
 
Ogre::String mFontName
 
Ogre::Vector3 mGlobalTranslation
 
HorizontalAlignment mHorizontalAlignment
 
Ogre::Real mLineSpacing
 
Ogre::LightList mLList
 
Ogre::Vector3 mLocalTranslation
 
Ogre::String mName
 
bool mNeedUpdate
 
bool mOnTop
 
Ogre::MaterialPtr mpBackgroundMaterial
 
Ogre::Camera * mpCam
 
Ogre::Font * mpFont
 
Ogre::MaterialPtr mpMaterial
 
Ogre::RenderWindow * mpWin
 
Ogre::Real mRadius
 
Ogre::RenderOperation mRenderOp
 
Ogre::Real mSpaceWidth
 
Ogre::Real mTimeUntilNextToggle
 
Ogre::String mType
 
bool mUpdateColors
 
VerticalAlignment mVerticalAlignment
 

Detailed Description

Definition at line 61 of file movable_text.h.

Member Enumeration Documentation

◆ HorizontalAlignment

enum rviz::MovableText::HorizontalAlignment
Enumerator
H_LEFT 
H_CENTER 

Definition at line 65 of file movable_text.h.

◆ VerticalAlignment

enum rviz::MovableText::VerticalAlignment
Enumerator
V_BELOW 
V_ABOVE 
V_CENTER 

Definition at line 70 of file movable_text.h.

Constructor & Destructor Documentation

◆ MovableText()

rviz::MovableText::MovableText ( const Ogre::String &  caption,
const Ogre::String &  fontName = "Liberation Sans",
Ogre::Real  charHeight = 1.0,
const Ogre::ColourValue &  color = Ogre::ColourValue::White 
)

Definition at line 64 of file movable_text.cpp.

◆ ~MovableText()

rviz::MovableText::~MovableText ( )
override

Definition at line 96 of file movable_text.cpp.

Member Function Documentation

◆ _notifyCurrentCamera()

void rviz::MovableText::_notifyCurrentCamera ( Ogre::Camera *  cam)
overrideprotected

Definition at line 539 of file movable_text.cpp.

◆ _setupGeometry()

void rviz::MovableText::_setupGeometry ( )
protected

Definition at line 222 of file movable_text.cpp.

◆ _updateColors()

void rviz::MovableText::_updateColors ( )
protected

Definition at line 467 of file movable_text.cpp.

◆ _updateRenderQueue()

void rviz::MovableText::_updateRenderQueue ( Ogre::RenderQueue *  queue)
overrideprotected

Definition at line 544 of file movable_text.cpp.

◆ GetAABB()

Ogre::AxisAlignedBox rviz::MovableText::GetAABB ( )
inline

Definition at line 169 of file movable_text.h.

◆ getBoundingBox()

const Ogre::AxisAlignedBox& rviz::MovableText::getBoundingBox ( ) const
inlineoverrideprotected

Definition at line 201 of file movable_text.h.

◆ getBoundingRadius()

Ogre::Real rviz::MovableText::getBoundingRadius ( ) const
inlineoverrideprotected

Definition at line 189 of file movable_text.h.

◆ getCaption()

const Ogre::String& rviz::MovableText::getCaption ( ) const
inline

Definition at line 140 of file movable_text.h.

◆ getCharacterHeight()

Ogre::Real rviz::MovableText::getCharacterHeight ( ) const
inline

Definition at line 149 of file movable_text.h.

◆ getColor()

const Ogre::ColourValue& rviz::MovableText::getColor ( ) const
inline

Definition at line 144 of file movable_text.h.

◆ getFontName()

const Ogre::String& rviz::MovableText::getFontName ( ) const
inline

Definition at line 136 of file movable_text.h.

◆ getGlobalTranslation()

Ogre::Vector3 rviz::MovableText::getGlobalTranslation ( ) const
inline

Definition at line 157 of file movable_text.h.

◆ getLights()

const Ogre::LightList& rviz::MovableText::getLights ( ) const
inlineoverrideprotected

Definition at line 222 of file movable_text.h.

◆ getLocalTranslation()

Ogre::Vector3 rviz::MovableText::getLocalTranslation ( ) const
inline

Definition at line 161 of file movable_text.h.

◆ getMaterial()

const Ogre::MaterialPtr& rviz::MovableText::getMaterial ( ) const
inlineoverride

Definition at line 174 of file movable_text.h.

◆ getMovableType()

const Ogre::String& rviz::MovableText::getMovableType ( ) const
inlineoverrideprotected

Definition at line 211 of file movable_text.h.

◆ getName()

const Ogre::String& rviz::MovableText::getName ( ) const
inlineoverrideprotected

Definition at line 206 of file movable_text.h.

◆ getRenderOperation()

void rviz::MovableText::getRenderOperation ( Ogre::RenderOperation &  op)
overrideprotected

Definition at line 527 of file movable_text.cpp.

◆ getShowOnTop()

bool rviz::MovableText::getShowOnTop ( ) const
inline

Definition at line 165 of file movable_text.h.

◆ getSpaceWidth()

Ogre::Real rviz::MovableText::getSpaceWidth ( ) const
inline

Definition at line 153 of file movable_text.h.

◆ getSquaredViewDepth()

Ogre::Real rviz::MovableText::getSquaredViewDepth ( const Ogre::Camera *  ) const
inlineoverrideprotected

Definition at line 194 of file movable_text.h.

◆ getWorldOrientation()

const Quaternion & rviz::MovableText::getWorldOrientation ( ) const
protected

Definition at line 484 of file movable_text.cpp.

◆ getWorldPosition()

const Vector3 & rviz::MovableText::getWorldPosition ( ) const
protected

Definition at line 497 of file movable_text.cpp.

◆ getWorldTransforms()

void rviz::MovableText::getWorldTransforms ( Ogre::Matrix4 *  xform) const
overrideprotected

Definition at line 503 of file movable_text.cpp.

◆ setCaption()

void rviz::MovableText::setCaption ( const Ogre::String &  caption)

Definition at line 141 of file movable_text.cpp.

◆ setCharacterHeight()

void rviz::MovableText::setCharacterHeight ( Ogre::Real  height)

Definition at line 159 of file movable_text.cpp.

◆ setColor()

void rviz::MovableText::setColor ( const Ogre::ColourValue &  color)

Definition at line 150 of file movable_text.cpp.

◆ setFontName()

void rviz::MovableText::setFontName ( const Ogre::String &  fontName)

Definition at line 105 of file movable_text.cpp.

◆ setGlobalTranslation()

void rviz::MovableText::setGlobalTranslation ( Ogre::Vector3  trans)

Definition at line 201 of file movable_text.cpp.

◆ setLineSpacing()

void rviz::MovableText::setLineSpacing ( Ogre::Real  height)

Definition at line 168 of file movable_text.cpp.

◆ setLocalTranslation()

void rviz::MovableText::setLocalTranslation ( Ogre::Vector3  trans)

Definition at line 206 of file movable_text.cpp.

◆ setSpaceWidth()

void rviz::MovableText::setSpaceWidth ( Ogre::Real  width)

Definition at line 177 of file movable_text.cpp.

◆ setTextAlignment()

void rviz::MovableText::setTextAlignment ( const HorizontalAlignment &  horizontalAlignment,
const VerticalAlignment &  verticalAlignment 
)

Definition at line 186 of file movable_text.cpp.

◆ showOnTop()

void rviz::MovableText::showOnTop ( bool  show = true)

Definition at line 211 of file movable_text.cpp.

Member Data Documentation

◆ mAABB

Ogre::AxisAlignedBox rviz::MovableText::mAABB
protected

Definition at line 87 of file movable_text.h.

◆ mCaption

Ogre::String rviz::MovableText::mCaption
protected

Definition at line 81 of file movable_text.h.

◆ mCharHeight

Ogre::Real rviz::MovableText::mCharHeight
protected

Definition at line 90 of file movable_text.h.

◆ mColor

Ogre::ColourValue rviz::MovableText::mColor
protected

Definition at line 85 of file movable_text.h.

◆ mFontName

Ogre::String rviz::MovableText::mFontName
protected

Definition at line 78 of file movable_text.h.

◆ mGlobalTranslation

Ogre::Vector3 rviz::MovableText::mGlobalTranslation
protected

Definition at line 101 of file movable_text.h.

◆ mHorizontalAlignment

HorizontalAlignment rviz::MovableText::mHorizontalAlignment
protected

Definition at line 82 of file movable_text.h.

◆ mLineSpacing

Ogre::Real rviz::MovableText::mLineSpacing
protected

Definition at line 91 of file movable_text.h.

◆ mLList

Ogre::LightList rviz::MovableText::mLList
protected

Definition at line 88 of file movable_text.h.

◆ mLocalTranslation

Ogre::Vector3 rviz::MovableText::mLocalTranslation
protected

Definition at line 102 of file movable_text.h.

◆ mName

Ogre::String rviz::MovableText::mName
protected

Definition at line 80 of file movable_text.h.

◆ mNeedUpdate

bool rviz::MovableText::mNeedUpdate
protected

Definition at line 94 of file movable_text.h.

◆ mOnTop

bool rviz::MovableText::mOnTop
protected

Definition at line 96 of file movable_text.h.

◆ mpBackgroundMaterial

Ogre::MaterialPtr rviz::MovableText::mpBackgroundMaterial
protected

Definition at line 108 of file movable_text.h.

◆ mpCam

Ogre::Camera* rviz::MovableText::mpCam
protected

Definition at line 104 of file movable_text.h.

◆ mpFont

Ogre::Font* rviz::MovableText::mpFont
protected

Definition at line 106 of file movable_text.h.

◆ mpMaterial

Ogre::MaterialPtr rviz::MovableText::mpMaterial
protected

Definition at line 107 of file movable_text.h.

◆ mpWin

Ogre::RenderWindow* rviz::MovableText::mpWin
protected

Definition at line 105 of file movable_text.h.

◆ mRadius

Ogre::Real rviz::MovableText::mRadius
protected

Definition at line 99 of file movable_text.h.

◆ mRenderOp

Ogre::RenderOperation rviz::MovableText::mRenderOp
protected

Definition at line 86 of file movable_text.h.

◆ mSpaceWidth

Ogre::Real rviz::MovableText::mSpaceWidth
protected

Definition at line 92 of file movable_text.h.

◆ mTimeUntilNextToggle

Ogre::Real rviz::MovableText::mTimeUntilNextToggle
protected

Definition at line 98 of file movable_text.h.

◆ mType

Ogre::String rviz::MovableText::mType
protected

Definition at line 79 of file movable_text.h.

◆ mUpdateColors

bool rviz::MovableText::mUpdateColors
protected

Definition at line 95 of file movable_text.h.

◆ mVerticalAlignment

VerticalAlignment rviz::MovableText::mVerticalAlignment
protected

Definition at line 83 of file movable_text.h.

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

rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat May 27 2023 02:06:26