API Search || Global Search

More...

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

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...
 
- Public Types inherited from HPS.Event
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)
 
override bool Equals (HPS.InputEvent in_that)
 Check if the source object is equivalent to this object. More...
 
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)
 
delegate IntPtr TouchEventDelegate_0 (IntPtr cPtr)
 
delegate bool TouchEventDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool TouchEventDelegate_2 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr TouchEventDelegate_3 (IntPtr cPtr)
 
- Public Member Functions inherited from HPS.InputEvent
override bool Equals (System.Object obj)
 
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 IntPtr InputEventDelegate_0 (IntPtr cPtr)
 
delegate bool InputEventDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool InputEventDelegate_2 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr InputEventDelegate_3 (IntPtr cPtr)
 
- Public Member Functions inherited from HPS.Event
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 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

HPS.TouchEvent.Action CurrentAction [get, set]
 
HPS.Touch[] Touches [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 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

HPS.TouchEvent.TouchEvent ( )
inline

The default constructor creates an uninitialized TouchEvent object.

HPS.TouchEvent.TouchEvent ( HPS.TouchEvent.Action  in_action,
HPS.ModifierKeys  in_modifier 
)
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_actionAction of this TouchEvent.
in_modifierThe modifier keys for this TouchEvent.
HPS.TouchEvent.TouchEvent ( HPS.TouchEvent.Action  in_action)
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_actionAction of this TouchEvent.
HPS.TouchEvent.TouchEvent ( HPS.TouchEvent.Action  in_action,
HPS.Touch[]  in_touches,
HPS.ModifierKeys  in_modifier 
)
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_actionAction of this TouchEvent.
in_touchesAn array or touches for this TouchEvent.
in_modifierThe modifier keys for this TouchEvent.
HPS.TouchEvent.TouchEvent ( HPS.TouchEvent.Action  in_action,
HPS.Touch[]  in_touches 
)
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_actionAction of this TouchEvent.
in_touchesAn array or touches for this TouchEvent.
HPS.TouchEvent.TouchEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a TouchEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

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

Allocates and returns a copy of this TouchEvent.

Returns
A copy of this TouchEvent.

Reimplemented from HPS.InputEvent.

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

Determines if this TouchEvent can be dropped in favor of the following touch event.

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

Reimplemented from HPS.Event.

override bool HPS.TouchEvent.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.

bool HPS.TouchEvent.Equals ( HPS.TouchEvent  in_that)
inline

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.

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