[4.0] pan-gesture code refactor and environment variables

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

diff --git a/dali/internal/event/events/pan-gesture-processor.h b/dali/internal/event/events/pan-gesture-processor.h
index 60fab3e..871e6b4 100644 (file)
--- a/dali/internal/event/events/pan-gesture-processor.h
+++ b/dali/internal/event/events/pan-gesture-processor.h
@@ -2,7 +2,7 @@
 #define __DALI_INTERNAL_PAN_GESTURE_EVENT_PROCESSOR_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
@@ -41,16 +41,15 @@ class Stage;
 namespace SceneGraph
 {
 class PanGesture;
+class UpdateManager;
 }
 
 /**
  * Pan Gesture Event Processing:
  *
- * When we receive a pinch gesture event, we do the following:
- * - Determine the hot actor underneath the current position of the pan gesture event.
- * - Determine whether this actor is, or is a child of, the actor(s) attached to any of the
- *   detectors.
- * - Emit the gesture when all the above conditions are met.
+ * When we receive a pan gesture event, we do the following:
+ * - Find the actor that requires a pan where the pan started from (i.e. the down position).
+ * - Emit the gesture if the event satisfies the detector conditions.
  *
  * The above is only checked when our gesture starts.  We continue sending the pan gesture to the
  * same actor and detector until the pan ends or is cancelled.
@@ -63,18 +62,19 @@ public:
    * Create a pan gesture processor.
    * @param[in] stage The stage.
    * @param[in] gestureManager The gesture manager
+   * @param[in] updateManager The Update Manager
    */
-  PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager );
+  PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager, SceneGraph::UpdateManager& updateManager );
 
   /**
-   * Non-virtual destructor; PanGestureProcessor is not a base class
+   * Destructor
    */
-  ~PanGestureProcessor();
+  virtual ~PanGestureProcessor();
 
 public: // To be called by GestureEventProcessor
 
   /**
-   * This method is called whenever a pinch gesture event occurs.
+   * This method is called whenever a pan gesture event occurs.
    * @param[in] panEvent The event that has occurred.
    */
   void Process( const Integration::PanGestureEvent& panEvent );
@@ -132,6 +132,27 @@ public: // To be called by GestureEventProcessor
   void SetPredictionAmount(unsigned int amount);
 
   /**
+   * @brief Sets the upper bound of the prediction amount for clamping
+   *
+   * @param[in] amount The prediction amount in milliseconds
+   */
+  void SetMaximumPredictionAmount(unsigned int amount);
+
+  /**
+   * @brief Sets the lower bound of the prediction amount for clamping
+   *
+   * @param[in] amount The prediction amount in milliseconds
+   */
+  void SetMinimumPredictionAmount(unsigned int amount);
+
+  /**
+   * @brief Sets the amount of prediction interpolation to adjust when the pan velocity is changed
+   *
+   * @param[in] amount The prediction amount in milliseconds
+   */
+  void SetPredictionAmountAdjustment(unsigned int amount);
+
+  /**
    * Called to set the prediction mode for pan gestures
    *
    * @param[in] mode The prediction mode
@@ -149,6 +170,62 @@ public: // To be called by GestureEventProcessor
    */
   void SetSmoothingAmount(float amount);
 
+  /*
+   * @brief Sets whether to use actual times of the real gesture and frames or not.
+   *
+   * @param[in] value True = use actual times, False = use perfect values
+   */
+  void SetUseActualTimes( bool value );
+
+  /**
+   * @brief Sets the interpolation time range (ms) of past points to use (with weights) when interpolating.
+   *
+   * @param[in] value Time range in ms
+   */
+  void SetInterpolationTimeRange( int value );
+
+  /**
+   * @brief Sets whether to use scalar only prediction, which when enabled, ignores acceleration.
+   *
+   * @param[in] value True = use scalar prediction only
+   */
+  void SetScalarOnlyPredictionEnabled( bool value );
+
+  /**
+   * @brief Sets whether to use two point prediction. This combines two interpolated points to get more steady acceleration and velocity values.
+   *
+   * @param[in] value True = use two point prediction
+   */
+  void SetTwoPointPredictionEnabled( bool value );
+
+  /**
+   * @brief Sets the time in the past to interpolate the second point when using two point interpolation.
+   *
+   * @param[in] value Time in past in ms
+   */
+  void SetTwoPointInterpolatePastTime( int value );
+
+  /**
+   * @brief Sets the two point velocity bias. This is the ratio of first and second points to use for velocity.
+   *
+   * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
+   */
+  void SetTwoPointVelocityBias( float value );
+
+  /**
+   * @brief Sets the two point acceleration bias. This is the ratio of first and second points to use for acceleration.
+   *
+   * @param[in] value 0.0f = 100% first point. 1.0f = 100% of second point.
+   */
+  void SetTwoPointAccelerationBias( float value );
+
+  /**
+   * @brief Sets the range of time (ms) of points in the history to perform multitap smoothing with (if enabled).
+   *
+   * @param[in] value Time in past in ms
+   */
+  void SetMultitapSmoothingRange( int value );
+
 private:
 
   // Undefined