dali/internal/update/gestures/scene-graph-pan-gesture.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_PAN_GESTURE_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_PAN_GESTURE_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/devel-api/threading/mutex.h>
  23 #include <dali/public-api/common/vector-wrapper.h>
  24 #include <dali/internal/event/events/pan-gesture/pan-gesture-impl.h>
  25 #include <dali/internal/update/common/property-owner.h>
  26 #include <dali/internal/update/gestures/gesture-properties.h>
  27
  28 namespace Dali
  29 {
  30
  31 class PanGesture;
  32
  33 namespace Internal
  34 {
  35
  36 struct PanGestureProfiling;
  37
  38 namespace SceneGraph
  39 {
  40
  41 /**
  42  * The latest pan gesture information is stored in this scene object.
  43  */
  44 class PanGesture : public PropertyOwner
  45 {
  46 public:
  47
  48   enum PredictionMode
  49   {
  50     PREDICTION_NONE = 0,
  51     PREDICTION_1,
  52     PREDICTION_2,
  53   };
  54
  55   enum SmoothingMode
  56   {
  57     SMOOTHING_NONE,           // No smoothing.
  58     SMOOTHING_LAST_VALUE,     // Smooth between last value and latest value.
  59     SMOOTHING_MULTI_TAP,      // Uses multitap smoothing, only available with Prediction mode 2.
  60   };
  61
  62   static const PredictionMode DEFAULT_PREDICTION_MODE;
  63   static const int NUM_PREDICTION_MODES;
  64
  65   static const SmoothingMode DEFAULT_SMOOTHING_MODE;
  66   static const int NUM_SMOOTHING_MODES;
  67
  68   // Latest Pan Information
  69
  70   /**
  71    * Only stores the information we actually require from Dali::PanGesture
  72    */
  73   struct PanInfo
  74   {
  75     /**
  76      * Stores the velocity, displacement and position.
  77      */
  78     struct Info
  79     {
  80       Info() = default;
  81
  82       /**
  83        * Copy constructor
  84        */
  85       Info(const Info& rhs) = default;
  86
  87       /**
  88        * Assignment operator
  89        */
  90       Info& operator=( const Info& rhs )
  91       {
  92         if( this != &rhs )
  93         {
  94           velocity = rhs.velocity;
  95           displacement = rhs.displacement;
  96           position = rhs.position;
  97         }
  98
  99         return *this;
 100       }
 101
 102       // Data
 103
 104       Vector2 velocity;
 105       Vector2 displacement;
 106       Vector2 position;
 107     };
 108
 109     /**
 110      * Constructor
 111      */
 112     PanInfo()
 113     : time( 0u ),
 114       state( GestureState::CLEAR ),
 115       read( true )
 116     {
 117     }
 118
 119     /**
 120      * Copy constructor
 121      */
 122     PanInfo( const PanInfo& rhs )
 123     : time( rhs.time ),
 124       state( rhs.state ),
 125       local( rhs.local ),
 126       screen( rhs.screen ),
 127       read( true )
 128     {
 129     }
 130
 131     /**
 132      * Assignment operator
 133      */
 134     PanInfo& operator=( const PanInfo& rhs )
 135     {
 136       if( this != &rhs )
 137       {
 138         time = rhs.time;
 139         state = rhs.state;
 140         local = rhs.local;
 141         screen = rhs.screen;
 142         read = rhs.read;
 143       }
 144
 145       return *this;
 146     }
 147
 148     /**
 149      * Assignment operator
 150      * @param[in] gesture A Dali::Gesture
 151      */
 152     PanInfo& operator=( const Internal::PanGesture& rhs )
 153     {
 154       time = rhs.GetTime();
 155       state = rhs.GetState();
 156
 157       local.velocity = rhs.GetVelocity();
 158       local.displacement = rhs.GetDisplacement();
 159       local.position = rhs.GetPosition();
 160
 161       screen.velocity = rhs.GetScreenVelocity();
 162       screen.displacement = rhs.GetScreenDisplacement();
 163       screen.position = rhs.GetScreenPosition();
 164
 165       return *this;
 166     }
 167
 168     // Data
 169     unsigned int time;
 170     GestureState state;
 171     Info local;
 172     Info screen;
 173     volatile bool read;
 174   };
 175
 176   using PanInfoHistory          = std::vector<PanInfo>;
 177   using PanInfoHistoryIter      = PanInfoHistory::iterator;
 178   using PanInfoHistoryConstIter = PanInfoHistory::const_iterator;
 179
 180 private:
 181   static const unsigned int PAN_GESTURE_HISTORY = 30u;
 182
 183 public:
 184
 185   /**
 186    * Create a new PanGesture
 187    */
 188   static PanGesture* New();
 189
 190   /**
 191    * Virtual destructor
 192    */
 193   ~PanGesture() override;
 194
 195   /**
 196    * Adds a PanGesture to the internal circular-buffer waiting to be handled by UpdateProperties.
 197    * @param[in]  gesture  The latest pan gesture.
 198    */
 199   void AddGesture( const Internal::PanGesture& gesture );
 200
 201   /**
 202    * @brief Removes pan events from the history that are older than maxAge, leaving at least minEvents
 203    *
 204    * @param[in] panHistory The pan event history container
 205    * @param[in] currentTime The current frame time
 206    * @param[in] maxAge Maximum age of an event before removing (in millis)
 207    * @param[in] minEvents The minimum number of events to leave in history, oldest events are removed before newest
 208    */
 209   void RemoveOldHistory(PanInfoHistory& panHistory, unsigned int currentTime, unsigned int maxAge, unsigned int minEvents);
 210
 211   /**
 212    * Uses elapsed time and time stamps
 213    */
 214   void PredictionMode1(int eventsThisFrame, PanInfo& gestureOut, PanInfoHistory& panHistory, unsigned int lastVSyncTime, unsigned int nextVSyncTime);
 215
 216   /**
 217    * Blends two points together.
 218    * The blend value ranges are:
 219    * 0.0f = use 100% of current value.
 220    * 1.0f = use half-way average of current and last value.
 221    *
 222    * @param[in,out] gesture     Pass in current gesture, outputs result of blend.
 223    * @param[in]     lastGesture Pass in gesture to blend between.
 224    */
 225   void BlendPoints( PanInfo& gesture, PanInfo& lastGesture, float blendValue );
 226
 227   /**
 228    * Called by the update manager so that we can update the value of our properties.
 229    * @param[in]  nextRenderTime  The estimated time of the next render (in milliseconds).
 230    * @return true, if properties were updated.
 231    */
 232   bool UpdateProperties( unsigned int lastRenderTime, unsigned int nextRenderTime );
 233
 234   /**
 235    * Retrieves a reference to the panning flag property.
 236    * @return The panning flag property.
 237    */
 238   const GesturePropertyBool& GetPanningProperty() const;
 239
 240   /**
 241    * Retrieves a reference to the screen position property.
 242    * @return The screen position property.
 243    */
 244   const GesturePropertyVector2& GetScreenPositionProperty() const;
 245
 246   /**
 247    * Retrieves a reference to the screen velocity property.
 248    * @return The screen velocity property.
 249    */
 250   const GesturePropertyVector2& GetScreenVelocityProperty() const;
 251
 252   /**
 253    * Retrieves a reference to the screen displacement property.
 254    * @return The screen displacement property.
 255    */
 256   const GesturePropertyVector2& GetScreenDisplacementProperty() const;
 257
 258   /**
 259    * Retrieves a reference to the local position property.
 260    * @return The local position property.
 261    */
 262   const GesturePropertyVector2& GetLocalPositionProperty() const;
 263
 264   /**
 265    * Retrieves a reference to the local displacement property.
 266    * @return The local displacement property.
 267    */
 268   const GesturePropertyVector2& GetLocalDisplacementProperty() const;
 269
 270   /**
 271    * Retrieves a reference to the local velocity property.
 272    * @return The local velocity property.
 273    */
 274   const GesturePropertyVector2& GetLocalVelocityProperty() const;
 275
 276   /**
 277    * @brief Sets the prediction mode of the pan gesture
 278    *
 279    * @param[in] mode The prediction mode
 280    */
 281   void SetPredictionMode(PredictionMode mode);
 282
 283   /**
 284    * @brief Sets the prediction amount of the pan gesture
 285    *
 286    * @param[in] amount The prediction amount in milliseconds
 287    */
 288   void SetPredictionAmount(unsigned int amount);
 289
 290   /**
 291    * @brief Sets the upper bound of the prediction amount for clamping
 292    *
 293    * @param[in] amount The prediction amount in milliseconds
 294    */
 295   void SetMaximumPredictionAmount(unsigned int amount);
 296
 297   /**
 298    * @brief Sets the lower bound of the prediction amount for clamping
 299    *
 300    * @param[in] amount The prediction amount in milliseconds
 301    */
 302   void SetMinimumPredictionAmount(unsigned int amount);
 303
 304   /**
 305    * @brief Sets the amount of prediction interpolation to adjust when the pan velocity is changed
 306    *
 307    * @param[in] amount The prediction amount in milliseconds
 308    */
 309   void SetPredictionAmountAdjustment(unsigned int amount);
 310
 311   /**
 312    * @brief Sets the prediction mode of the pan gesture
 313    *
 314    * @param[in] mode The prediction mode
 315    */
 316   void SetSmoothingMode(SmoothingMode mode);
 317
 318   /**
 319    * @brief Sets the amount of smoothing to apply for the current smoothing mode
 320    *
 321    * @param[in] amount The amount of smoothing [0.0f,1.0f]
 322    */
 323   void SetSmoothingAmount(float amount);
 324
 325   /*
 326    * @brief Sets whether to use actual times of the real gesture and frames or not.
 327    *
 328    * @param[in] value True = use actual times, False = use perfect values
 329    */
 330   void SetUseActualTimes( bool value );
 331
 332   /**
 333    * @brief Sets the interpolation time range (ms) of past points to use (with weights) when interpolating.
 334    *
 335    * @param[in] value Time range in ms
 336    */
 337   void SetInterpolationTimeRange( int value );
 338
 339   /**
 340    * @brief Sets whether to use scalar only prediction, which when enabled, ignores acceleration.
 341    *
 342    * @param[in] value True = use scalar prediction only
 343    */
 344   void SetScalarOnlyPredictionEnabled( bool value );
 345
 346   /**
 347    * @brief Sets whether to use two point prediction. This combines two interpolated points to get more steady acceleration and velocity values.
 348    *
 349    * @param[in] value True = use two point prediction
 350    */
 351   void SetTwoPointPredictionEnabled( bool value );
 352
 353   /**
 354    * @brief Sets the time in the past to interpolate the second point when using two point interpolation.
 355    *
 356    * @param[in] value Time in past in ms
 357    */
 358   void SetTwoPointInterpolatePastTime( int value );
 359
 360   /**
 361    * @brief Sets the two point velocity bias. This is the ratio of first and second points to use for velocity.
 362    *
 363    * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
 364    */
 365   void SetTwoPointVelocityBias( float value );
 366
 367   /**
 368    * @brief Sets the two point acceleration bias. This is the ratio of first and second points to use for acceleration.
 369    *
 370    * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
 371    */
 372   void SetTwoPointAccelerationBias( float value );
 373
 374   /**
 375    * @brief Sets the range of time (ms) of points in the history to perform multitap smoothing with (if enabled).
 376    *
 377    * @param[in] value Time in past in ms
 378    */
 379   void SetMultitapSmoothingRange( int value );
 380
 381   /**
 382    * Called to provide pan-gesture profiling information.
 383    */
 384   void EnableProfiling();
 385
 386   /**
 387    * Reset default properties, custom ones not supported due to this being the only object in scene side
 388    * @param updateBufferIndex index to use
 389    */
 390   void ResetDefaultProperties( BufferIndex updateBufferIndex );
 391
 392 private:
 393
 394   /**
 395    * Protected constructor.
 396    */
 397   PanGesture();
 398
 399   // Undefined
 400   PanGesture(const PanGesture&);
 401
 402 private:
 403
 404   // Struct to keep pairs of local and screen data together.
 405   // TODO: This can encapsulate some functionality also.
 406   using RelativeVectors = struct
 407
 408   {
 409     Vector2 local;
 410
 411     Vector2 screen;
 412   };
 413
 414   /**
 415    * Houses new code to process input events and generate an output point.
 416    *
 417    * @param[in]  lastVSyncTime The time of the last render (in milliseconds)
 418    * @param[in]  nextVSyncTime The estimated time of the next render (in milliseconds)
 419    */
 420   bool NewAlgorithm( unsigned int lastVSyncTime, unsigned int nextVSyncTime );
 421
 422   /**
 423    * Gets the (absolute) time difference between two times.
 424    * This is limited by minimumDelta, so it can be safe to use as a divisor.
 425    * This function is wrapped so that the behviour can be overridden to return a "perfect" time difference (overrideDifference).
 426    *
 427    * @param[in]  timeA The first time to calculate from
 428    * @param[in]  timeB The second time to calculate from
 429    * @param[in]  minimumDelta The smallest amount the difference can become
 430    * @param[in]  overrideDifference The time difference to return if using perfect times
 431    */
 432   inline float GetDivisibleTimeDifference( int timeA, int timeB, float minimumDelta, float overrideDifference );
 433
 434   /**
 435    * This limits the change currentAcceleration can have over lastAcceleration by the specified changeLimit value.
 436    *
 437    * @param[in]  currentAcceleration The acceleration to modify
 438    * @param[in]  lastAcceleration The acceleration to limit against
 439    * @param[in]  changeLimit The maximum change (in either direction)
 440    */
 441   void LimitAccelerationChange( RelativeVectors& currentAcceleration, RelativeVectors& lastAcceleration, float changeLimit );
 442
 443   /**
 444    * Reads all events received this frame into a linear buffer.
 445    * A lock is held while this is done.
 446    */
 447   unsigned int ReadFrameEvents();
 448
 449   /**
 450    * Converts between input rate and internal rate (typically 60Hz internally).
 451    * Also writes to the pan history container.
 452    * TODO: Does not need to return the gesture if it is in the history also, but currently it's used.
 453    * (if rate conversion does not generate a point there are points still in history, but this can been done with a bool property).
 454    *
 455    * @param[out] rateConvertedGesture Result gesture for this frame is writen here.
 456    * @param[in]  eventsThisFrame Number of events to convert
 457    * @param[in]  currentFrameTime Time of the frame we will render to
 458    * @param[in]  lastFrameTime Time of the last rendered frame
 459    * @param[out] justStarted Set to true if we are now starting a new gesture
 460    * @param[out] justFinished Set to true if we are now finishing a gesture
 461    */
 462   bool InputRateConversion( PanInfo& rateConvertedGesture, unsigned int eventsThisFrame,
 463       unsigned int currentFrameTime, unsigned int lastFrameTime, bool& justStarted, bool& justFinished );
 464
 465   /**
 466    * Generates an interpolated point at the specified point in time.
 467    *
 468    * @param[in]  history of points to use
 469    * @param[in]  currentTime Time of the frame we will render to
 470    * @param[in]  targetTime Time of the point to generate
 471    * @param[in]  range Range of time (each side of target time) to use points from
 472    * @param[out] outPoint Generated point
 473    * @param[out] acceleration Generated acceleration
 474    * @param[in]  outputTimeGranularity Time difference between output point (typically 60Hz)
 475    * @param[in]  eraseUnused Set to true to clean up any history not used by the function
 476    */
 477   bool InterpolatePoint( PanInfoHistory& history, unsigned int currentTime, unsigned int targetTime, unsigned int range,
 478       PanInfo& outPoint, RelativeVectors& acceleration, int outputTimeGranularity, bool eraseUnused );
 479
 480   /**
 481    * Predicts a point in the future, based on the supplied point and acceleration.
 482    * Other user configuration settings are considered.
 483    *
 484    * @param[in] startPoint Starting point to use. Position and velocity are taken from here.
 485    * @param[in] accelerationToUse The acceleration to use.
 486    * @param[out] predictedPoint Generated predicted point
 487    * @param[in]  currentFrameTime Time of the frame we will render to
 488    * @param[in]  previousFrameTime Time of the last rendered frame
 489    * @param[in]  noPreviousData Set to true if we are just starting a gesture
 490    */
 491   void PredictionMode2( PanInfo& startPoint, RelativeVectors& accelerationToUse,
 492       PanInfo& predictedPoint, unsigned int currentFrameTime, unsigned int previousFrameTime, bool noPreviousData );
 493
 494 private:
 495
 496   // Undefined
 497   PanGesture& operator=(const PanGesture&);
 498
 499   // Defines information to be gathered by the gesture reading code.
 500   struct FrameGestureInfo
 501   {
 502     PanGesture::PanInfo frameGesture;
 503     float acceleration;
 504     unsigned int eventsThisFrame;
 505     bool justStarted;
 506     bool justFinished;
 507
 508     FrameGestureInfo()
 509     : acceleration( 0.0f ),
 510       eventsThisFrame( 0 ),
 511       justStarted( false ),
 512       justFinished( false )
 513     {
 514     }
 515   };
 516
 517   /**
 518    * Reads gestures from input, builds history.
 519    * @param[out] info Written to with information about gestures read this frame.
 520    * @param[in] currentTimestamp The time of this frame.
 521    */
 522   bool ReadGestures( FrameGestureInfo& info, unsigned int currentTimestamp );
 523
 524   /**
 525    * Reads gestures from input and resamples data, builds history.
 526    * @param[out] info Written to with information about gestures read this frame.
 527    * @param[in] currentTimestamp The time of this frame.
 528    */
 529   bool ReadAndResampleGestures( FrameGestureInfo& info, unsigned int currentTimestamp );
 530
 531 private:
 532
 533   // Properties
 534   GesturePropertyBool    mPanning;            ///< panning flag
 535   GesturePropertyVector2 mScreenPosition;     ///< screenPosition
 536   GesturePropertyVector2 mScreenDisplacement; ///< screenDisplacement
 537   GesturePropertyVector2 mScreenVelocity;     ///< screenVelocity
 538   GesturePropertyVector2 mLocalPosition;      ///< localPosition
 539   GesturePropertyVector2 mLocalDisplacement;  ///< localDisplacement
 540   GesturePropertyVector2 mLocalVelocity;      ///< localVelocity
 541
 542   PanInfoHistory mPanHistory;
 543   PanInfoHistory mPredictionHistory;
 544   PanInfo mGestures[PAN_GESTURE_HISTORY];     ///< Circular buffer storing the 4 most recent gestures.
 545   PanInfo mReadGestures[PAN_GESTURE_HISTORY]; ///< Linear buffer storing the most recent gestures (to reduce read lock time).
 546   PanInfo mLastGesture;                       ///< The last gesture. (last update frame).
 547   PanInfo mTargetGesture;                     ///< The most recent input gesture, if the current used gesture does not match.
 548   PanInfo mLastUnmodifiedGesture;             ///< The last gesture before any processing was done on it.
 549   PanInfo mLastSecondInterpolatedPoint;       ///< Stores the last second interpolated point we generated.
 550   PanInfo mLastFrameReadGesture;              ///< Stores the last gesture read.
 551   PanInfo mLastPredictedPoint;                ///< Stores the last predicted point we generated.
 552   RelativeVectors mLastAcceleration;          ///< Stores the acceleration value from the acceleration limiting last frame.
 553   RelativeVectors mLastInterpolatedAcceleration;  ///< Stores the second interpolated point acceleration value from the last frame.
 554   RelativeVectors mLastInitialAcceleration;   ///< Stores the initial acceleration value from the last frame.
 555
 556   volatile unsigned int mWritePosition;       ///< The next PanInfo buffer to write to. (starts at 0).
 557   unsigned int mReadPosition;                 ///< The next PanInfo buffer to read. (starts at 0).
 558   bool mNotAtTarget;                          ///< Keeps track of if the last gesture used was the most recent received.
 559   bool mInGesture;                            ///< True if the gesture is currently being handled i.e. between STARTED <-> FINISHED/CANCELLED.
 560   bool mPredictionAmountOverridden;
 561   bool mSmoothingAmountOverridden;
 562
 563   PanGestureProfiling* mProfiling;            ///< NULL unless pan-gesture profiling information is required.
 564   Dali::Mutex mMutex;                         ///< Mutex to lock access.
 565
 566   // Environment variables:
 567
 568   PredictionMode mPredictionMode;             ///< The pan gesture prediction mode
 569   unsigned int mPredictionAmount;             ///< how far into future to predict in milliseconds
 570   unsigned int mCurrentPredictionAmount;      ///< the current prediction amount used by the prediction algorithm
 571   unsigned int mMaxPredictionAmount;          ///< the maximum prediction amount used by the prediction algorithm
 572   unsigned int mMinPredictionAmount;          ///< the minimum prediction amount used by the prediction algorithm
 573   unsigned int mPredictionAmountAdjustment;   ///< the prediction amount to adjust in milliseconds when pan velocity changes
 574   SmoothingMode mSmoothingMode;               ///< The pan gesture prediction mode
 575   float         mSmoothingAmount;             ///< How much smoothing to apply [0.0f,1.0f]
 576   bool mUseActualTimes;                       ///< Disable to optionally override actual times if they make results worse.
 577   int mInterpolationTimeRange;                ///< Time into past history (ms) to use points to interpolate the first point.
 578   bool mScalarOnlyPredictionEnabled;          ///< If enabled, prediction is done using velocity alone (no integration or acceleration).
 579   bool mTwoPointPredictionEnabled;            ///< If enabled, a second interpolated point is predicted and combined with the first to get more stable values.
 580   int mTwoPointPastInterpolateTime;           ///< The target time in the past to generate the second interpolated point.
 581   float mTwoPointVelocityBias;                ///< The ratio of first and second interpolated points to use for velocity. 0.0f = 100% of first point. 1.0f = 100% of second point.
 582   float mTwoPointAccelerationBias;            ///< The ratio of first and second interpolated points to use for acceleration. 0.0f = 100% of first point. 1.0f = 100% of second point.
 583   int mMultiTapSmoothingRange;                ///< The range in time (ms) of points in the history to smooth the final output against.
 584 };
 585
 586 } // namespace SceneGraph
 587
 588 } // namespace Internal
 589
 590 } // namespace Dali
 591
 592 #endif // DALI_INTERNAL_SCENE_GRAPH_PAN_GESTURE_H