< Home

< Table of Contents

REFERENCE MANUAL

TouchState Class Reference

#include <hps.h>

Inheritance diagram for TouchState:
Object

Public Member Functions

void Assign (TouchState const &in_that)
 
bool Equals (TouchState const &in_that) const
 
TouchEvent GetActiveEvent () const
 
KeyArray GetEventPath () const
 
WindowKey GetEventSource () const
 
ModifierKeys GetModifierKeys () const
 
size_t GetTouchCount () const
 
TouchArray GetTouches () const
 
Type ObjectType () const
 
bool operator!= (TouchState const &in_that) const
 
TouchStateoperator= (TouchState &&in_that)
 
TouchStateoperator= (TouchState const &in_that)
 
bool operator== (TouchState const &in_that) const
 
 TouchState ()
 
 TouchState (TouchState const &in_that)
 
 TouchState (TouchState &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

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

Constructor & Destructor Documentation

TouchState::TouchState ( )

The default constructor creates an empty TouchState object.

TouchState::TouchState ( TouchState const &  in_that)

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

Parameters
in_thatThe source TouchState to copy.
TouchState::TouchState ( TouchState &&  in_that)

The move constructor creates a TouchState by transferring the underlying impl of the rvalue reference to this TouchState thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a TouchState to take the impl from.

Member Function Documentation

void TouchState::Assign ( TouchState const &  in_that)

Copies the source TouchState into this TouchState.

Parameters
in_thatThe source TouchState to copy.
bool TouchState::Equals ( TouchState const &  in_that) const

Check if the source TouchState is equivalent to this TouchState.

Parameters
in_kitThe source TouchState to compare to this TouchState.
Returns
true if the objects are equivalent, false otherwise.
TouchEvent TouchState::GetActiveEvent ( ) const

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.
KeyArray TouchState::GetEventPath ( ) const

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.
WindowKey TouchState::GetEventSource ( ) const

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.
ModifierKeys TouchState::GetModifierKeys ( ) const

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

Returns
An object representing the state of modifier keys.
size_t TouchState::GetTouchCount ( ) const

Get the number of touches currently down in this TouchState.

Returns
Number of touches.
TouchArray TouchState::GetTouches ( ) const

Get the touches currently down in this TouchState.

Returns
The list of touches.
Type TouchState::ObjectType ( ) const
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 Object.

bool TouchState::operator!= ( TouchState const &  in_that) const

Check if the source TouchState is not equivalent to this TouchState.

Parameters
in_kitThe source TouchState to compare to this TouchState.
Returns
true if the objects are not equivalent, false otherwise.
TouchState& TouchState::operator= ( TouchState &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this TouchState thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a TouchState to take the impl from.
Returns
A reference to this TouchState.
TouchState& TouchState::operator= ( TouchState const &  in_that)

Copies the source TouchState into this TouchState.

Parameters
in_thatThe source TouchState to copy.
Returns
A reference to this TouchState.
bool TouchState::operator== ( TouchState const &  in_that) const

Check if the source TouchState is equivalent to this TouchState.

Parameters
in_kitThe source TouchState to compare to this TouchState.
Returns
true if the objects are equivalent, false otherwise.

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