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