HInfoWindowObject
Functions
char const * |
|
void |
|
void |
|
void |
|
char const * |
|
void |
Detailed Description
-
class HInfoWindowObject : public HObject
The HInfoWindowObject class displays is a floating window that can display any text information that you wish to show to the user.
Public Functions
-
HInfoWindowObject(HBaseView *view, float startposx = -0.95f, float startposy = 0.3, int maxlines = 20, int displaylength = 7)
Constructs an HInfoWindowObject object.
- Parameters
view – A pointer to the HBaseView object.
startposx – The initial x cordinate of the text.
startposy – The initial y coordinate of the text.
maxlines – The maximum number of lines that the information window can display.
displaylength – The amount of time in seconds to display the text before it is erased if EraseAfterDisplay is true.
-
~HInfoWindowObject()
-
virtual char const *GetName()
- Returns
The name of the object which is ‘info_window’.
-
void AddLine(char const *text, char const *font = 0, char const *color = 0, bool EraseAfterDisplay = false, int DisplayLength = -1)
This method adds a line of text to the information window.
- Parameters
text – A pointer to the text to be inserted into the information window.
font – A pointer to the font for the text.
color – A pointer to the color of the text.
EraseAfterDisplay – Pass true to erase after a limited amount of time or false to keep the text as it is.
DisplayLength – The amount of time in seconds to display the text before it is erased if EraseAfterDisplay is true.
-
void UpdateInfoBox()
This method flushes the contents of the information window key. Then it inserts the text in the memory into HOOPS and requests an update in the view.
-
void Flush()
This method clears out all the text in the information window.
-
HInfoWindowObject(HBaseView *view, float startposx = -0.95f, float startposy = 0.3, int maxlines = 20, int displaylength = 7)