dali/internal/event/events/tap-gesture/tap-gesture-event.h

   1 #ifndef DALI_INTERNAL_EVENT_TAP_GESTURE_H
   2 #define DALI_INTERNAL_EVENT_TAP_GESTURE_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
  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 // INTERNAL INCLUDES
  22 #include <dali/public-api/math/vector2.h>
  23 #include <dali/internal/event/events/gesture-event.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 /**
  32  * If the adaptor detects a tap gesture, then it should create an instance of this structure and
  33  * send it to the Core.
  34  *
  35  * A Tap Gesture event should be in one of three states:
  36  * - Possible:  When the user first puts their finger down - Core needs to hit test the down point so
  37  *              that a tap (down and up quickly) is also on the same actor.
  38  * - Started:   If a tap is detected (No Finished state is expected).
  39  * - Cancelled: If, after a down event, no tap is detected, or a system interruption.
  40  *
  41  * A Started state will be ignored if a Possible state does not precede it.
  42  */
  43 struct TapGestureEvent : public GestureEvent
  44 {
  45   // Construction & Destruction
  46
  47   /**
  48    * Default Constructor
  49    * @param[in]  state  Possible, denotes down press;
  50    *                    Started, of a tap occurs; and
  51    *                    Cancelled, when tap does not occur.
  52    */
  53   TapGestureEvent( Gesture::State state );
  54
  55   /**
  56    * Virtual destructor
  57    */
  58   virtual ~TapGestureEvent();
  59
  60   // Data
  61
  62   /**
  63    * @copydoc Dali::TapGesture::numberOfTaps
  64    */
  65   unsigned int numberOfTaps;
  66
  67   /**
  68    * @copydoc Dali::TapGesture::numberOfTouches
  69    */
  70   unsigned int numberOfTouches;
  71
  72   /**
  73    * This is the point, in screen coordinates, where the tap occurred.
  74    * If a multi-touch tap, then this should be the centroid of all the touch points.
  75    */
  76   Vector2 point;
  77 };
  78
  79 } // namespace Internal
  80
  81 } // namespace Dali
  82
  83 #endif // DALI_INTERNAL_EVENT_TAP_GESTURE_H