TouchState

class HPS.TouchState : public HPS.Object

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

Public Functions

void Assign (HPS.TouchState in_that)

Copies the source TouchState into this TouchState.

Param in_that

The source TouchState to copy.

override void Dispose ()

bool Equals (HPS.TouchState in_that)

Check if the source TouchState is equivalent to this TouchState.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

HPS.TouchEvent GetActiveEvent ()

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

Return

The action for the active touches for this TouchState.

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.

Return

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

Return

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

override int GetHashCode ()

HPS.ModifierKeys GetModifierKeys ()

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

Return

An object representing the state of modifier keys.

ulong GetTouchCount ()

Get the number of touches currently down in this TouchState.

Return

Number of touches.

HPS.Touch[] GetTouches ()

Get the touches currently down in this TouchState.

Return

The list of touches.

override HPS.Type ObjectType ()

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

Return

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

void Set (HPS.Key[] in_path, HPS.TouchEvent in_event, HPS.Touch[] in_touches)

Sets the properties of this TouchState.

Param in_path

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

Param in_event

The touch event.

Param in_touches

The touches down during this touch event.

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

Sets the properties of this TouchState.

Param in_path

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

Param in_event

The touch event.

Param in_touches

The touches down during this touch event.

Param in_modifiers

The state of modifier keys for this touch event.

void SetActiveEvent (HPS.TouchEvent in_event)

Sets the active event for this TouchState.

Param in_event

The action for this TouchState.

void SetEventPath (HPS.Key[] in_path)

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

Param in_path

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

void SetModifierKeys (HPS.ModifierKeys in_modifiers)

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

Param in_modifiers

An object representing the state of modifier keys.

void SetTouches (HPS.Touch[] in_touches)

Sets the touches currently down in this TouchState.

Param in_touches

The list of touches.

TouchState ()

The default constructor creates an empty TouchState object.

TouchState (HPS.TouchState in_that)

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

Param in_that

The source TouchState to copy.

Public Static Functions

bool operator!= (HPS.TouchState a, HPS.TouchState b)

bool operator== (HPS.TouchState a, HPS.TouchState b)