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