VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Protected Attributes
makVrv::DtWindowText Class Reference

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

Inheritance diagram for makVrv::DtWindowText:
Inheritance graph
[legend]

List of all members.

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 DtWindowTextInstanceinstance ()
 Get the text instance that implements the text graphically.

Protected Attributes

DtWindowTextInstancemyInstance

Detailed Description

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


Member Enumeration Documentation

Enumerator:
Left 
Center 
Right 
Justify 

Constructor & Destructor Documentation

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.

Get the text instance that implements the text graphically.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)