#include <MovableText.h>

Inheritance diagram for RoR::MovableText:

Collaboration diagram for RoR::MovableText:

Public Types
enum	HorizontalAlignment { H_LEFT, H_CENTER }

enum	VerticalAlignment { V_BELOW, V_ABOVE }

Public Member Functions
	MovableText (const Ogre::UTFString &name, const Ogre::UTFString &caption, const Ogre::UTFString &fontName="highcontrast_black", Ogre::Real charHeight=1.0, const Ogre::ColourValue &color=Ogre::ColourValue::Black)

virtual	~MovableText ()

virtual void	visitRenderables (Ogre::Renderable::Visitor *visitor, bool debugRenderables=false)

void	setFontName (const Ogre::UTFString &fontName)

void	setCaption (const Ogre::UTFString &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	setAdditionalHeight (Ogre::Real height)

void	showOnTop (bool show=true)

const Ogre::UTFString &	getFontName () const

const Ogre::UTFString &	getCaption () const

const Ogre::ColourValue &	getColor () const

Ogre::uint	getCharacterHeight () const

Ogre::uint	getSpaceWidth () const

Ogre::Real	getAdditionalHeight () 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

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::UTFString	mFontName

Ogre::UTFString	mType

Ogre::String	mName

Ogre::UTFString	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::Real	mAdditionalHeight

Ogre::Camera *	mpCam

Ogre::RenderWindow *	mpWin

Ogre::Font *	mpFont

Ogre::MaterialPtr	mpMaterial

Ogre::MaterialPtr	mpBackgroundMaterial

Detailed Description

Definition at line 39 of file MovableText.h.

Member Enumeration Documentation

◆ HorizontalAlignment

enum RoR::MovableText::HorizontalAlignment

Enumerator
H_LEFT
H_CENTER

Definition at line 43 of file MovableText.h.

◆ VerticalAlignment

enum RoR::MovableText::VerticalAlignment

Enumerator
V_BELOW
V_ABOVE

Definition at line 44 of file MovableText.h.

Constructor & Destructor Documentation

◆ MovableText()

MovableText::MovableText	(	const Ogre::UTFString &	name,
		const Ogre::UTFString &	caption,
		const Ogre::UTFString &	fontName = `"highcontrast_black"`,
		Ogre::Real	charHeight = `1.0`,
		const Ogre::ColourValue &	color = `Ogre::ColourValue::Black`
	)

Definition at line 37 of file MovableText.cpp.

Here is the call graph for this function:

◆ ~MovableText()

MovableText::~MovableText ( )

virtual

Definition at line 67 of file MovableText.cpp.

Member Function Documentation

◆ _notifyCurrentCamera()

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

protected

Definition at line 529 of file MovableText.cpp.

◆ _setupGeometry()

void MovableText::_setupGeometry ( )

protected

Definition at line 178 of file MovableText.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _updateColors()

void MovableText::_updateColors ( )

protected

Definition at line 462 of file MovableText.cpp.

Here is the caller graph for this function:

◆ _updateRenderQueue()

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

protected

Definition at line 534 of file MovableText.cpp.

Here is the call graph for this function:

◆ GetAABB()

Ogre::AxisAlignedBox RoR::MovableText::GetAABB ( void )

inline

Definition at line 105 of file MovableText.h.

◆ getAdditionalHeight()

Ogre::Real RoR::MovableText::getAdditionalHeight ( ) const

inline

Definition at line 103 of file MovableText.h.

◆ getBoundingBox()

const Ogre::AxisAlignedBox& RoR::MovableText::getBoundingBox ( void ) const

inlineprotected

Definition at line 120 of file MovableText.h.

◆ getBoundingRadius()

Ogre::Real RoR::MovableText::getBoundingRadius ( void ) const

inlineprotected

Definition at line 116 of file MovableText.h.

◆ getCaption()

const Ogre::UTFString& RoR::MovableText::getCaption ( ) const

inline

Definition at line 98 of file MovableText.h.

◆ getCharacterHeight()

Ogre::uint RoR::MovableText::getCharacterHeight ( ) const

inline

Definition at line 101 of file MovableText.h.

◆ getColor()

const Ogre::ColourValue& RoR::MovableText::getColor ( ) const

inline

Definition at line 99 of file MovableText.h.

◆ getFontName()

const Ogre::UTFString& RoR::MovableText::getFontName ( ) const

inline

Definition at line 97 of file MovableText.h.

◆ getLights()

const Ogre::LightList& RoR::MovableText::getLights ( void ) const

inlineprotected

Definition at line 130 of file MovableText.h.

◆ getMaterial()

const Ogre::MaterialPtr& RoR::MovableText::getMaterial ( void ) const

inlineprotected

Definition at line 129 of file MovableText.h.

◆ getMovableType()

const Ogre::String& RoR::MovableText::getMovableType ( void ) const

inlineprotected

Definition at line 122 of file MovableText.h.

◆ getName()

const Ogre::String& RoR::MovableText::getName ( void ) const

inlineprotected

Definition at line 121 of file MovableText.h.

◆ getRenderOperation()

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

protected

Definition at line 517 of file MovableText.cpp.

Here is the call graph for this function:

◆ getShowOnTop()

bool RoR::MovableText::getShowOnTop ( ) const

inline

Definition at line 104 of file MovableText.h.

◆ getSpaceWidth()

Ogre::uint RoR::MovableText::getSpaceWidth ( ) const

inline

Definition at line 102 of file MovableText.h.

◆ getSquaredViewDepth()

Ogre::Real RoR::MovableText::getSquaredViewDepth ( const Ogre::Camera * cam ) const

inlineprotected

Definition at line 117 of file MovableText.h.

◆ getWorldOrientation()

const Quaternion & MovableText::getWorldOrientation ( void ) const

protected

Definition at line 482 of file MovableText.cpp.

◆ getWorldPosition()

const Vector3 & MovableText::getWorldPosition ( void ) const

protected

Definition at line 488 of file MovableText.cpp.

◆ getWorldTransforms()

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

protected

Definition at line 494 of file MovableText.cpp.

◆ setAdditionalHeight()

void MovableText::setAdditionalHeight ( Ogre::Real height )

Definition at line 158 of file MovableText.cpp.

Here is the caller graph for this function:

◆ setCaption()

void MovableText::setCaption ( const Ogre::UTFString & caption )

Definition at line 108 of file MovableText.cpp.

◆ setCharacterHeight()

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

Definition at line 126 of file MovableText.cpp.

Here is the caller graph for this function:

◆ setColor()

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

Definition at line 117 of file MovableText.cpp.

Here is the caller graph for this function:

◆ setFontName()

void MovableText::setFontName ( const Ogre::UTFString & fontName )

Definition at line 73 of file MovableText.cpp.

Here is the caller graph for this function:

◆ setSpaceWidth()

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

Definition at line 135 of file MovableText.cpp.

◆ setTextAlignment()

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

Definition at line 144 of file MovableText.cpp.

Here is the caller graph for this function:

◆ showOnTop()

void MovableText::showOnTop ( bool show = true )

Definition at line 167 of file MovableText.cpp.

◆ visitRenderables()

virtual void RoR::MovableText::visitRenderables	(	Ogre::Renderable::Visitor *	visitor,
		bool	debugRenderables = `false`
	)

inlinevirtual

Definition at line 84 of file MovableText.h.

Field Documentation

◆ mAABB

Ogre::AxisAlignedBox RoR::MovableText::mAABB

protected

Definition at line 56 of file MovableText.h.

◆ mAdditionalHeight

Ogre::Real RoR::MovableText::mAdditionalHeight

protected

Definition at line 68 of file MovableText.h.

◆ mCaption

Ogre::UTFString RoR::MovableText::mCaption

protected

Definition at line 50 of file MovableText.h.

◆ mCharHeight

Ogre::Real RoR::MovableText::mCharHeight

protected

Definition at line 59 of file MovableText.h.

◆ mColor

Ogre::ColourValue RoR::MovableText::mColor

protected

Definition at line 54 of file MovableText.h.

◆ mFontName

Ogre::UTFString RoR::MovableText::mFontName

protected

Definition at line 47 of file MovableText.h.

◆ mHorizontalAlignment

HorizontalAlignment RoR::MovableText::mHorizontalAlignment

protected

Definition at line 51 of file MovableText.h.

◆ mLList

Ogre::LightList RoR::MovableText::mLList

protected

Definition at line 57 of file MovableText.h.

◆ mName

Ogre::String RoR::MovableText::mName

protected

Definition at line 49 of file MovableText.h.

◆ mNeedUpdate

bool RoR::MovableText::mNeedUpdate

protected

Definition at line 62 of file MovableText.h.

◆ mOnTop

bool RoR::MovableText::mOnTop

protected

Definition at line 64 of file MovableText.h.

◆ mpBackgroundMaterial

Ogre::MaterialPtr RoR::MovableText::mpBackgroundMaterial

protected

Definition at line 74 of file MovableText.h.

◆ mpCam

Ogre::Camera* RoR::MovableText::mpCam

protected

Definition at line 70 of file MovableText.h.

◆ mpFont

Ogre::Font* RoR::MovableText::mpFont

protected

Definition at line 72 of file MovableText.h.

◆ mpMaterial

Ogre::MaterialPtr RoR::MovableText::mpMaterial

protected

Definition at line 73 of file MovableText.h.

◆ mpWin

Ogre::RenderWindow* RoR::MovableText::mpWin

protected

Definition at line 71 of file MovableText.h.

◆ mRadius

Ogre::Real RoR::MovableText::mRadius

protected

Definition at line 67 of file MovableText.h.

◆ mRenderOp

Ogre::RenderOperation RoR::MovableText::mRenderOp

protected

Definition at line 55 of file MovableText.h.

◆ mSpaceWidth

Ogre::Real RoR::MovableText::mSpaceWidth

protected

Definition at line 60 of file MovableText.h.

◆ mTimeUntilNextToggle

Ogre::Real RoR::MovableText::mTimeUntilNextToggle

protected

Definition at line 66 of file MovableText.h.

◆ mType

Ogre::UTFString RoR::MovableText::mType

protected

Definition at line 48 of file MovableText.h.

◆ mUpdateColors

bool RoR::MovableText::mUpdateColors

protected

Definition at line 63 of file MovableText.h.

◆ mVerticalAlignment

VerticalAlignment RoR::MovableText::mVerticalAlignment

protected

Definition at line 52 of file MovableText.h.

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

source/main/gfx/MovableText.h
source/main/gfx/MovableText.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ HorizontalAlignment

◆ VerticalAlignment

Constructor & Destructor Documentation

◆ MovableText()

◆ ~MovableText()

Member Function Documentation

◆ _notifyCurrentCamera()

◆ _setupGeometry()

◆ _updateColors()

◆ _updateRenderQueue()

◆ GetAABB()

◆ getAdditionalHeight()

◆ getBoundingBox()

◆ getBoundingRadius()

◆ getCaption()

◆ getCharacterHeight()

◆ getColor()

◆ getFontName()

◆ getLights()

◆ getMaterial()

◆ getMovableType()

◆ getName()

◆ getRenderOperation()

◆ getShowOnTop()

◆ getSpaceWidth()

◆ getSquaredViewDepth()

◆ getWorldOrientation()

◆ getWorldPosition()

◆ getWorldTransforms()

◆ setAdditionalHeight()

◆ setCaption()

◆ setCharacterHeight()

◆ setColor()

◆ setFontName()

◆ setSpaceWidth()

◆ setTextAlignment()

◆ showOnTop()

◆ visitRenderables()

Field Documentation

◆ mAABB

◆ mAdditionalHeight

◆ mCaption

◆ mCharHeight

◆ mColor

◆ mFontName

◆ mHorizontalAlignment

◆ mLList

◆ mName

◆ mNeedUpdate

◆ mOnTop

◆ mpBackgroundMaterial

◆ mpCam

◆ mpFont

◆ mpMaterial

◆ mpWin

◆ mRadius

◆ mRenderOp

◆ mSpaceWidth

◆ mTimeUntilNextToggle

◆ mType

◆ mUpdateColors

◆ mVerticalAlignment