OgreTextFigure Class Reference

#include <OgreRenderTypes.h>

Inheritance diagram for OgreTextFigure:

Collaboration diagram for OgreTextFigure:

Public Member Functions
	OgreTextFigure (const std::string &name, OgreRenderScene *scene) throw (RenderException)
virtual	~OgreTextFigure ()
virtual void	setText (const std::string &text)
virtual void	setFont (const std::string &fontname) throw (RenderException)
virtual void	setColor (const color &col)
virtual void	setVAlign (VAlignType align)
virtual void	setHAlign (HAlignType align)
virtual void	setTextHeight (real height)
virtual void	setSpaceWidth (real width)
virtual void	setCameraAlign (bool align)
virtual std::string	getText () const
virtual std::string	getFont () const
virtual color	getColor () const
virtual VAlignType	getVAlign () const
virtual HAlignType	getHAlign () const
virtual real	getTextHeight () const
virtual real	getSpaceWidth () const
virtual bool	isCameraAligned () const
virtual void	setOverlay (bool isOverlay)
	Set the overlay state of the figure, this doesn't actually change data but affects how the renderer treates the object. More...
Public Member Functions inherited from OgreBaseFigure< TextRenderable, TextFigure >
	OgreBaseFigure (TextRenderable *obj, Ogre::SceneNode *node, OgreRenderScene *scene)
virtual	~OgreBaseFigure ()
TextRenderable *	getRenderable () const
virtual const char *	getName ()
virtual void	setPosition (const vec3 &v)
virtual void	setRotation (const rotator &r)
virtual void	setScale (const vec3 &v)
virtual void	setMaterial (const char *mat) throw (RenderException)
virtual const char *	getMaterial () const
virtual std::pair< vec3, vec3 >	getAABB () const
virtual void	setParent (Figure *fig)
void	setCameraVisibility (const Camera *cam, bool isVisible)
void	setVisible (bool isVisible)
virtual bool	isVisible () const
virtual bool	isTransparent () const
virtual bool	isOverlay () const
virtual void	setTransparent (bool isTrans)
virtual void	setRenderQueue (sval queue)
virtual sval	getRenderQueue () const
virtual vec3	getPosition (bool isDerived=false) const
virtual vec3	getScale (bool isDerived=false) const
virtual rotator	getRotation (bool isDerived=false) const
Public Member Functions inherited from TextFigure
virtual	~TextFigure ()
Public Member Functions inherited from Figure
virtual	~Figure ()
virtual void	setTransform (const transform &t)
	Set position, rotation, and scale for this figure simultaneously. More...
virtual void	setTransform (const vec3 &trans, const vec3 &scale, const rotator &rot)
	Set position, rotation, and scale for this figure simultaneously. More...
virtual transform	getTransform (bool isDerived=false) const
	Get the figure's position, scale, and rotation transform. More...
virtual void	setMaterial (const Material *mat) throw (RenderException)
	Set's the figure's material. More...
virtual void	fillData (const VertexBuffer *vb, const IndexBuffer *ib, bool deferFill=false, bool doubleSided=false) throw (RenderException)

Additional Inherited Members
Protected Attributes inherited from OgreBaseFigure< TextRenderable, TextFigure >
TextRenderable *	obj
Ogre::SceneNode *	node
	The OgreBaseRenderable object which implements the actual rendering operations. More...
OgreRenderScene *	scene

Constructor & Destructor Documentation

OgreTextFigure()

OgreTextFigure	(	const std::string &	name,
		OgreRenderScene *	scene
	)
throw	(	RenderException
	)

Here is the call graph for this function:

~OgreTextFigure()

virtual ~OgreTextFigure ( )

inlinevirtual

Member Function Documentation

getColor()

virtual color getColor ( ) const

inlinevirtual

Reimplemented from TextFigure.

getFont()

virtual std::string getFont ( ) const

inlinevirtual

Reimplemented from TextFigure.

getHAlign()

virtual HAlignType getHAlign ( ) const

inlinevirtual

Reimplemented from TextFigure.

getSpaceWidth()

virtual real getSpaceWidth ( ) const

inlinevirtual

Reimplemented from TextFigure.

getText()

virtual std::string getText ( ) const

inlinevirtual

Reimplemented from TextFigure.

getTextHeight()

virtual real getTextHeight ( ) const

inlinevirtual

Reimplemented from TextFigure.

getVAlign()

virtual VAlignType getVAlign ( ) const

inlinevirtual

Reimplemented from TextFigure.

isCameraAligned()

virtual bool isCameraAligned ( ) const

inlinevirtual

Reimplemented from TextFigure.

setCameraAlign()

virtual void setCameraAlign ( bool  align )

inlinevirtual

Reimplemented from TextFigure.

setColor()

virtual void setColor ( const color &  col )

inlinevirtual

Reimplemented from TextFigure.

setFont()

virtual void setFont ( const std::string &  fontname ) throw ( RenderException )

inlinevirtual

Reimplemented from TextFigure.

Here is the caller graph for this function:

setHAlign()

virtual void setHAlign ( HAlignType  align )

inlinevirtual

Reimplemented from TextFigure.

setOverlay()

virtual void setOverlay ( bool  isOverlay )

inlinevirtual

Set the overlay state of the figure, this doesn't actually change data but affects how the renderer treates the object.

Reimplemented from OgreBaseFigure< TextRenderable, TextFigure >.

Here is the call graph for this function:

setSpaceWidth()

virtual void setSpaceWidth ( real  width )

inlinevirtual

Reimplemented from TextFigure.

setText()

virtual void setText ( const std::string &  text )

inlinevirtual

Reimplemented from TextFigure.

setTextHeight()

virtual void setTextHeight ( real  height )

inlinevirtual

Reimplemented from TextFigure.

setVAlign()

virtual void setVAlign ( VAlignType  align )

inlinevirtual

Reimplemented from TextFigure.

---

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

• eidolon/renderer/OgreRenderTypes.h
• eidolon/renderer/OgreRenderTypes.cpp