[dali_2.3.27] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / internal / event / events / pan-gesture / pan-gesture-recognizer.h

diff --git a/dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h b/dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h
index 3babbc7..c1b1f30 100644 (file)
--- a/dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h
+++ b/dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_EVENT_PAN_GESTURE_RECOGNIZER_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
  */
 
 // EXTERNAL INCLUDES
-#include <cstdint> // uint32_t
 #include <dali/public-api/common/vector-wrapper.h>
 #include <dali/public-api/math/vector2.h>
+#include <cstdint> // uint32_t
 
 // INTERNAL INCLUDES
 #include <dali/internal/event/events/gesture-recognizer.h>
@@ -29,17 +29,15 @@
 
 namespace Dali
 {
-
 namespace Integration
 {
 class Core;
 struct TouchEvent;
 
-}
+} // namespace Integration
 
 namespace Internal
 {
-
 struct PanGestureRequest;
 /**
  * When given a set of touch events, this detector attempts to determine if a pan gesture has taken place.
@@ -47,15 +45,16 @@ struct PanGestureRequest;
 class PanGestureRecognizer : public GestureRecognizer
 {
 public:
-
   using Observer = RecognizerObserver<PanGestureEvent>;
 
   /**
    * Constructor
-   * @param[in]  screenSize  The size of the screen.
-   * @param[in]  request     The details of the request.
+   * @param[in] screenSize       The size of the screen.
+   * @param[in] request          The details of the request.
+   * @param[in] minimumDistance  The minimum required motion distance to start pan gesture. If this value is less than 0, we use default setuped distance.
+   * @param[in] minimumPanEvents The minimum required motion event number to start pan gesture. If this value is less than 1, we use default setuped number.
    */
-  PanGestureRecognizer( Observer& observer, Vector2 screenSize, const PanGestureRequest& request, int32_t minimumDistance, int32_t minimumPanEvents);
+  PanGestureRecognizer(Observer& observer, Vector2 screenSize, const PanGestureRequest& request, int32_t minimumDistance, int32_t minimumPanEvents);
 
   /**
    * Virtual destructor.
@@ -63,6 +62,17 @@ public:
   ~PanGestureRecognizer() override;
 
 public:
+  /**
+   * This method sets the minimum distance to start a pan
+   * @param[in] minimumDistance The distance in pixels
+   */
+  void SetMinimumDistance(int32_t minimumDistance);
+
+  /**
+   * Sets the minimum touch events required before a pan can be started
+   * @param[in] minimumPanEvents The number of touch events
+   */
+  void SetMinimumPanEvents(int32_t minimumPanEvents);
 
   /**
    * @copydoc Dali::Internal::GestureDetector::SendEvent(const Integration::TouchEvent&)
@@ -75,7 +85,6 @@ public:
   void Update(const GestureRequest& request) override;
 
 private:
-
   /**
    * Emits the pan gesture event (performs some smoothing operation).
    * @param[in]  state         The state of the pan.
@@ -84,7 +93,6 @@ private:
   void SendPan(GestureState state, const Integration::TouchEvent& currentEvent);
 
 private:
-
   // Reference to the gesture processor for this recognizer
   Observer& mObserver;
 
@@ -100,23 +108,25 @@ private:
     FAILED,   ///< Current touch event data suggests a pan gesture is not possible.
   };
 
-  State mState; ///< The current state of the detector.
-  std::vector<Integration::TouchEvent> mTouchEvents;     ///< A container of all touch events after an initial down event.
+  State                                mState;       ///< The current state of the detector.
+  std::vector<Integration::TouchEvent> mTouchEvents; ///< A container of all touch events after an initial down event.
 
   Vector2 mPrimaryTouchDownLocation;    ///< The initial touch down point.
   Vector2 mThresholdAdjustmentPerFrame; ///< The adjustment per frame at the start of a slow pan.
   Vector2 mPreviousPosition;            ///< The previous position.
 
-  unsigned int mThresholdAdjustmentsRemaining; ///< No. of threshold adjustments still to apply (for a slow-pan).
-  unsigned int mThresholdTotalAdjustments;     ///< The total number of adjustments required.
+  uint32_t mThresholdAdjustmentsRemaining; ///< No. of threshold adjustments still to apply (for a slow-pan).
+  uint32_t mThresholdTotalAdjustments;     ///< The total number of adjustments required.
+
+  uint32_t mPrimaryTouchDownTime;   ///< The initial touch down time.
+  uint32_t mMinimumTouchesRequired; ///< The minimum touches required before a pan should be emitted.
+  uint32_t mMaximumTouchesRequired; ///< The maximum touches after which a pan should not be emitted.
 
-  uint32_t mPrimaryTouchDownTime;       ///< The initial touch down time.
-  unsigned int mMinimumTouchesRequired; ///< The minimum touches required before a pan should be emitted.
-  unsigned int mMaximumTouchesRequired; ///< The maximum touches after which a pan should not be emitted.
+  uint32_t mMinimumDistanceSquared; ///< The minimum distance squared before pan should start.
+  uint32_t mMinimumMotionEvents;    ///< The minimum motion events before pan should start.
+  uint32_t mMotionEvents;           ///< The motion events received so far (before pan is emitted).
 
-  unsigned int mMinimumDistanceSquared; ///< The minimum distance squared before pan should start.
-  unsigned int mMinimumMotionEvents;    ///< The minimum motion events before pan should start.
-  unsigned int mMotionEvents;           ///< The motion events received so far (before pan is emitted).
+  uint32_t mMaximumMotionEventAge; ///< The maximum acceptable motion event age as Milliseconds.
 };
 
 } // namespace Internal