base/dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__
   2 #define __DALI_TOOLKIT_INTERNAL_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 // EXTERNAL INCLUDES
  22 #include <dali/dali.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/control-impl.h>
  26 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-base-impl.h>
  27 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  28 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
  29
  30 // predefined effect includes
  31 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-custom-effect.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 class ScrollView;
  43 typedef IntrusivePtr<ScrollView>    ScrollViewPtr;
  44
  45 class ScrollInternalConstraints;
  46 typedef IntrusivePtr<ScrollInternalConstraints>    ScrollInternalConstraintsPtr;
  47
  48 class ScrollOvershootIndicator;
  49 typedef IntrusivePtr<ScrollOvershootIndicator> ScrollOvershootIndicatorPtr;
  50
  51 /**
  52  * @copydoc Toolkit::ScrollView
  53  */
  54 class ScrollView : public ScrollBase
  55 {
  56 public:
  57
  58   /**
  59    * FindDirection specifies how searching is conducted within the Find... routines.
  60    */
  61   enum FindDirection
  62   {
  63     None = -3,        ///< Includes none within the search query.
  64     All = -2,         ///< Includes all within the search query.
  65     Left = -1,        ///< Includes only those not right !(>)
  66     Right = 1,        ///< Includes only those right (>)
  67     Up = -1,          ///< Includes only those not below  !(>)
  68     Down = 1,         ///< Includes only those below (>)
  69     Out = -1,         ///< Includes only those not infront  !(>)
  70     In = 1            ///< Includes only those infront (>)
  71   };
  72
  73   enum LockAxis
  74   {
  75     LockPossible = 0, ///< Locking is possible, but not set in stone yet.
  76     LockHorizontal,   ///< Locking is set to horizontal. (can pan vertically)
  77     LockVertical,     ///< Locking is set to vertical. (can pan horizontally)
  78     LockNone          ///< Locking is set to none (free panning).
  79   };
  80
  81   enum ScrollStateFlag
  82   {
  83     AnimatingInternalX = 0x01, ///< animating mPropertyX due to externally requested ScrollTo or internal snapping operation
  84     AnimatingInternalY = 0x02, ///< animating mPropertyY due to externally requested ScrollTo or internal snapping operation
  85     SnappingInternalX  = 0x04, ///< snapping mPropertyX back to mPropertyPreScroll x value to remove x overshoot over time
  86     SnappingInternalY  = 0x08, ///< snapping mPropertyY back to mPropertyPreScroll y value to remove y overshoot over time
  87   };
  88
  89   static const unsigned int SCROLL_X_STATE_MASK = AnimatingInternalX | SnappingInternalX;
  90   static const unsigned int SCROLL_Y_STATE_MASK = AnimatingInternalY | SnappingInternalY;
  91   static const unsigned int SCROLL_ANIMATION_FLAGS = AnimatingInternalX | AnimatingInternalY;
  92   static const unsigned int SNAP_ANIMATION_FLAGS = SnappingInternalX | SnappingInternalY;
  93
  94 public:
  95
  96   /**
  97    * Create a new ScrollView.
  98    * @return A public handle to the newly allocated ScrollView.
  99    */
 100   static Dali::Toolkit::ScrollView New();
 101
 102 public:
 103
 104   /**
 105    * @copydoc Toolkit::ScrollView::GetScrollSnapAlphaFunction
 106    */
 107   AlphaFunction GetScrollSnapAlphaFunction() const;
 108
 109   /**
 110    * @copydoc Toolkit::ScrollView::SetScrollSnapAlphaFunction
 111    */
 112   void SetScrollSnapAlphaFunction(AlphaFunction alpha);
 113
 114   /**
 115    * @copydoc Toolkit::ScrollView::GetScrollFlickAlphaFunction
 116    */
 117   AlphaFunction GetScrollFlickAlphaFunction() const;
 118
 119   /**
 120    * @copydoc Toolkit::ScrollView::SetScrollFlickAlphaFunction
 121    */
 122   void SetScrollFlickAlphaFunction(AlphaFunction alpha);
 123
 124   /**
 125    * @copydoc Toolkit::ScrollView::GetScrollSnapDuration
 126    */
 127   float GetScrollSnapDuration() const;
 128
 129   /**
 130    * @copydoc Toolkit::ScrollView::SetScrollSnapDuration
 131    */
 132   void SetScrollSnapDuration(float time);
 133
 134   /**
 135    * @copydoc Toolkit::ScrollView::GetScrollFlickDuration
 136    */
 137   float GetScrollFlickDuration() const;
 138
 139   /**
 140    * @copydoc Toolkit::ScrollView::SetScrollFlickDuration
 141    */
 142   void SetScrollFlickDuration(float time);
 143
 144   /**
 145    * @copydoc Toolkit::ScrollView::ApplyEffect
 146    */
 147   void ApplyEffect(Toolkit::ScrollViewEffect effect);
 148
 149   /**
 150    * @brief ApplyEffect Applies a predefined effect
 151    * @param effect
 152    */
 153   Toolkit::ScrollViewEffect ApplyEffect(Toolkit::ScrollView::PageEffect effect);
 154
 155   /**
 156    * @copydoc Toolkit::ScrollView::RemoveEffect
 157    */
 158   void RemoveEffect(Toolkit::ScrollViewEffect effect);
 159
 160   /**
 161    * @copydoc Toolkit::ScrollView::RemoveAllEffects
 162    */
 163   void RemoveAllEffects();
 164
 165   /**
 166    * @copydoc Toolkit::ScrollView::ApplyConstraintToChildren
 167    */
 168   void ApplyConstraintToChildren(Constraint constraint);
 169
 170   /**
 171    * @copydoc Toolkit::ScrollView::RemoveConstraintsFromChildren
 172    */
 173   void RemoveConstraintsFromChildren();
 174
 175   /**
 176    * @copydoc Toolkit::ScrollView::GetRulerX
 177    */
 178   const RulerPtr GetRulerX() const;
 179
 180   /**
 181    * @copydoc Toolkit::ScrollView::GetRulerY
 182    */
 183   const RulerPtr GetRulerY() const;
 184
 185   /**
 186    * @copydoc Toolkit::ScrollView::SetRulerX
 187    */
 188   void SetRulerX(RulerPtr ruler);
 189
 190   /**
 191    * @copydoc Toolkit::ScrollView::SetRulerY
 192    */
 193   void SetRulerY(RulerPtr ruler);
 194
 195   /**
 196    * @copydoc Toolkit::ScrollView::SetScrollSensitive
 197    */
 198   void SetScrollSensitive(bool sensitive);
 199
 200   /**
 201    * @copydoc Toolkit::ScrollView::SetMaxOvershoot
 202    */
 203   void SetMaxOvershoot(float overshootX, float overshootY);
 204
 205   /**
 206    * @copydoc Toolkit::ScrollView::SetSnapOvershootAlphaFunction
 207    */
 208   void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
 209
 210   /**
 211    * @copydoc Toolkit::ScrollView::SetSnapOvershootDuration
 212    */
 213   void SetSnapOvershootDuration(float duration);
 214
 215   /**
 216    * @copydoc Toolkit::ScrollView::SetTouchesRequiredForPanning
 217    */
 218   void SetTouchesRequiredForPanning(unsigned int minTouches, unsigned int maxTouches, bool endOutside);
 219
 220   /**
 221    * @copydoc Toolkit::ScrollView::SetActorAutoSnap
 222    */
 223   void SetActorAutoSnap(bool enable);
 224
 225   /**
 226    * Enables or Disables Auto Resizing mode for ScrollView contents.
 227    *
 228    * When enabled, the ScrollView's X/Y Domains are restricted to the
 229    * dimensions of the content's bounds, which may change as Actors are
 230    * Added/Removed, and repositioned.
 231    *
 232    * @note This has been disabled for now, as this requires some fundamental
 233    * changes to the way Actors positions and bounds are retrieved.
 234    * (currently only constraints have these initial state knowledge)
 235    *
 236    * @param[in] enable Enables (true), or disables (false) Auto Resize.
 237    */
 238   void SetAutoResize(bool enable);
 239
 240   /**
 241    * Returns whether the wrap mode has been enabled (true) or not (false).
 242    *
 243    * @return Wrap Mode Enabled flag.
 244    */
 245   bool GetWrapMode() const;
 246
 247   /**
 248    * @copydoc Toolkit::ScrollView::SetWrapMode
 249    */
 250   void SetWrapMode(bool enable);
 251
 252   /**
 253    * @copydoc Toolkit::ScrollView::GetScrollupdateDistance
 254    */
 255   int GetScrollUpdateDistance() const;
 256
 257   /**
 258    * @copydoc Toolkit::ScrollView::SetScrollUpdateDistance
 259    */
 260   void SetScrollUpdateDistance(int distance);
 261
 262   /**
 263    * @copydoc Toolkit::ScrollView::GetAxisAutoLock
 264    */
 265   bool GetAxisAutoLock() const;
 266
 267   /**
 268    * @copydoc Toolkit::ScrollView::SetAxisAutoLock
 269    */
 270   void SetAxisAutoLock(bool enable);
 271
 272   /**
 273    * @copydoc Toolkit::ScrollView::GetAxisAutoLockGradient
 274    */
 275   float GetAxisAutoLockGradient() const;
 276
 277   /**
 278    * @copydoc Toolkit::ScrollView::SetAxisAutoLockGradient
 279    */
 280   void SetAxisAutoLockGradient(float gradient);
 281
 282   /**
 283    * @copydoc Toolkit::ScrollView::GetFrictionCoefficient
 284    */
 285   float GetFrictionCoefficient() const;
 286
 287   /**
 288    * @copydoc Toolkit::ScrollView::SetFrictionCoefficient
 289    */
 290   void SetFrictionCoefficient(float friction);
 291
 292   /**
 293    * @copydoc Toolkit::ScrollView::GetFlickSpeedCoefficient
 294    */
 295   float GetFlickSpeedCoefficient() const;
 296
 297   /**
 298    * @copydoc Toolkit::ScrollView::SetFlickSpeedCoefficient
 299    */
 300   void SetFlickSpeedCoefficient(float speed);
 301
 302   /**
 303    * @copydoc Toolkit::ScrollView::GetMinimumDistanceForFlick
 304    */
 305   Vector2 GetMinimumDistanceForFlick() const;
 306
 307   /**
 308    * @copydoc Toolkit::ScrollView::SetMinimumDistanceForFlick
 309    */
 310   void SetMinimumDistanceForFlick( const Vector2& distance );
 311
 312   /**
 313    * @copydoc Toolkit::ScrollView::GetMinimumSpeedForFlick
 314    */
 315   float GetMinimumSpeedForFlick() const;
 316
 317   /**
 318    * @copydoc Toolkit::ScrollView::SetMinimumSpeedForFlick
 319    */
 320   void SetMinimumSpeedForFlick( float speed );
 321
 322   /**
 323    * @copydoc Toolkit::ScrollView::GetMaxFlickSpeed
 324    */
 325   float GetMaxFlickSpeed() const;
 326
 327   /**
 328    * @copydoc Toolkit::ScrollView::SetMaxFlickSpeed
 329    */
 330   void SetMaxFlickSpeed(float speed);
 331
 332   /**
 333    * @copydoc Toolkit::ScrollView::GetMouseWheelScrollDistanceStep
 334    */
 335   Vector2 GetMouseWheelScrollDistanceStep() const;
 336
 337   /**
 338    * @copydoc Toolkit::ScrollView::SetMouseWheelScrollDistanceStep
 339    */
 340   void SetMouseWheelScrollDistanceStep(Vector2 step);
 341
 342   /**
 343    * @copydoc Toolkit::ScrollView::GetCurrentPage
 344    */
 345   unsigned int GetCurrentPage() const;
 346
 347   /**
 348    * @copydoc Toolkit::ScrollView::GetCurrentScrollPosition
 349    */
 350   Vector3 GetCurrentScrollPosition() const;
 351
 352   /**
 353    * @copydoc Toolkit::ScrollView::SetScrollPosition
 354    */
 355   void SetScrollPosition(const Vector3& position);
 356
 357   /**
 358    * @copydoc Toolkit::Scrollable::GetDomainSize
 359    */
 360   Vector3 GetDomainSize() const;
 361
 362   /**
 363    * @copydoc ScrollTo(const Vector3&)
 364    */
 365   void TransformTo(const Vector3& position,
 366                    DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
 367
 368   /**
 369    * @copydoc ScrollTo(const Vector3&, float, DirectionBias, DirectionBias)
 370    */
 371   void TransformTo(const Vector3& position, float duration,
 372                    DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
 373
 374   /**
 375    * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position)
 376    */
 377   void ScrollTo(const Vector3 &position);
 378
 379   /**
 380    * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
 381    */
 382   void ScrollTo(const Vector3& position, float duration);
 383
 384   /**
 385    * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
 386    */
 387   void ScrollTo(const Vector3& position, float duration,
 388                 DirectionBias horizontalBias, DirectionBias verticalBias);
 389
 390   /**
 391    * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page)
 392    */
 393   void ScrollTo(unsigned int page);
 394
 395   /**
 396    * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
 397    */
 398   void ScrollTo(unsigned int page, float duration, DirectionBias bias = DirectionBiasNone);
 399
 400   /**
 401    * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor)
 402    */
 403   void ScrollTo(Actor &actor);
 404
 405   /**
 406    * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor, float duration)
 407    */
 408   void ScrollTo(Actor &actor, float duration);
 409
 410   /**
 411    * @copydoc Toolkit::ScrollView::SetScrollingDirection()
 412    */
 413   void SetScrollingDirection( Radian direction, Radian threshold );
 414
 415   /**
 416    * @copydoc Toolkit::ScrollView::RemoveScrollingDirection()
 417    */
 418   void RemoveScrollingDirection( Radian angle );
 419
 420   /**
 421     * Finds the closest Actor to the current center of the ScrollView.
 422     *
 423     * @return A handle to the actor if found, or an empty handle if not.
 424     */
 425    Actor FindClosestActor();
 426
 427   /**
 428    * Finds the closest Actor to position in ScrollView
 429    *
 430    * @param[in] position position within ScrollView.
 431    * @param[in] dirX Whether to search only those elements that are Left,Right, or All
 432    * @param[in] dirY Whether to search only those elements that are Up,Down, or All
 433    * @param[in] dirZ Whether to search only those elements that are Out,In, or All
 434    * @return A handle to the actor if found, or an empty handle if not.
 435    */
 436   Actor FindClosestActorToPosition(const Vector3& position, FindDirection dirX = All, FindDirection dirY = All, FindDirection dirZ = All);
 437
 438   /**
 439    * @copydoc Toolkit::ScrollView::ScrollToSnapPoint
 440   */
 441   bool ScrollToSnapPoint();
 442
 443   /**
 444    * Stops animation
 445    */
 446   void StopAnimation(void);
 447
 448   /**
 449    * Stops the input animation
 450    *
 451    * @param[in] the animation to stop
 452    */
 453   void StopAnimation(Animation& animation);
 454
 455   /**
 456    * Animates to position transform.
 457    *
 458    * @param[in] position The position to animate to
 459    * @param[in] positionDuration The number of seconds this animation should run for in each axis.
 460    * @param[in] alpha The easing alpha function to use.
 461    * @param[in] findShortcuts (optional) Whether to find the shortest route (in Wrap mode)
 462    * @param[in] horizontalBias (optional) Whether to bias animation to left or right (or no biasing)
 463    * @param[in] verticalBias (optional) Whether to bias animation to top or bottom (or no biasing)
 464    * @return True if animation necessary and taking place to reach desired transform.
 465    */
 466   bool AnimateTo(const Vector3& position, const Vector3& positionDuration,
 467                              AlphaFunction alpha, bool findShortcuts = true,
 468                              DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone,
 469                              SnapType snapType = Snap);
 470
 471   /**
 472    * @copydoc Toolkit::Scrollable::AddOverlay()
 473    */
 474   void AddOverlay(Actor actor);
 475
 476   /**
 477    * @copydoc Toolkit::Scrollable::RemoveOverlay()
 478    */
 479   void RemoveOverlay(Actor actor);
 480
 481   /**
 482    * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
 483    */
 484   void SetOvershootEffectColor( const Vector4& color );
 485
 486 public: //Signals
 487
 488   /**
 489    * @copydoc Dali::Toolkit::ScrollView::SnapStartedSignal()
 490    */
 491   Toolkit::ScrollView::SnapStartedSignalV2& SnapStartedSignal();
 492
 493   /**
 494    * Connects a callback function with the object's signals.
 495    * @param[in] object The object providing the signal.
 496    * @param[in] tracker Used to disconnect the signal.
 497    * @param[in] signalName The signal to connect to.
 498    * @param[in] functor A newly allocated FunctorDelegate.
 499    * @return True if the signal was connected.
 500    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 501    */
 502   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 503
 504 private: // private overriden functions from CustomActorImpl and Controls
 505
 506   /**
 507    * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
 508    */
 509   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
 510
 511   /**
 512    * @copydoc Dali::Control::OnControlSizeSet(const Vector3&)
 513    */
 514   virtual void OnControlSizeSet( const Vector3& size );
 515
 516   /**
 517    * From CustomActorImpl; called after a child has been added to the owning actor.
 518    * @param[in] child The child which has been added.
 519    */
 520   virtual void OnChildAdd(Actor& child);
 521
 522   /**
 523    * From CustomActorImpl; called shortly before a child is removed from the owning actor.
 524    * @param[in] child The child being removed.
 525    */
 526   virtual void OnChildRemove(Actor& child);
 527
 528   /**
 529    * @copydoc Dali::CustomActorImpl::OnPropertySet( Property::Index index, Property::Value propertyValue )
 530    */
 531   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
 532
 533   /**
 534    * From CustomActorImpl; called after a touch-signal is received by the owning actor.
 535    *
 536    * We don't listen to these events as content within the contain may consume events.
 537    *
 538    * @param[in] event The touch event.
 539    * @return True if the event should be consumed.
 540    */
 541   virtual bool OnTouchEvent(const TouchEvent& event);
 542
 543   /**
 544    * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
 545    * @param[in] event The mouse wheel event.
 546    * @return True if the event should be consumed.
 547    */
 548   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 549
 550   /**
 551    * @copydoc Toolkit::Control::OnInitialize()
 552    */
 553   virtual void OnInitialize();
 554
 555   /**
 556    * @copydoc Toolkit::Control::OnControlStageConnection()
 557    */
 558   virtual void OnControlStageConnection();
 559
 560   /**
 561    * @copydoc Toolkit::Control::OnControlStageConnection()
 562    */
 563   virtual void OnControlStageDisconnection();
 564
 565   /**
 566    * @copydoc Toolkit::Control::OnAccessibilityPan()
 567    */
 568   virtual bool OnAccessibilityPan(PanGesture gesture);
 569
 570   /**
 571    * @copydoc Toolkit::Scrollable::SetOvershootEnabled()
 572    */
 573   virtual void SetOvershootEnabled(bool enable);
 574
 575 private:
 576
 577   /**
 578    * Start a timer which calls OnTouchDownTimeout()
 579    */
 580   void StartTouchDownTimer();
 581
 582   /**
 583    * Stop a timer which calls OnTouchDownTimeout()
 584    */
 585   void StopTouchDownTimer();
 586
 587   /**
 588    * Helper to detect when touch-point has been down (outside of pan gesture)
 589    */
 590   bool OnTouchDownTimeout();
 591
 592   /**
 593    * Called whenever a snap animation has completed
 594    * @param[in] source the Animation instance that has completed.
 595    * Resets all scrolling animations and states, leaving current scroll position at mPropertyPosition
 596    */
 597   void ResetScrolling();
 598
 599   /**
 600    * Updates mScrollInternalPosition, mScrollPrePosition and mScrollPostPosition from their property counterparts
 601    */
 602   void UpdateLocalScrollProperties();
 603
 604   /**
 605    * Makes sure scroll values are ready for animated scrolling
 606    */
 607   void PreAnimatedScrollSetup();
 608
 609   /**
 610    * Finish an animated scroll, ensuring all scroll properties are updated
 611    * and synchronised
 612    */
 613   void FinaliseAnimatedScroll();
 614
 615   /**
 616    * Animates the internal x property to the given value
 617    *
 618    * @param[in] position The X position to animate to
 619    * @param[in] duration The time in seconds for animation
 620    * @param[in] alpha The alpha function to use for animating
 621    */
 622   void AnimateInternalXTo( float position, float duration, AlphaFunction alpha );
 623
 624   /**
 625    * Animates the internal y property to the given value
 626    *
 627    * @param[in] position The Y position to animate to
 628    * @param[in] duration The time in seconds for animation
 629    * @param[in] alpha The alpha function to use for animating
 630    */
 631   void AnimateInternalYTo( float position, float duration, AlphaFunction alpha );
 632
 633   /**
 634    * Called whenever a snap animation on the x-axis has completed
 635    * @param[in] source the Animation instance that has completed.
 636    */
 637   void OnScrollAnimationFinished( Animation& source );
 638
 639   /**
 640    * Called when either the X or Y internal scroll positions have finished snapping back to mPropertyPrePosition
 641    *
 642    * @param[in] source the Animation instance that has completed.
 643    */
 644   void OnSnapInternalPositionFinished( Animation& source );
 645
 646   /**
 647    * Called whenever a snap animation on the x-axis has completed and we need to snap pre scroll
 648    * position to our clamped position
 649    * @param[in] position The x position to snap pre scroll property to
 650    */
 651   void SnapInternalXTo( float position );
 652
 653   /**
 654    * Called whenever a snap animation on the y-axis has completed and we need to snap pre scroll
 655    * position to our clamped position
 656    * @param[in] position The y position to snap pre scroll property to
 657    */
 658   void SnapInternalYTo( float position );
 659
 660   /**
 661    * This is called internally whenever the Scroll Rulers are
 662    * modified. This will update the properties: 'scroll-position-min'
 663    * and 'scroll-position-max' to reflect the changes.
 664    *
 665    * @param[in] size size of the visible scroll area (ScrollView control size)
 666    */
 667   void UpdatePropertyDomain(const Vector3& size);
 668
 669   /**
 670    * Called when the gesture starts.
 671    */
 672   void GestureStarted();
 673
 674   /**
 675    * Amalgamated Gesture Continuing event
 676    *
 677    * @param[in] panDelta average panning delta from base position (0)
 678    */
 679   void GestureContinuing(const Vector2& panDelta);
 680
 681   /**
 682    * Called upon pan gesture event.
 683    *
 684    * @param[in] gesture The gesture event.
 685    */
 686   void OnPan(PanGesture pan);
 687
 688   /**
 689    * Extension of the above gestures.
 690    *
 691    * @param[in] gesture The gesture event.
 692    */
 693   void OnGestureEx(Gesture::State state);
 694
 695   /**
 696    * Performs snapping while taking into account Velocity of gesture
 697    * (velocity in pixels/sec)
 698    *
 699    * @param[in] velocity velocity in pixels/sec
 700    */
 701   bool SnapWithVelocity(Vector2 velocity);
 702
 703   /**
 704    * Finishes Container Transform
 705    * (occurs upon finishing gesture i.e. releasing)
 706    */
 707   void FinishTransform();
 708
 709   /**
 710    * Returns overshoot vector based on current position
 711    *
 712    * Overshoot vector is defined as how far outside of bounds
 713    * the viewport is trying to view (prior to being clamped).
 714    *
 715    * an overshoot of (100,50), means user is in bottom right corner,
 716    * trying to pan +100 to the right, and +50 below. This can be used
 717    * to determine an effect, such as stretching.
 718    *
 719    * @param[in] position The position for which you wish to obtain overshoot vector
 720    */
 721   Vector3 GetOvershoot(Vector3& position) const;
 722
 723   /**
 724    * Clamps position within the domain set up by X/Y Rulers
 725    *
 726    * @param[in,out] position The position you wish to clamp
 727    */
 728   void ClampPosition(Vector3& position) const;
 729
 730   /**
 731    * Clamps position within the domain set up by X/Y Rulers
 732    *
 733    * @param[in,out] position The position you wish to clamp
 734    * @param[out] clamped The results of the clamping.
 735    */
 736   void ClampPosition(Vector3& position, ClampState3 &clamped) const;
 737
 738   /**
 739    * Wraps position within the domain set up by X/Y Rulers
 740    *
 741    * @note Only wraps if mWrapMode is enabled, and respective domains
 742    * are enabled.
 743    *
 744    * @param[in,out] position The position you wish to wrap
 745    */
 746   void WrapPosition(Vector3& position) const;
 747
 748   /**
 749    * Updates the main internal scroll constraints with new ruler and domain
 750    * values
 751    */
 752   void UpdateMainInternalConstraint();
 753
 754   /**
 755    * Enables/disables the overshoot constraints
 756    *
 757    * @param[in] enabled whether to enable or disable the overshoot constraints
 758    */
 759   void SetOvershootConstraintsEnabled(bool enabled);
 760
 761   /**
 762    * Sets internal constraints for this ScrollView.
 763    * Many of these internal constraints are based on properties within
 764    * ScrollView.
 765    */
 766   void SetInternalConstraints();
 767
 768 protected:
 769
 770   /**
 771    * Construct a new ScrollView.
 772    */
 773   ScrollView();
 774
 775   /**
 776    * A reference counted object may only be deleted by calling Unreference()
 777    */
 778   virtual ~ScrollView();
 779
 780 private:
 781
 782   /**
 783    * Searches this ScrollView, and attempts to Unbind
 784    * systematically this Actor from the ScrollView attached.
 785    *
 786    * @param[in] child The actor to be unbound.
 787    */
 788   virtual void FindAndUnbindActor(Actor child);
 789
 790   /**
 791    * Gets position property.
 792    *
 793    * @return The current position
 794    */
 795   Vector3 GetPropertyPrePosition() const;
 796
 797   /**
 798    * Gets position property.
 799    *
 800    * @return The current position
 801    */
 802   Vector3 GetPropertyPosition() const;
 803
 804   /**
 805    * Handles a Stopped animation. Its position properties need to be saved, and the animation flag
 806    * switched off.
 807    */
 808   void HandleStoppedAnimation();
 809
 810   /**
 811    * Handles a Stopped animation (whether the animation completed, or was
 812    * manually stopped). Its position properties need to be saved, and the
 813    * animation flag switched off.
 814    */
 815   void HandleSnapAnimationFinished();
 816
 817   /**
 818    * Checks if the property notifications are active and adds them if not
 819    */
 820   void SetScrollUpdateNotification( bool enabled );
 821
 822   /**
 823    * Refresh the ScrollView (used when animating to update application developer of changes)
 824    * @return True if the refresh timer should be kept running.
 825    */
 826   void OnScrollUpdateNotification(Dali::PropertyNotification& source);
 827
 828 private:
 829
 830   // Undefined
 831   ScrollView(const ScrollView&);
 832
 833   // Undefined
 834   ScrollView& operator=(const ScrollView& rhs);
 835
 836 private:
 837
 838   unsigned long mTouchDownTime;         ///< The touch down time
 839
 840   int mGestureStackDepth;               ///< How many gestures are currently occuring.
 841   Vector2 mPanStartPosition;            ///< Where the pan gesture's touch down occured
 842   Vector3 mPanDelta;                    ///< Amount currently panned.
 843
 844   unsigned int mScrollStateFlags;       ///< flags indicating current state of scrolling
 845   // Scroll delegate pre and post position properties...
 846   Vector3 mScrollPrePosition;           ///< Wrapped scroll position, but not clamped
 847   Vector3 mScrollPostPosition;          ///< Wrapped and clamped, this is the final scroll position used
 848   Vector3 mScrollTargetPosition;        ///< Final target position for an animated scroll
 849   Vector3 mDomainOffset;                ///< Domain offset (this keeps track of the domain boundaries that scroll positions traverses)
 850
 851   // Rulers for each axes...
 852   RulerPtr mRulerX;
 853   RulerPtr mRulerY;
 854
 855   // Last property values set to ScrollView
 856   Vector3 mMinScroll;
 857   Vector3 mMaxScroll;
 858
 859   unsigned int mMinTouchesForPanning;   ///< Minimum number of touches for panning to be used.
 860   unsigned int mMaxTouchesForPanning;   ///< Maximum number of touches for panning to be used.
 861
 862   Animation mInternalXAnimation;        ///< Animates mPropertyX to a snap position or application requested scroll position
 863   Animation mInternalYAnimation;        ///< Animates mPropertyY to a snap position or application requested scroll position
 864
 865
 866   Vector2 mLastVelocity;                ///< Record the last velocity from PanGesture (Finish event doesn't have correct velocity)
 867   LockAxis mLockAxis;
 868
 869   Timer mTouchDownTimer;                ///< Used to interrupt snap-animation. This cannot be done in OnTouchEvent without breaking fast flick behavior.
 870
 871   float mScrollUpdateDistance;          ///< Distance for scrolling to travel for the scroll update notifications
 872   Dali::PropertyNotification mScrollXUpdateNotification; ///< scroll x position update notification
 873   Dali::PropertyNotification mScrollYUpdateNotification; ///< scroll y position update notification
 874
 875   Actor mInternalActor;                 ///< Internal actor (we keep internal actors in here e.g. scrollbars, so we can ignore it in searches)
 876
 877   ScrollViewEffectContainer mEffects;   ///< Container keeping track of all the applied effects.
 878
 879   float     mOvershootDelay;                    ///< Time to wait for input before reducing overshoot back to 0
 880   Vector2   mMaxOvershoot;                      ///< Number of scrollable pixels that will take overshoot from 0.0f to 1.0f
 881   Vector2   mUserMaxOvershoot;                  ///< Set by user, allows overriding of default max overshoot for the scroll indicator
 882   float     mSnapOvershootDuration;             ///< Duration for overshoot snapping back to Vector3::ZERO
 883   AlphaFunction mSnapOvershootAlphaFunction;    ///< AlphaFunction to be used for this overshoot.
 884
 885   float mSnapDuration;                          ///< Time for the snap animation to take (in seconds).
 886   AlphaFunction mSnapAlphaFunction;             ///< AlphaFunction to be used for the Snap Animation.
 887
 888   Vector2 mMinFlickDistance;                      ///< Minimum pan distance required for a flick
 889   float mFlickSpeedThreshold;                   ///< Minimum pan speed required for a flick in pixels/ms
 890   float mFlickDuration;                         ///< Time for the flick animation to take (in seconds).
 891   AlphaFunction mFlickAlphaFunction;            ///< AlphaFunction to be used for the Flick Animation.
 892
 893   float mAxisAutoLockGradient;                  ///< Axis Auto-lock gradient threshold. Above this gradient and it will lock scrolling to closest axis.
 894   float mFrictionCoefficient;                   ///< Friction coefficient. Amount of friction to apply to free panning flick animation. in stage.lengths/sec
 895   float mFlickSpeedCoefficient;                 ///< Flick velocity coefficient. Input touch velocity is multiplied by this.
 896   float mMaxFlickSpeed;                         ///< Maximum flick speed. Maximum speed of flick in stage.lengths/sec.
 897
 898   Vector2 mMouseWheelScrollDistanceStep;        ///< The step of scroll distance in actor coordinates in X and Y axes for each mouse wheel event received.
 899
 900   //ScrollInternalConstraintsPtr mScrollInternalConstraints;
 901   ActiveConstraint mScrollMainInternalPrePositionConstraint;
 902   ActiveConstraint mScrollMainInternalPositionConstraint;
 903   ActiveConstraint mScrollMainInternalOvershootXConstraint;
 904   ActiveConstraint mScrollMainInternalOvershootYConstraint;
 905   ActiveConstraint mScrollMainInternalDeltaConstraint;
 906   ActiveConstraint mScrollMainInternalFinalConstraint;
 907   ActiveConstraint mScrollMainInternalRelativeConstraint;
 908
 909   ScrollOvershootIndicatorPtr mOvershootIndicator;
 910
 911   Toolkit::ScrollView::SnapStartedSignalV2 mSnapStartedSignalV2;
 912
 913   bool mInAccessibilityPan : 1;           ///< With AccessibilityPan its easier to move between snap positions
 914   bool mInitialized:1;
 915   bool mScrolling:1;                      ///< Flag indicating whether the scroll view is being scrolled (by user or animation)
 916   bool mScrollInterrupted:1;              ///< Flag set for when a down event interrupts a scroll
 917   bool mPanning:1;                        ///< Whether scroll view is currently panning or not
 918   bool mSensitive:1;                      ///< Scroll Sensitivity Flag.
 919   bool mTouchDownTimeoutReached:1;        ///< Indicates when down event timeout occured without corresponding up event (touch still down)
 920   bool mActorAutoSnapEnabled:1;           ///< Whether to automatically snap to closest actor.
 921   bool mAutoResizeContainerEnabled:1;     ///< Whether to automatically resize container (affects RulerDomain's on X/Y axes)
 922   bool mWrapMode:1;                       ///< Whether to wrap contents based on container size.
 923   bool mAxisAutoLock:1;                   ///< Whether to automatically lock axis when panning.
 924   bool mAlterChild:1;                     ///< Internal flag to control behavior of OnChildAdd/OnChildRemove when Adding internal Actors.
 925   bool mDefaultMaxOvershoot:1;            ///< Whether to use default max overshoot or application defined one
 926   bool mCanScrollHorizontal:1;            ///< Local value of our property to check against
 927   bool mCanScrollVertical:1;              ///< Local value of our property to check against
 928 };
 929
 930 } // namespace Internal
 931
 932 // Helpers for public-api forwarding methods
 933
 934 inline Toolkit::Internal::ScrollView& GetImpl(Toolkit::ScrollView& scrollView)
 935 {
 936   DALI_ASSERT_ALWAYS(scrollView);
 937
 938   Dali::RefObject& handle = scrollView.GetImplementation();
 939
 940   return static_cast<Toolkit::Internal::ScrollView&>(handle);
 941 }
 942
 943 inline const Toolkit::Internal::ScrollView& GetImpl(const Toolkit::ScrollView& scrollView)
 944 {
 945   DALI_ASSERT_ALWAYS(scrollView);
 946
 947   const Dali::RefObject& handle = scrollView.GetImplementation();
 948
 949   return static_cast<const Toolkit::Internal::ScrollView&>(handle);
 950 }
 951
 952 } // namespace Toolkit
 953
 954 } // namespace Dali
 955
 956 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__