Inheritance diagram for HPS.TouchState:
HPS.Object

Public Member Functions

void Assign (HPS.TouchState in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TouchState in_that)
 
HPS.TouchEvent GetActiveEvent ()
 
HPS.Key [] GetEventPath ()
 
HPS.WindowKey GetEventSource ()
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 
ulong GetTouchCount ()
 
HPS.Touch [] GetTouches ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Key[] in_path, HPS.TouchEvent in_event, HPS.Touch[] in_touches, HPS.ModifierKeys in_modifiers)
 
void Set (HPS.Key[] in_path, HPS.TouchEvent in_event, HPS.Touch[] in_touches)
 
void SetActiveEvent (HPS.TouchEvent in_event)
 
void SetEventPath (HPS.Key[] in_path)
 
void SetModifierKeys (HPS.ModifierKeys in_modifiers)
 
void SetTouches (HPS.Touch[] in_touches)
 
 TouchState ()
 
 TouchState (HPS.TouchState in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

◆ TouchState() [1/2]

HPS.TouchState.TouchState ( )
inline

The default constructor creates an empty TouchState object.

◆ TouchState() [2/2]

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

◆ Assign()

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

Copies the source TouchState into this TouchState.

Parameters
in_thatThe source TouchState to copy.

◆ Equals()

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.

◆ GetActiveEvent()

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.

◆ GetEventPath()

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.

◆ GetEventSource()

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.

◆ GetModifierKeys()

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.

◆ GetTouchCount()

ulong HPS.TouchState.GetTouchCount ( )
inline

Get the number of touches currently down in this TouchState.

Returns
Number of touches.

◆ GetTouches()

HPS.Touch [] HPS.TouchState.GetTouches ( )
inline

Get the touches currently down in this TouchState.

Returns
The list of touches.

◆ ObjectType()

override HPS.Type HPS.TouchState.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

Reimplemented from HPS.Object.

◆ Set() [1/2]

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.

◆ Set() [2/2]

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.

◆ SetActiveEvent()

void HPS.TouchState.SetActiveEvent ( HPS.TouchEvent  in_event)
inline

Sets the active event for this TouchState.

Parameters
in_eventThe action for this TouchState.

◆ SetEventPath()

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.

◆ SetModifierKeys()

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.

◆ SetTouches()

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