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

   1 #ifndef __DALI_GESTURE_DETECTOR_H__
   2 #define __DALI_GESTURE_DETECTOR_H__
   3
   4 /*
   5  * Copyright (c) 2018 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/object/handle.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_core_events
  28  * @{
  29  */
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 class GestureDetector;
  34 }
  35
  36 class Actor;
  37
  38 /**
  39  * @brief GestureDetectors analyse a stream of touch events and attempt to determine the intention of the user.
  40  *
  41  * An actor is attached to a gesture detector and if the detector recognises a pattern in its analysis, it will
  42  * emit a detected signal to the application.
  43  *
  44  * This is the base class for different gesture detectors available and provides functionality that is common
  45  * to all the gesture detectors.
  46  *
  47  * @SINCE_1_0.0
  48  * @see Gesture
  49  */
  50 class DALI_CORE_API GestureDetector : public Handle
  51 {
  52 public: // Creation & Destruction
  53
  54   /**
  55    * @brief Creates an uninitialized GestureDetector.
  56    *
  57    * This can be initialized with one of the derived gesture detectors' New() methods. For example, PanGestureDetector::New().
  58    *
  59    * Calling member functions with an uninitialized Dali::GestureDetector handle is not allowed.
  60    * @SINCE_1_0.0
  61    */
  62   GestureDetector();
  63
  64   /**
  65    * @brief Downcasts a handle to GestureDetector handle.
  66    *
  67    * If handle points to a GestureDetector object, the downcast produces valid handle.
  68    * If not, the returned handle is left uninitialized.
  69    * @SINCE_1_0.0
  70    * @param[in] handle Handle to an object
  71    * @return Handle to a GestureDetector object or an uninitialized handle
  72    */
  73   static GestureDetector DownCast( BaseHandle handle );
  74
  75   /**
  76    * @brief Dali::GestureDetector is intended as a base class.
  77    *
  78    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  79    * @SINCE_1_0.0
  80    */
  81   ~GestureDetector();
  82
  83   /**
  84    * @brief This copy constructor is required for (smart) pointer semantics.
  85    *
  86    * @SINCE_1_0.0
  87    * @param[in] handle A reference to the copied handle
  88    */
  89   GestureDetector(const GestureDetector& handle);
  90
  91   /**
  92    * @brief This assignment operator is required for (smart) pointer semantics.
  93    *
  94    * @SINCE_1_0.0
  95    * @param[in] rhs A reference to the copied handle
  96    * @return A reference to this
  97    */
  98   GestureDetector& operator=(const GestureDetector& rhs);
  99
 100 public: // Actor related
 101
 102   /**
 103    * @brief Attaches an actor to the gesture.
 104    *
 105    * The detected signal will be dispatched when the gesture occurs on
 106    * the attached actor.
 107    * @SINCE_1_0.0
 108    * @param[in] actor The actor to attach to the gesture detector
 109    * @pre The gesture detector has been initialized.
 110    * @note You can attach several actors to a gesture detector.
 111    */
 112   void Attach(Actor actor);
 113
 114   /**
 115    * @brief Detaches the attached actor from the gesture detector.
 116    *
 117    * @SINCE_1_0.0
 118    * @param[in] actor The actor to detach from the gesture detector
 119    * @pre The gesture detector has been initialized.
 120    * @pre The specified actor has been attached to the gesture detector.
 121    */
 122   void Detach(Actor actor);
 123
 124   /**
 125    * @brief Detaches all the actors that have been attached to the gesture detector.
 126    *
 127    * @SINCE_1_0.0
 128    * @pre The gesture detector has been initialized.
 129    * @pre At least one actor has been attached to the gesture detector.
 130    */
 131   void DetachAll();
 132
 133   /**
 134    * @brief Returns the number of actors attached to the gesture detector.
 135    *
 136    * @SINCE_1_0.0
 137    * @return The count
 138    * @pre The gesture detector has been initialized.
 139    */
 140   size_t GetAttachedActorCount() const;
 141
 142   /**
 143    * @brief Returns an actor by index. An empty handle if the index is not valid.
 144    *
 145    * @SINCE_1_0.0
 146    * @param[in] index The attached actor's index
 147    * @return The attached actor or an empty handle
 148    * @pre The gesture detector has been initialized.
 149    */
 150   Actor GetAttachedActor(size_t index) const;
 151
 152 protected:
 153
 154   /// @cond internal
 155   /**
 156    * @brief This constructor is used by New() methods of derived classes (For example, PanGestureDetector::New()).
 157    *
 158    * @SINCE_1_0.0
 159    * @param[in] internal A pointer to a newly allocated Dali resource
 160    */
 161   explicit DALI_INTERNAL GestureDetector(Internal::GestureDetector* internal);
 162   /// @endcond
 163 };
 164
 165 /**
 166  * @}
 167  */
 168 } // namespace Dali
 169
 170 #endif // __DALI_GESTURE_DETECTOR_H__