[3.0] pan-gesture code refactor and environment variables
[platform/core/uifw/dali-adaptor.git] / adaptors / base / environment-options.h
index 6dffb2c..a677d2e 100644 (file)
@@ -21,6 +21,9 @@
 // EXTERNAL INCLUDES
 #include <dali/integration-api/debug.h>
 
+// INTERNAL INCLUDES
+#include <base/threading-mode.h>
+
 namespace Dali
 {
 namespace Internal
@@ -79,6 +82,11 @@ public:
   unsigned int GetUpdateStatusLoggingFrequency() const;
 
   /**
+   * @return object profiler status interval ( 0 == off )
+   */
+  unsigned int GetObjectProfilerInterval() const;
+
+  /**
    * @return performance statistics log level ( 0 == off )
    */
   unsigned int GetPerformanceStatsLoggingOptions() const;
@@ -119,6 +127,13 @@ public:
   int GetPanGestureMinimumPredictionAmount() const;
 
   /**
+   * @brief Gets the prediction amount to adjust when the pan velocity is changed.
+   *
+   * If the pan velocity is accelerating, the prediction amount will be increased
+   * by the specified amount until it reaches the upper bound. If the pan velocity
+   * is decelerating, the prediction amount will be decreased by the specified
+   * amount until it reaches the lower bound.
+   *
    * @return pan-gesture prediction amount adjustment
    */
   int GetPanGesturePredictionAmountAdjustment() const;
@@ -134,128 +149,101 @@ public:
   float GetPanGestureSmoothingAmount() const;
 
   /**
-   * @return The minimum distance before a pan can be started (-1 means it's not set)
+   * @return pan-gesture use actual times is true if real gesture and frame times are to be used.
    */
-  int GetMinimumPanDistance() const;
+  int GetPanGestureUseActualTimes() const;
 
   /**
-   * @return The minimum events before a pan can be started (-1 means it's not set)
+   * @return pan-gesture interpolation time range is the time range (ms) of past points to use (with weights) when interpolating.
    */
-  int GetMinimumPanEvents() const;
+  int GetPanGestureInterpolationTimeRange() const;
 
   /**
-   * @return The width of the window
+   * @return pan-gesture scalar only prediction, when enabled, ignores acceleration.
    */
-  unsigned int GetWindowWidth() const;
+  int GetPanGestureScalarOnlyPredictionEnabled() const;
 
   /**
-   * @return The height of the window
+   * @return pan-gesture two point prediction combines two interpolated points to get more steady acceleration and velocity values.
    */
-  unsigned int GetWindowHeight() const;
+  int GetPanGestureTwoPointPredictionEnabled() const;
 
   /**
-   * @brief Sets the mode used to predict pan gesture movement
-   *
-   * @param[in] mode The prediction mode to use
+   * @return pan-gesture two point interpolate past time is the time delta (ms) in the past to interpolate the second point.
    */
-  void SetPanGesturePredictionMode( unsigned int mode );
+  int GetPanGestureTwoPointInterpolatePastTime() const;
 
   /**
-   * @brief Sets the prediction amount of the pan gesture
-   *
-   * @param[in] amount The prediction amount in milliseconds
+   * @return pan-gesture two point velocity bias is the ratio of first and second points to use for velocity.
+   * 0.0f = 100% of first point. 1.0f = 100% of second point.
    */
-  void SetPanGesturePredictionAmount( unsigned int amount );
+  float GetPanGestureTwoPointVelocityBias() const;
 
   /**
-   * @brief Sets the upper bound of the prediction amount for clamping
-   *
-   * @param[in] amount The prediction amount in milliseconds
+   * @return pan-gesture two point acceleration bias is the ratio of first and second points to use for acceleration.
+   * 0.0f = 100% of first point. 1.0f = 100% of second point.
    */
-  void SetPanGestureMaximumPredictionAmount( unsigned int amount );
+  float GetPanGestureTwoPointAccelerationBias() const;
 
   /**
-   * @brief Sets the lower bound of the prediction amount for clamping
-   *
-   * @param[in] amount The prediction amount in milliseconds
+   * @return pan-gesture multitap smoothing range is the range in time (ms) of points in the history to smooth the final output against.
    */
-  void SetPanGestureMinimumPredictionAmount( unsigned int amount );
+  int GetPanGestureMultitapSmoothingRange() const;
 
   /**
-   * @brief Sets the prediction amount to adjust when the pan velocity is changed.
-   * If the pan velocity is accelerating, the prediction amount will be increased
-   * by the specified amount until it reaches the upper bound. If the pan velocity
-   * is decelerating, the prediction amount will be decreased by the specified
-   * amount until it reaches the lower bound.
-   *
-   * @param[in] amount The prediction amount in milliseconds
-   */
-  void SetPanGesturePredictionAmountAdjustment( unsigned int amount );
-
-  /**
-   * @brief Called to set how pan gestures smooth input
-   *
-   * @param[in] mode The smoothing mode to use
+   * @return The minimum distance before a pan can be started (-1 means it's not set)
    */
-  void SetPanGestureSmoothingMode( unsigned int mode );
+  int GetMinimumPanDistance() const;
 
   /**
-   * @brief Sets the mode used to smooth pan gesture movement properties calculated on the Update thread
-   *
-   * @param[in] amount The smoothing amount [0.0f,1.0f] - 0.0f would be no smoothing, 1.0f maximum smoothing
+   * @return The minimum events before a pan can be started (-1 means it's not set)
    */
-  void SetPanGestureSmoothingAmount( float amount );
+  int GetMinimumPanEvents() const;
 
   /**
-   * @brief Sets the minimum distance required before a pan starts
-   *
-   * @param[in] distance The minimum distance before a pan starts
+   * @return The width of the window
    */
-  void SetMinimumPanDistance( int distance );
+  unsigned int GetWindowWidth() const;
 
   /**
-   * @brief Sets the minimum number of events required before a pan starts
-   *
-   * @param[in] events The minimum events before a pan starts
+   * @return The height of the window
    */
-  void SetMinimumPanEvents( int events );
+  unsigned int GetWindowHeight() const;
 
   /**
-   * @brief Sets how often the gles call logging occurs
-   *
-   * @param[in] time the number of seconds between logging output
+   * @brief Get the graphics status time
    */
-  void SetGlesCallTime( int time );
+  int GetGlesCallTime() const;
 
   /**
-   * @brief Get the graphics status time
+   * @brief Get whether or not to accumulate gles call statistics
    */
-  int GetGlesCallTime() const;
+  bool GetGlesCallAccumulate() const;
 
   /**
-   * @brief Sets the width of the window
+   * @return true if performance server is required
    */
-  void SetWindowWidth( int width );
+  bool PerformanceServerRequired() const;
 
   /**
-   * @brief Sets the width of the window
+   * @return Gets the window name.
    */
-  void SetWindowHeight( int height );
+  const std::string& GetWindowName() const;
 
   /**
-   * @return true if performance server is required
+   * @return Gets the window class.
    */
-  bool PerformanceServerRequired() const;
+  const std::string& GetWindowClassName() const;
 
   /**
-   * @brief Sets the window name.
+   * @return The thread mode that DALi should use.
    */
-  void SetWindowName( const char * name );
+  ThreadingMode::Type GetThreadingMode() const;
 
   /**
-   * @return Gets the window name. NULL if not set
+   * @return The render refresh rate.
    */
-  const std::string& GetWindowName() const;
+  unsigned int GetRenderRefreshRate() const;
 
 private: // Internal
 
@@ -268,9 +256,11 @@ private: // Internal
 private: // Data
 
   std::string mWindowName;                        ///< name of the window
+  std::string mWindowClassName;                   ///< name of the class the window belongs to
   unsigned int mNetworkControl;                   ///< whether network control is enabled
   unsigned int mFpsFrequency;                     ///< how often fps is logged out in seconds
   unsigned int mUpdateStatusFrequency;            ///< how often update status is logged out in frames
+  unsigned int mObjectProfilerInterval;           ///< how often object counts are logged out in seconds
   unsigned int mPerformanceStatsLevel;            ///< performance statistics logging bitmask
   unsigned int mPerformanceStatsFrequency;        ///< performance statistics logging frequency (seconds)
   unsigned int mPerformanceTimeStampOutput;       ///< performance time stamp output ( bitmask)
@@ -282,11 +272,22 @@ private: // Data
   int mPanGesturePredictionAmountAdjustment;      ///< adjustment of prediction amount for pan gestures
   int mPanGestureSmoothingMode;                   ///< prediction mode for pan gestures
   float mPanGestureSmoothingAmount;               ///< prediction amount for pan gestures
+  int mPanGestureUseActualTimes;                  ///< Disable to optionally override actual times if they make results worse.
+  int mPanGestureInterpolationTimeRange;          ///< Time into past history (ms) to use points to interpolate the first point.
+  int mPanGestureScalarOnlyPredictionEnabled;     ///< If enabled, prediction is done using velocity alone (no integration or acceleration).
+  int mPanGestureTwoPointPredictionEnabled;       ///< If enabled, a second interpolated point is predicted and combined with the first to get more stable values.
+  int mPanGestureTwoPointInterpolatePastTime;     ///< The target time in the past to generate the second interpolated point.
+  float mPanGestureTwoPointVelocityBias;          ///< The ratio of first and second interpolated points to use for velocity. 0.0f = 100% of first point. 1.0f = 100% of second point.
+  float mPanGestureTwoPointAccelerationBias;      ///< The ratio of first and second interpolated points to use for acceleration. 0.0f = 100% of first point. 1.0f = 100% of second point.
+  int mPanGestureMultitapSmoothingRange;          ///< The range in time (ms) of points in the history to smooth the final output against.
   int mPanMinimumDistance;                        ///< minimum distance required before pan starts
   int mPanMinimumEvents;                          ///< minimum events required before pan starts
   int mGlesCallTime;                              ///< time in seconds between status updates
   unsigned int mWindowWidth;                      ///< width of the window
   unsigned int mWindowHeight;                     ///< height of the window
+  ThreadingMode::Type mThreadingMode;             ///< threading mode
+  unsigned int mRenderRefreshRate;                ///< render refresh rate
+  bool mGlesCallAccumulate;                       ///< Whether or not to accumulate gles call statistics
 
   Dali::Integration::Log::LogFunction mLogFunction;