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

   1 #ifndef __DALI_PAN_GESTURE_DETECTOR_H__
   2 #define __DALI_PAN_GESTURE_DETECTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/object/property-index-ranges.h>
  24 #include <dali/public-api/signals/dali-signal.h>
  25
  26 namespace Dali
  27 {
  28
  29 struct Radian;
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 class PanGestureDetector;
  34 }
  35
  36 struct PanGesture;
  37
  38 /**
  39  * @brief This class looks for panning (or dragging) gestures.
  40  *
  41  * The user will be pressing one or more fingers on an actor while they pan it.
  42  *
  43  * The application programmer can use this gesture detector as follows:
  44  * @code
  45  * PanGestureDetector detector = PanGestureDetector::New();
  46  * detector.Attach(myActor);
  47  * detector.DetectedSignal().Connect(this, &MyApplication::OnPan);
  48  *
  49  * // Detect pan gesture for single and double touch.
  50  * detector.SetMaximumTouchesRequired(2);
  51  * @endcode
  52  *
  53  * @see PanGesture
  54  *
  55  * Signals
  56  * | %Signal Name | Method                |
  57  * |--------------|-----------------------|
  58  * | pan-detected | @ref DetectedSignal() |
  59  */
  60 class DALI_IMPORT_API PanGestureDetector : public GestureDetector
  61 {
  62 public:
  63
  64   /**
  65    * @brief An enumeration of properties belonging to the PanGestureDetector class.
  66    */
  67   struct Property
  68   {
  69     enum
  70     {
  71       ScreenPosition = DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX, ///< name "screen-position",     type Vector2
  72       ScreenDisplacement,                                             ///< name "screen-displacement", type Vector2
  73       ScreenVelocity,                                                 ///< name "screen-velocity",     type Vector2
  74       LocalPosition,                                                  ///< name "local-position",      type Vector2
  75       LocalDisplacement,                                              ///< name "local-displacement",  type Vector2
  76       LocalVelocity,                                                  ///< name "local-velocity",      type Vector2
  77       Panning,                                                        ///< name "panning",             type Boolean
  78     };
  79   };
  80
  81   // Typedefs
  82   typedef Signal< void ( Actor, const PanGesture& ) > DetectedSignalType; ///< Pan gesture detected signal type
  83
  84   // Directional Pan
  85   typedef std::pair< Radian, Radian > AngleThresholdPair; ///< Range of angles for a direction
  86   typedef std::vector< AngleThresholdPair > AngleContainer; ///< Group of angular thresholds for all directions
  87
  88   static const Radian DIRECTION_LEFT;       ///< For a left pan (-PI Radians).
  89   static const Radian DIRECTION_RIGHT;      ///< For a right pan (0 Radians).
  90   static const Radian DIRECTION_UP;         ///< For an up pan (-0.5 * PI Radians).
  91   static const Radian DIRECTION_DOWN;       ///< For a down pan (0.5 * PI Radians).
  92   static const Radian DIRECTION_HORIZONTAL; ///< For a left and right pan (PI Radians). Useful for AddDirection().
  93   static const Radian DIRECTION_VERTICAL;   ///< For an up and down pan (-0.5 * PI Radians). Useful for AddDirection().
  94
  95   static const Radian DEFAULT_THRESHOLD;    ///< The default threshold is PI * 0.25 radians (or 45 degrees).
  96
  97 public: // Creation & Destruction
  98
  99   /**
 100    * @brief Create an uninitialized PanGestureDetector; this can be initialized with PanGestureDetector::New().
 101    *
 102    * Calling member functions with an uninitialized Dali::Object is not allowed.
 103    */
 104   PanGestureDetector();
 105
 106   /**
 107    * @brief Create an initialized PanGestureDetector.
 108    *
 109    * @return A handle to a newly allocated Dali resource.
 110    */
 111   static PanGestureDetector New();
 112
 113   /**
 114    * @brief Downcast an Object handle to PanGestureDetector handle.
 115    *
 116    * If handle points to a PanGestureDetector object the
 117    * downcast produces valid handle. If not the returned handle is left uninitialized.
 118    * @param[in] handle to An object
 119    * @return handle to a PanGestureDetector object or an uninitialized handle
 120    */
 121   static PanGestureDetector DownCast( BaseHandle handle );
 122
 123   /**
 124    * @brief Destructor
 125    *
 126    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 127    */
 128   ~PanGestureDetector();
 129
 130   /**
 131    * @brief This copy constructor is required for (smart) pointer semantics.
 132    *
 133    * @param [in] handle A reference to the copied handle
 134    */
 135   PanGestureDetector(const PanGestureDetector& handle);
 136
 137   /**
 138    * @brief This assignment operator is required for (smart) pointer semantics.
 139    *
 140    * @param [in] rhs  A reference to the copied handle
 141    * @return A reference to this
 142    */
 143   PanGestureDetector& operator=(const PanGestureDetector& rhs);
 144
 145 public: // Setters
 146
 147   /**
 148    * @brief This is the minimum number of touches required for the pan gesture to be detected.
 149    *
 150    * @param[in]  minimum  Minimum touches required.
 151    * @pre The gesture detector has been initialized.
 152    * @note The default minimum is '1'.
 153    */
 154   void SetMinimumTouchesRequired(unsigned int minimum);
 155
 156   /**
 157    * @brief This is the maximum number of touches required for the pan gesture to be detected.
 158    *
 159    * @param[in]  maximum  Maximum touches required.
 160    * @pre The gesture detector has been initialized.
 161    * @note The default maximum is '1'.
 162    */
 163   void SetMaximumTouchesRequired(unsigned int maximum);
 164
 165 public: // Getters
 166
 167   /**
 168    * @brief Retrieves the minimum number of touches required for the pan gesture to be detected.
 169    *
 170    * @return The minimum touches required.
 171    * @pre The gesture detector has been initialized.
 172    */
 173   unsigned int GetMinimumTouchesRequired() const;
 174
 175   /**
 176    * @brief Retrieves the maximum number of touches required for the pan gesture to be detected.
 177    *
 178    * @return The maximum touches required.
 179    * @pre The gesture detector has been initialized.
 180    */
 181   unsigned int GetMaximumTouchesRequired() const;
 182
 183 public: // Directional Panning
 184
 185   /**
 186    * @brief The pan gesture is only emitted if the pan occurs in the direction specified by this method with a +/- threshold allowance.
 187    *
 188    * The angle is from -180 -> 0 -> 180 degrees (or -M_PI -> 0 -> M_PI in radians) i.e:
 189    *
 190    * @code
 191    *           -90.0f ( -0.5f * PI )
 192    *                     |
 193    *                     |
 194    * 180.0f ( PI ) ------------- 0.0f ( 0.0f )
 195    *                     |
 196    *                     |
 197    *            90.0f ( 0.5f * PI )
 198    * @endcode
 199    *
 200    * If an angle of 0.0 degrees is specified and the threshold is 45 degrees then the acceptable
 201    * direction range is from -45 to 45 degrees.
 202    *
 203    * @param[in]  angle      The angle that pan should be allowed.
 204    * @param[in]  threshold  The threshold around that angle.
 205    *
 206    * @note The angle added using this API is only checked when the gesture first starts, after that,
 207    *       this detector will emit the gesture regardless of what angle the pan is moving.
 208    * @note The user can add as many angles as they require.
 209    * @note If an angle outside the range above is given, then it is wrapped within the range, i.e.
 210    *       190 degrees becomes -170 degrees and 370 degrees becomes 10 degrees.
 211    * @note As long as you specify the type, you can also pass in a Dali::Degree to this method.
 212    * @note If no threshold is provided, then the default threshold (PI * 0.25) is used.
 213    * @note If the threshold is greater than PI, then PI will be used as the threshold.
 214    *
 215    * @pre The gesture detector has been initialized.
 216    */
 217   void AddAngle( Radian angle, Radian threshold = DEFAULT_THRESHOLD );
 218
 219   /**
 220    * @brief A helper method for adding bi-directional angles where the pan should take place.
 221    *
 222    * In other words, if 0 is requested, then PI will also be added so that we have both left and
 223    * right scrolling.
 224    *
 225    * @param[in]  direction  The direction of panning required.
 226    * @param[in]  threshold  The threshold.
 227    *
 228    * @note If a direction outside the range above is given, then it is wrapped within the range, i.e.
 229    *       190 degrees becomes -170 degrees and 370 degrees becomes 10 degrees.
 230    * @note If no threshold is provided, then the default threshold (PI * 0.25) is used.
 231    * @note If the threshold is greater than PI, then PI will be used as the threshold.
 232    * @note As long as you specify the type, you can also pass in a Dali::Degree to this method.
 233    *
 234    * @pre The gesture detector has been initialized.
 235    *
 236    * @see AddAngle
 237    */
 238   void AddDirection( Radian direction, Radian threshold = DEFAULT_THRESHOLD );
 239
 240   /**
 241    * @brief Returns the container of all the angles this pan gesture detector emits a signal.
 242    *
 243    * @return a const reference to the container of all the angles.
 244    * @pre The gesture detector has been initialized.
 245    */
 246   const AngleContainer& GetAngles() const;
 247
 248   /**
 249    * @brief Clears any directional angles that are used by the gesture detector.
 250    *
 251    * After this, the pan gesture
 252    * will be emitted for a pan in ANY direction.
 253    * @pre The gesture detector has been initialized.
 254    */
 255   void ClearAngles();
 256
 257   /**
 258    * @brief Removes the angle specified from the container.
 259    *
 260    * @param[in]  angle  The angle to remove.
 261    * @pre The gesture detector has been initialized.
 262    * @note This will only remove the first instance of the angle found from the container.
 263    * @note If an angle outside the range in AddAngle() is given, then the value is wrapped within
 264    *       the range and that is removed.
 265    */
 266   void RemoveAngle( Radian angle );
 267
 268   /**
 269    * @brief Removes the two angles that make up the direction from the container.
 270    *
 271    * @param[in]  direction  The direction to remove.
 272    * @pre The gesture detector has been initialized.
 273    * @note If a direction outside the range in AddAngle() is given, then the value is wrapped within
 274    *       the range and that is removed.
 275    */
 276   void RemoveDirection( Radian direction );
 277
 278 public: // Signals
 279
 280   /**
 281    * @brief This signal is emitted when the pan gesture is detected on the attached actor.
 282    *
 283    * A callback of the following type may be connected:
 284    * @code
 285    *   void YourCallbackName( Actor actor, const PanGesture& gesture );
 286    * @endcode
 287    * @pre The gesture detector has been initialized.
 288    * @return The signal to connect to.
 289    */
 290   DetectedSignalType& DetectedSignal();
 291
 292 public: // Pan Properties Setters
 293
 294   /**
 295    * @brief Allows setting of the pan properties that are returned in constraints.
 296    *
 297    * @param[in]  pan  The pan gesture to set.
 298    *@note If a normal pan is taking place, then any value set is ignored.
 299    */
 300   static void SetPanGestureProperties( const PanGesture& pan );
 301
 302 public: // Not intended for Application developers
 303
 304   /**
 305    * @brief This constructor is used by Dali New() methods.
 306    *
 307    * @param [in]  internal  A pointer to a newly allocated Dali resource.
 308    */
 309   explicit DALI_INTERNAL PanGestureDetector(Internal::PanGestureDetector* internal);
 310
 311 };
 312
 313 } // namespace Dali
 314
 315 #endif // __DALI_PAN_GESTURE_DETECTOR_H__