capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_H__
   2 #define __DALI_TOOLKIT_SCROLL_VIEW_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class ScrollView;
  38 }
  39
  40 /**
  41  * @brief The snap type
  42  */
  43 enum SnapType
  44 {
  45   Snap,  ///< Snap
  46   Flick  ///< Flick
  47 };
  48
  49 /**
  50  * @brief DirectionBias types.
  51  */
  52 enum DirectionBias
  53 {
  54   DirectionBiasLeft  = -1,  ///< Bias scroll snap to Left
  55   DirectionBiasNone  =  0,  ///< Don't bias scroll snap
  56   DirectionBiasRight =  1   ///< Bias scroll snap to Right
  57 };
  58
  59 /**
  60  * @brief Used for specifying minimum/maximum extents of a ruler.
  61  */
  62 class RulerDomain
  63 {
  64 public:
  65
  66   /**
  67    * @brief Creates Ruler domain allowing a point to traverse between min and max extents.
  68    *
  69    * @param[in] min Minimum extent (point cannot traverse less than this)
  70    * @param[in] max Maximum extent (point cannot traverse greater than this)
  71    * @param[in] enabled Whether domain has been enabled or not.
  72    */
  73   explicit RulerDomain(float min, float max, bool enabled = true);
  74
  75 public:
  76
  77   float min;    ///< Minimum extent (point cannot traverse less than this)
  78   float max;    ///< Maximum extent (point cannot traverse greater than this)
  79   bool enabled; ///< Whether domain has been enabled or not.
  80
  81   /**
  82    * @brief Clamps value (x) from (min) to (max).
  83    *
  84    * An optional length parameter can be specified to suggest that the
  85    * subject is not a point but a line to that should be clamped.
  86    *
  87    * @param[in] x X point to be clamped between (min) and (max) extents.
  88    * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
  89    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
  90    * @return The clamped value.
  91    */
  92   float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
  93
  94   /**
  95    * @brief Clamps value (x) from (min) to (max).
  96    *
  97    * An optional length parameter can be specified to suggest that the
  98    * subject is not a point but a line to that should be clamped.
  99    *
 100    * @param[in] x X point to be clamped between (min) and (max) extents.
 101    * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
 102    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
 103    * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
 104    * @return The clamped value.
 105    */
 106   float Clamp(float x, float length, float scale, ClampState &clamped) const;
 107
 108   /**
 109    * @brief Returns (max-min) size of ruler.
 110    *
 111    * @return The size of the ruler from min to max.
 112    */
 113   float GetSize() const;
 114
 115 };
 116
 117 /**
 118  * @brief Abstract class to define scroll axes.
 119  *
 120  * It can specify whether they are traversable, where their snap
 121  * points are and their domain.
 122  */
 123 class Ruler : public RefObject
 124 {
 125 public:
 126   /// @brief The type of the ruler
 127   enum RulerType {
 128     Fixed,  ///< A fixed ruler
 129     Free    ///< A free ruler
 130   };
 131
 132 public:
 133
 134   /**
 135    * @brief Constructs ruler, default enabled, with limitless domain.
 136    */
 137   Ruler();
 138
 139   /**
 140    * @brief Snaps (x) in accordance to the ruler settings.
 141    *
 142    * @param[in] x The input value on the ruler to be snapped.
 143    * @param[in] bias (optional) The biasing employed for snapping
 144    * 0 floor input (floor x) "Used for Flick Left"
 145    * 0.5 round input (floor x + 0.5) "Used for Release"
 146    * 1 ceil input (floor x + 1.0) "Used for Flick Right"
 147    * @return The position of the one dimensional point passed in once snapped.
 148    */
 149   virtual float Snap(float x, float bias = 0.5f) const = 0;
 150
 151   /**
 152    * @brief Returns position from page, based on whatever the ruler
 153    * defines as a page.
 154    *
 155    * If (wrap) is true, then will set volume to the number of
 156    * times page has exceeded the domain's volume (volume being the
 157    * number of pages within the domain), while wrapping the position
 158    * within the domain.
 159    *
 160    * @param[in] page The page index
 161    * @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled)
 162    * @param[in] wrap Enable wrap mode
 163    * @return The position representing this page point.
 164    */
 165   virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const = 0;
 166
 167   /**
 168    * @brief Returns page from position, based on whatever the ruler
 169    * defines as a page.
 170    *
 171    * If (wrap) is true, then will return a page wrapped within the domain.
 172    *
 173    * @param[in] position The position on the domain
 174    * @param[in] wrap Enable wrap mode
 175    * @return The page where this position resides.
 176    */
 177   virtual unsigned int GetPageFromPosition(float position, bool wrap) const = 0;
 178
 179   /**
 180    * @brief Returns the total number of pages within this Ruler.
 181    *
 182    * @return The number of pages in the Ruler.
 183    */
 184   virtual unsigned int GetTotalPages() const = 0;
 185
 186 public:
 187
 188   /**
 189    * @brief Gets the ruler type.
 190    *
 191    * @return The ruler type.
 192    */
 193   Ruler::RulerType GetType() const;
 194
 195   /**
 196    * @brief Returns whether this axis has been enabled or not.
 197    *
 198    * @return true if axis is enabled
 199    */
 200   bool IsEnabled() const;
 201
 202   /**
 203    * @brief Enables ruler (ruler must be enabled in order to traverse along it).
 204    */
 205   void Enable();
 206
 207   /**
 208    * @brief Disables ruler.
 209    */
 210   void Disable();
 211
 212   /**
 213    * @brief Sets Domain.
 214    *
 215    * @param[in] domain Ruler domain object.
 216    */
 217   void SetDomain(RulerDomain domain);
 218
 219   /**
 220    * @brief Gets Domain.
 221    *
 222    * @return The domain
 223    */
 224   const RulerDomain &GetDomain() const;
 225
 226   /**
 227    * @brief Disables Domain (minimum/maximum extents for this axis).
 228    */
 229   void DisableDomain();
 230
 231   /**
 232    * @brief Clamps value (x) from (min) to (max).
 233    *
 234    * An optional length parameter can be specified to suggest that the
 235    * subject is not a point but a line that should be clamped.
 236    *
 237    * @param[in] x X point to be clamped between (min) and (max) extents.
 238    * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
 239    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
 240    * @return The clamped value.
 241    */
 242   float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
 243
 244
 245   /**
 246    * @brief Clamps value (x) from (min) to (max).
 247    *
 248    * An optional length parameter can be specified to suggest that the
 249    * subject is not a point but a line to that should be clamped.
 250    *
 251    * @param[in] x X point to be clamped between (min) and (max) extents.
 252    * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
 253    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
 254    * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
 255    * @return The clamped value.
 256    */
 257   float Clamp(float x, float length, float scale, ClampState &clamped) const;
 258
 259   /**
 260    * @brief Snaps and Clamps (x) in accordance to ruler settings.
 261    *
 262    * @param[in] x value to be snapped in accordance to ruler snap value,
 263    *            and clamped in accordance to the ruler's domain (if set).
 264    * @param[in] bias (optional) The biasing employed for snapping
 265    *            0 floor input (floor x) "Used for Flick Left"
 266    *            0.5 round input (floor x + 0.5) "Used for Release"
 267    *            1 ceil input (floor x + 1.0) "Used for Flick Right"
 268    * @param[in] length (optional) The Length of the line from (x) to (x + length)
 269    *            to be clamped.
 270    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
 271    * @return the clamped value after snapping
 272    */
 273   float SnapAndClamp(float x, float bias = 0.5f, float length = 0.0f, float scale = 1.0f) const;
 274
 275   /**
 276    * @brief Snaps and Clamps (x) in accordance to ruler settings.
 277    *
 278    * @param[in] x value to be snapped in accordance to ruler snap value,
 279    *            and clamped in accordance to the ruler's domain (if set).
 280    * @param[in] bias (optional) The biasing employed for snapping
 281    * 0 floor input (floor x) "Used for Flick Left"
 282    * 0.5 round input (floor x + 0.5) "Used for Release"
 283    * 1 ceil input (floor x + 1.0) "Used for Flick Right"
 284    * @param[in] length (optional) The Length of the line from (x) to (x + length)
 285    * to be clamped.
 286    * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
 287    * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
 288    * @return The clamped value after snapping
 289    */
 290   float SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const;
 291
 292 protected:
 293
 294   /**
 295    * @brief Destructor - A reference counted object may only be deleted by calling Unreference().
 296    */
 297   virtual ~Ruler();
 298
 299 protected:
 300
 301   RulerType mType;               ///< Type of Ruler (Fixed or Free).
 302   bool mEnabled;                 ///< If the ruler is enabled.
 303   RulerDomain mDomain;           ///< The domain of the ruler.
 304
 305 };
 306
 307 typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object
 308
 309 /**
 310  * @brief Concrete implementation of Ruler that has no snapping and has one single page.
 311  */
 312 class DefaultRuler : public Ruler
 313 {
 314 public:
 315   /**
 316    * @brief DefaultRuler constructor.
 317    */
 318   DefaultRuler();
 319
 320   /**
 321    * @copydoc Toolkit::Ruler::Snap
 322    */
 323   virtual float Snap(float x, float bias) const;
 324
 325   /**
 326    * @copydoc Toolkit::Ruler::GetPositionFromPage
 327    */
 328   virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
 329
 330   /**
 331    * @copydoc Toolkit::Ruler::GetPageFromPosition
 332    */
 333   virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
 334
 335   /**
 336    * @copydoc Toolkit::Ruler::GetTotalPages
 337    */
 338   virtual unsigned int GetTotalPages() const;
 339 };
 340
 341 /**
 342  * @brief Concrete implementation of Ruler that has fixed snapping.
 343  */
 344 class FixedRuler : public Ruler
 345 {
 346 public:
 347   /**
 348    * @brief Constructor
 349    *
 350    * @param[in] spacing The spacing between each interval on this ruler.
 351    */
 352   FixedRuler(float spacing = 1.0f);
 353
 354   /**
 355    * @copydoc Toolkit::Ruler::Snap
 356    */
 357   virtual float Snap(float x, float bias) const;
 358
 359   /**
 360    * @copydoc Toolkit::Ruler::GetPositionFromPage
 361    */
 362   virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
 363
 364   /**
 365    * @copydoc Toolkit::Ruler::GetPageFromPosition
 366    */
 367   virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
 368
 369   /**
 370    * @copydoc Toolkit::Ruler::GetTotalPages
 371    */
 372   virtual unsigned int GetTotalPages() const;
 373
 374 private:
 375   float mSpacing; ///< The spacing between each interval
 376 };
 377
 378 class ScrollViewEffect;
 379 class ScrollView;
 380
 381 /**
 382  * @brief ScrollView contains actors that can be scrolled manually (via touch)
 383  * or automatically.
 384  */
 385 class ScrollView : public Scrollable
 386 {
 387 public:
 388   /// Page effect types
 389   enum PageEffect
 390   {
 391     PageEffectNone,      ///< No Effect (Standard ScrollView)
 392     PageEffectOuterCube, ///< 3D Rotating Cube Effect
 393     PageEffectDepth,     ///< Depth Effect
 394     PageEffectInnerCube, ///< Page Cube Effect
 395     PageEffectCarousel,  ///< Page Carousel Effect
 396     PageEffectSpiral,    ///< Page Spiral Effect
 397
 398     Total                ///< The total number of effect types
 399   };
 400
 401   // Custom properties
 402
 403   static const std::string SCROLL_PAGE_CURRENT;                         ///< Property, name "scroll-page-current",       type INT
 404   static const std::string SCROLL_TIME_PROPERTY_NAME;                   ///< Property, name "scroll-time",               type FLOAT
 405   static const std::string SCROLL_POSITION_PROPERTY_NAME;               ///< Property, name "scroll-position",           type VECTOR3
 406   static const std::string SCROLL_PRE_POSITION_PROPERTY_NAME;           ///< Property, name "scroll-pre-position",       type VECTOR3
 407   static const std::string SCROLL_OVERSHOOT_X_PROPERTY_NAME;            ///< Property, name "scroll-overshoot-x",         type float
 408   static const std::string SCROLL_OVERSHOOT_Y_PROPERTY_NAME;            ///< Property, name "scroll-overshoot-y",         type float
 409   static const std::string SCROLL_FINAL_PROPERTY_NAME;                  ///< Property, name "scroll-final",              type VECTOR3
 410   static const std::string SCROLL_X_PROPERTY_NAME;                      ///< Property, name "scroll-x",                  type FLOAT
 411   static const std::string SCROLL_Y_PROPERTY_NAME;                      ///< Property, name "scroll-y",                  type FLOAT
 412   static const std::string SCROLL_SCALE_PROPERTY_NAME;                  ///< Property, name "scroll-scale",              type VECTOR3
 413   static const std::string SCROLL_WRAP_PROPERTY_NAME;                   ///< Property, name "scroll-wrap",               type BOOLEAN
 414   static const std::string SCROLL_PANNING_PROPERTY_NAME;                ///< Property, name "scroll-panning",            type BOOLEAN
 415   static const std::string SCROLL_SCROLLING_PROPERTY_NAME;              ///< Property, name "scroll-scrolling",          type BOOLEAN
 416   static const std::string SCROLL_POSITION_DELTA_PROPERTY_NAME;         ///< Property, name "scroll-position-delta"      type VECTOR3
 417   static const std::string SCROLL_START_PAGE_POSITION_PROPERTY_NAME;    ///< Property, name "scroll-start-page-position" type VECTOR3
 418
 419   // Default settings
 420
 421   static const float DEFAULT_SLOW_SNAP_ANIMATION_DURATION;              ///< Default Drag-Release animation time.
 422   static const float DEFAULT_FAST_SNAP_ANIMATION_DURATION;              ///< Default Drag-Flick animation time.
 423   static const float DEFAULT_SNAP_OVERSHOOT_DURATION;                   ///< Default Overshoot snapping animation time.
 424   static const float DEFAULT_MAX_OVERSHOOT;                             ///< Default maximum allowed overshoot
 425
 426   static const float DEFAULT_AXIS_AUTO_LOCK_GRADIENT;                   ///< Default Axis-AutoLock gradient threshold. default is 0.36:1 (20 degrees)
 427   static const float DEFAULT_FRICTION_COEFFICIENT;                      ///< Default Friction Co-efficient. (in stage diagonals per second)
 428   static const float DEFAULT_FLICK_SPEED_COEFFICIENT;                   ///< Default Flick speed coefficient (multiples input touch velocity)
 429   static const float DEFAULT_MAX_FLICK_SPEED;                           ///< Default Maximum flick speed. (in stage diagonals per second)
 430
 431   //Signal Names
 432   static const char* const SIGNAL_SNAP_STARTED; ///< Name "snap-started"
 433
 434   /// Direction of transitions
 435   enum EDirectionFlag
 436   {
 437     DirectionFlagLeft               = 0x01,
 438     DirectionFlagRight              = 0x02,
 439     DirectionFlagUp                 = 0x04,
 440     DirectionFlagDown               = 0x08,
 441     DirectionFlagTransitionOn       = 0x10,            ///< doesnt mean a page is moving towards centre, it affects whether the current page is using values for moving onto screen or off screen, if the user changes scroll direction we dont want things to flip over when in view
 442     DirectionFlagTransitionOff      = 0x20,
 443     DirectionFlagMask_Direction     = DirectionFlagLeft | DirectionFlagRight | DirectionFlagUp | DirectionFlagDown,
 444     DirectionFlagMask_Transition    = DirectionFlagTransitionOn | DirectionFlagTransitionOff
 445   };
 446
 447 public:
 448
 449   /**
 450    * @brief Snap signal event's data.
 451    */
 452   struct SnapEvent
 453   {
 454     SnapType type;    ///< Current snap commencing
 455     Vector3 position; ///< Target snap position
 456     float duration;   ///< Duration of snap animation.
 457   };
 458
 459   typedef SignalV2< void ( const SnapEvent& ) > SnapStartedSignalV2; ///< SnapStarted signal type
 460
 461   /**
 462    * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
 463    * position, scale, rotation for the snap or flick)
 464    */
 465   SnapStartedSignalV2& SnapStartedSignal();
 466
 467 public:
 468
 469   /**
 470    * @brief Creates an empty ScrollView handle.
 471    */
 472   ScrollView();
 473
 474   /**
 475    * @brief Copy constructor.
 476    *
 477    * Creates another handle that points to the same real object
 478    *
 479    * @param[in] handle to copy from
 480    */
 481   ScrollView( const ScrollView& handle );
 482
 483   /**
 484    * @brief Assignment operator.
 485    *
 486    * Changes this handle to point to another real object
 487    * @param[in] handle The handle to copy from
 488    * @return A reference to this
 489    */
 490   ScrollView& operator=( const ScrollView& handle );
 491
 492   /**
 493    * @brief Destructor
 494    *
 495    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 496    */
 497   ~ScrollView();
 498
 499   /**
 500    * @brief Create an initialized ScrollView.
 501    *
 502    * @return A handle to a newly allocated Dali resource.
 503    */
 504   static ScrollView New();
 505
 506   /**
 507    * @brief Downcast an Object handle to ScrollView.
 508    *
 509    * If handle points to a ScrollView the downcast produces valid
 510    * handle. If not the returned handle is left uninitialized.
 511    *
 512    * @param[in] handle Handle to an object
 513    * @return handle to a ScrollView or an uninitialized handle
 514    */
 515   static ScrollView DownCast( BaseHandle handle );
 516
 517 public:
 518
 519   /**
 520    * @brief Get snap-animation's AlphaFunction.
 521    *
 522    * @return Current easing alpha function of the snap animation.
 523    */
 524   AlphaFunction GetScrollSnapAlphaFunction() const;
 525
 526   /**
 527    * @brief Set snap-animation's AlphaFunction.
 528    *
 529    * @param[in] alpha Easing alpha function of the snap animation.
 530    */
 531   void SetScrollSnapAlphaFunction(AlphaFunction alpha);
 532
 533   /**
 534    * @brief Get flick-animation's AlphaFunction.
 535    *
 536    * @return Current easing alpha function of the flick animation.
 537    */
 538   AlphaFunction GetScrollFlickAlphaFunction() const;
 539
 540   /**
 541    * @brief Set flick-animation's AlphaFunction.
 542    *
 543    * @param[in] alpha Easing alpha function of the flick animation.
 544    */
 545   void SetScrollFlickAlphaFunction(AlphaFunction alpha);
 546
 547   /**
 548    * @brief Gets the time for the scroll snap-animation.
 549    *
 550    * This animation occurs when the user drags, and releases.
 551    *
 552    * @return The time in seconds for the animation to take.
 553    */
 554   float GetScrollSnapDuration() const;
 555
 556   /**
 557    * @brief Sets the time for the scroll snap-animation.
 558    *
 559    * This animation occurs when the user drags, and releases.
 560    *
 561    * @param[in] time The time in seconds for the animation to take.
 562    */
 563   void SetScrollSnapDuration(float time);
 564
 565   /**
 566    * @brief Gets the time for the scroll flick-animation.
 567    *
 568    * This animation occurs when the user flicks scroll view.
 569    *
 570    * @return The time in seconds for the animation to take.
 571    */
 572   float GetScrollFlickDuration() const;
 573
 574   /**
 575    * @brief Sets the time for the scroll flick-animation.
 576    *
 577    * This animation occurs when the user flicks scroll view.
 578    *
 579    * @param[in] time The time in seconds for the animation to take.
 580    */
 581   void SetScrollFlickDuration(float time);
 582
 583   /**
 584    * @brief Set X axis ruler.
 585    *
 586    * Defines how scrolling horizontally is snapped, and
 587    * the boundary (domain) in which the ScrollView can pan.
 588    *
 589    * @param[in] ruler The ruler to be used for the X axis
 590    */
 591   void SetRulerX(RulerPtr ruler);
 592
 593   /**
 594    * @brief Set Y axis ruler.
 595    *
 596    * Defines how scrolling vertically is snapped, and the boundary
 597    * (domain) in which the ScrollView can pan.
 598    *
 599    * @param[in] ruler The ruler to be used for the Y axis
 600    */
 601   void SetRulerY(RulerPtr ruler);
 602
 603   /**
 604    * @brief Set Scale-X axis ruler.
 605    *
 606    * Defines how scaling horizontally is snapped, and the extent
 607    * (domain) to which scaling can be performed e.g. 10% to 200%
 608    *
 609    * @param[in] ruler The ruler to be used for the Scale-X axis
 610    *
 611    * @deprecated Scaling not supported
 612    */
 613   void SetRulerScaleX(RulerPtr ruler);
 614
 615   /**
 616    * @brief Set Scale-Y axis ruler.
 617    *
 618    * Defines how scaling vertically is snapped, and the extent
 619    * (domain) to which scaling can be performed e.g. 10% to 200%
 620    *
 621    * @param[in] ruler The ruler to be used for the Scale-Y axis
 622    *
 623    * @deprecated Scaling not supported
 624    */
 625   void SetRulerScaleY(RulerPtr ruler);
 626
 627   /**
 628    * @brief Set Scroll's touch sensitivity.
 629    *
 630    * @note Unlike SetSensitive(), this determines whether this ScrollView
 631    * should react (e.g. pan), without disrupting the sensitivity of it's children.
 632    *
 633    * @param[in] sensitive true to enable scroll, false to disable scrolling
 634    */
 635   void SetScrollSensitive(bool sensitive);
 636
 637   /**
 638    * @brief Set maximum overshoot amount.
 639    *
 640    * The final overshoot value is within 0.0f to 1.0f, but the maximum
 641    * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
 642    * edge of a scrollable area and the maximum overshoot is 100 then
 643    * the final overshoot value will be 0.75f)
 644    *
 645    * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
 646    * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
 647    */
 648   void SetMaxOvershoot(float overshootX, float overshootY);
 649
 650   /**
 651    * @brief Set Snap Overshoot animation's AlphaFunction.
 652    *
 653    * @param[in] alpha Easing alpha function of the overshoot snap animation.
 654    */
 655   void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
 656
 657   /**
 658    * @brief Set Snap Overshoot animation's Duration.
 659    *
 660    * @note Set duration to 0 seconds, to disable Animation.
 661    *
 662    * @param[in] duration The duration of the overshoot snap animation.
 663    */
 664   void SetSnapOvershootDuration(float duration);
 665
 666   /**
 667    * @brief Sets Touches required for pan gestures.
 668    *
 669    * Panning requires number of touches to be within (minTouches) and
 670    * (maxTouches).
 671    *
 672    * If (endOutside) is true, then outside this range of touches,
 673    * the pan gesture will end and thus will snap.
 674    *
 675    * If (endOutside) is false, then outside this range of touches,
 676    * the pan gesture will pause. but will not end until touches = 0.
 677    *
 678    * @param[in] minTouches Minimum touches for panning to occur.
 679    * @param[out] maxTouches Maxiumum touches for panning to occur.
 680    * @param[in] endOutside Whether to end the panning gesture outside of touch range
 681    */
 682   void SetTouchesRequiredForPanning(unsigned int minTouches = 1, unsigned int maxTouches = 1, bool endOutside = true);
 683
 684   /**
 685    * @brief Enables or Disables Actor Auto-Snap mode.
 686    *
 687    * When Actor Auto-Snap mode has been enabled, ScrollView will automatically
 688    * snap to the closest actor (The closest actor will appear in the center of
 689    * the ScrollView).
 690    *
 691    * @param[in] enable Enables (true), or disables (false) Actor AutoSnap
 692    */
 693   void SetActorAutoSnap(bool enable);
 694
 695   /**
 696    * @brief Enables or Disables Wrap mode for ScrollView contents.
 697    *
 698    * When enabled, the ScrollView contents are wrapped over the X/Y Domain.
 699    *
 700    * @note You must apply a position constraint that causes Wrapping
 701    * to all children.
 702    *
 703    * @param[in] enable Enables (true), or disables (false) Wrap Mode.
 704    */
 705   void SetWrapMode(bool enable);
 706
 707   /**
 708    * @deprecated
 709    * @brief Gets the current refresh interval in milliseconds.
 710    *
 711    * @return Current refresh interval in milliseconds
 712    */
 713   int GetRefreshInterval() const;
 714
 715   /**
 716    * @deprecated
 717    * @brief Sets the refresh interval in milliseconds.
 718    *
 719    * The refresh interval is a notification signal
 720    * (SignalScrollUpdate), that is periodically fired when scrolling
 721    * animation is occuring.
 722    *
 723    * When set to 0. No update signals are sent.
 724    *
 725    * @param[in] milliseconds The frequency of the event in milliseconds
 726    */
 727   void SetRefreshInterval(int milliseconds);
 728
 729   /**
 730    * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
 731    *
 732    * @return Current scroll update distance
 733    */
 734   int GetScrollUpdateDistance() const;
 735
 736   /**
 737    * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted
 738    *
 739    * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
 740    * Each time the ScrollView crosses this distance the signal will be emitted
 741    *
 742    * @param[in] distance The distance for ScrollView to move before emitting update signal
 743    */
 744   void SetScrollUpdateDistance(int distance);
 745
 746   /**
 747    * @brief Returns state of Axis Auto Lock mode.
 748    *
 749    * @return Whether Axis Auto Lock mode has been enabled or not.
 750    */
 751   bool GetAxisAutoLock() const;
 752
 753   /**
 754    * @brief Enables or Disables Axis Auto Lock mode for panning within the ScrollView.
 755    *
 756    * When enabled, any pan gesture that appears mostly horizontal or mostly
 757    * vertical, will be automatically restricted to horizontal only or vertical
 758    * only panning, until the pan gesture has completed.
 759    *
 760    * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
 761    */
 762   void SetAxisAutoLock(bool enable);
 763
 764   /**
 765    * @brief Gets the gradient threshold at which a panning gesture
 766    * should be locked to the Horizontal or Vertical axis.
 767    *
 768    * @return The gradient, a value between 0.0 and 1.0f.
 769    */
 770   float GetAxisAutoLockGradient() const;
 771
 772   /**
 773    * @brief Sets the gradient threshold at which a panning gesture should be locked to the
 774    * Horizontal or Vertical axis.
 775    *
 776    * By default this is 0.36 (0.36:1) which means angles less than 20
 777    * degrees to an axis will lock to that axis.
 778    *
 779    * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
 780    * all panning gestures will auto-lock. Either to the horizontal or vertical axis.
 781    *
 782    * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
 783    */
 784   void SetAxisAutoLockGradient(float gradient);
 785
 786   /**
 787    * @brief Gets the friction coefficient setting for ScrollView when
 788    * flicking in free panning mode.
 789    *
 790    * This is a value in stage-diagonals per second^2.
 791    * stage-diagonal = Length( stage.width, stage.height )
 792    * @return Friction coefficient is returned.
 793    */
 794   float GetFrictionCoefficient() const;
 795
 796   /**
 797    * @brief Sets the friction coefficient for ScrollView when flicking
 798    * in free panning mode.
 799    *
 800    * This is a value in stage-diagonals per second^2.
 801    * stage-diagonal = Length( stage.width, stage.height ).
 802    * example:
 803    * A stage 480x800 in size has a diagonal length of 933.
 804    * Friction coefficient of 1.0 means the swipe velocity will
 805    * reduce by 1.0 * 933 pixels/sec^2.
 806    * @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0)
 807    */
 808   void SetFrictionCoefficient(float friction);
 809
 810   /**
 811    * @brief Gets the flick speed coefficient for ScrollView when
 812    * flicking in free panning mode.
 813    *
 814    * This is a constant which multiplies the input touch
 815    * flick velocity to determine the actual velocity at
 816    * which to move the scrolling area.
 817    * @return The flick speed coefficient is returned.
 818    */
 819   float GetFlickSpeedCoefficient() const;
 820
 821   /**
 822    * @brief Sets the flick speed coefficient for ScrollView when
 823    * flicking in free panning mode.
 824    *
 825    * This is a constant which multiplies the input touch
 826    * flick velocity to determine the actual velocity at
 827    * which to move the scrolling area.
 828    * @param[in] speed The flick speed coefficient (default = 1.0).
 829    */
 830   void SetFlickSpeedCoefficient(float speed);
 831
 832   /**
 833    * @brief Returns the minimum pan distance required for a flick gesture in pixels
 834    *
 835    * @return Minimum pan distance vector with separate x and y distance
 836    */
 837   Vector2 GetMinimumDistanceForFlick() const;
 838
 839   /**
 840    * @brief Sets the minimum pan distance required for a flick in pixels
 841    *
 842    * Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed
 843    *
 844    * @param[in] distance The minimum pan distance for a flick
 845    */
 846   void SetMinimumDistanceForFlick( const Vector2& distance );
 847
 848   /**
 849    * @brief Returns the minimum pan speed required for a flick gesture in pixels per second
 850    *
 851    * @return Minimum pan speed
 852    */
 853   float GetMinimumSpeedForFlick() const;
 854
 855   /**
 856    * @brief Sets the minimum pan speed required for a flick in pixels per second
 857    *
 858    * @param[in] speed The minimum pan speed for a flick
 859    */
 860   void SetMinimumSpeedForFlick( float speed );
 861
 862   /**
 863    * @brief Gets the maximum flick speed setting for ScrollView when
 864    * flicking in free panning mode.
 865    *
 866    * This is a value in stage-diagonals per second.
 867    * stage-diagonal = Length( stage.width, stage.height )
 868    * @return Maximum flick speed is returned
 869    */
 870   float GetMaxFlickSpeed() const;
 871
 872   /**
 873    * @brief Sets the maximum flick speed for the ScrollView when
 874    * flicking in free panning mode.
 875    *
 876    * This is a value in stage-diagonals per second.
 877    * stage-diagonal = Length( stage.width, stage.height )
 878    * example:
 879    * A stage 480x800 in size has a diagonal length of 933.
 880    * Max Flick speed of 1.0 means the maximum velocity of
 881    * a swipe can be 1.0 * 933 pixels/sec.
 882    * @param[in] speed Maximum flick speed (default = 3.0)
 883    */
 884   void SetMaxFlickSpeed(float speed);
 885
 886   /**
 887    * @brief Gets the step of scroll distance in actor coordinates for
 888    * each mouse wheel event received in free panning mode.
 889    *
 890    * @return The step of scroll distance(pixel) in X and Y axes.
 891    */
 892   Vector2 GetMouseWheelScrollDistanceStep() const;
 893
 894   /**
 895    * @brief Sets the step of scroll distance in actor coordinates for
 896    * each mouse wheel event received in free panning mode.
 897    *
 898    * @param[in] step The step of scroll distance(pixel) in X and Y axes.
 899    *
 900    * @note: If snap points are defined in the rulers, it will always
 901    * scroll to the next snap point towards the scroll direction while
 902    * receiving the mouse wheel events.
 903    *
 904    */
 905   void SetMouseWheelScrollDistanceStep(Vector2 step);
 906
 907   /**
 908    * @brief Retrieves current scroll position.
 909    *
 910    * @returns The current scroll position.
 911    */
 912   Vector3 GetCurrentScrollPosition() const;
 913
 914   /**
 915    * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place
 916    *        SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function.
 917    *
 918    * @param[in] position The new scroll position to set.
 919    */
 920   void SetScrollPosition(const Vector3& position);
 921
 922   /**
 923    * @brief Retrieves current scroll scale.
 924    *
 925    * @returns The current scroll scale.
 926    *
 927    * @deprecated Scaling not supported
 928    */
 929   Vector3 GetCurrentScrollScale() const;
 930
 931   /**
 932    * @brief Retrieves current scroll page based on ScrollView
 933    * dimensions being the size of one page, and all pages laid out in
 934    * a grid fashion, increasing from left to right until the end of
 935    * the X-domain.
 936    *
 937    * @note: Pages start from 0 as the first page, not 1.
 938    *
 939    * @returns The Current page.
 940    */
 941   unsigned int GetCurrentPage() const;
 942
 943   /**
 944    * @brief Transforms View to position, scale and rotation specified.
 945    *
 946    * @param[in] position The position to transform to.
 947    * @param[in] scale The scale to transform to.
 948    * @param[in] rotation The rotation to transform to.
 949    *
 950    * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&)
 951    */
 952   void TransformTo(const Vector3& position, const Vector3& scale, float rotation);
 953
 954   /**
 955    * @brief Transforms View to position, scale and rotation specified in the duration specified.
 956    *
 957    * @param[in] position The position to transform to.
 958    * @param[in] scale The scale to transform to.
 959    * @param[in] rotation The rotation to transform to.
 960    * @param[in] duration The duration for this animation in seconds.
 961    *
 962    * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&, float)
 963    */
 964   void TransformTo(const Vector3& position, const Vector3& scale, float rotation, float duration);
 965
 966   /**
 967    * @brief Scrolls View to position specified (contents will scroll to this position).
 968    *
 969    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 970    * increasing Y scrolls contents up.
 971    * - If Rulers have been applied to the axes, then the contents will scroll until
 972    * reaching the domain boundary.
 973    * @note Contents will not snap to ruler snap points.
 974    *
 975    * @param[in] position The position to scroll to.
 976    */
 977   void ScrollTo(const Vector3 &position);
 978
 979   /**
 980    * @brief Scrolls View to position specified (contents will scroll to this position).
 981    *
 982    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 983    * increasing Y scrolls contents up.
 984    * - If Rulers have been applied to the axes, then the contents will scroll until
 985    * reaching the domain boundary.
 986    * @note Contents will not snap to ruler snap points.
 987    *
 988    * @param[in] position The position to scroll to.
 989    * @param[in] duration The duration of the animation in seconds
 990    */
 991   void ScrollTo(const Vector3 &position, float duration);
 992
 993   /**
 994    * @brief Scrolls View to position specified (contents will scroll to this position).
 995    *
 996    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 997    * increasing Y scrolls contents up.
 998    * - If Rulers have been applied to the axes, then the contents will scroll until
 999    * reaching the domain boundary.
1000    * @note Contents will not snap to ruler snap points.
1001    * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
1002    * wrap mode, the application developer can decide whether to scroll left or right
1003    * to get to the target page
1004    *
1005    * @param[in] position The position to scroll to.
1006    * @param[in] duration The duration of the animation in seconds
1007    * @param[in] horizontalBias Whether to bias scrolling to left or right.
1008    * @param[in] verticalBias Whether to bias scrolling to top or bottom.
1009    */
1010   void ScrollTo(const Vector3 &position, float duration,
1011                 DirectionBias horizontalBias, DirectionBias verticalBias);
1012
1013   /**
1014    * @brief Scrolls View to page currently based on assumption that each page is
1015    * "(page) * ScrollViewSize.width, 0".
1016    *
1017    * @note Should probably be upgraded so that page is an abstract class, that can be
1018    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1019    * orchestrated in a 2D grid fashion, or variable width.
1020    *
1021    * @param[in] page to scroll to
1022    */
1023   void ScrollTo(unsigned int page);
1024
1025   /**
1026    * @brief Scrolls View to page currently based on assumption that each page is
1027    * "(page) * ScrollViewSize.width, 0".
1028    *
1029    * @note Should probably be upgraded so that page is an abstract class, that can be
1030    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1031    * orchestrated in a 2D grid fashion, or variable width.
1032    *
1033    * @param[in] page to scroll to
1034    * @param[in] duration The duration of the animation in seconds
1035    */
1036   void ScrollTo(unsigned int page, float duration);
1037
1038   /**
1039    * @brief Scrolls View to page currently based on assumption that each page is
1040    * "(page) * ScrollViewSize.width, 0".
1041    *
1042    * @note Should probably be upgraded so that page is an abstract class, that can be
1043    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1044    * orchestrated in a 2D grid fashion, or variable width.
1045    * A biasing parameter is provided such that in scenarios with 2 pages in wrap mode,
1046    * the application developer can decide whether to scroll left or right to get to
1047    * the target page.
1048    *
1049    * @param[in] page to scroll to
1050    * @param[in] duration The duration of the animation in seconds
1051    * @param[in] bias Whether to bias scrolling to left or right.
1052    */
1053   void ScrollTo(unsigned int page, float duration, DirectionBias bias);
1054
1055   /**
1056    * @brief Scrolls View such that actor appears in the center of the ScrollView.
1057    *
1058    * @note Actor must be a direct child of ScrollView, otherwise will
1059    * cause an assertion failure.
1060    * @param[in] actor The actor to center in on (via Scrolling).
1061    */
1062   void ScrollTo(Actor& actor);
1063
1064   /**
1065    * @brief Scrolls View such that actor appears in the center of the ScrollView.
1066    *
1067    * @note Actor must be a direct child of ScrollView, otherwise will
1068    * cause an assertion failure.
1069    * @param[in] actor The actor to center in on (via Scrolling).
1070    * @param[in] duration The duration of the animation in seconds
1071    */
1072   void ScrollTo(Actor& actor, float duration);
1073
1074   /**
1075    * @brief Scrolls View to the nearest snap points as specified by the Rulers.
1076    *
1077    * If already at snap points, then will return false, and not scroll.
1078    *
1079    * @return True if Snapping necessary.
1080    */
1081   bool ScrollToSnapPoint();
1082
1083   /**
1084    * @brief Scales View to (scale).
1085    *
1086    * @param[in] scale The scale factor the animate to.
1087    *
1088    * @deprecated Scaling not supported
1089    */
1090   void ScaleTo(const Vector3& scale);
1091
1092   /**
1093    * @brief Scales View to (scale).
1094    *
1095    * @param[in] scale The scale factor the animate to.
1096    * @param[in] duration The duration of the animation in seconds.
1097    *
1098    * @deprecated Scaling not supported
1099    */
1100   void ScaleTo(const Vector3& scale, float duration);
1101
1102   /**
1103    * @brief Applies a constraint that will affect the children of ScrollView.
1104    *
1105    * @note this affects all existing and future Actors that are added to scrollview.
1106    * @param[in] constraint The constraint to apply
1107    */
1108   void ApplyConstraintToChildren(Constraint constraint);
1109
1110   /**
1111    * @brief Removes all constraints that will affect the children of ScrollView.
1112    *
1113    * @note this removes all constraints from actors that have been added
1114    * to scrollview.
1115    */
1116   void RemoveConstraintsFromChildren();
1117
1118   /**
1119    * @brief Apply Effect to ScrollView.
1120    *
1121    * @param[in] effect The effect to apply to scroll view
1122    */
1123   void ApplyEffect(ScrollViewEffect effect);
1124
1125   /**
1126    * @brief ApplyEffect Applies a predefined effect.
1127    *
1128    * @param[in] effect enum for the predefined effect
1129    * @return The scrollview effect that was applied
1130    */
1131   ScrollViewEffect ApplyEffect(ScrollView::PageEffect effect);
1132
1133   /**
1134    * @brief Remove Effect from ScrollView.
1135    *
1136    * @param[in] effect The effect to remove.
1137    */
1138   void RemoveEffect(ScrollViewEffect effect);
1139
1140   /**
1141    * @brief Remove All Effects from ScrollView.
1142    */
1143   void RemoveAllEffects();
1144
1145   /**
1146    * @brief Binds actor to this ScrollView.
1147    *
1148    * Once an actor is bound to a ScrollView, it will be subject to
1149    * that ScrollView's properties.
1150    *
1151    * @param[in] child The actor to add to this ScrollView.
1152    */
1153   void BindActor(Actor child);
1154
1155   /**
1156    * @brief Unbind Actor from this ScrollView.
1157    *
1158    * Once Unbound, this ScrollView will not affect the actor.
1159    * @note this does not remove the child from the ScrollView container
1160    *
1161    * @param[in] child The actor to be unbound.
1162    */
1163   void UnbindActor(Actor child);
1164
1165   /**
1166    * @brief Allows the user to constrain the scroll view in a particular direction.
1167    *
1168    * @param[in] direction The axis to constrain the scroll-view to.
1169    *                      Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1170    * @param[in] threshold The threshold to apply around the axis.
1171    * @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
1172    */
1173   void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
1174
1175   /**
1176    * @brief Remove a direction constraint from the scroll view.
1177    *
1178    * @param[in] direction The axis to stop constraining to.
1179    *                      Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1180    */
1181   void RemoveScrollingDirection( Radian direction );
1182
1183 public: // Not intended for application developers
1184
1185   /**
1186    * @brief Creates a handle using the Toolkit::Internal implementation.
1187    *
1188    * @param[in]  implementation  The Control implementation.
1189    */
1190   ScrollView(Internal::ScrollView& implementation);
1191
1192   /**
1193    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
1194    *
1195    * @param[in]  internal  A pointer to the internal CustomActor.
1196    */
1197   ScrollView( Dali::Internal::CustomActor* internal );
1198 };
1199
1200 } // namespace Toolkit
1201
1202 } // namespace Dali
1203
1204 /**
1205  * @}
1206  */
1207 #endif // __DALI_TOOLKIT_SCROLL_VIEW_H__