Inheritance diagram for HPS.MouseEvent:
HPS.InputEvent HPS.Event

Public Types

enum  Action : uint {
  ButtonUp = 0x00000000, Action.ButtonDown = 0x00000001, Action.Move = 0x00000002, Action.Scroll = 0x00000003,
  Action.Enter = 0x00000004, Action.Leave = 0x00000005
}


 
- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 

Public Member Functions

override HPS.Event Clone ()
 
override void Dispose ()
 
override bool Drop (HPS.Event in_that_event)
 
override bool Equals (System.Object obj)
 
override bool Equals (HPS.InputEvent in_that)
 
virtual bool Equals (HPS.MouseEvent in_that)
 
override IntPtr Freshen ()
 
override int GetHashCode ()
 
 MouseEvent ()
 
 MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button, HPS.ModifierKeys in_modifier, ulong in_click_count)
 
 MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button, HPS.ModifierKeys in_modifier)
 
 MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button)
 
 MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location)
 
 MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location, HPS.ModifierKeys in_modifier, ulong in_click_count)
 
 MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location, HPS.ModifierKeys in_modifier)
 
 MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location)
 
 MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta)
 
 MouseEvent (HPS.Event in_event)
 
 MouseEvent (HPS.MouseEvent in_that)
 
- Public Member Functions inherited from HPS.InputEvent
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 
 InputEvent ()
 
 InputEvent (HPS.ModifierKeys in_modifiers)
 
 InputEvent (HPS.InputEvent in_that)
 
- Public Member Functions inherited from HPS.Event
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 
 Event ()
 
 Event (HPS.Event in_that)
 
IntPtr GetChannel ()
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 
bool IsConsumable ()
 

Static Public Member Functions

static bool operator!= (HPS.MouseEvent a, HPS.MouseEvent b)
 
static bool operator== (HPS.MouseEvent a, HPS.MouseEvent b)
 
- Static Public Member Functions inherited from HPS.InputEvent
static bool operator!= (HPS.InputEvent a, HPS.InputEvent b)
 
static bool operator== (HPS.InputEvent a, HPS.InputEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

ulong ClickCount [get, set]
 
HPS.MouseEvent.Action CurrentAction [get, set]
 
HPS.MouseButtons CurrentButton [get, set]
 
HPS.WindowPoint Location [get, set]
 
float WheelDelta [get, set]
 
- Properties inherited from HPS.InputEvent
HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The MouseEvent class is the event generated for each mouse action.

Member Enumeration Documentation

◆ Action

enum HPS.MouseEvent.Action : uint
strong

Enumeration of various actions a mouse can undergo for a MouseEvent.

Enumerator
ButtonDown 

A mouse button has been released.

Move 

A mouse button has been pressed.

Scroll 

The mouse location has changed.

Enter 

The scroll wheel has been moved.

Leave 

The mouse cursor has moved into the active window.

Constructor & Destructor Documentation

◆ MouseEvent() [1/10]

HPS.MouseEvent.MouseEvent ( )
inline

The default constructor creates an uninitialized MouseEvent object.

◆ MouseEvent() [2/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location,
HPS.MouseButtons  in_button,
HPS.ModifierKeys  in_modifier,
ulong  in_click_count 
)
inline

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this MouseEvent.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.
in_modifierThe modifier keys for this MouseEvent.
in_click_countThe number of clicks received.

◆ MouseEvent() [3/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location,
HPS.MouseButtons  in_button,
HPS.ModifierKeys  in_modifier 
)
inline

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this MouseEvent.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.
in_modifierThe modifier keys for this MouseEvent.

◆ MouseEvent() [4/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location,
HPS.MouseButtons  in_button 
)
inline

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this MouseEvent.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.

◆ MouseEvent() [5/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location 
)
inline

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this MouseEvent.
in_locationThe location in window space of the mouse cursor.

◆ MouseEvent() [6/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
float  in_wheel_delta,
HPS.WindowPoint  in_location,
HPS.ModifierKeys  in_modifier,
ulong  in_click_count 
)
inline

This constructor creates a MouseEvent object, most useful for a wheel action.

Parameters
in_actionAction of the mouse for this MouseEvent.
in_wheel_deltaIf the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user).
in_locationThe location in window space of the mouse cursor.
in_modifierThe modifier keys for this MouseEvent.
in_click_countThe number of clicks received.

◆ MouseEvent() [7/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
float  in_wheel_delta,
HPS.WindowPoint  in_location,
HPS.ModifierKeys  in_modifier 
)
inline

This constructor creates a MouseEvent object, most useful for a wheel action.

Parameters
in_actionAction of the mouse for this MouseEvent.
in_wheel_deltaIf the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user).
in_locationThe location in window space of the mouse cursor.
in_modifierThe modifier keys for this MouseEvent.

◆ MouseEvent() [8/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
float  in_wheel_delta,
HPS.WindowPoint  in_location 
)
inline

This constructor creates a MouseEvent object, most useful for a wheel action.

Parameters
in_actionAction of the mouse for this MouseEvent.
in_wheel_deltaIf the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user).
in_locationThe location in window space of the mouse cursor.

◆ MouseEvent() [9/10]

HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
float  in_wheel_delta 
)
inline

This constructor creates a MouseEvent object, most useful for a wheel action.

Parameters
in_actionAction of the mouse for this MouseEvent.
in_wheel_deltaIf the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user).

◆ MouseEvent() [10/10]

HPS.MouseEvent.MouseEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a MouseEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

◆ Clone()

override HPS.Event HPS.MouseEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this MouseEvent.

Returns
A copy of this MouseEvent.

Reimplemented from HPS.InputEvent.

◆ Drop()

override bool HPS.MouseEvent.Drop ( HPS.Event  in_that_event)
inlinevirtual

Determines if this MouseEvent can be dropped in favor of the following mouse event.

Parameters
in_that_eventEvent to compare with this MouseEvent.
Returns
true if this event can be dropped, false otherwise.

Reimplemented from HPS.Event.

◆ Equals() [1/2]

override bool HPS.MouseEvent.Equals ( HPS.InputEvent  in_that)
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

Reimplemented from HPS.InputEvent.

◆ Equals() [2/2]

virtual bool HPS.MouseEvent.Equals ( HPS.MouseEvent  in_that)
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Freshen()

override IntPtr HPS.MouseEvent.Freshen ( )
inlinevirtual

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns
A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented from HPS.Event.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MouseEvent.cs