API Search || Global Search

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. This will throw an exception if there is no active action 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. This will throw an exception if there is no event path for this TouchState. More...
 
HPS.WindowKey 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. 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. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Key[] in_path, HPS.TouchEvent in_event, HPS.Touch[] in_touches, HPS.ModifierKeys in_modifiers)
 Sets the properties of this TouchState. More...
 
void Set (HPS.Key[] in_path, HPS.TouchEvent in_event, HPS.Touch[] in_touches)
 Sets the properties of this TouchState. More...
 
void SetActiveEvent (HPS.TouchEvent in_event)
 Sets the active event for this TouchState. More...
 
void SetEventPath (HPS.Key[] in_path)
 Sets the relevant list of keys up to the window which had focus for this touch event. More...
 
void SetModifierKeys (HPS.ModifierKeys in_modifiers)
 Sets an object representing the state of modifier keys for this TouchState. More...
 
void SetTouches (HPS.Touch[] in_touches)
 Sets the touches currently down in this TouchState. 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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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
 

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

The default constructor creates an empty TouchState object.

HPS.TouchState.TouchState ( HPS.TouchState  in_that)
inline

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

Parameters
in_thatThe source TouchState to copy.

Member Function Documentation

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

Copies the source TouchState into this TouchState.

Parameters
in_thatThe source TouchState to copy.
bool HPS.TouchState.Equals ( HPS.TouchState  in_that)
inline

Check if the source TouchState is equivalent to this TouchState.

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

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

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

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

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

Get the number of touches currently down in this TouchState.

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

Get the touches currently down in this TouchState.

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

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.

void HPS.TouchState.Set ( HPS.Key[]  in_path,
HPS.TouchEvent  in_event,
HPS.Touch[]  in_touches,
HPS.ModifierKeys  in_modifiers 
)
inline

Sets the properties of this TouchState.

Parameters
in_pathThe list of keys up to the window which had focus for this touch event.
in_eventThe touch event.
in_touchesThe touches down during this touch event.
in_modifiersThe state of modifier keys for this touch event.
void HPS.TouchState.Set ( HPS.Key[]  in_path,
HPS.TouchEvent  in_event,
HPS.Touch[]  in_touches 
)
inline

Sets the properties of this TouchState.

Parameters
in_pathThe list of keys up to the window which had focus for this touch event.
in_eventThe touch event.
in_touchesThe touches down during this touch event.
void HPS.TouchState.SetActiveEvent ( HPS.TouchEvent  in_event)
inline

Sets the active event for this TouchState.

Parameters
in_eventThe action for this TouchState.
void HPS.TouchState.SetEventPath ( HPS.Key[]  in_path)
inline

Sets the relevant list of keys up to the window which had focus for this touch event.

Parameters
in_pathThe relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.
void HPS.TouchState.SetModifierKeys ( HPS.ModifierKeys  in_modifiers)
inline

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

Parameters
in_modifiersAn object representing the state of modifier keys.
void HPS.TouchState.SetTouches ( HPS.Touch[]  in_touches)
inline

Sets the touches currently down in this TouchState.

Parameters
in_touchesThe list of touches.

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