The HInfoWindowObject class displays is a floating window that can display any text information that you wish to show to the user.
More...
#include <HObjects.h>
The HInfoWindowObject class displays is a floating window that can display any text information that you wish to show to the user.
HInfoWindowObject::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. |
void HInfoWindowObject::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 HInfoWindowObject::DoTimer |
( |
| ) |
|
|
protected |
This method is a helper function for InfowWindowTimerClbk. It updates the text and captures the time stamp to compare elapsed time.
void HInfoWindowObject::Flush |
( |
| ) |
|
This method clears out all the text in the information window.
void HInfoWindowObject::FlushInternal |
( |
| ) |
|
|
protected |
This is for internal use only.
const char* HInfoWindowObject::GetName |
( |
| ) |
|
|
virtual |
- Returns
- The name of the object which is 'info_window'.
Implements HObject.
static const char* HInfoWindowObject::GetStaticName |
( |
| ) |
|
|
static |
- Returns
- The name of the object which is 'info_window'.
static bool HInfoWindowObject::InfowWindowTimerClbk |
( |
float |
request_time, |
|
|
float |
actual_time, |
|
|
void * |
user_data |
|
) |
| |
|
staticprotected |
The callback for the timer client.
- Parameters
-
request_time | The time the callback requested to be called. |
actual_time | The actual time the callback was called. |
user_data | Additional information for time events. |
void HInfoWindowObject::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.
static void HInfoWindowObject::WindowResizeCallback |
( |
int |
signal, |
|
|
void * |
signal_data, |
|
|
void * |
user_data |
|
) |
| |
|
static |
This method handles the window resize event.
bool HInfoWindowObject::m_bEraseAfterDisplay |
|
protected |
The value is true if the window will erase the text after an elapsed display time.
int HInfoWindowObject::m_DefaultDisplayLength |
|
protected |
The default display time in seconds for the text.
char* HInfoWindowObject::m_InfoText[25] |
|
protected |
The text that will be displayed in the information window.
char* HInfoWindowObject::m_InfoTextColor[25] |
|
protected |
The color of the text in the information window.
char* HInfoWindowObject::m_InfoTextFont[25] |
|
protected |
The font of the text in the information window.
HC_KEY HInfoWindowObject::m_InfoWindowKey |
|
protected |
The key to the information window.
HTClient* HInfoWindowObject::m_InfoWindowTimer |
|
protected |
int HInfoWindowObject::m_LineMax |
|
protected |
The maximum number of lines of text.
int HInfoWindowObject::m_LineNum |
|
protected |
The number of lines of text.
float HInfoWindowObject::m_StartPosX |
|
protected |
The initial x position for the text.
float HInfoWindowObject::m_StartPosY |
|
protected |
The initial y position for the text.
int HInfoWindowObject::m_TempDisplayLength |
|
protected |
The temporary display time in seconds for the text.
float HInfoWindowObject::m_TimeStamp |
|
protected |
The time in which the last timer callback was called.
The documentation for this class was generated from the following file: