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 HPointGetJoystickRotation () const
 
const HPointGetJoystickTranslation () const
 
const HPointGetMousePixelPos () const
 
const HPointGetMouseViewpointPos () const
 
int GetMouseWheelDelta () const
 
const HPointGetMouseWindowPos () const
 
const HPointGetMouseWorldPos () const
 
unsigned int GetTimerId () const
 
HEventType GetType () const
 
HBaseViewGetView () 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
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ HEventInfo()

HEventInfo::HEventInfo ( HBaseView view)

Constructs an HEventInfo object.

Parameters
viewA pointer to the HBaseView object.

Member Function Documentation

◆ Alt()

bool HEventInfo::Alt ( ) const
inline
Returns
True if the alt key is currently depressed.

◆ Control()

bool HEventInfo::Control ( ) const
inline
Returns
True if the control key is currently depressed.

Referenced by HOpSelectAreaOOC< SelectionSet >::OnLButtonDown().

◆ DownArrow()

bool HEventInfo::DownArrow ( ) const
inline
Returns
True if the down arrow key is depressed.

◆ GetChar()

unsigned int HEventInfo::GetChar ( ) const
inline
Returns
The key character associated with a keypress event.

◆ GetCharRepCount()

unsigned int HEventInfo::GetCharRepCount ( ) const
inline
Returns
The number of times the key press event was repeated.

◆ GetFlags()

unsigned int HEventInfo::GetFlags ( ) const
inline
Returns
The MVO-specific bit flags like #MVO_LBUTTON for the special key events shift, control, and Left, Middle, and Right mouse buttons.

◆ GetJoystickRotation()

const HPoint& HEventInfo::GetJoystickRotation ( ) const
inline
Returns
The rotation data from the Joystick or 3D Mouse.

◆ GetJoystickTranslation()

const HPoint& HEventInfo::GetJoystickTranslation ( ) const
inline
Returns
The translation data from the Joystick or 3D Mouse.

◆ GetMousePixelPos()

const HPoint& HEventInfo::GetMousePixelPos ( ) const
inline
Returns
The mouse position in pixel coordinates.

◆ GetMouseViewpointPos()

const HPoint& HEventInfo::GetMouseViewpointPos ( ) const
inline
Returns
The mouse position in viewpoint (camera) coordinates.

◆ GetMouseWheelDelta()

int HEventInfo::GetMouseWheelDelta ( ) const
inline
Returns
The change value of the mouse wheel position.

◆ GetMouseWindowPos()

const HPoint& HEventInfo::GetMouseWindowPos ( ) const
inline
Returns
The mouse position in window coordinates.

◆ GetMouseWorldPos()

const HPoint& HEventInfo::GetMouseWorldPos ( ) const
inline
Returns
The mouse position in world coordinates.

◆ GetTimerId()

unsigned int HEventInfo::GetTimerId ( ) const
inline
Returns
The Id number of the current timer event.

◆ GetType()

HEventType HEventInfo::GetType ( ) const
inline
Returns
The event type associated to this HEventInfo.

◆ GetView()

HBaseView* HEventInfo::GetView ( ) const
inline
Returns
A pointer to the HBaseView object.

◆ LButton()

bool HEventInfo::LButton ( ) const
inline
Returns
True if the left mouse button is depressed.

◆ LeftAlt()

bool HEventInfo::LeftAlt ( ) const
inline
Returns
True if the left alt key is depressed.

◆ LeftArrow()

bool HEventInfo::LeftArrow ( ) const
inline
Returns
True if the left arrow key is depressed.

◆ LeftControl()

bool HEventInfo::LeftControl ( ) const
inline
Returns
True if the left control key is depressed.

◆ LeftShift()

bool HEventInfo::LeftShift ( ) const
inline
Returns
True if the left shift key is depressed.

◆ MButton()

bool HEventInfo::MButton ( ) const
inline
Returns
True if the middle mouse button is depressed.

◆ RButton()

bool HEventInfo::RButton ( ) const
inline
Returns
True if the right mouse button is depressed.

◆ RightAlt()

bool HEventInfo::RightAlt ( ) const
inline
Returns
True if the right alt key is depressed.

◆ RightArrow()

bool HEventInfo::RightArrow ( ) const
inline
Returns
True if the right arrow key is depressed.

◆ RightControl()

bool HEventInfo::RightControl ( ) const
inline
Returns
True if the right control key is depressed.

◆ RightShift()

bool HEventInfo::RightShift ( ) const
inline
Returns
True if the right shift key is depressed.

◆ SetFlags()

void HEventInfo::SetFlags ( int  flags)
inline

This method sets the bitwise flags that indicates the state of the mouse buttons, shift and control keys.

Parameters
flagsThe 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.

◆ SetKey()

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.

Parameters
NewTypeThe type of event.
nCharThe key character that is currently depressed.
nRepCntThe number of times the event has been repeated.
NewFlagsThe 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.

◆ SetMouseWheelDelta()

void HEventInfo::SetMouseWheelDelta ( int  NewWheelDelta)

This method sets the change value in the Mouse Wheel.

Parameters
NewWheelDeltaThe new mouse wheel change value.

◆ SetPixelPos()

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.

Parameters
NewTypeThe type of event.
NewPointThe point in pixel coordinates.
NewFlagsThe 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.

◆ SetPoint()

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.

Parameters
NewTypeThe type of event.
xThe X coordinate of the mouse event, in window space.
yThe Y coordinate of the mouse event, in window space.
NewFlagsThe 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.

◆ SetTimer()

void HEventInfo::SetTimer ( HEventType  NewType,
unsigned int  nIDEvent 
)

This method receives and stores timer event information from the user interface.

Parameters
NewTypeThe type of event.
nIDEventThe timer ID number generated by the UI.

◆ SetType()

void HEventInfo::SetType ( HEventType  NewType)
inline

This method sets the event type on the HEventInfo object.

◆ SetViewpointPos()

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.

Parameters
NewTypeThe type of event
NewPointThe point in viewpoint coordinates.
NewFlagsThe 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.

◆ SetWindowPos()

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.

Parameters
NewTypeThe type of event
NewPointThe point in window coordinates.
NewFlagsThe 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.

◆ SetWorldPos()

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.

Parameters
NewTypeThe type of event.
NewPointThe point in world coordinates.
NewFlagsThe 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.

◆ Shift()

bool HEventInfo::Shift ( ) const
inline
Returns
True if the shift key is currently depressed.

◆ UpArrow()

bool HEventInfo::UpArrow ( ) const
inline
Returns
True if the up arrow key is depressed.

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