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

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