The TouchEvent class is the event generated for each touch action on a multi-touch device. More...

Public Types | |
enum | Action : uint { Action.TouchDown = 0x00000000, Action.TouchUp = 0x00000001, Action.Move = 0x00000002 } |
Enumeration of various actions touches can undergo for a TouchEvent. More... | |
![]() | |
enum | Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 } |
Event Status - returned from a notifier to give the status of the event. More... | |
Public Member Functions | |
override HPS.Event | Clone () |
Allocates and returns a copy of this TouchEvent. More... | |
override void | Dispose () |
override bool | Drop (HPS.Event in_that_event) |
Determines if this TouchEvent can be dropped in favor of the following touch event. More... | |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.TouchEvent in_that) |
Check if the source object is equivalent to this object. More... | |
override int | GetHashCode () |
TouchEvent () | |
The default constructor creates an uninitialized TouchEvent object. More... | |
TouchEvent (HPS.TouchEvent.Action in_action, HPS.ModifierKeys in_modifier) | |
This constructor creates a TouchEvent object for a given action without an array of Touches. Specifying TouchUp without an array of Touches clears tracked touches. More... | |
TouchEvent (HPS.TouchEvent.Action in_action) | |
This constructor creates a TouchEvent object for a given action without an array of Touches. Specifying TouchUp without an array of Touches clears tracked touches. More... | |
TouchEvent (HPS.TouchEvent.Action in_action, HPS.Touch[] in_touches, HPS.ModifierKeys in_modifier) | |
This constructor creates a TouchEvent object for a given action with an array of Touches. Specifying TouchUp with an empty an array of Touches clears tracked touches. More... | |
TouchEvent (HPS.TouchEvent.Action in_action, HPS.Touch[] in_touches) | |
This constructor creates a TouchEvent object for a given action with an array of Touches. Specifying TouchUp with an empty an array of Touches clears tracked touches. More... | |
TouchEvent (HPS.Event in_event) | |
This constructor converts an EventObject to a TouchEvent object. More... | |
TouchEvent (HPS.TouchEvent in_that) | |
![]() | |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.InputEvent in_that) |
Check if the source object is equivalent to this object. More... | |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierKeys () |
Queries which modifier keys are active More... | |
InputEvent () | |
This constructor creates a default InputEvent object. More... | |
InputEvent (HPS.ModifierKeys in_modifiers) | |
This constructor creates a new InputEvent with the specified modifier keys initialized. More... | |
InputEvent (HPS.InputEvent in_that) | |
![]() | |
delegate void | DtorDelegate (IntPtr cPtr) |
Event (IntPtr in_channel) | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event () | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event (HPS.Event in_that) | |
delegate IntPtr | EventDelegate_0 (IntPtr cPtr) |
delegate bool | EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 (IntPtr cPtr) |
virtual IntPtr | Freshen () |
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. More... | |
IntPtr | GetChannel () |
Returns the channel ID assigned to an event. More... | |
IntPtr | GetClassID () |
double | GetTimeStamp () |
Returns the time an event was injected into the event queue. More... | |
bool | IsConsumable () |
Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.TouchEvent a, HPS.TouchEvent b) |
static bool | operator== (HPS.TouchEvent a, HPS.TouchEvent b) |
![]() | |
static bool | operator!= (HPS.InputEvent a, HPS.InputEvent b) |
static bool | operator== (HPS.InputEvent a, HPS.InputEvent b) |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
void | DtorCallback (IntPtr p) |
virtual IntPtr | GetNonDirectorClassID () |
Properties | |
HPS.TouchEvent.Action | CurrentAction [get, set] |
HPS.Touch[] | Touches [get, set] |
![]() | |
HPS.ModifierKeys | ModifierKeyState [get, set] |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The TouchEvent class is the event generated for each touch action on a multi-touch device.
Member Enumeration Documentation
enum HPS.TouchEvent.Action : uint |
Enumeration of various actions touches can undergo for a TouchEvent.
Enumerator | |
---|---|
TouchDown |
A touch, or touches, has just gone down. |
TouchUp |
A touch, or touches, has just gone up. |
Move |
A touch, or touches, has just moved. |
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized TouchEvent object.
|
inline |
This constructor creates a TouchEvent object for a given action without an array of Touches. Specifying TouchUp without an array of Touches clears tracked touches.
- Parameters
-
in_action Action of this TouchEvent. in_modifier The modifier keys for this TouchEvent.
|
inline |
This constructor creates a TouchEvent object for a given action without an array of Touches. Specifying TouchUp without an array of Touches clears tracked touches.
- Parameters
-
in_action Action of this TouchEvent.
|
inline |
This constructor creates a TouchEvent object for a given action with an array of Touches. Specifying TouchUp with an empty an array of Touches clears tracked touches.
- Parameters
-
in_action Action of this TouchEvent. in_touches An array or touches for this TouchEvent. in_modifier The modifier keys for this TouchEvent.
|
inline |
This constructor creates a TouchEvent object for a given action with an array of Touches. Specifying TouchUp with an empty an array of Touches clears tracked touches.
- Parameters
-
in_action Action of this TouchEvent. in_touches An array or touches for this TouchEvent.
|
inline |
This constructor converts an EventObject to a TouchEvent object.
- Parameters
-
in_event The EventObject to be converted.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this TouchEvent.
- Returns
- A copy of this TouchEvent.
Reimplemented from HPS.InputEvent.
|
inlinevirtual |
Determines if this TouchEvent can be dropped in favor of the following touch event.
- Parameters
-
in_that_event Event to compare with this TouchEvent.
- Returns
- true if this event can be dropped, false otherwise.
Reimplemented from HPS.Event.
|
inlinevirtual |
Check if the source object is equivalent to this object.
- Returns
- true if the objects are equivalent, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TouchEvent.cs