#include <visualization/3d/TextObject.h>

Inheritance diagram for TextObject:

Public Types
enum	HorizontalAlignment { H_LEFT, H_CENTER, H_RIGHT }

enum	VerticalAlignment { V_BELOW, V_ABOVE, V_CENTER }

Public Member Functions
	TextObject (const Ogre::String &caption, Ogre::SceneManager sceneManager, Ogre::SceneNode parent=NULL)

	TextObject (const Ogre::String &caption, const Ogre::String &fontName, Ogre::SceneManager sceneManager, Ogre::SceneNode parent=NULL)

virtual	~TextObject ()

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

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

virtual void	setVisible (bool visible, bool cascade=true)

void	setFontName (const Ogre::String &fontName)

void	setCaption (const Ogre::String &caption)

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)

virtual void	setScale (const Ogre::Vector3 &scale)

virtual void	setScale (const Eigen::Vector3f &scale)

virtual void	setPosition (const Ogre::Vector3 &position)

virtual void	setPosition (const Eigen::Vector3f &position)

virtual void	setOrientation (const Ogre::Quaternion &orientation)

virtual void	setOrientation (const Eigen::Quaternionf &orientation)

virtual void	setColor (Color::RGBA color)

virtual void	setTransform (const RigidTransform2f &transform)

virtual void	setTransform (const RigidTransform3f &transform)

Ogre::SceneNode *	getNode ()

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::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 *	mCam

Ogre::RenderWindow *	mWin

Ogre::Font *	mFont

Ogre::MaterialPtr	mMaterial

Ogre::MaterialPtr	mBackgroundMaterial

Ogre::SceneManager *	mSceneManager

Ogre::SceneNode *	mNode

Member Enumeration Documentation

◆ HorizontalAlignment

enum HorizontalAlignment

Enumerator
H_LEFT
H_CENTER
H_RIGHT

◆ VerticalAlignment

enum VerticalAlignment

Enumerator
V_BELOW
V_ABOVE
V_CENTER

Constructor & Destructor Documentation

◆ TextObject() [1/2]

TextObject	(	const Ogre::String &	caption,
		Ogre::SceneManager *	sceneManager,
		Ogre::SceneNode *	parent = `NULL`
	)

◆ TextObject() [2/2]

TextObject	(	const Ogre::String &	caption,
		const Ogre::String &	fontName,
		Ogre::SceneManager *	sceneManager,
		Ogre::SceneNode *	parent = `NULL`
	)

◆ ~TextObject()

virtual ~TextObject ( )

virtual

Member Function Documentation

◆ visitRenderables()

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

virtual

◆ setColor() [1/2]

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

virtual

Reimplemented from VisualizationObject.

◆ setVisible()

virtual void setVisible	(	bool	visible,
		bool	cascade = `true`
	)

virtual

Reimplemented from VisualizationObject.

◆ setFontName()

void setFontName ( const Ogre::String & fontName )

◆ setCaption()

void setCaption ( const Ogre::String & caption )

◆ setCharacterHeight()

void setCharacterHeight ( Ogre::Real height )

◆ setSpaceWidth()

void setSpaceWidth ( Ogre::Real width )

◆ setTextAlignment()

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

◆ setGlobalTranslation()

void setGlobalTranslation ( Ogre::Vector3 trans )

◆ setLocalTranslation()

void setLocalTranslation ( Ogre::Vector3 trans )

◆ showOnTop()

void showOnTop ( bool show = true )

◆ getFontName()

const Ogre::String& getFontName ( ) const

inline

◆ getCaption()

const Ogre::String& getCaption ( ) const

inline

◆ getColor()

const Ogre::ColourValue& getColor ( ) const

inline

◆ getCharacterHeight()

Ogre::Real getCharacterHeight ( ) const

inline

◆ getSpaceWidth()

Ogre::Real getSpaceWidth ( ) const

inline

◆ getGlobalTranslation()

Ogre::Vector3 getGlobalTranslation ( ) const

inline

◆ getLocalTranslation()

Ogre::Vector3 getLocalTranslation ( ) const

inline

◆ getShowOnTop()

bool getShowOnTop ( ) const

inline

◆ GetAABB()

Ogre::AxisAlignedBox GetAABB ( void )

inline

◆ _setupGeometry()

void _setupGeometry ( )

protected

◆ _updateColors()

void _updateColors ( )

protected

◆ getWorldTransforms()

void getWorldTransforms ( Ogre::Matrix4 * xform ) const

protected

◆ getBoundingRadius()

Ogre::Real getBoundingRadius ( void ) const

inlineprotected

◆ getSquaredViewDepth()

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

inlineprotected

◆ getWorldOrientation()

const Ogre::Quaternion& getWorldOrientation ( void ) const

protected

◆ getWorldPosition()

const Ogre::Vector3& getWorldPosition ( void ) const

protected

◆ getBoundingBox()

const Ogre::AxisAlignedBox& getBoundingBox ( void ) const

inlineprotected

◆ getName()

const Ogre::String& getName ( void ) const

inlineprotected

◆ getMovableType()

const Ogre::String& getMovableType ( void ) const

inlineprotected

◆ _notifyCurrentCamera()

void _notifyCurrentCamera ( Ogre::Camera * cam )

protected

◆ _updateRenderQueue()

void _updateRenderQueue ( Ogre::RenderQueue * queue )

protected

◆ getRenderOperation()

void getRenderOperation ( Ogre::RenderOperation & op )

protected

◆ getMaterial()

const Ogre::MaterialPtr& getMaterial ( void ) const

inlineprotected

◆ getLights()

const Ogre::LightList& getLights ( void ) const

inlineprotected

◆ setScale() [1/2]

virtual void setScale ( const Ogre::Vector3 & scale )

virtualinherited

◆ setScale() [2/2]

virtual void setScale ( const Eigen::Vector3f & scale )

virtualinherited

◆ setPosition() [1/2]

virtual void setPosition ( const Ogre::Vector3 & position )

virtualinherited

◆ setPosition() [2/2]

virtual void setPosition ( const Eigen::Vector3f & position )

virtualinherited

◆ setOrientation() [1/2]

virtual void setOrientation ( const Ogre::Quaternion & orientation )

virtualinherited

◆ setOrientation() [2/2]

virtual void setOrientation ( const Eigen::Quaternionf & orientation )

virtualinherited

◆ setColor() [2/2]

virtual void setColor ( Color::RGBA color )

inlinevirtualinherited

◆ setTransform() [1/2]

virtual void setTransform ( const RigidTransform2f & transform )

virtualinherited

◆ setTransform() [2/2]

virtual void setTransform ( const RigidTransform3f & transform )

virtualinherited

◆ getNode()

Ogre::SceneNode* getNode ( )

inlineinherited

Member Data Documentation

◆ mFontName

Ogre::String mFontName

protected

◆ mType

Ogre::String mType

protected

◆ mName

Ogre::String mName

protected

◆ mCaption

Ogre::String mCaption

protected

◆ mHorizontalAlignment

HorizontalAlignment mHorizontalAlignment

protected

◆ mVerticalAlignment

VerticalAlignment mVerticalAlignment

protected

◆ mColor

Ogre::ColourValue mColor

protected

◆ mRenderOp

Ogre::RenderOperation mRenderOp

protected

◆ mAABB

Ogre::AxisAlignedBox mAABB

protected

◆ mLList

Ogre::LightList mLList

protected

◆ mCharHeight

Ogre::Real mCharHeight

protected

◆ mSpaceWidth

Ogre::Real mSpaceWidth

protected

◆ mNeedUpdate

bool mNeedUpdate

protected

◆ mUpdateColors

bool mUpdateColors

protected

◆ mOnTop

bool mOnTop

protected

◆ mTimeUntilNextToggle

Ogre::Real mTimeUntilNextToggle

protected

◆ mRadius

Ogre::Real mRadius

protected

◆ mGlobalTranslation

Ogre::Vector3 mGlobalTranslation

protected

◆ mLocalTranslation

Ogre::Vector3 mLocalTranslation

protected

◆ mCam

Ogre::Camera* mCam

protected

◆ mWin

Ogre::RenderWindow* mWin

protected

◆ mFont

Ogre::Font* mFont

protected

◆ mMaterial

Ogre::MaterialPtr mMaterial

protected

◆ mBackgroundMaterial

Ogre::MaterialPtr mBackgroundMaterial

protected

◆ mSceneManager

Ogre::SceneManager* mSceneManager

protectedinherited

◆ mNode

Ogre::SceneNode* mNode

protectedinherited

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

gui/include/visualization/3d/TextObject.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ HorizontalAlignment

◆ VerticalAlignment

Constructor & Destructor Documentation

◆ TextObject() [1/2]

◆ TextObject() [2/2]

◆ ~TextObject()

Member Function Documentation

◆ visitRenderables()

◆ setColor() [1/2]

◆ setVisible()

◆ setFontName()

◆ setCaption()

◆ setCharacterHeight()

◆ setSpaceWidth()

◆ setTextAlignment()

◆ setGlobalTranslation()

◆ setLocalTranslation()

◆ showOnTop()

◆ getFontName()

◆ getCaption()

◆ getColor()

◆ getCharacterHeight()

◆ getSpaceWidth()

◆ getGlobalTranslation()

◆ getLocalTranslation()

◆ getShowOnTop()

◆ GetAABB()

◆ _setupGeometry()

◆ _updateColors()

◆ getWorldTransforms()

◆ getBoundingRadius()

◆ getSquaredViewDepth()

◆ getWorldOrientation()

◆ getWorldPosition()

◆ getBoundingBox()

◆ getName()

◆ getMovableType()

◆ _notifyCurrentCamera()

◆ _updateRenderQueue()

◆ getRenderOperation()

◆ getMaterial()

◆ getLights()

◆ setScale() [1/2]

◆ setScale() [2/2]

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ setOrientation() [1/2]

◆ setOrientation() [2/2]

◆ setColor() [2/2]

◆ setTransform() [1/2]

◆ setTransform() [2/2]

◆ getNode()

Member Data Documentation

◆ mFontName

◆ mType

◆ mName

◆ mCaption

◆ mHorizontalAlignment

◆ mVerticalAlignment

◆ mColor

◆ mRenderOp

◆ mAABB

◆ mLList

◆ mCharHeight

◆ mSpaceWidth

◆ mNeedUpdate

◆ mUpdateColors

◆ mOnTop

◆ mTimeUntilNextToggle

◆ mRadius

◆ mGlobalTranslation

◆ mLocalTranslation

◆ mCam

◆ mWin

◆ mFont