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