#include <hps.h>

Public Types | |
enum | Action : uint32_t { Action::TouchDown, Action::TouchUp, Action::Move } |
![]() | |
enum | Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed } |
Public Member Functions | |
Event * | Clone () const |
virtual bool | Drop (Event const *in_that_event) const |
virtual bool | Equals (TouchEvent const &in_that) const |
virtual bool | operator!= (TouchEvent const &in_that) const |
virtual bool | operator== (TouchEvent const &in_that) const |
TouchEvent () | |
TouchEvent (Action in_action, ModifierKeys in_modifier=ModifierKeys()) | |
TouchEvent (Action in_action, TouchArray const &in_touches, ModifierKeys in_modifier=ModifierKeys()) | |
TouchEvent (Action in_action, size_t in_touch_count, Touch const in_touches[], ModifierKeys in_modifier=ModifierKeys()) | |
TouchEvent (Event const &in_event) | |
![]() | |
virtual bool | Equals (InputEvent const &in_that) const |
ModifierKeys | GetModifierKeys () const |
InputEvent () | |
InputEvent (ModifierKeys const &in_modifiers) | |
virtual bool | operator!= (InputEvent const &in_that) const |
virtual bool | operator== (InputEvent const &in_that) const |
![]() | |
Event (intptr_t in_channel=0) | |
virtual intptr_t | Freshen () const |
intptr_t | GetChannel () const |
intptr_t | GetClassID () const |
Time | GetTimeStamp () const |
bool | IsConsumable () const |
Public Attributes | |
HPS::TouchEvent::Action | CurrentAction |
The action for the touches of this TouchEvent. | |
HPS::TouchArray | Touches |
Array of Touches for this TouchEvent. | |
![]() | |
ModifierKeys | ModifierKeyState |
The modifier keys which are active for this InputEvent. | |
Additional Inherited Members | |
![]() | |
static void | operator delete (void *in_ptr, size_t in_size) throw () |
static void * | operator new (size_t in_size) |
![]() | |
intptr_t | channel |
bool | consumable |
Detailed Description
The TouchEvent class is the event generated for each touch action on a multi-touch device.
Member Enumeration Documentation
|
strong |
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
|
inline |
The default constructor creates an uninitialized TouchEvent object.
|
inline |
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_action Action of this TouchEvent. in_modifier The modifier keys for this TouchEvent.
|
inline |
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_action Action of this TouchEvent. in_touches An array or touches for this TouchEvent. in_modifier The modifier keys for this TouchEvent.
|
inline |
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_action Action of this TouchEvent. in_touch_count the number of Touches in the touch array. in_touches An array or touches for this TouchEvent. in_modifier The modifier keys for this TouchEvent.
|
inline |
This constructor converts an Event Object to a TouchEvent object.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this TouchEvent.
- Returns
- A copy of this TouchEvent.
Reimplemented from HPS::InputEvent.
|
inlinevirtual |
Determines if this TouchEvent can be dropped in favor of the following touch event.
- Parameters
-
in_that_event Event to compare with this TouchEvent.
- Returns
- true if this event can be dropped, false otherwise.
Reimplemented from HPS::Event.
|
inlinevirtual |
Check if the source object is equivalent to this object.
- Parameters
-
in_kit The source object to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinevirtual |
Check if the source object is not equivalent to this object.
- Parameters
-
in_kit The source object to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
|
inlinevirtual |
Check if the source object is equivalent to this object.
- Parameters
-
in_kit The source object to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
The documentation for this class was generated from the following file:
- include/hps.h