capi/dali/public-api/events/tap-gesture.h

   1 #ifndef __DALI_TAP_GESTURE_H__
   2 #define __DALI_TAP_GESTURE_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.0 (the License);
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //     http://floralicense.org/license/
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an AS IS BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19
  20 /**
  21  * @addtogroup CAPI_DALI_EVENTS_MODULE
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/events/gesture.h>
  27 #include <dali/public-api/math/vector2.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 /**
  33  * @brief A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times.
  34  *
  35  * This is a discrete gesture so does not have any state information.
  36  * @see TapGestureDetector
  37  */
  38 struct TapGesture : public Gesture
  39 {
  40   // Construction & Destruction
  41
  42   /**
  43    * @brief Default Constructor
  44    */
  45   TapGesture();
  46
  47   /**
  48    * @brief Copy constructor
  49    */
  50   TapGesture( const TapGesture& rhs );
  51
  52   /**
  53    * @brief Assignment operator
  54    */
  55   TapGesture& operator=( const TapGesture& rhs );
  56
  57   /**
  58    * @brief Virtual destructor
  59    */
  60   virtual ~TapGesture();
  61
  62   // Data
  63
  64   /**
  65    * @brief The number of taps in this tap gesture.
  66    */
  67   unsigned int numberOfTaps;
  68
  69   /**
  70    * @brief The number of touch points in this tap gesture, i.e. the number of fingers the user had on the
  71    * screen to generate the tap gesture.
  72    */
  73   unsigned int numberOfTouches;
  74
  75   /**
  76    * @brief This is the point, in screen coordinates, where the tap occurred.
  77    *
  78    * If a multi-touch tap, then this is the centroid of all the touch points.
  79    */
  80   Vector2 screenPoint;
  81
  82   /**
  83    * @brief This is the point, in local actor coordinates, where the tap occurred.
  84    *
  85    * If a multi-touch tap, then this is the centroid of all the touch points.
  86    * @return The point where tap has occurred (in local actor coordinates).
  87    */
  88   Vector2 localPoint;
  89 };
  90
  91 } // namespace Dali
  92
  93 /**
  94  * @}
  95  */
  96 #endif // __DALI_TAP_GESTURE_H__