makVrv::DtWindowText Class Reference

A model-like object that draws a 2D text. More...

Inheritance diagram for makVrv::DtWindowText:

Public Types
enum	TextAlignment { Left = 0, Center = 1, Right = 2, Justify = 3 }

Public Member Functions
	DtWindowText (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWindowText ()
	DTOR.
virtual void	setTopLeftCorner (float x, float y)
	Set the Top left corner of the text in normalized screen coordinates (0..1)
virtual void	setVisible (bool isVisible)
	Set the text visible or invisible.
virtual void	setColor (float r, float g, float b, float a)
	Set the text's color.
virtual void	setText (const std::string &textString)
	Set the text to display.
virtual void	setFont (const std::string &fontFile, float sizeInPoints)
	Set the font file and size in points to display the text in.
virtual void	setTextBoxWidth (unsigned int widthInPixels)
	Set the width of the text box in pixels.
virtual void	setAlignment (unsigned int alignment)
	Set the alignment mode of the text.
virtual void	setInstance (DtWindowTextInstance *instance)
	Set or replace the text instance that implements the text graphically Transfers ownership.
virtual DtWindowTextInstance *	instance ()
	Get the text instance that implements the text graphically.
Public Member Functions inherited from makVrv::DtWindowObject
	DtWindowObject (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWindowObject ()
	DTOR.

Protected Attributes
DtWindowTextInstance *	myInstance
Protected Attributes inherited from makVrv::DtWindowObject
DtDe &	myDe
DtUniqueID	myUniqueId

Detailed Description

A model-like object that draws a 2D text.

Member Enumeration Documentation

enum makVrv::DtWindowText::TextAlignment

Enumerator:

Left
Center
Right
Justify

Constructor & Destructor Documentation

makVrv::DtWindowText::DtWindowText	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWindowText::~DtWindowText ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowText::setTopLeftCorner ( float  x, float  y  )

virtual

Set the Top left corner of the text in normalized screen coordinates (0..1)

virtual void makVrv::DtWindowText::setVisible ( bool  isVisible )

virtual

Set the text visible or invisible.

Implements makVrv::DtWindowObject.

virtual void makVrv::DtWindowText::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set the text's color.

virtual void makVrv::DtWindowText::setText ( const std::string &  textString )

virtual

Set the text to display.

virtual void makVrv::DtWindowText::setFont ( const std::string &  fontFile, float  sizeInPoints  )

virtual

Set the font file and size in points to display the text in.

virtual void makVrv::DtWindowText::setTextBoxWidth ( unsigned int  widthInPixels )

virtual

Set the width of the text box in pixels.

virtual void makVrv::DtWindowText::setAlignment ( unsigned int  alignment )

virtual

Set the alignment mode of the text.

virtual void makVrv::DtWindowText::setInstance ( DtWindowTextInstance *  instance )

virtual

Set or replace the text instance that implements the text graphically Transfers ownership.

virtual DtWindowTextInstance* makVrv::DtWindowText::instance ( )

virtual

Get the text instance that implements the text graphically.

Member Data Documentation

DtWindowTextInstance* makVrv::DtWindowText::myInstance

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtWindowText.h