The HEventInfo class stores and manages event information. More...
#include <HEventInfo.h>
Public Member Functions | |
bool | Alt () const |
bool | Control () const |
bool | DownArrow () const |
unsigned int | GetChar () const |
unsigned int | GetCharRepCount () const |
unsigned int | GetFlags () const |
const HPoint & | GetJoystickRotation () const |
const HPoint & | GetJoystickTranslation () const |
const HPoint & | GetMousePixelPos () const |
const HPoint & | GetMouseViewpointPos () const |
int | GetMouseWheelDelta () const |
const HPoint & | GetMouseWindowPos () const |
const HPoint & | GetMouseWorldPos () const |
unsigned int | GetTimerId () const |
HEventType | GetType () const |
HBaseView * | GetView () const |
HEventInfo (HBaseView *view) | |
bool | LButton () const |
bool | LeftAlt () const |
bool | LeftArrow () const |
bool | LeftControl () const |
bool | LeftShift () const |
bool | MButton () const |
bool | RButton () const |
bool | RightAlt () const |
bool | RightArrow () const |
bool | RightControl () const |
bool | RightShift () const |
void | SetFlags (int flags) |
void | SetKey (HEventType NewType, unsigned int nChar, unsigned int nRepCnt, unsigned int NewFlags) |
void | SetMouseWheelDelta (int NewWheelDelta) |
void | SetPixelPos (HEventType NewType, const HPoint &NewPoint, unsigned int NewFlags) |
void | SetPoint (HEventType NewType, int x, int y, unsigned int NewFlags) |
void | SetTimer (HEventType NewType, unsigned int nIDEvent) |
void | SetType (HEventType NewType) |
void | SetViewpointPos (HEventType NewType, const HPoint &NewPoint, unsigned int NewFlags) |
void | SetWindowPos (HEventType NewType, const HPoint &NewPoint, unsigned int NewFlags) |
void | SetWorldPos (HEventType NewType, const HPoint &NewPoint, unsigned int NewFlags) |
bool | Shift () const |
bool | UpArrow () const |
Static Public Attributes | |
static const int | MAX_TOUCHES = 10 |
default = 10 | |
The HEventInfo class stores and manages event information.
HEventInfo encapusulates information associated with an event, including the type (timer, key press, or button), location in various coordinates systems, mouse state, and key press state. This is the primary MVO object that receives event information from the user interface.
HEventInfo::HEventInfo | ( | HBaseView * | view | ) |
Constructs an HEventInfo object.
view | A pointer to the HBaseView object. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
This method sets the bitwise flags that indicates the state of the mouse buttons, shift and control keys.
flags | The bitwise flags for mouse and key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetKey | ( | HEventType | NewType, |
unsigned int | nChar, | ||
unsigned int | nRepCnt, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores key event information from the user interface.
NewType | The type of event. |
nChar | The key character that is currently depressed. |
nRepCnt | The number of times the event has been repeated. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetMouseWheelDelta | ( | int | NewWheelDelta | ) |
This method sets the change value in the Mouse Wheel.
NewWheelDelta | The new mouse wheel change value. |
void HEventInfo::SetPixelPos | ( | HEventType | NewType, |
const HPoint & | NewPoint, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores mouse event information in pixel coordinates and translates it for use by HOOPS functions.
NewType | The type of event. |
NewPoint | The point in pixel coordinates. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetPoint | ( | HEventType | NewType, |
int | x, | ||
int | y, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores mouse event information from the user interface and translates it for use by HOOPS functions.
NewType | The type of event. |
x | The X coordinate of the mouse event, in window space. |
y | The Y coordinate of the mouse event, in window space. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetTimer | ( | HEventType | NewType, |
unsigned int | nIDEvent | ||
) |
This method receives and stores timer event information from the user interface.
NewType | The type of event. |
nIDEvent | The timer ID number generated by the UI. |
|
inline |
This method sets the event type on the HEventInfo object.
void HEventInfo::SetViewpointPos | ( | HEventType | NewType, |
const HPoint & | NewPoint, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores mouse event information in viewpoint (camera) coordinates and translates it for use in by HOOPS functions.
NewType | The type of event |
NewPoint | The point in viewpoint coordinates. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetWindowPos | ( | HEventType | NewType, |
const HPoint & | NewPoint, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores mouse event information in window coordinates and translates it for use by HOOPS functions.
NewType | The type of event |
NewPoint | The point in window coordinates. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
void HEventInfo::SetWorldPos | ( | HEventType | NewType, |
const HPoint & | NewPoint, | ||
unsigned int | NewFlags | ||
) |
This method receives and stores mouse event information in world coordinates and translates it for use by HOOPS functions.
NewType | The type of event. |
NewPoint | The point in world coordinates. |
NewFlags | The bitwise MVO flags for mouse buttons, shift and control Key states. For example, if both the shift key and left mouse button are depressed, pass #MVO_SHIFT|#MVO_LBUTTON. |
|
inline |
|
inline |