Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
rviz::MovableText Class Reference

#include <movable_text.h>

List of all members.

Public Types

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

Public Member Functions

Ogre::AxisAlignedBox GetAABB (void)
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 (void) const
bool getShowOnTop () const
Ogre::Real getSpaceWidth () const
 MovableText (const Ogre::String &caption, const Ogre::String &fontName="Arial", 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)
virtual ~MovableText ()

Protected Member Functions

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

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


Definition at line 65 of file movable_text.h.


Definition at line 69 of file movable_text.h.

Constructor & Destructor Documentation

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

Definition at line 63 of file movable_text.cpp.

Definition at line 92 of file movable_text.cpp.

Member Function Documentation

void rviz::MovableText::_notifyCurrentCamera ( Ogre::Camera *  cam) [protected]

Definition at line 587 of file movable_text.cpp.

void rviz::MovableText::_setupGeometry ( ) [protected]

Definition at line 218 of file movable_text.cpp.

void rviz::MovableText::_updateColors ( void  ) [protected]

Definition at line 514 of file movable_text.cpp.

void rviz::MovableText::_updateRenderQueue ( Ogre::RenderQueue *  queue) [protected]

Definition at line 592 of file movable_text.cpp.

Ogre::AxisAlignedBox rviz::MovableText::GetAABB ( void  ) [inline]

Definition at line 164 of file movable_text.h.

const Ogre::AxisAlignedBox& rviz::MovableText::getBoundingBox ( void  ) const [inline, protected]

Definition at line 198 of file movable_text.h.

Ogre::Real rviz::MovableText::getBoundingRadius ( void  ) const [inline, protected]

Definition at line 186 of file movable_text.h.

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

Definition at line 135 of file movable_text.h.

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

Definition at line 144 of file movable_text.h.

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

Definition at line 139 of file movable_text.h.

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

Definition at line 131 of file movable_text.h.

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

Definition at line 152 of file movable_text.h.

const Ogre::LightList& rviz::MovableText::getLights ( void  ) const [inline, protected]

Definition at line 220 of file movable_text.h.

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

Definition at line 156 of file movable_text.h.

const Ogre::MaterialPtr& rviz::MovableText::getMaterial ( void  ) const [inline]

Definition at line 169 of file movable_text.h.

const Ogre::String& rviz::MovableText::getMovableType ( void  ) const [inline, protected]

Definition at line 208 of file movable_text.h.

const Ogre::String& rviz::MovableText::getName ( void  ) const [inline, protected]

Definition at line 203 of file movable_text.h.

void rviz::MovableText::getRenderOperation ( Ogre::RenderOperation &  op) [protected]

Definition at line 575 of file movable_text.cpp.

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

Definition at line 160 of file movable_text.h.

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

Definition at line 148 of file movable_text.h.

Ogre::Real rviz::MovableText::getSquaredViewDepth ( const Ogre::Camera *  cam) const [inline, protected]

Definition at line 191 of file movable_text.h.

const Quaternion & rviz::MovableText::getWorldOrientation ( void  ) const [protected]

Definition at line 531 of file movable_text.cpp.

const Vector3 & rviz::MovableText::getWorldPosition ( void  ) const [protected]

Definition at line 544 of file movable_text.cpp.

void rviz::MovableText::getWorldTransforms ( Ogre::Matrix4 *  xform) const [protected]

Definition at line 550 of file movable_text.cpp.

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

Definition at line 136 of file movable_text.cpp.

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

Definition at line 154 of file movable_text.cpp.

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

Definition at line 145 of file movable_text.cpp.

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

Definition at line 101 of file movable_text.cpp.

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

Definition at line 197 of file movable_text.cpp.

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

Definition at line 163 of file movable_text.cpp.

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

Definition at line 202 of file movable_text.cpp.

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

Definition at line 172 of file movable_text.cpp.

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

Definition at line 181 of file movable_text.cpp.

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

Definition at line 207 of file movable_text.cpp.

Member Data Documentation

Ogre::AxisAlignedBox rviz::MovableText::mAABB [protected]

Definition at line 84 of file movable_text.h.

Ogre::String rviz::MovableText::mCaption [protected]

Definition at line 78 of file movable_text.h.

Ogre::Real rviz::MovableText::mCharHeight [protected]

Definition at line 87 of file movable_text.h.

Ogre::ColourValue rviz::MovableText::mColor [protected]

Definition at line 82 of file movable_text.h.

Ogre::String rviz::MovableText::mFontName [protected]

Definition at line 75 of file movable_text.h.

Ogre::Vector3 rviz::MovableText::mGlobalTranslation [protected]

Definition at line 98 of file movable_text.h.

Definition at line 79 of file movable_text.h.

Ogre::Real rviz::MovableText::mLineSpacing [protected]

Definition at line 88 of file movable_text.h.

Ogre::LightList rviz::MovableText::mLList [protected]

Definition at line 85 of file movable_text.h.

Ogre::Vector3 rviz::MovableText::mLocalTranslation [protected]

Definition at line 99 of file movable_text.h.

Ogre::String rviz::MovableText::mName [protected]

Definition at line 77 of file movable_text.h.

Definition at line 91 of file movable_text.h.

bool rviz::MovableText::mOnTop [protected]

Definition at line 93 of file movable_text.h.

Ogre::MaterialPtr rviz::MovableText::mpBackgroundMaterial [protected]

Definition at line 105 of file movable_text.h.

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

Definition at line 101 of file movable_text.h.

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

Definition at line 103 of file movable_text.h.

Ogre::MaterialPtr rviz::MovableText::mpMaterial [protected]

Definition at line 104 of file movable_text.h.

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

Definition at line 102 of file movable_text.h.

Ogre::Real rviz::MovableText::mRadius [protected]

Definition at line 96 of file movable_text.h.

Ogre::RenderOperation rviz::MovableText::mRenderOp [protected]

Definition at line 83 of file movable_text.h.

Ogre::Real rviz::MovableText::mSpaceWidth [protected]

Definition at line 89 of file movable_text.h.

Definition at line 95 of file movable_text.h.

Ogre::String rviz::MovableText::mType [protected]

Definition at line 76 of file movable_text.h.

Definition at line 92 of file movable_text.h.

Definition at line 80 of file movable_text.h.

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

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