VR-Engage  2.2
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
makVre::HudTextItem Class Reference

Detailed Description

HudTextItem extends HudItem with text-specific properties including the text content, font path, and font size.

#include <hudItem.h>

Inheritance diagram for makVre::HudTextItem:
[legend]

Public Member Functions

 HudTextItem ()
 
virtual ~HudTextItem () override
 
virtual std::string getText () const
 
virtual void setText (const std::string &text)
 
virtual std::string getFontPath () const
 
virtual void setFontPath (const std::string &path)
 
virtual float getFontSize () const
 
virtual void setFontSize (float size)
 
- Public Member Functions inherited from makVre::HudItem
 HudItem ()
 
virtual ~HudItem ()
 
virtual Type type () const
 
virtual int dirtyKey () const
 
virtual void makeDirty ()
 
virtual void getPosition (float *x, float *y) const
 
virtual void setPosition (float x, float y)
 
virtual AlignHorizontal getHorizontalAlignment () const
 
virtual void setHorizontalAlignment (AlignHorizontal align)
 
virtual AlignVertical getVerticalAlignment () const
 
virtual void setVerticalAlignment (AlignVertical align)
 
virtual float getX () const
 
virtual float getY () const
 
virtual bool getVisible () const
 
virtual void setVisible (bool visible)
 
virtual void getColor (float *r, float *g, float *b, float *a) const
 
virtual void setColor (float r, float g, float b, float a)
 
virtual float getRed () const
 
virtual float getGreen () const
 
virtual float getBlue () const
 
virtual float getAlpha () const
 

Protected Attributes

std::string myText
 
std::string myFontPath
 
float myFontSize
 
- Protected Attributes inherited from makVre::HudItem
Type myType
 
int myDirtyKey
 
float myPosition [2]
 
AlignHorizontal myHorizontalAlignment
 
AlignVertical myVerticalAlignment
 
bool myVisible
 
float myColor [4]
 

Additional Inherited Members

- Public Types inherited from makVre::HudItem
enum  Type { ILLEGAL_TYPE_UNDEFINED , TEXT , IMAGE }
 
enum  AlignHorizontal { LEFT , CENTER , RIGHT }
 
enum  AlignVertical { TOP , MIDDLE , BOTTOM }
 

Constructor & Destructor Documentation

◆ HudTextItem()

makVre::HudTextItem::HudTextItem ( )

Constructor for HudTextItem.

Initializes the item as a TEXT type with default font size of 0.0

◆ ~HudTextItem()

virtual makVre::HudTextItem::~HudTextItem ( )
overridevirtual

Virtual destructor for HudTextItem.

Member Function Documentation

◆ getText()

virtual std::string makVre::HudTextItem::getText ( ) const
virtual

Gets the current text content.

Returns
The current text string

◆ setText()

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

Sets the text content.

Parameters
textThe new text string to display

Updates the dirty key if the text changes

◆ getFontPath()

virtual std::string makVre::HudTextItem::getFontPath ( ) const
virtual

Gets the current font path.

Returns
Path to the font file

◆ setFontPath()

virtual void makVre::HudTextItem::setFontPath ( const std::string & path)
virtual

Sets the font path.

Parameters
pathPath to the font file to use

Updates the dirty key if the font path changes

◆ getFontSize()

virtual float makVre::HudTextItem::getFontSize ( ) const
virtual

Gets the current font size.

Returns
The font size

◆ setFontSize()

virtual void makVre::HudTextItem::setFontSize ( float size)
virtual

Sets the font size.

Parameters
sizeThe new font size to use

Updates the dirty key if the font size changes

Member Data Documentation

◆ myText

std::string makVre::HudTextItem::myText
protected

The text content to display.

◆ myFontPath

std::string makVre::HudTextItem::myFontPath
protected

Path to the font file.

◆ myFontSize

float makVre::HudTextItem::myFontSize
protected

Font size for rendering.

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