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