
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. This will throw an exception if there is no active action 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. This will throw an exception if there is no event path for this MouseState. More... | |
HPS.WindowKey | 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. 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 MouseState. More... | |
bool | HasAll (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) |
Checks if this MouseState has all of the specified properties. 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. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Key[] in_path, HPS.MouseEvent in_event, HPS.WindowPoint in_point, HPS.MouseButtons in_buttons, HPS.ModifierKeys in_modifiers) |
Sets the properties of this MouseState. More... | |
void | Set (HPS.Key[] in_path, HPS.MouseEvent in_event, HPS.WindowPoint in_point, HPS.MouseButtons in_buttons) |
Sets the properties of this MouseState. More... | |
void | Set (HPS.Key[] in_path, HPS.MouseEvent in_event, HPS.WindowPoint in_point) |
Sets the properties of this MouseState. More... | |
void | SetActiveEvent (HPS.MouseEvent in_event) |
Sets the active event for this MouseState. More... | |
void | SetButtons (HPS.MouseButtons in_buttons) |
Sets the current state of the mouse buttons immediately after the active event. More... | |
void | SetEventPath (HPS.Key[] in_path) |
Sets the relevant list of keys up to the window which had focus for this mouse event. More... | |
void | SetLocation (HPS.WindowPoint in_point) |
Sets the current mouse position. More... | |
void | SetModifierKeys (HPS.ModifierKeys in_modifiers) |
Sets an object representing the state of modifier keys for this MouseState. 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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
Detailed Description
The MouseState class represents the state of the mouse or similar pointer device for a particular event.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty MouseState object.
|
inline |
The copy constructor creates a new MouseState object that contains the same settings as the source MouseState.
- Parameters
-
in_that The source MouseState to copy.
Member Function Documentation
|
inline |
Copies the source MouseState into this MouseState.
- Parameters
-
in_that The source MouseState to copy.
|
inline |
Check if the source MouseState is equivalent to this MouseState.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Get the active event for this MouseState. This will throw an exception if there is no active action for this MouseState.
- Returns
- The action for this MouseState.
|
inline |
Get the current state of the mouse buttons immediately after the active event.
- Returns
- The state of the mouse buttons.
|
inline |
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.
- Returns
- The relevant list of keys up to the window which had focus when the mouse event represented by this MouseState underwent the active action.
|
inline |
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.
- Returns
- The window which had focus when the mouse represented by this MouseState underwent the active action.
|
inline |
Get the current mouse position.
- Returns
- The location, in window space of the mouse cursor.
|
inline |
Get an object representing the state of modifier keys for this MouseState.
- Returns
- An object representing the state of modifier keys.
|
inline |
Checks if this MouseState has all of the specified properties.
- Parameters
-
in_mouse_trigger The mouse button properties to test for. in_modifier_trigger The modifier keys properties to test for.
- Returns
- true if this MouseState has all of the specified properties, false otherwise.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Sets the properties of this MouseState.
- Parameters
-
in_path The list of keys up to the window which had focus for this mouse event. in_event The mouse event. in_point The location, in window space of the mouse cursor for this mouse event. in_buttons The state of the mouse buttons immediately after this mouse event. in_modifiers The state of modifier keys for this mouse event.
|
inline |
Sets the properties of this MouseState.
- Parameters
-
in_path The list of keys up to the window which had focus for this mouse event. in_event The mouse event. in_point The location, in window space of the mouse cursor for this mouse event. in_buttons The state of the mouse buttons immediately after this mouse event.
|
inline |
Sets the properties of this MouseState.
- Parameters
-
in_path The list of keys up to the window which had focus for this mouse event. in_event The mouse event. in_point The location, in window space of the mouse cursor for this mouse event.
|
inline |
Sets the active event for this MouseState.
- Parameters
-
in_event The action for this MouseState.
|
inline |
Sets the current state of the mouse buttons immediately after the active event.
- Parameters
-
in_buttons The state of the mouse buttons.
|
inline |
Sets the relevant list of keys up to the window which had focus for this mouse event.
- Parameters
-
in_path The relevant list of keys up to the window which had focus when the mouse event represented by this MouseState underwent the active action.
|
inline |
Sets the current mouse position.
- Parameters
-
in_point The location, in window space of the mouse cursor.
|
inline |
Sets an object representing the state of modifier keys for this MouseState.
- Parameters
-
in_modifiers An object representing the state of modifier keys.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.MouseState.cs