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_SCALE_PROPERTY_NAME;                  ///< Property, name "scroll-scale",              type VECTOR3
 411   static const std::string SCROLL_WRAP_PROPERTY_NAME;                   ///< Property, name "scroll-wrap",               type BOOLEAN
 412   static const std::string SCROLL_PANNING_PROPERTY_NAME;                ///< Property, name "scroll-panning",            type BOOLEAN
 413   static const std::string SCROLL_SCROLLING_PROPERTY_NAME;              ///< Property, name "scroll-scrolling",          type BOOLEAN
 414   static const std::string SCROLL_POSITION_DELTA_PROPERTY_NAME;         ///< Property, name "scroll-position-delta"      type VECTOR3
 415   static const std::string SCROLL_START_PAGE_POSITION_PROPERTY_NAME;    ///< Property, name "scroll-start-page-position" type VECTOR3
 416
 417   // Default settings
 418
 419   static const float DEFAULT_SLOW_SNAP_ANIMATION_DURATION;              ///< Default Drag-Release animation time.
 420   static const float DEFAULT_FAST_SNAP_ANIMATION_DURATION;              ///< Default Drag-Flick animation time.
 421   static const float DEFAULT_SNAP_OVERSHOOT_DURATION;                   ///< Default Overshoot snapping animation time.
 422   static const float DEFAULT_MAX_OVERSHOOT;                             ///< Default maximum allowed overshoot
 423
 424   static const float DEFAULT_AXIS_AUTO_LOCK_GRADIENT;                   ///< Default Axis-AutoLock gradient threshold. default is 0.36:1 (20 degrees)
 425   static const float DEFAULT_FRICTION_COEFFICIENT;                      ///< Default Friction Co-efficient. (in stage diagonals per second)
 426   static const float DEFAULT_FLICK_SPEED_COEFFICIENT;                   ///< Default Flick speed coefficient (multiples input touch velocity)
 427   static const float DEFAULT_MAX_FLICK_SPEED;                           ///< Default Maximum flick speed. (in stage diagonals per second)
 428
 429   //Signal Names
 430   static const char* const SIGNAL_SNAP_STARTED; ///< Name "snap-started"
 431
 432   /// Direction of transitions
 433   enum EDirectionFlag
 434   {
 435     DirectionFlagLeft               = 0x01,
 436     DirectionFlagRight              = 0x02,
 437     DirectionFlagUp                 = 0x04,
 438     DirectionFlagDown               = 0x08,
 439     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
 440     DirectionFlagTransitionOff      = 0x20,
 441     DirectionFlagMask_Direction     = DirectionFlagLeft | DirectionFlagRight | DirectionFlagUp | DirectionFlagDown,
 442     DirectionFlagMask_Transition    = DirectionFlagTransitionOn | DirectionFlagTransitionOff
 443   };
 444
 445 public:
 446
 447   /**
 448    * @brief Snap signal event's data.
 449    */
 450   struct SnapEvent
 451   {
 452     SnapType type;    ///< Current snap commencing
 453     Vector3 position; ///< Target snap position
 454     float duration;   ///< Duration of snap animation.
 455   };
 456
 457   typedef SignalV2< void ( const SnapEvent& ) > SnapStartedSignalV2; ///< SnapStarted signal type
 458
 459   /**
 460    * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
 461    * position, scale, rotation for the snap or flick)
 462    */
 463   SnapStartedSignalV2& SnapStartedSignal();
 464
 465 public:
 466
 467   /**
 468    * @brief Creates an empty ScrollView handle.
 469    */
 470   ScrollView();
 471
 472   /**
 473    * @brief Copy constructor.
 474    *
 475    * Creates another handle that points to the same real object
 476    *
 477    * @param[in] handle to copy from
 478    */
 479   ScrollView( const ScrollView& handle );
 480
 481   /**
 482    * @brief Assignment operator.
 483    *
 484    * Changes this handle to point to another real object
 485    * @param[in] handle The handle to copy from
 486    * @return A reference to this
 487    */
 488   ScrollView& operator=( const ScrollView& handle );
 489
 490   /**
 491    * @brief Destructor
 492    *
 493    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 494    */
 495   ~ScrollView();
 496
 497   /**
 498    * @brief Create an initialized ScrollView.
 499    *
 500    * @return A handle to a newly allocated Dali resource.
 501    */
 502   static ScrollView New();
 503
 504   /**
 505    * @brief Downcast an Object handle to ScrollView.
 506    *
 507    * If handle points to a ScrollView the downcast produces valid
 508    * handle. If not the returned handle is left uninitialized.
 509    *
 510    * @param[in] handle Handle to an object
 511    * @return handle to a ScrollView or an uninitialized handle
 512    */
 513   static ScrollView DownCast( BaseHandle handle );
 514
 515 public:
 516
 517   /**
 518    * @brief Get snap-animation's AlphaFunction.
 519    *
 520    * @return Current easing alpha function of the snap animation.
 521    */
 522   AlphaFunction GetScrollSnapAlphaFunction() const;
 523
 524   /**
 525    * @brief Set snap-animation's AlphaFunction.
 526    *
 527    * @param[in] alpha Easing alpha function of the snap animation.
 528    */
 529   void SetScrollSnapAlphaFunction(AlphaFunction alpha);
 530
 531   /**
 532    * @brief Get flick-animation's AlphaFunction.
 533    *
 534    * @return Current easing alpha function of the flick animation.
 535    */
 536   AlphaFunction GetScrollFlickAlphaFunction() const;
 537
 538   /**
 539    * @brief Set flick-animation's AlphaFunction.
 540    *
 541    * @param[in] alpha Easing alpha function of the flick animation.
 542    */
 543   void SetScrollFlickAlphaFunction(AlphaFunction alpha);
 544
 545   /**
 546    * @brief Gets the time for the scroll snap-animation.
 547    *
 548    * This animation occurs when the user drags, and releases.
 549    *
 550    * @return The time in seconds for the animation to take.
 551    */
 552   float GetScrollSnapDuration() const;
 553
 554   /**
 555    * @brief Sets the time for the scroll snap-animation.
 556    *
 557    * This animation occurs when the user drags, and releases.
 558    *
 559    * @param[in] time The time in seconds for the animation to take.
 560    */
 561   void SetScrollSnapDuration(float time);
 562
 563   /**
 564    * @brief Gets the time for the scroll flick-animation.
 565    *
 566    * This animation occurs when the user flicks scroll view.
 567    *
 568    * @return The time in seconds for the animation to take.
 569    */
 570   float GetScrollFlickDuration() const;
 571
 572   /**
 573    * @brief Sets the time for the scroll flick-animation.
 574    *
 575    * This animation occurs when the user flicks scroll view.
 576    *
 577    * @param[in] time The time in seconds for the animation to take.
 578    */
 579   void SetScrollFlickDuration(float time);
 580
 581   /**
 582    * @brief Set X axis ruler.
 583    *
 584    * Defines how scrolling horizontally is snapped, and
 585    * the boundary (domain) in which the ScrollView can pan.
 586    *
 587    * @param[in] ruler The ruler to be used for the X axis
 588    */
 589   void SetRulerX(RulerPtr ruler);
 590
 591   /**
 592    * @brief Set Y axis ruler.
 593    *
 594    * Defines how scrolling vertically is snapped, and the boundary
 595    * (domain) in which the ScrollView can pan.
 596    *
 597    * @param[in] ruler The ruler to be used for the Y axis
 598    */
 599   void SetRulerY(RulerPtr ruler);
 600
 601   /**
 602    * @brief Set Scale-X axis ruler.
 603    *
 604    * Defines how scaling horizontally is snapped, and the extent
 605    * (domain) to which scaling can be performed e.g. 10% to 200%
 606    *
 607    * @param[in] ruler The ruler to be used for the Scale-X axis
 608    *
 609    * @deprecated Scaling not supported
 610    */
 611   void SetRulerScaleX(RulerPtr ruler);
 612
 613   /**
 614    * @brief Set Scale-Y axis ruler.
 615    *
 616    * Defines how scaling vertically is snapped, and the extent
 617    * (domain) to which scaling can be performed e.g. 10% to 200%
 618    *
 619    * @param[in] ruler The ruler to be used for the Scale-Y axis
 620    *
 621    * @deprecated Scaling not supported
 622    */
 623   void SetRulerScaleY(RulerPtr ruler);
 624
 625   /**
 626    * @brief Set Scroll's touch sensitivity.
 627    *
 628    * @note Unlike SetSensitive(), this determines whether this ScrollView
 629    * should react (e.g. pan), without disrupting the sensitivity of it's children.
 630    *
 631    * @param[in] sensitive true to enable scroll, false to disable scrolling
 632    */
 633   void SetScrollSensitive(bool sensitive);
 634
 635   /**
 636    * @brief Set maximum overshoot amount.
 637    *
 638    * The final overshoot value is within 0.0f to 1.0f, but the maximum
 639    * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
 640    * edge of a scrollable area and the maximum overshoot is 100 then
 641    * the final overshoot value will be 0.75f)
 642    *
 643    * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
 644    * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
 645    */
 646   void SetMaxOvershoot(float overshootX, float overshootY);
 647
 648   /**
 649    * @brief Set Snap Overshoot animation's AlphaFunction.
 650    *
 651    * @param[in] alpha Easing alpha function of the overshoot snap animation.
 652    */
 653   void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
 654
 655   /**
 656    * @brief Set Snap Overshoot animation's Duration.
 657    *
 658    * @note Set duration to 0 seconds, to disable Animation.
 659    *
 660    * @param[in] duration The duration of the overshoot snap animation.
 661    */
 662   void SetSnapOvershootDuration(float duration);
 663
 664   /**
 665    * @brief Sets Touches required for pan gestures.
 666    *
 667    * Panning requires number of touches to be within (minTouches) and
 668    * (maxTouches).
 669    *
 670    * If (endOutside) is true, then outside this range of touches,
 671    * the pan gesture will end and thus will snap.
 672    *
 673    * If (endOutside) is false, then outside this range of touches,
 674    * the pan gesture will pause. but will not end until touches = 0.
 675    *
 676    * @param[in] minTouches Minimum touches for panning to occur.
 677    * @param[out] maxTouches Maxiumum touches for panning to occur.
 678    * @param[in] endOutside Whether to end the panning gesture outside of touch range
 679    */
 680   void SetTouchesRequiredForPanning(unsigned int minTouches = 1, unsigned int maxTouches = 1, bool endOutside = true);
 681
 682   /**
 683    * @brief Enables or Disables Actor Auto-Snap mode.
 684    *
 685    * When Actor Auto-Snap mode has been enabled, ScrollView will automatically
 686    * snap to the closest actor (The closest actor will appear in the center of
 687    * the ScrollView).
 688    *
 689    * @param[in] enable Enables (true), or disables (false) Actor AutoSnap
 690    */
 691   void SetActorAutoSnap(bool enable);
 692
 693   /**
 694    * @brief Enables or Disables Wrap mode for ScrollView contents.
 695    *
 696    * When enabled, the ScrollView contents are wrapped over the X/Y Domain.
 697    *
 698    * @note You must apply a position constraint that causes Wrapping
 699    * to all children.
 700    *
 701    * @param[in] enable Enables (true), or disables (false) Wrap Mode.
 702    */
 703   void SetWrapMode(bool enable);
 704
 705   /**
 706    * @deprecated
 707    * @brief Gets the current refresh interval in milliseconds.
 708    *
 709    * @return Current refresh interval in milliseconds
 710    */
 711   int GetRefreshInterval() const;
 712
 713   /**
 714    * @deprecated
 715    * @brief Sets the refresh interval in milliseconds.
 716    *
 717    * The refresh interval is a notification signal
 718    * (SignalScrollUpdate), that is periodically fired when scrolling
 719    * animation is occuring.
 720    *
 721    * When set to 0. No update signals are sent.
 722    *
 723    * @param[in] milliseconds The frequency of the event in milliseconds
 724    */
 725   void SetRefreshInterval(int milliseconds);
 726
 727   /**
 728    * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
 729    *
 730    * @return Current scroll update distance
 731    */
 732   int GetScrollUpdateDistance() const;
 733
 734   /**
 735    * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted
 736    *
 737    * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
 738    * Each time the ScrollView crosses this distance the signal will be emitted
 739    *
 740    * @param[in] distance The distance for ScrollView to move before emitting update signal
 741    */
 742   void SetScrollUpdateDistance(int distance);
 743
 744   /**
 745    * @brief Returns state of Axis Auto Lock mode.
 746    *
 747    * @return Whether Axis Auto Lock mode has been enabled or not.
 748    */
 749   bool GetAxisAutoLock() const;
 750
 751   /**
 752    * @brief Enables or Disables Axis Auto Lock mode for panning within the ScrollView.
 753    *
 754    * When enabled, any pan gesture that appears mostly horizontal or mostly
 755    * vertical, will be automatically restricted to horizontal only or vertical
 756    * only panning, until the pan gesture has completed.
 757    *
 758    * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
 759    */
 760   void SetAxisAutoLock(bool enable);
 761
 762   /**
 763    * @brief Gets the gradient threshold at which a panning gesture
 764    * should be locked to the Horizontal or Vertical axis.
 765    *
 766    * @return The gradient, a value between 0.0 and 1.0f.
 767    */
 768   float GetAxisAutoLockGradient() const;
 769
 770   /**
 771    * @brief Sets the gradient threshold at which a panning gesture should be locked to the
 772    * Horizontal or Vertical axis.
 773    *
 774    * By default this is 0.36 (0.36:1) which means angles less than 20
 775    * degrees to an axis will lock to that axis.
 776    *
 777    * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
 778    * all panning gestures will auto-lock. Either to the horizontal or vertical axis.
 779    *
 780    * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
 781    */
 782   void SetAxisAutoLockGradient(float gradient);
 783
 784   /**
 785    * @brief Gets the friction coefficient setting for ScrollView when
 786    * flicking in free panning mode.
 787    *
 788    * This is a value in stage-diagonals per second^2.
 789    * stage-diagonal = Length( stage.width, stage.height )
 790    * @return Friction coefficient is returned.
 791    */
 792   float GetFrictionCoefficient() const;
 793
 794   /**
 795    * @brief Sets the friction coefficient for ScrollView when flicking
 796    * in free panning mode.
 797    *
 798    * This is a value in stage-diagonals per second^2.
 799    * stage-diagonal = Length( stage.width, stage.height ).
 800    * example:
 801    * A stage 480x800 in size has a diagonal length of 933.
 802    * Friction coefficient of 1.0 means the swipe velocity will
 803    * reduce by 1.0 * 933 pixels/sec^2.
 804    * @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0)
 805    */
 806   void SetFrictionCoefficient(float friction);
 807
 808   /**
 809    * @brief Gets the flick speed coefficient for ScrollView when
 810    * flicking in free panning mode.
 811    *
 812    * This is a constant which multiplies the input touch
 813    * flick velocity to determine the actual velocity at
 814    * which to move the scrolling area.
 815    * @return The flick speed coefficient is returned.
 816    */
 817   float GetFlickSpeedCoefficient() const;
 818
 819   /**
 820    * @brief Sets the flick speed coefficient for ScrollView when
 821    * flicking in free panning mode.
 822    *
 823    * This is a constant which multiplies the input touch
 824    * flick velocity to determine the actual velocity at
 825    * which to move the scrolling area.
 826    * @param[in] speed The flick speed coefficient (default = 1.0).
 827    */
 828   void SetFlickSpeedCoefficient(float speed);
 829
 830   /**
 831    * @brief Returns the minimum pan distance required for a flick gesture in pixels
 832    *
 833    * @return Minimum pan distance vector with separate x and y distance
 834    */
 835   Vector2 GetMinimumDistanceForFlick() const;
 836
 837   /**
 838    * @brief Sets the minimum pan distance required for a flick in pixels
 839    *
 840    * 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
 841    *
 842    * @param[in] distance The minimum pan distance for a flick
 843    */
 844   void SetMinimumDistanceForFlick( const Vector2& distance );
 845
 846   /**
 847    * @brief Returns the minimum pan speed required for a flick gesture in pixels per second
 848    *
 849    * @return Minimum pan speed
 850    */
 851   float GetMinimumSpeedForFlick() const;
 852
 853   /**
 854    * @brief Sets the minimum pan speed required for a flick in pixels per second
 855    *
 856    * @param[in] speed The minimum pan speed for a flick
 857    */
 858   void SetMinimumSpeedForFlick( float speed );
 859
 860   /**
 861    * @brief Gets the maximum flick speed setting for ScrollView when
 862    * flicking in free panning mode.
 863    *
 864    * This is a value in stage-diagonals per second.
 865    * stage-diagonal = Length( stage.width, stage.height )
 866    * @return Maximum flick speed is returned
 867    */
 868   float GetMaxFlickSpeed() const;
 869
 870   /**
 871    * @brief Sets the maximum flick speed for the ScrollView when
 872    * flicking in free panning mode.
 873    *
 874    * This is a value in stage-diagonals per second.
 875    * stage-diagonal = Length( stage.width, stage.height )
 876    * example:
 877    * A stage 480x800 in size has a diagonal length of 933.
 878    * Max Flick speed of 1.0 means the maximum velocity of
 879    * a swipe can be 1.0 * 933 pixels/sec.
 880    * @param[in] speed Maximum flick speed (default = 3.0)
 881    */
 882   void SetMaxFlickSpeed(float speed);
 883
 884   /**
 885    * @brief Gets the step of scroll distance in actor coordinates for
 886    * each mouse wheel event received in free panning mode.
 887    *
 888    * @return The step of scroll distance(pixel) in X and Y axes.
 889    */
 890   Vector2 GetMouseWheelScrollDistanceStep() const;
 891
 892   /**
 893    * @brief Sets the step of scroll distance in actor coordinates for
 894    * each mouse wheel event received in free panning mode.
 895    *
 896    * @param[in] step The step of scroll distance(pixel) in X and Y axes.
 897    *
 898    * @note: If snap points are defined in the rulers, it will always
 899    * scroll to the next snap point towards the scroll direction while
 900    * receiving the mouse wheel events.
 901    *
 902    */
 903   void SetMouseWheelScrollDistanceStep(Vector2 step);
 904
 905   /**
 906    * @brief Retrieves current scroll position.
 907    *
 908    * @returns The current scroll position.
 909    */
 910   Vector3 GetCurrentScrollPosition() const;
 911
 912   /**
 913    * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place
 914    *        SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function.
 915    *
 916    * @param[in] position The new scroll position to set.
 917    */
 918   void SetScrollPosition(const Vector3& position);
 919
 920   /**
 921    * @brief Retrieves current scroll scale.
 922    *
 923    * @returns The current scroll scale.
 924    *
 925    * @deprecated Scaling not supported
 926    */
 927   Vector3 GetCurrentScrollScale() const;
 928
 929   /**
 930    * @brief Retrieves current scroll page based on ScrollView
 931    * dimensions being the size of one page, and all pages laid out in
 932    * a grid fashion, increasing from left to right until the end of
 933    * the X-domain.
 934    *
 935    * @note: Pages start from 0 as the first page, not 1.
 936    *
 937    * @returns The Current page.
 938    */
 939   unsigned int GetCurrentPage() const;
 940
 941   /**
 942    * @brief Transforms View to position, scale and rotation specified.
 943    *
 944    * @param[in] position The position to transform to.
 945    * @param[in] scale The scale to transform to.
 946    * @param[in] rotation The rotation to transform to.
 947    *
 948    * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&)
 949    */
 950   void TransformTo(const Vector3& position, const Vector3& scale, float rotation);
 951
 952   /**
 953    * @brief Transforms View to position, scale and rotation specified in the duration specified.
 954    *
 955    * @param[in] position The position to transform to.
 956    * @param[in] scale The scale to transform to.
 957    * @param[in] rotation The rotation to transform to.
 958    * @param[in] duration The duration for this animation in seconds.
 959    *
 960    * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&, float)
 961    */
 962   void TransformTo(const Vector3& position, const Vector3& scale, float rotation, float duration);
 963
 964   /**
 965    * @brief Scrolls View to position specified (contents will scroll to this position).
 966    *
 967    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 968    * increasing Y scrolls contents up.
 969    * - If Rulers have been applied to the axes, then the contents will scroll until
 970    * reaching the domain boundary.
 971    * @note Contents will not snap to ruler snap points.
 972    *
 973    * @param[in] position The position to scroll to.
 974    */
 975   void ScrollTo(const Vector3 &position);
 976
 977   /**
 978    * @brief Scrolls View to position specified (contents will scroll to this position).
 979    *
 980    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 981    * increasing Y scrolls contents up.
 982    * - If Rulers have been applied to the axes, then the contents will scroll until
 983    * reaching the domain boundary.
 984    * @note Contents will not snap to ruler snap points.
 985    *
 986    * @param[in] position The position to scroll to.
 987    * @param[in] duration The duration of the animation in seconds
 988    */
 989   void ScrollTo(const Vector3 &position, float duration);
 990
 991   /**
 992    * @brief Scrolls View to position specified (contents will scroll to this position).
 993    *
 994    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 995    * increasing Y scrolls contents up.
 996    * - If Rulers have been applied to the axes, then the contents will scroll until
 997    * reaching the domain boundary.
 998    * @note Contents will not snap to ruler snap points.
 999    * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
1000    * wrap mode, the application developer can decide whether to scroll left or right
1001    * to get to the target page
1002    *
1003    * @param[in] position The position to scroll to.
1004    * @param[in] duration The duration of the animation in seconds
1005    * @param[in] horizontalBias Whether to bias scrolling to left or right.
1006    * @param[in] verticalBias Whether to bias scrolling to top or bottom.
1007    */
1008   void ScrollTo(const Vector3 &position, float duration,
1009                 DirectionBias horizontalBias, DirectionBias verticalBias);
1010
1011   /**
1012    * @brief Scrolls View to page currently based on assumption that each page is
1013    * "(page) * ScrollViewSize.width, 0".
1014    *
1015    * @note Should probably be upgraded so that page is an abstract class, that can be
1016    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1017    * orchestrated in a 2D grid fashion, or variable width.
1018    *
1019    * @param[in] page to scroll to
1020    */
1021   void ScrollTo(unsigned int page);
1022
1023   /**
1024    * @brief Scrolls View to page currently based on assumption that each page is
1025    * "(page) * ScrollViewSize.width, 0".
1026    *
1027    * @note Should probably be upgraded so that page is an abstract class, that can be
1028    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1029    * orchestrated in a 2D grid fashion, or variable width.
1030    *
1031    * @param[in] page to scroll to
1032    * @param[in] duration The duration of the animation in seconds
1033    */
1034   void ScrollTo(unsigned int page, float duration);
1035
1036   /**
1037    * @brief Scrolls View to page currently based on assumption that each page is
1038    * "(page) * ScrollViewSize.width, 0".
1039    *
1040    * @note Should probably be upgraded so that page is an abstract class, that can be
1041    * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1042    * orchestrated in a 2D grid fashion, or variable width.
1043    * A biasing parameter is provided such that in scenarios with 2 pages in wrap mode,
1044    * the application developer can decide whether to scroll left or right to get to
1045    * the target page.
1046    *
1047    * @param[in] page to scroll to
1048    * @param[in] duration The duration of the animation in seconds
1049    * @param[in] bias Whether to bias scrolling to left or right.
1050    */
1051   void ScrollTo(unsigned int page, float duration, DirectionBias bias);
1052
1053   /**
1054    * @brief Scrolls View such that actor appears in the center of the ScrollView.
1055    *
1056    * @note Actor must be a direct child of ScrollView, otherwise will
1057    * cause an assertion failure.
1058    * @param[in] actor The actor to center in on (via Scrolling).
1059    */
1060   void ScrollTo(Actor& actor);
1061
1062   /**
1063    * @brief Scrolls View such that actor appears in the center of the ScrollView.
1064    *
1065    * @note Actor must be a direct child of ScrollView, otherwise will
1066    * cause an assertion failure.
1067    * @param[in] actor The actor to center in on (via Scrolling).
1068    * @param[in] duration The duration of the animation in seconds
1069    */
1070   void ScrollTo(Actor& actor, float duration);
1071
1072   /**
1073    * @brief Scrolls View to the nearest snap points as specified by the Rulers.
1074    *
1075    * If already at snap points, then will return false, and not scroll.
1076    *
1077    * @return True if Snapping necessary.
1078    */
1079   bool ScrollToSnapPoint();
1080
1081   /**
1082    * @brief Scales View to (scale).
1083    *
1084    * @param[in] scale The scale factor the animate to.
1085    *
1086    * @deprecated Scaling not supported
1087    */
1088   void ScaleTo(const Vector3& scale);
1089
1090   /**
1091    * @brief Scales View to (scale).
1092    *
1093    * @param[in] scale The scale factor the animate to.
1094    * @param[in] duration The duration of the animation in seconds.
1095    *
1096    * @deprecated Scaling not supported
1097    */
1098   void ScaleTo(const Vector3& scale, float duration);
1099
1100   /**
1101    * @brief Applies a constraint that will affect the children of ScrollView.
1102    *
1103    * @note this affects all existing and future Actors that are added to scrollview.
1104    * @param[in] constraint The constraint to apply
1105    */
1106   void ApplyConstraintToChildren(Constraint constraint);
1107
1108   /**
1109    * @brief Removes all constraints that will affect the children of ScrollView.
1110    *
1111    * @note this removes all constraints from actors that have been added
1112    * to scrollview.
1113    */
1114   void RemoveConstraintsFromChildren();
1115
1116   /**
1117    * @brief Apply Effect to ScrollView.
1118    *
1119    * @param[in] effect The effect to apply to scroll view
1120    */
1121   void ApplyEffect(ScrollViewEffect effect);
1122
1123   /**
1124    * @brief ApplyEffect Applies a predefined effect.
1125    *
1126    * @param[in] effect enum for the predefined effect
1127    * @return The scrollview effect that was applied
1128    */
1129   ScrollViewEffect ApplyEffect(ScrollView::PageEffect effect);
1130
1131   /**
1132    * @brief Remove Effect from ScrollView.
1133    *
1134    * @param[in] effect The effect to remove.
1135    */
1136   void RemoveEffect(ScrollViewEffect effect);
1137
1138   /**
1139    * @brief Remove All Effects from ScrollView.
1140    */
1141   void RemoveAllEffects();
1142
1143   /**
1144    * @brief Binds actor to this ScrollView.
1145    *
1146    * Once an actor is bound to a ScrollView, it will be subject to
1147    * that ScrollView's properties.
1148    *
1149    * @param[in] child The actor to add to this ScrollView.
1150    */
1151   void BindActor(Actor child);
1152
1153   /**
1154    * @brief Unbind Actor from this ScrollView.
1155    *
1156    * Once Unbound, this ScrollView will not affect the actor.
1157    * @note this does not remove the child from the ScrollView container
1158    *
1159    * @param[in] child The actor to be unbound.
1160    */
1161   void UnbindActor(Actor child);
1162
1163   /**
1164    * @brief Allows the user to constrain the scroll view in a particular direction.
1165    *
1166    * @param[in] direction The axis to constrain the scroll-view to.
1167    *                      Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1168    * @param[in] threshold The threshold to apply around the axis.
1169    * @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
1170    */
1171   void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
1172
1173   /**
1174    * @brief Remove a direction constraint from the scroll view.
1175    *
1176    * @param[in] direction The axis to stop constraining to.
1177    *                      Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1178    */
1179   void RemoveScrollingDirection( Radian direction );
1180
1181 public: // Not intended for application developers
1182
1183   /**
1184    * @brief Creates a handle using the Toolkit::Internal implementation.
1185    *
1186    * @param[in]  implementation  The Control implementation.
1187    */
1188   ScrollView(Internal::ScrollView& implementation);
1189
1190   /**
1191    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
1192    *
1193    * @param[in]  internal  A pointer to the internal CustomActor.
1194    */
1195   ScrollView( Dali::Internal::CustomActor* internal );
1196 };
1197
1198 } // namespace Toolkit
1199
1200 } // namespace Dali
1201
1202 /**
1203  * @}
1204  */
1205 #endif // __DALI_TOOLKIT_SCROLL_VIEW_H__