ogre_tools::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 58 of file movable_text.h.

---

Member Enumeration Documentation

enum ogre_tools::MovableText::HorizontalAlignment

Enumerator:

H_LEFT
H_CENTER

Definition at line 62 of file movable_text.h.

enum ogre_tools::MovableText::VerticalAlignment

Enumerator:

V_BELOW
V_ABOVE
V_CENTER

Definition at line 66 of file movable_text.h.

---

Constructor & Destructor Documentation

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

ogre_tools::MovableText::~MovableText

(

)

[virtual]

Definition at line 91 of file movable_text.cpp.

---

Member Function Documentation

void ogre_tools::MovableText::_notifyCurrentCamera

(

Ogre::Camera *

cam

)

[protected]

void ogre_tools::MovableText::_setupGeometry

(

)

[protected]

Definition at line 217 of file movable_text.cpp.

void ogre_tools::MovableText::_updateColors

(

void

)

[protected]

Definition at line 513 of file movable_text.cpp.

void ogre_tools::MovableText::_updateRenderQueue

(

Ogre::RenderQueue *

queue

)

[protected]

Ogre::AxisAlignedBox ogre_tools::MovableText::GetAABB

(

void

)

[inline]

Definition at line 161 of file movable_text.h.

const Ogre::AxisAlignedBox& ogre_tools::MovableText::getBoundingBox

(

void

)

const [inline, protected]

Definition at line 195 of file movable_text.h.

Ogre::Real ogre_tools::MovableText::getBoundingRadius

(

void

)

const [inline, protected]

Definition at line 183 of file movable_text.h.

const Ogre::String& ogre_tools::MovableText::getCaption

(

)

const [inline]

Definition at line 132 of file movable_text.h.

Ogre::Real ogre_tools::MovableText::getCharacterHeight

(

)

const [inline]

Definition at line 141 of file movable_text.h.

const Ogre::ColourValue& ogre_tools::MovableText::getColor

(

)

const [inline]

Definition at line 136 of file movable_text.h.

const Ogre::String& ogre_tools::MovableText::getFontName

(

)

const [inline]

Definition at line 128 of file movable_text.h.

Ogre::Vector3 ogre_tools::MovableText::getGlobalTranslation

(

)

const [inline]

Definition at line 149 of file movable_text.h.

const Ogre::LightList& ogre_tools::MovableText::getLights

(

void

)

const [inline, protected]

Definition at line 217 of file movable_text.h.

Ogre::Vector3 ogre_tools::MovableText::getLocalTranslation

(

)

const [inline]

Definition at line 153 of file movable_text.h.

const Ogre::MaterialPtr& ogre_tools::MovableText::getMaterial

(

void

)

const [inline]

Definition at line 166 of file movable_text.h.

const Ogre::String& ogre_tools::MovableText::getMovableType

(

void

)

const [inline, protected]

Definition at line 205 of file movable_text.h.

const Ogre::String& ogre_tools::MovableText::getName

(

void

)

const [inline, protected]

Definition at line 200 of file movable_text.h.

void ogre_tools::MovableText::getRenderOperation

(

Ogre::RenderOperation &

op

)

[protected]

bool ogre_tools::MovableText::getShowOnTop

(

)

const [inline]

Definition at line 157 of file movable_text.h.

Ogre::Real ogre_tools::MovableText::getSpaceWidth

(

)

const [inline]

Definition at line 145 of file movable_text.h.

Ogre::Real ogre_tools::MovableText::getSquaredViewDepth

(

const Ogre::Camera *

cam

)

const [inline, protected]

Definition at line 188 of file movable_text.h.

const Quaternion & ogre_tools::MovableText::getWorldOrientation

(

void

)

const [protected]

Definition at line 530 of file movable_text.cpp.

const Vector3 & ogre_tools::MovableText::getWorldPosition

(

void

)

const [protected]

Definition at line 542 of file movable_text.cpp.

void ogre_tools::MovableText::getWorldTransforms

(

Ogre::Matrix4 *

xform

)

const [protected]

void ogre_tools::MovableText::setCaption

(

const Ogre::String &

caption

)

void ogre_tools::MovableText::setCharacterHeight

(

Ogre::Real

height

)

void ogre_tools::MovableText::setColor

(

const Ogre::ColourValue &

color

)

void ogre_tools::MovableText::setFontName

(

const Ogre::String &

fontName

)

void ogre_tools::MovableText::setGlobalTranslation

(

Ogre::Vector3

trans

)

void ogre_tools::MovableText::setLineSpacing

(

Ogre::Real

height

)

void ogre_tools::MovableText::setLocalTranslation

(

Ogre::Vector3

trans

)

void ogre_tools::MovableText::setSpaceWidth

(

Ogre::Real

width

)

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

Definition at line 180 of file movable_text.cpp.

void ogre_tools::MovableText::showOnTop

(

bool

show = true

)

Definition at line 206 of file movable_text.cpp.

---

Member Data Documentation

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

Definition at line 81 of file movable_text.h.

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

Definition at line 75 of file movable_text.h.

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

Definition at line 84 of file movable_text.h.

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

Definition at line 79 of file movable_text.h.

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

Definition at line 72 of file movable_text.h.

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

Definition at line 95 of file movable_text.h.

HorizontalAlignment ogre_tools::MovableText::mHorizontalAlignment [protected]

Definition at line 76 of file movable_text.h.

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

Definition at line 85 of file movable_text.h.

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

Definition at line 82 of file movable_text.h.

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

Definition at line 96 of file movable_text.h.

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

Definition at line 74 of file movable_text.h.

bool ogre_tools::MovableText::mNeedUpdate [protected]

Definition at line 88 of file movable_text.h.

bool ogre_tools::MovableText::mOnTop [protected]

Definition at line 90 of file movable_text.h.

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

Definition at line 102 of file movable_text.h.

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

Definition at line 98 of file movable_text.h.

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

Definition at line 100 of file movable_text.h.

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

Definition at line 101 of file movable_text.h.

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

Definition at line 99 of file movable_text.h.

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

Definition at line 93 of file movable_text.h.

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

Definition at line 80 of file movable_text.h.

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

Definition at line 86 of file movable_text.h.

Ogre::Real ogre_tools::MovableText::mTimeUntilNextToggle [protected]

Definition at line 92 of file movable_text.h.

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

Definition at line 73 of file movable_text.h.

bool ogre_tools::MovableText::mUpdateColors [protected]

Definition at line 89 of file movable_text.h.

VerticalAlignment ogre_tools::MovableText::mVerticalAlignment [protected]

Definition at line 77 of file movable_text.h.

---

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

• movable_text.h
• movable_text.cpp