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

Public Types

enum  Action : uint { Action.TouchDown = 0x00000000, Action.TouchUp = 0x00000001, Action.Move = 0x00000002 }
 
- 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)
 
bool Equals (HPS.TouchEvent in_that)
 
override int GetHashCode ()
 
 TouchEvent ()
 
 TouchEvent (HPS.TouchEvent.Action in_action, HPS.ModifierKeys in_modifier)
 
 TouchEvent (HPS.TouchEvent.Action in_action)
 
 TouchEvent (HPS.TouchEvent.Action in_action, HPS.Touch[] in_touches, HPS.ModifierKeys in_modifier)
 
 TouchEvent (HPS.TouchEvent.Action in_action, HPS.Touch[] in_touches)
 
 TouchEvent (HPS.Event in_event)
 
 TouchEvent (HPS.TouchEvent 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)
 
virtual IntPtr Freshen ()
 
IntPtr GetChannel ()
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 
bool IsConsumable ()
 

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

◆ Action

enum HPS.TouchEvent.Action : uint
strong

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

◆ TouchEvent() [1/6]

HPS.TouchEvent.TouchEvent ( )
inline

The default constructor creates an uninitialized TouchEvent object.

◆ TouchEvent() [2/6]

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.

◆ TouchEvent() [3/6]

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.

◆ TouchEvent() [4/6]

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.

◆ TouchEvent() [5/6]

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.

◆ TouchEvent() [6/6]

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

◆ Clone()

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.

◆ Drop()

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.

◆ Equals() [1/2]

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.

◆ Equals() [2/2]

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