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

   1 #ifndef DALI_TAP_GESTURE_DETECTOR_H
   2 #define DALI_TAP_GESTURE_DETECTOR_H
   3
   4 /*
   5  * Copyright (c) 2021 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 // EXTERNAL INCLUDES
  22 #include <cstdint> // uint32_t
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/events/gesture-detector.h>
  26 #include <dali/public-api/signals/dali-signal.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_events
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class TapGestureDetector;
  38 }
  39
  40 class TapGesture;
  41
  42 /**
  43  * @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the
  44  * application.
  45  *
  46  * See @ref TapGestureDetector::SetMinimumTapsRequired
  47  * See @ref TapGestureDetector::SetMaximumTapsRequired
  48  *
  49  * A TapGesture is a discrete gesture, which means it does not have any state information attached
  50  * to it.  Please see TapGesture for more information.
  51  *
  52  * The application programmer can use this gesture detector as follows:
  53  * @code
  54  * TapGestureDetector detector = TapGestureDetector::New();
  55  * detector.Attach(myActor);
  56  * detector.DetectedSignal().Connect(this, &MyApplication::OnTap);
  57  * @endcode
  58  *
  59  * @SINCE_1_0.0
  60  * @note Multi-touch taps (two or more points of contact with the surface) are not currently
  61  * supported. However, multiple taps (double & triple tap etc.) are supported.
  62  *
  63  * Signals
  64  * | %Signal Name | Method                |
  65  * |--------------|-----------------------|
  66  * | tapDetected  | @ref DetectedSignal() |
  67  * @see TapGesture
  68  *
  69  */
  70 class DALI_CORE_API TapGestureDetector : public GestureDetector
  71 {
  72 public: // Typedefs
  73   /**
  74    * @brief Signal type for detected signal.
  75    * @SINCE_1_0.0
  76    */
  77   using DetectedSignalType = Signal<void(Actor, const TapGesture&)>;
  78
  79 public: // Creation & Destruction
  80   /**
  81    * @brief Creates an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
  82    *
  83    * Calling member functions with an uninitialized TapGestureDetector handle is not allowed.
  84    * @SINCE_1_0.0
  85    */
  86   TapGestureDetector();
  87
  88   /**
  89    * @brief Creates an initialized TapGestureDetector.
  90    *
  91    * By default, this would create a gesture detector which requires one tap with one touch.
  92    * @SINCE_1_0.0
  93    * @return A handle to a newly allocated Dali resource
  94    */
  95   static TapGestureDetector New();
  96
  97   /**
  98    * @brief Creates an initialized TapGestureDetector with the specified parameters.
  99    *
 100    * @SINCE_1_0.0
 101    * @param[in] tapsRequired The minimum & maximum number of taps required
 102    * @return A handle to a newly allocated Dali resource
 103    */
 104   static TapGestureDetector New(uint32_t tapsRequired);
 105
 106   /**
 107    * @brief Downcasts a handle to TapGestureDetector handle.
 108    *
 109    * If handle points to a TapGestureDetector object, the
 110    * downcast produces valid handle. If not, the returned handle is left uninitialized.
 111    * @SINCE_1_0.0
 112    * @param[in] handle Handle to an object
 113    * @return Handle to a TapGestureDetector object or an uninitialized handle
 114    */
 115   static TapGestureDetector DownCast(BaseHandle handle);
 116
 117   /**
 118    * @brief Destructor.
 119    *
 120    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 121    * @SINCE_1_0.0
 122    */
 123   ~TapGestureDetector();
 124
 125   /**
 126    * @brief This copy constructor is required for (smart) pointer semantics.
 127    *
 128    * @SINCE_1_0.0
 129    * @param[in] handle A reference to the copied handle
 130    */
 131   TapGestureDetector(const TapGestureDetector& handle);
 132
 133   /**
 134    * @brief This assignment operator is required for (smart) pointer semantics.
 135    *
 136    * @SINCE_1_0.0
 137    * @param[in] rhs A reference to the copied handle
 138    * @return A reference to this
 139    */
 140   TapGestureDetector& operator=(const TapGestureDetector& rhs);
 141
 142 public: // Setters
 143   /**
 144    * @brief Sets the minimum number of taps required.
 145    *
 146    * The tap count is the number of times a user should "tap" the screen.
 147    * @SINCE_1_0.0
 148    * @param[in] minimumTaps The minimum taps required
 149    * @pre The gesture detector has been initialized.
 150    * @note The default is '1', the maximum is 2.
 151    * @see ReceiveAllTapEvents
 152    */
 153   void SetMinimumTapsRequired(uint32_t minimumTaps);
 154
 155   /**
 156    * @brief Sets the maximum number of taps required.
 157    *
 158    * The tap count is the number of times a user should "tap" the screen.
 159    * @SINCE_1_0.0
 160    * @param[in] maximumTaps The maximum taps required
 161    * @pre The gesture detector has been initialized.
 162    * @note The default is '1', the maximum is 2.
 163    * @see ReceiveAllTapEvents
 164    */
 165   void SetMaximumTapsRequired(uint32_t maximumTaps);
 166
 167   /**
 168    * @brief When set to true, all tap gestures will be received when multiple taps are supported by the gesture detector.
 169    *
 170    * @param[in] receive The receiving all tap events flag
 171    * @pre The gesture detector has been initialized.
 172    * @note The default is false.
 173    */
 174   void ReceiveAllTapEvents(bool receive);
 175
 176 public: // Getters
 177   /**
 178    * @brief Retrieves the minimum number of taps required.
 179    *
 180    * @SINCE_1_0.0
 181    * @return The minimum taps required
 182    * @pre The gesture detector has been initialized.
 183    */
 184   uint32_t GetMinimumTapsRequired() const;
 185
 186   /**
 187    * @brief Retrieves the maximum number of taps required.
 188    *
 189    * @SINCE_1_0.0
 190    * @return The maximum taps required
 191    * @pre The gesture detector has been initialized.
 192    */
 193   uint32_t GetMaximumTapsRequired() const;
 194
 195 public: // Signals
 196   /**
 197    * @brief This signal is emitted when the specified tap is detected on the attached actor.
 198    *
 199    * A callback of the following type may be connected:
 200    * @code
 201    *   void YourCallbackName( Actor actor, const TapGesture& gesture );
 202    * @endcode
 203    * @SINCE_1_0.0
 204    * @return The signal to connect to
 205    * @pre The gesture detector has been initialized.
 206    */
 207   DetectedSignalType& DetectedSignal();
 208
 209 public: // Not intended for Application developers
 210   /// @cond internal
 211   /**
 212    * @brief This constructor is used by TapGestureDetector::New() methods.
 213    *
 214    * @SINCE_1_0.0
 215    * @param[in] internal A pointer to a newly allocated Dali resource
 216    */
 217   explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
 218   /// @endcond
 219 };
 220
 221 /**
 222  * @}
 223  */
 224
 225 } // namespace Dali
 226
 227 #endif // DALI_TAP_GESTURE_DETECTOR_H