< Home

< Table of Contents

REFERENCE MANUAL

HPS.TouchState Class Reference

The TouchState class represents the state of touches on a multi-touch device for a particular event. More...

Inheritance diagram for HPS.TouchState:
HPS.Object

Public Member Functions

void Assign (HPS.TouchState in_that)
 Copies the source TouchState into this TouchState. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TouchState in_that)
 Check if the source TouchState is equivalent to this TouchState. More...
 
HPS.TouchEvent GetActiveEvent ()
 Get the active event for this TouchState. More...
 
HPS.Key[] GetEventPath ()
 Get the relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action. More...
 
HPS.WindowKey GetEventSource ()
 Get the window which had focus when the touches represented by this TouchState underwent the active action. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 Get an object representing the state of modifier keys for this TouchState. More...
 
ulong GetTouchCount ()
 Get the number of touches currently down in this TouchState. More...
 
HPS.Touch[] GetTouches ()
 Get the touches currently down in this TouchState. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 TouchState ()
 The default constructor creates an empty TouchState object. More...
 
 TouchState (HPS.TouchState in_that)
 The copy constructor creates a new TouchState object that contains the same settings as the source TouchState. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.TouchState a, HPS.TouchState b)
 
static bool operator== (HPS.TouchState a, HPS.TouchState b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

The TouchState class represents the state of touches on a multi-touch device for a particular event.

Constructor & Destructor Documentation

HPS.TouchState.TouchState ( )

The default constructor creates an empty TouchState object.

HPS.TouchState.TouchState ( HPS.TouchState  in_that)

The copy constructor creates a new TouchState object that contains the same settings as the source TouchState.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_touch_state" kindref="compound">TouchState</ref> to copy.

Member Function Documentation

void HPS.TouchState.Assign ( HPS.TouchState  in_that)

Copies the source TouchState into this TouchState.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_touch_state" kindref="compound">TouchState</ref> to copy.
bool HPS.TouchState.Equals ( HPS.TouchState  in_that)

Check if the source TouchState is equivalent to this TouchState.

Returns
true if the objects are equivalent, false otherwise.
HPS.TouchEvent HPS.TouchState.GetActiveEvent ( )

Get the active event for this TouchState.

This will throw an exception if there is no active action for this TouchState.

Returns
The action for the active touches for this TouchState.
HPS.Key [] HPS.TouchState.GetEventPath ( )

Get the relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.

This will throw an exception if there is no event path for this TouchState.

Returns
The relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.
HPS.WindowKey HPS.TouchState.GetEventSource ( )

Get the window which had focus when the touches represented by this TouchState underwent the active action.

This will throw an exception if there is no event source for this TouchState.

Returns
The window which had focus when the touches represented by this TouchState underwent the active action.
HPS.ModifierKeys HPS.TouchState.GetModifierKeys ( )

Get an object representing the state of modifier keys for this TouchState.

Returns
An object representing the state of modifier keys.
ulong HPS.TouchState.GetTouchCount ( )

Get the number of touches currently down in this TouchState.

Returns
Number of touches.
HPS.Touch [] HPS.TouchState.GetTouches ( )

Get the touches currently down in this TouchState.

Returns
The list of touches.
override HPS.Type HPS.TouchState.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.


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