API Search || Global Search

More...

Inheritance diagram for HPS.MouseState:
HPS.Object

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 ()
 
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...
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

HPS.MouseState.MouseState ( )
inline

The default constructor creates an empty MouseState object.

HPS.MouseState.MouseState ( HPS.MouseState  in_that)
inline

The copy constructor creates a new MouseState object that contains the same settings as the source MouseState.

Parameters
in_thatThe source MouseState to copy.

Member Function Documentation

void HPS.MouseState.Assign ( HPS.MouseState  in_that)
inline

Copies the source MouseState into this MouseState.

Parameters
in_thatThe source MouseState to copy.
bool HPS.MouseState.Equals ( HPS.MouseState  in_that)
inline

Check if the source MouseState is equivalent to this MouseState.

Returns
true if the objects are equivalent, false otherwise.
HPS.MouseEvent HPS.MouseState.GetActiveEvent ( )
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.
HPS.MouseButtons HPS.MouseState.GetButtons ( )
inline

Get the current state of the mouse buttons immediately after the active event.

Returns
The state of the mouse buttons.
HPS.Key [] HPS.MouseState.GetEventPath ( )
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.
HPS.WindowKey HPS.MouseState.GetEventSource ( )
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.
HPS.WindowPoint HPS.MouseState.GetLocation ( )
inline

Get the current mouse position.

Returns
The location, in window space of the mouse cursor.
HPS.ModifierKeys HPS.MouseState.GetModifierKeys ( )
inline

Get an object representing the state of modifier keys for this MouseState.

Returns
An object representing the state of modifier keys.
bool HPS.MouseState.HasAll ( HPS.MouseButtons  in_mouse_trigger,
HPS.ModifierKeys  in_modifier_trigger 
)
inline

Checks if this MouseState has all of the specified properties.

Parameters
in_mouse_triggerThe mouse button properties to test for.
in_modifier_triggerThe modifier keys properties to test for.
Returns
true if this MouseState has all of the specified properties, false otherwise.
void HPS.MouseState.Set ( HPS.Key[]  in_path,
HPS.MouseEvent  in_event,
HPS.WindowPoint  in_point,
HPS.MouseButtons  in_buttons,
HPS.ModifierKeys  in_modifiers 
)
inline

Sets the properties of this MouseState.

Parameters
in_pathThe list of keys up to the window which had focus for this mouse event.
in_eventThe mouse event.
in_pointThe location, in window space of the mouse cursor for this mouse event.
in_buttonsThe state of the mouse buttons immediately after this mouse event.
in_modifiersThe state of modifier keys for this mouse event.
void HPS.MouseState.Set ( HPS.Key[]  in_path,
HPS.MouseEvent  in_event,
HPS.WindowPoint  in_point,
HPS.MouseButtons  in_buttons 
)
inline

Sets the properties of this MouseState.

Parameters
in_pathThe list of keys up to the window which had focus for this mouse event.
in_eventThe mouse event.
in_pointThe location, in window space of the mouse cursor for this mouse event.
in_buttonsThe state of the mouse buttons immediately after this mouse event.
void HPS.MouseState.Set ( HPS.Key[]  in_path,
HPS.MouseEvent  in_event,
HPS.WindowPoint  in_point 
)
inline

Sets the properties of this MouseState.

Parameters
in_pathThe list of keys up to the window which had focus for this mouse event.
in_eventThe mouse event.
in_pointThe location, in window space of the mouse cursor for this mouse event.
void HPS.MouseState.SetActiveEvent ( HPS.MouseEvent  in_event)
inline

Sets the active event for this MouseState.

Parameters
in_eventThe action for this MouseState.
void HPS.MouseState.SetButtons ( HPS.MouseButtons  in_buttons)
inline

Sets the current state of the mouse buttons immediately after the active event.

Parameters
in_buttonsThe state of the mouse buttons.
void HPS.MouseState.SetEventPath ( HPS.Key[]  in_path)
inline

Sets the relevant list of keys up to the window which had focus for this mouse event.

Parameters
in_pathThe relevant list of keys up to the window which had focus when the mouse event represented by this MouseState underwent the active action.
void HPS.MouseState.SetLocation ( HPS.WindowPoint  in_point)
inline

Sets the current mouse position.

Parameters
in_pointThe location, in window space of the mouse cursor.
void HPS.MouseState.SetModifierKeys ( HPS.ModifierKeys  in_modifiers)
inline

Sets an object representing the state of modifier keys for this MouseState.

Parameters
in_modifiersAn 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