Inheritance diagram for HPS.MouseState:
HPS.Object

Public Member Functions

void Assign (HPS.MouseState in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MouseState in_that)
 
HPS.MouseEvent GetActiveEvent ()
 
HPS.MouseButtons GetButtons ()
 
HPS.Key [] GetEventPath ()
 
HPS.WindowKey GetEventSource ()
 
override int GetHashCode ()
 
HPS.WindowPoint GetLocation ()
 
HPS.ModifierKeys GetModifierKeys ()
 
bool HasAll (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 MouseState ()
 
 MouseState (HPS.MouseState in_that)
 
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)
 
void Set (HPS.Key[] in_path, HPS.MouseEvent in_event, HPS.WindowPoint in_point, HPS.MouseButtons in_buttons)
 
void Set (HPS.Key[] in_path, HPS.MouseEvent in_event, HPS.WindowPoint in_point)
 
void SetActiveEvent (HPS.MouseEvent in_event)
 
void SetButtons (HPS.MouseButtons in_buttons)
 
void SetEventPath (HPS.Key[] in_path)
 
void SetLocation (HPS.WindowPoint in_point)
 
void SetModifierKeys (HPS.ModifierKeys in_modifiers)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

◆ MouseState() [1/2]

HPS.MouseState.MouseState ( )
inline

The default constructor creates an empty MouseState object.

◆ MouseState() [2/2]

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

◆ Assign()

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

Copies the source MouseState into this MouseState.

Parameters
in_thatThe source MouseState to copy.

◆ Equals()

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.

◆ GetActiveEvent()

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.

◆ GetButtons()

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.

◆ GetEventPath()

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.

◆ GetEventSource()

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.

◆ GetLocation()

HPS.WindowPoint HPS.MouseState.GetLocation ( )
inline

Get the current mouse position.

Returns
The location, in window space of the mouse cursor.

◆ GetModifierKeys()

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.

◆ HasAll()

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.

◆ ObjectType()

override HPS.Type HPS.MouseState.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ Set() [1/3]

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.

◆ Set() [2/3]

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.

◆ Set() [3/3]

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.

◆ SetActiveEvent()

void HPS.MouseState.SetActiveEvent ( HPS.MouseEvent  in_event)
inline

Sets the active event for this MouseState.

Parameters
in_eventThe action for this MouseState.

◆ SetButtons()

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.

◆ SetEventPath()

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.

◆ SetLocation()

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.

◆ SetModifierKeys()

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