Project

General

Profile

SO3Engine
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OgreNewt::OgreAddons::MovableText Class Reference

#include <OgreNewt_Tools.h>

Inheritance diagram for OgreNewt::OgreAddons::MovableText:

Public Types

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

Public Member Functions

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

Protected Member Functions

void _setupGeometry ()
 
void _updateColors ()
 
void getWorldTransforms (Ogre::Matrix4 *xform) const
 
Ogre::Real getBoundingRadius (void) const
 
Ogre::Real getSquaredViewDepth (const Ogre::Camera *cam) const
 
void visitRenderables (Ogre::Renderable::Visitor *visitor, bool debugRenderables=false)
 
const Ogre::Quaternion & getWorldOrientation (void) const
 
const Ogre::Vector3 & getWorldPosition (void) const
 
const Ogre::AxisAlignedBox & getBoundingBox (void) const
 
const Ogre::String & getName (void) const
 
const Ogre::String & getMovableType (void) const
 
void _notifyCurrentCamera (Ogre::Camera *cam)
 
void _updateRenderQueue (Ogre::RenderQueue *queue)
 
void getRenderOperation (Ogre::RenderOperation &op)
 
const Ogre::MaterialPtr & getMaterial (void) const
 
const Ogre::LightList & getLights (void) const
 

Protected Attributes

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

Detailed Description

File: MovableText.h

description: This create create a billboarding object that display a text.

Author
2003 by cTh see gavoc.nosp@m.anov.nosp@m.@ramb.nosp@m.ler..nosp@m.ru @update 2006 by barraq see nospa.nosp@m.m@ba.nosp@m.rraqu.nosp@m.and..nosp@m.com

Definition at line 133 of file OgreNewt_Tools.h.

Member Enumeration Documentation

◆ HorizontalAlignment

enum OgreNewt::OgreAddons::MovableText::HorizontalAlignment
Enumerator
H_LEFT 
H_CENTER 

Definition at line 137 of file OgreNewt_Tools.h.

◆ VerticalAlignment

enum OgreNewt::OgreAddons::MovableText::VerticalAlignment
Enumerator
V_BELOW 
V_ABOVE 
V_CENTER 

Definition at line 138 of file OgreNewt_Tools.h.

Constructor & Destructor Documentation

◆ MovableText()

OgreNewt::OgreAddons::MovableText::MovableText ( const Ogre::String &  name,
const Ogre::String &  caption,
const Ogre::String &  fontName,
Ogre::Real  charHeight,
const Ogre::ColourValue &  color = Ogre::ColourValue::White 
)

Definition at line 262 of file OgreNewt_Tools.cpp.

◆ ~MovableText()

OgreNewt::OgreAddons::MovableText::~MovableText ( )
virtual

Definition at line 291 of file OgreNewt_Tools.cpp.

Member Function Documentation

◆ _notifyCurrentCamera()

void OgreNewt::OgreAddons::MovableText::_notifyCurrentCamera ( Ogre::Camera *  cam)
protected

Definition at line 777 of file OgreNewt_Tools.cpp.

◆ _setupGeometry()

void OgreNewt::OgreAddons::MovableText::_setupGeometry ( )
protected

Definition at line 413 of file OgreNewt_Tools.cpp.

◆ _updateColors()

void OgreNewt::OgreAddons::MovableText::_updateColors ( void  )
protected

Definition at line 709 of file OgreNewt_Tools.cpp.

◆ _updateRenderQueue()

void OgreNewt::OgreAddons::MovableText::_updateRenderQueue ( Ogre::RenderQueue *  queue)
protected

Definition at line 782 of file OgreNewt_Tools.cpp.

◆ GetAABB()

Ogre::AxisAlignedBox OgreNewt::OgreAddons::MovableText::GetAABB ( void  )
inline

Definition at line 198 of file OgreNewt_Tools.h.

◆ getBoundingBox()

const Ogre::AxisAlignedBox & OgreNewt::OgreAddons::MovableText::getBoundingBox ( void  ) const
inlineprotected

Definition at line 214 of file OgreNewt_Tools.h.

◆ getBoundingRadius()

Ogre::Real OgreNewt::OgreAddons::MovableText::getBoundingRadius ( void  ) const
inlineprotected

Definition at line 209 of file OgreNewt_Tools.h.

◆ getCaption()

const Ogre::String & OgreNewt::OgreAddons::MovableText::getCaption ( ) const
inline

Definition at line 190 of file OgreNewt_Tools.h.

◆ getCharacterHeight()

Ogre::Real OgreNewt::OgreAddons::MovableText::getCharacterHeight ( ) const
inline

Definition at line 193 of file OgreNewt_Tools.h.

◆ getColor()

const Ogre::ColourValue & OgreNewt::OgreAddons::MovableText::getColor ( ) const
inline

Definition at line 191 of file OgreNewt_Tools.h.

◆ getFontName()

const Ogre::String & OgreNewt::OgreAddons::MovableText::getFontName ( ) const
inline

Definition at line 189 of file OgreNewt_Tools.h.

◆ getGlobalTranslation()

Ogre::Vector3 OgreNewt::OgreAddons::MovableText::getGlobalTranslation ( ) const
inline

Definition at line 195 of file OgreNewt_Tools.h.

◆ getLights()

const Ogre::LightList & OgreNewt::OgreAddons::MovableText::getLights ( void  ) const
inlineprotected

Definition at line 224 of file OgreNewt_Tools.h.

◆ getLocalTranslation()

Ogre::Vector3 OgreNewt::OgreAddons::MovableText::getLocalTranslation ( ) const
inline

Definition at line 196 of file OgreNewt_Tools.h.

◆ getMaterial()

const Ogre::MaterialPtr & OgreNewt::OgreAddons::MovableText::getMaterial ( void  ) const
inlineprotected

Definition at line 223 of file OgreNewt_Tools.h.

◆ getMovableType()

const Ogre::String & OgreNewt::OgreAddons::MovableText::getMovableType ( void  ) const
inlineprotected

Definition at line 216 of file OgreNewt_Tools.h.

◆ getName()

const Ogre::String & OgreNewt::OgreAddons::MovableText::getName ( void  ) const
inlineprotected

Definition at line 215 of file OgreNewt_Tools.h.

◆ getRenderOperation()

void OgreNewt::OgreAddons::MovableText::getRenderOperation ( Ogre::RenderOperation &  op)
protected

Definition at line 765 of file OgreNewt_Tools.cpp.

◆ getShowOnTop()

bool OgreNewt::OgreAddons::MovableText::getShowOnTop ( ) const
inline

Definition at line 197 of file OgreNewt_Tools.h.

◆ getSpaceWidth()

Ogre::Real OgreNewt::OgreAddons::MovableText::getSpaceWidth ( ) const
inline

Definition at line 194 of file OgreNewt_Tools.h.

◆ getSquaredViewDepth()

Ogre::Real OgreNewt::OgreAddons::MovableText::getSquaredViewDepth ( const Ogre::Camera *  cam) const
inlineprotected

Definition at line 210 of file OgreNewt_Tools.h.

◆ getWorldOrientation()

const Quaternion & OgreNewt::OgreAddons::MovableText::getWorldOrientation ( void  ) const
protected

Definition at line 729 of file OgreNewt_Tools.cpp.

◆ getWorldPosition()

const Vector3 & OgreNewt::OgreAddons::MovableText::getWorldPosition ( void  ) const
protected

Definition at line 735 of file OgreNewt_Tools.cpp.

◆ getWorldTransforms()

void OgreNewt::OgreAddons::MovableText::getWorldTransforms ( Ogre::Matrix4 *  xform) const
protected

Definition at line 741 of file OgreNewt_Tools.cpp.

◆ setCaption()

void OgreNewt::OgreAddons::MovableText::setCaption ( const Ogre::String &  caption)

Definition at line 342 of file OgreNewt_Tools.cpp.

◆ setCharacterHeight()

void OgreNewt::OgreAddons::MovableText::setCharacterHeight ( Ogre::Real  height)

Definition at line 360 of file OgreNewt_Tools.cpp.

◆ setColor()

void OgreNewt::OgreAddons::MovableText::setColor ( const Ogre::ColourValue &  color)

Definition at line 351 of file OgreNewt_Tools.cpp.

◆ setFontName()

void OgreNewt::OgreAddons::MovableText::setFontName ( const Ogre::String &  fontName)

Definition at line 300 of file OgreNewt_Tools.cpp.

◆ setGlobalTranslation()

void OgreNewt::OgreAddons::MovableText::setGlobalTranslation ( Ogre::Vector3  trans)

Definition at line 392 of file OgreNewt_Tools.cpp.

◆ setLocalTranslation()

void OgreNewt::OgreAddons::MovableText::setLocalTranslation ( Ogre::Vector3  trans)

Definition at line 397 of file OgreNewt_Tools.cpp.

◆ setSpaceWidth()

void OgreNewt::OgreAddons::MovableText::setSpaceWidth ( Ogre::Real  width)

Definition at line 369 of file OgreNewt_Tools.cpp.

◆ setTextAlignment()

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

Definition at line 378 of file OgreNewt_Tools.cpp.

◆ showOnTop()

void OgreNewt::OgreAddons::MovableText::showOnTop ( bool  show = true)

Definition at line 402 of file OgreNewt_Tools.cpp.

◆ visitRenderables()

void OgreNewt::OgreAddons::MovableText::visitRenderables ( Ogre::Renderable::Visitor *  visitor,
bool  debugRenderables = false 
)
protected

Definition at line 796 of file OgreNewt_Tools.cpp.

Member Data Documentation

◆ mAABB

Ogre::AxisAlignedBox OgreNewt::OgreAddons::MovableText::mAABB
protected

Definition at line 150 of file OgreNewt_Tools.h.

◆ mCaption

Ogre::String OgreNewt::OgreAddons::MovableText::mCaption
protected

Definition at line 144 of file OgreNewt_Tools.h.

◆ mCharHeight

Ogre::Real OgreNewt::OgreAddons::MovableText::mCharHeight
protected

Definition at line 153 of file OgreNewt_Tools.h.

◆ mColor

Ogre::ColourValue OgreNewt::OgreAddons::MovableText::mColor
protected

Definition at line 148 of file OgreNewt_Tools.h.

◆ mFontName

Ogre::String OgreNewt::OgreAddons::MovableText::mFontName
protected

Definition at line 141 of file OgreNewt_Tools.h.

◆ mGlobalTranslation

Ogre::Vector3 OgreNewt::OgreAddons::MovableText::mGlobalTranslation
protected

Definition at line 163 of file OgreNewt_Tools.h.

◆ mHorizontalAlignment

HorizontalAlignment OgreNewt::OgreAddons::MovableText::mHorizontalAlignment
protected

Definition at line 145 of file OgreNewt_Tools.h.

◆ mLList

Ogre::LightList OgreNewt::OgreAddons::MovableText::mLList
protected

Definition at line 151 of file OgreNewt_Tools.h.

◆ mLocalTranslation

Ogre::Vector3 OgreNewt::OgreAddons::MovableText::mLocalTranslation
protected

Definition at line 164 of file OgreNewt_Tools.h.

◆ mName

Ogre::String OgreNewt::OgreAddons::MovableText::mName
protected

Definition at line 143 of file OgreNewt_Tools.h.

◆ mNeedUpdate

bool OgreNewt::OgreAddons::MovableText::mNeedUpdate
protected

Definition at line 156 of file OgreNewt_Tools.h.

◆ mOnTop

bool OgreNewt::OgreAddons::MovableText::mOnTop
protected

Definition at line 158 of file OgreNewt_Tools.h.

◆ mpBackgroundMaterial

Ogre::MaterialPtr OgreNewt::OgreAddons::MovableText::mpBackgroundMaterial
protected

Definition at line 170 of file OgreNewt_Tools.h.

◆ mpCam

Ogre::Camera* OgreNewt::OgreAddons::MovableText::mpCam
protected

Definition at line 166 of file OgreNewt_Tools.h.

◆ mpFont

Ogre::FontPtr OgreNewt::OgreAddons::MovableText::mpFont
protected

Definition at line 168 of file OgreNewt_Tools.h.

◆ mpMaterial

Ogre::MaterialPtr OgreNewt::OgreAddons::MovableText::mpMaterial
protected

Definition at line 169 of file OgreNewt_Tools.h.

◆ mpWin

Ogre::RenderWindow* OgreNewt::OgreAddons::MovableText::mpWin
protected

Definition at line 167 of file OgreNewt_Tools.h.

◆ mRadius

Ogre::Real OgreNewt::OgreAddons::MovableText::mRadius
protected

Definition at line 161 of file OgreNewt_Tools.h.

◆ mRenderOp

Ogre::RenderOperation OgreNewt::OgreAddons::MovableText::mRenderOp
protected

Definition at line 149 of file OgreNewt_Tools.h.

◆ mSpaceWidth

Ogre::Real OgreNewt::OgreAddons::MovableText::mSpaceWidth
protected

Definition at line 154 of file OgreNewt_Tools.h.

◆ mTimeUntilNextToggle

Ogre::Real OgreNewt::OgreAddons::MovableText::mTimeUntilNextToggle
protected

Definition at line 160 of file OgreNewt_Tools.h.

◆ mType

Ogre::String OgreNewt::OgreAddons::MovableText::mType
protected

Definition at line 142 of file OgreNewt_Tools.h.

◆ mUpdateColors

bool OgreNewt::OgreAddons::MovableText::mUpdateColors
protected

Definition at line 157 of file OgreNewt_Tools.h.

◆ mVerticalAlignment

VerticalAlignment OgreNewt::OgreAddons::MovableText::mVerticalAlignment
protected

Definition at line 146 of file OgreNewt_Tools.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8