< Home

< Table of Contents

REFERENCE MANUAL

HPS.TouchEvent Class Reference

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

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

Public Types

enum  Action { Action.TouchDown = 0, Action.TouchUp = 1, Action.Move = 2 }
 Enumeration of various actions touches can undergo for a TouchEvent. More...
 
- Public Types inherited from HPS.Event
enum  Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 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 ()
 
void SetTouches (HPS.Touch[] in_touches)
 Sets the touches for this TouchEvent. More...
 
 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. More...
 
 TouchEvent (HPS.TouchEvent.Action in_action)
 This constructor creates a TouchEvent object for a given action without an array of 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. 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. More...
 
 TouchEvent (HPS.Event in_event)
 This constructor converts an EventObject to a TouchEvent object. More...
 
 TouchEvent (HPS.TouchEvent in_that)
 
- Public Member Functions inherited from HPS.InputEvent
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 ()
 Query whether a particular modifier key is active for this InputEvent. More...
 
- 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 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
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 ()
 
- Protected Member Functions inherited from HPS.Event
void DtorCallback (IntPtr p)
 
virtual IntPtr GetNonDirectorClassID ()
 

Properties

HPS.TouchEvent.Action CurrentAction [get, set]
 
- Properties inherited from HPS.InputEvent
HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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

Member Enumeration Documentation

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 ( )

The default constructor creates an uninitialized TouchEvent object.

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

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
HPS.TouchEvent.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.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
HPS.TouchEvent.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.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
in_touch_countthe number of Touches in the touch array.
in_touchesAn array or touches for this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
HPS.TouchEvent.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.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
in_touch_countthe number of Touches in the touch array.
in_touchesAn array or touches for this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
HPS.TouchEvent.TouchEvent ( HPS.Event  in_event)

This constructor converts an EventObject to a TouchEvent object.

Parameters
in_eventThe <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref><ref refid="class_h_p_s_1_1_object" kindref="compound">Object</ref> to be converted.

Member Function Documentation

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

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)
virtual

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

Parameters
in_that_event<ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref> to compare with this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.
Returns
true if this event can be dropped.

Reimplemented from HPS.Event.

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

Check if the source object is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.
void HPS.TouchEvent.SetTouches ( HPS.Touch[]  in_touches)

Sets the touches for this TouchEvent.

Parameters
in_touch_countSize of the following array.
in_touchesArray of the touches for this <ref refid="class_h_p_s_1_1_touch_event" kindref="compound">TouchEvent</ref>.

The documentation for this class was generated from the following file: