REFERENCE MANUAL
The MouseState class represents the state of the mouse or similar pointer device for a particular event. More...
Public Member Functions | |
void | Assign (HPS.MouseState in_that) |
Copies the source MouseState into this MouseState. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.MouseState in_that) |
Check if the source MouseState is equivalent to this MouseState. More... | |
HPS.MouseEvent | GetActiveEvent () |
Get the active event for this MouseState. More... | |
HPS.MouseButtons | GetButtons () |
Get the current state of the mouse buttons immediately after the active event. More... | |
HPS.Key[] | GetEventPath () |
Get the relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action. More... | |
HPS.WindowKey | GetEventSource () |
Get the window which had focus when the mouse represented by this MouseState underwent the active action. More... | |
override int | GetHashCode () |
HPS.WindowPoint | GetLocation () |
Get the current mouse position. More... | |
HPS.ModifierKeys | GetModifierKeys () |
Get an object representing the state of modifier keys for this TouchState. More... | |
MouseState () | |
The default constructor creates an empty MouseState object. More... | |
MouseState (HPS.MouseState in_that) | |
The copy constructor creates a new MouseState object that contains the same settings as the source MouseState. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.MouseState a, HPS.MouseState b) |
static bool | operator== (HPS.MouseState a, HPS.MouseState b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The MouseState class represents the state of the mouse or similar pointer device for a particular event.
HPS.MouseState.MouseState | ( | ) |
The default constructor creates an empty MouseState object.
HPS.MouseState.MouseState | ( | HPS.MouseState | in_that | ) |
The copy constructor creates a new MouseState object that contains the same settings as the source MouseState.
in_that | The source <ref refid="class_h_p_s_1_1_mouse_state" kindref="compound">MouseState</ref> to copy. |
void HPS.MouseState.Assign | ( | HPS.MouseState | in_that | ) |
Copies the source MouseState into this MouseState.
in_that | The source <ref refid="class_h_p_s_1_1_mouse_state" kindref="compound">MouseState</ref> to copy. |
bool HPS.MouseState.Equals | ( | HPS.MouseState | in_that | ) |
Check if the source MouseState is equivalent to this MouseState.
HPS.MouseEvent HPS.MouseState.GetActiveEvent | ( | ) |
Get the active event for this MouseState.
This will throw an exception if there is no active action for this MouseState.
HPS.MouseButtons HPS.MouseState.GetButtons | ( | ) |
Get the current state of the mouse buttons immediately after the active event.
HPS.Key [] HPS.MouseState.GetEventPath | ( | ) |
Get the relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action.
This will throw an exception if there is no event path for this MouseState.
HPS.WindowKey HPS.MouseState.GetEventSource | ( | ) |
Get the window which had focus when the mouse represented by this MouseState underwent the active action.
This will throw an exception if there is no event source for this MouseState.
HPS.WindowPoint HPS.MouseState.GetLocation | ( | ) |
Get the current mouse position.
HPS.ModifierKeys HPS.MouseState.GetModifierKeys | ( | ) |
Get an object representing the state of modifier keys for this TouchState.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.