dali/internal/event/events/pan-gesture/pan-gesture-processor.h

   1 #ifndef DALI_INTERNAL_EVENT_PAN_GESTURE_EVENT_PROCESSOR_H
   2 #define DALI_INTERNAL_EVENT_PAN_GESTURE_EVENT_PROCESSOR_H
   3
   4 /*
   5  * Copyright (c) 2020 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/internal/event/events/pan-gesture/pan-gesture-detector-impl.h>
  23 #include <dali/internal/event/events/gesture-processor.h>
  24 #include <dali/internal/event/render-tasks/render-task-impl.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 class Stage;
  33 class Scene;
  34 struct GestureEvent;
  35 struct PanGestureEvent;
  36
  37 namespace SceneGraph
  38 {
  39 class PanGesture;
  40 class UpdateManager;
  41 }
  42
  43 /**
  44  * Pan Gesture Event Processing:
  45  *
  46  * When we receive a pan gesture event, we do the following:
  47  * - Find the actor that requires a pan where the pan started from (i.e. the down position).
  48  * - Emit the gesture if the event satisfies the detector conditions.
  49  *
  50  * The above is only checked when our gesture starts.  We continue sending the pan gesture to the
  51  * same actor and detector until the pan ends or is cancelled.
  52  */
  53 class PanGestureProcessor : public GestureProcessor, public RecognizerObserver<PanGestureEvent>
  54 {
  55 public:
  56
  57   /**
  58    * Create a pan gesture processor.
  59    * @param[in] updateManager The Update Manager
  60    */
  61   PanGestureProcessor( SceneGraph::UpdateManager& updateManager );
  62
  63   /**
  64    * Destructor
  65    */
  66   virtual ~PanGestureProcessor();
  67
  68 public: // To be called by GestureEventProcessor
  69
  70   /**
  71    * This method is called whenever a pan gesture event occurs.
  72    * @param[in] scene The scene the pan gesture event occurs in.
  73    * @param[in] panEvent The event that has occurred.
  74    */
  75   void Process( Scene& scene, const PanGestureEvent& panEvent );
  76
  77   /**
  78    * Adds a gesture detector to this gesture processor.
  79    * If this is the first gesture detector being added, then this method registers the required
  80    * gesture with the adaptor.
  81    * @param[in]  gestureDetector  The gesture detector being added.
  82    */
  83   void AddGestureDetector( PanGestureDetector* gestureDetector, Scene& scene, int32_t minDistance, int32_t minPanEvents );
  84
  85   /**
  86    * Removes the specified gesture detector from this gesture processor.  If, after removing this
  87    * gesture detector, there are no more gesture detectors registered, then this method unregisters
  88    * the gesture from the adaptor.
  89    * @param[in]  gestureDetector  The gesture detector being removed.
  90    */
  91   void RemoveGestureDetector( PanGestureDetector* gestureDetector );
  92
  93   /**
  94    * This method updates the gesture detection parameters.
  95    * @param[in]  gestureDetector  The gesture detector that has been updated.
  96    */
  97   void GestureDetectorUpdated( PanGestureDetector* gestureDetector );
  98
  99   /**
 100    * Sets the pan gesture properties stored in the scene object directly,
 101    * @param[in]  pan  The pan gesture to override the properties with.
 102    * @return true if Core::Update required
 103    * @note If we are already processing a normal pan, then this call is ignored.
 104    */
 105   bool SetPanGestureProperties( const Dali::PanGesture& pan );
 106
 107   /**
 108    * Called to provide pan-gesture profiling information.
 109    */
 110   void EnableProfiling();
 111
 112   /**
 113    * Called to set the prediction mode for pan gestures
 114    *
 115    * @param[in] mode The prediction mode
 116    *
 117    * Valid modes:
 118    * 0 - No prediction
 119    * 1 - Prediction using average acceleration
 120    */
 121   void SetPredictionMode(int mode);
 122
 123   /**
 124    * @brief Sets the prediction amount of the pan gesture
 125    *
 126    * @param[in] amount The prediction amount in milliseconds
 127    */
 128   void SetPredictionAmount(unsigned int amount);
 129
 130   /**
 131    * @brief Sets the upper bound of the prediction amount for clamping
 132    *
 133    * @param[in] amount The prediction amount in milliseconds
 134    */
 135   void SetMaximumPredictionAmount(unsigned int amount);
 136
 137   /**
 138    * @brief Sets the lower bound of the prediction amount for clamping
 139    *
 140    * @param[in] amount The prediction amount in milliseconds
 141    */
 142   void SetMinimumPredictionAmount(unsigned int amount);
 143
 144   /**
 145    * @brief Sets the amount of prediction interpolation to adjust when the pan velocity is changed
 146    *
 147    * @param[in] amount The prediction amount in milliseconds
 148    */
 149   void SetPredictionAmountAdjustment(unsigned int amount);
 150
 151   /**
 152    * Called to set the prediction mode for pan gestures
 153    *
 154    * @param[in] mode The prediction mode
 155    *
 156    * Valid modes:
 157    * 0 - No smoothing
 158    * 1 - average between last 2 values
 159    */
 160   void SetSmoothingMode(int mode);
 161
 162   /**
 163    * @brief Sets the smoothing amount of the pan gesture
 164    *
 165    * @param[in] amount The smotthing amount from 0.0f (none) to 1.0f (full)
 166    */
 167   void SetSmoothingAmount(float amount);
 168
 169   /*
 170    * @brief Sets whether to use actual times of the real gesture and frames or not.
 171    *
 172    * @param[in] value True = use actual times, False = use perfect values
 173    */
 174   void SetUseActualTimes( bool value );
 175
 176   /**
 177    * @brief Sets the interpolation time range (ms) of past points to use (with weights) when interpolating.
 178    *
 179    * @param[in] value Time range in ms
 180    */
 181   void SetInterpolationTimeRange( int value );
 182
 183   /**
 184    * @brief Sets whether to use scalar only prediction, which when enabled, ignores acceleration.
 185    *
 186    * @param[in] value True = use scalar prediction only
 187    */
 188   void SetScalarOnlyPredictionEnabled( bool value );
 189
 190   /**
 191    * @brief Sets whether to use two point prediction. This combines two interpolated points to get more steady acceleration and velocity values.
 192    *
 193    * @param[in] value True = use two point prediction
 194    */
 195   void SetTwoPointPredictionEnabled( bool value );
 196
 197   /**
 198    * @brief Sets the time in the past to interpolate the second point when using two point interpolation.
 199    *
 200    * @param[in] value Time in past in ms
 201    */
 202   void SetTwoPointInterpolatePastTime( int value );
 203
 204   /**
 205    * @brief Sets the two point velocity bias. This is the ratio of first and second points to use for velocity.
 206    *
 207    * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
 208    */
 209   void SetTwoPointVelocityBias( float value );
 210
 211   /**
 212    * @brief Sets the two point acceleration bias. This is the ratio of first and second points to use for acceleration.
 213    *
 214    * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
 215    */
 216   void SetTwoPointAccelerationBias( float value );
 217
 218   /**
 219    * @brief Sets the range of time (ms) of points in the history to perform multitap smoothing with (if enabled).
 220    *
 221    * @param[in] value Time in past in ms
 222    */
 223   void SetMultitapSmoothingRange( int value );
 224
 225 public: // for PanGestureDetector
 226
 227   /**
 228    * @return the pan gesture scene object
 229    */
 230   const SceneGraph::PanGesture& GetSceneObject() const;
 231
 232 private:
 233
 234   // Undefined
 235   PanGestureProcessor( const PanGestureProcessor& );
 236   PanGestureProcessor& operator=( const PanGestureProcessor& rhs );
 237
 238   /**
 239    * Iterates through our GestureDetectors and determines if we need to ask the adaptor to update
 240    * its detection policy.  If it does, it sends the appropriate gesture update request to adaptor.
 241    */
 242   void UpdateDetection();
 243
 244   /**
 245    * Creates a PanGesture and asks the specified detector to emit its detected signal.
 246    * @param[in]  actor             The actor that has been panned.
 247    * @param[in]  gestureDetectors  The gesture detector container that should emit the signal.
 248    * @param[in]  panEvent          The panEvent received from the adaptor.
 249    * @param[in]  localCurrent      Current position relative to the actor attached to the detector.
 250    * @param[in]  state             The state of the gesture.
 251    * @param[in]  renderTask        The renderTask to use.
 252    */
 253   void EmitPanSignal( Actor* actor,
 254                       const GestureDetectorContainer& gestureDetectors,
 255                       const PanGestureEvent& panEvent,
 256                       Vector2 localCurrent,
 257                       Gesture::State state,
 258                       RenderTaskPtr renderTask );
 259
 260   // GestureProcessor overrides
 261
 262   /**
 263    * @copydoc GestureProcessor::OnGesturedActorStageDisconnection()
 264    */
 265   void OnGesturedActorStageDisconnection();
 266
 267   /**
 268    * @copydoc GestureProcessor::CheckGestureDetector()
 269    */
 270   bool CheckGestureDetector( GestureDetector* detector, Actor* actor );
 271
 272   /**
 273    * @copydoc GestureProcessor::EmitGestureSignal()
 274    */
 275   void EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates );
 276
 277 private:
 278
 279   PanGestureDetectorContainer mPanGestureDetectors;
 280   GestureDetectorContainer mCurrentPanEmitters;
 281   RenderTaskPtr mCurrentRenderTask;
 282   Vector2 mPossiblePanPosition;
 283
 284   uint32_t mMinTouchesRequired;
 285   uint32_t mMaxTouchesRequired;
 286
 287   Vector2 mLastVelocity;       ///< The last recorded velocity in local actor coordinates.
 288   Vector2 mLastScreenVelocity; ///< The last recorded velocity in screen coordinates.
 289
 290   const PanGestureEvent* mCurrentPanEvent; ///< Pointer to current PanEvent, used when calling ProcessAndEmit()
 291   SceneGraph::PanGesture* mSceneObject; ///< Not owned, but we write to it directly
 292 };
 293
 294 } // namespace Internal
 295
 296 } // namespace Dali
 297
 298 #endif // DALI_INTERNAL_EVENT_PAN_GESTURE_EVENT_PROCESSOR_H