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::SetRulerScaleX
 197    */
 198   void SetRulerScaleX(RulerPtr ruler);
 199
 200   /**
 201    * @copydoc Toolkit::ScrollView::SetRulerScaleY
 202    */
 203   void SetRulerScaleY(RulerPtr ruler);
 204
 205   /**
 206    * Set Rotation axis ruler (defines how rotating is snapped in radians)
 207    * @param[in] ruler The ruler to be used for the Rotation axis
 208    */
 209   void SetRulerRotation(RulerPtr ruler);
 210
 211   /**
 212    * @copydoc Toolkit::ScrollView::SetScrollSensitive
 213    */
 214   void SetScrollSensitive(bool sensitive);
 215
 216   /**
 217    * @copydoc Toolkit::ScrollView::SetMaxOvershoot
 218    */
 219   void SetMaxOvershoot(float overshootX, float overshootY);
 220
 221   /**
 222    * @copydoc Toolkit::ScrollView::SetSnapOvershootAlphaFunction
 223    */
 224   void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
 225
 226   /**
 227    * @copydoc Toolkit::ScrollView::SetSnapOvershootDuration
 228    */
 229   void SetSnapOvershootDuration(float duration);
 230
 231   /**
 232    * @copydoc Toolkit::ScrollView::SetTouchesRequiredForPanning
 233    */
 234   void SetTouchesRequiredForPanning(unsigned int minTouches, unsigned int maxTouches, bool endOutside);
 235
 236   /**
 237    * @copydoc Toolkit::ScrollView::SetActorAutoSnap
 238    */
 239   void SetActorAutoSnap(bool enable);
 240
 241   /**
 242    * Enables or Disables Auto Resizing mode for ScrollView contents.
 243    *
 244    * When enabled, the ScrollView's X/Y Domains are restricted to the
 245    * dimensions of the content's bounds, which may change as Actors are
 246    * Added/Removed, and repositioned.
 247    *
 248    * @note This has been disabled for now, as this requires some fundamental
 249    * changes to the way Actors positions and bounds are retrieved.
 250    * (currently only constraints have these initial state knowledge)
 251    *
 252    * @param[in] enable Enables (true), or disables (false) Auto Resize.
 253    */
 254   void SetAutoResize(bool enable);
 255
 256   /**
 257    * Returns whether the wrap mode has been enabled (true) or not (false).
 258    *
 259    * @return Wrap Mode Enabled flag.
 260    */
 261   bool GetWrapMode() const;
 262
 263   /**
 264    * @copydoc Toolkit::ScrollView::SetWrapMode
 265    */
 266   void SetWrapMode(bool enable);
 267
 268   /**
 269    * @copydoc Toolkit::ScrollView::GetRefreshInterval
 270    */
 271   int GetRefreshInterval() const;
 272
 273   /**
 274    * @copydoc Toolkit::ScrollView::SetRefreshInterval
 275    */
 276   void SetRefreshInterval(int milliseconds);
 277
 278   /**
 279    * @copydoc Toolkit::ScrollView::GetAxisAutoLock
 280    */
 281   bool GetAxisAutoLock() const;
 282
 283   /**
 284    * @copydoc Toolkit::ScrollView::SetAxisAutoLock
 285    */
 286   void SetAxisAutoLock(bool enable);
 287
 288   /**
 289    * @copydoc Toolkit::ScrollView::GetAxisAutoLockGradient
 290    */
 291   float GetAxisAutoLockGradient() const;
 292
 293   /**
 294    * @copydoc Toolkit::ScrollView::SetAxisAutoLockGradient
 295    */
 296   void SetAxisAutoLockGradient(float gradient);
 297
 298   /**
 299    * @copydoc Toolkit::ScrollView::GetFrictionCoefficient
 300    */
 301   float GetFrictionCoefficient() const;
 302
 303   /**
 304    * @copydoc Toolkit::ScrollView::SetFrictionCoefficient
 305    */
 306   void SetFrictionCoefficient(float friction);
 307
 308   /**
 309    * @copydoc Toolkit::ScrollView::GetFlickSpeedCoefficient
 310    */
 311   float GetFlickSpeedCoefficient() const;
 312
 313   /**
 314    * @copydoc Toolkit::ScrollView::SetFlickSpeedCoefficient
 315    */
 316   void SetFlickSpeedCoefficient(float speed);
 317
 318   /**
 319    * @copydoc Toolkit::ScrollView::GetMaxFlickSpeed
 320    */
 321   float GetMaxFlickSpeed() const;
 322
 323   /**
 324    * @copydoc Toolkit::ScrollView::SetMaxFlickSpeed
 325    */
 326   void SetMaxFlickSpeed(float speed);
 327
 328   /**
 329    * @copydoc Toolkit::ScrollView::GetMouseWheelScrollDistanceStep
 330    */
 331   Vector2 GetMouseWheelScrollDistanceStep() const;
 332
 333   /**
 334    * @copydoc Toolkit::ScrollView::SetMouseWheelScrollDistanceStep
 335    */
 336   void SetMouseWheelScrollDistanceStep(Vector2 step);
 337
 338   /**
 339    * @copydoc Toolkit::ScrollView::GetCurrentPage
 340    */
 341   unsigned int GetCurrentPage() const;
 342
 343   /**
 344    * @copydoc Toolkit::ScrollView::GetCurrentScrollPosition
 345    */
 346   Vector3 GetCurrentScrollPosition() const;
 347
 348   /**
 349    * @copydoc Toolkit::ScrollView::SetScrollPosition
 350    */
 351   void SetScrollPosition(const Vector3& position);
 352
 353   /**
 354    * @copydoc Toolkit::ScrollView::GetCurrentScrollScale
 355    */
 356   Vector3 GetCurrentScrollScale() const;
 357
 358   /**
 359    * @copydoc Toolkit::Scrollable::GetDomainSize
 360    */
 361   Vector3 GetDomainSize() const;
 362
 363   /**
 364    * @copydoc Toolkit::ScrollView::TransformTo(const Vector3& position, const Vector3& scale, float rotation)
 365    */
 366   void TransformTo(const Vector3& position, const Vector3& scale, float rotation,
 367                    DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
 368
 369   /**
 370    * @copydoc Toolkit::ScrollView::TransformTo(const Vector3& position, const Vector3& scale, float rotation, float duration)
 371    */
 372   void TransformTo(const Vector3& position, const Vector3& scale, float rotation, float duration,
 373                    DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
 374
 375   /**
 376    * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position)
 377    */
 378   void ScrollTo(const Vector3 &position);
 379
 380   /**
 381    * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
 382    */
 383   void ScrollTo(const Vector3& position, float duration);
 384
 385   /**
 386    * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
 387    */
 388   void ScrollTo(const Vector3& position, float duration,
 389                 DirectionBias horizontalBias, DirectionBias verticalBias);
 390
 391   /**
 392    * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page)
 393    */
 394   void ScrollTo(unsigned int page);
 395
 396   /**
 397    * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
 398    */
 399   void ScrollTo(unsigned int page, float duration, DirectionBias bias = DirectionBiasNone);
 400
 401   /**
 402    * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor)
 403    */
 404   void ScrollTo(Actor &actor);
 405
 406   /**
 407    * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor, float duration)
 408    */
 409   void ScrollTo(Actor &actor, float duration);
 410
 411   /**
 412    * @copydoc Toolkit::ScrollView::SetScrollingDirection()
 413    */
 414   void SetScrollingDirection( Radian direction, Radian threshold );
 415
 416   /**
 417    * @copydoc Toolkit::ScrollView::RemoveScrollingDirection()
 418    */
 419   void RemoveScrollingDirection( Radian angle );
 420
 421   /**
 422     * Finds the closest Actor to the current center of the ScrollView.
 423     *
 424     * @return A handle to the actor if found, or an empty handle if not.
 425     */
 426    Actor FindClosestActor();
 427
 428   /**
 429    * Finds the closest Actor to position in ScrollView
 430    *
 431    * @param[in] position position within ScrollView.
 432    * @param[in] dirX Whether to search only those elements that are Left,Right, or All
 433    * @param[in] dirY Whether to search only those elements that are Up,Down, or All
 434    * @param[in] dirZ Whether to search only those elements that are Out,In, or All
 435    * @return A handle to the actor if found, or an empty handle if not.
 436    */
 437   Actor FindClosestActorToPosition(const Vector3& position, FindDirection dirX = All, FindDirection dirY = All, FindDirection dirZ = All);
 438
 439   /**
 440    * @copydoc Toolkit::ScrollView::ScrollToSnapPoint
 441   */
 442   bool ScrollToSnapPoint();
 443
 444   /**
 445    * @copydoc Toolkit::ScrollView::ScaleTo(const Vector3& scale)
 446    */
 447   void ScaleTo(const Vector3& scale);
 448
 449   /**
 450    * @copydoc Toolkit::ScrollView::ScaleTo(const Vector3& scale, float duration)
 451    */
 452   void ScaleTo(const Vector3& scale, float duration);
 453
 454   /**
 455    * Stops animation
 456    */
 457   void StopAnimation(void);
 458
 459   /**
 460    * Stops the input animation
 461    *
 462    * @param[in] the animation to stop
 463    */
 464   void StopAnimation(Animation& animation);
 465
 466   /**
 467    * Animates to position/scale/rotation transform.
 468    *
 469    * @param[in] position The position to animate to
 470    * @param[in] positionDuration The number of seconds this animation should run for in each axis.
 471    * @param[in] scale The scale to animate to
 472    * @param[in] scaleDuration The number of seconds this animation should run for in each axis.
 473    * @param[in] rotation The angle to animate to
 474    * @param[in] rotationDuration The number of seconds this animation should run for in each axis.
 475    * @param[in] alpha The easing alpha function to use.
 476    * @param[in] findShortcuts (optional) Whether to find the shortest route (in Wrap mode)
 477    * @param[in] horizontalBias (optional) Whether to bias animation to left or right (or no biasing)
 478    * @param[in] verticalBias (optional) Whether to bias animation to top or bottom (or no biasing)
 479    * @return True if animation necessary and taking place to reach desired transform.
 480    */
 481   bool AnimateTo(const Vector3& position, const Vector3& positionDuration,
 482                              const Vector3& scale, const Vector3& scaleDuration,
 483                              float rotation, float rotationDuration,
 484                              AlphaFunction alpha, bool findShortcuts = true,
 485                              DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone,
 486                              SnapType snapType = Snap);
 487
 488   /**
 489    * @copydoc Toolkit::Scrollable::AddOverlay()
 490    */
 491   void AddOverlay(Actor actor);
 492
 493   /**
 494    * @copydoc Toolkit::Scrollable::RemoveOverlay()
 495    */
 496   void RemoveOverlay(Actor actor);
 497
 498 public: //Signals
 499
 500   /**
 501    * @copydoc Dali::Toolkit::ScrollView::SnapStartedSignal()
 502    */
 503   Toolkit::ScrollView::SnapStartedSignalV2& SnapStartedSignal();
 504
 505   /**
 506    * Connects a callback function with the object's signals.
 507    * @param[in] object The object providing the signal.
 508    * @param[in] tracker Used to disconnect the signal.
 509    * @param[in] signalName The signal to connect to.
 510    * @param[in] functor A newly allocated FunctorDelegate.
 511    * @return True if the signal was connected.
 512    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 513    */
 514   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 515
 516 private: // private overriden functions from CustomActorImpl and Controls
 517
 518   /**
 519    * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
 520    */
 521   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
 522
 523   /**
 524    * @copydoc Dali::Control::OnControlSizeSet(const Vector3&)
 525    */
 526   virtual void OnControlSizeSet( const Vector3& size );
 527
 528   /**
 529    * From CustomActorImpl; called after a child has been added to the owning actor.
 530    * @param[in] child The child which has been added.
 531    */
 532   virtual void OnChildAdd(Actor& child);
 533
 534   /**
 535    * From CustomActorImpl; called shortly before a child is removed from the owning actor.
 536    * @param[in] child The child being removed.
 537    */
 538   virtual void OnChildRemove(Actor& child);
 539
 540   /**
 541    * @copydoc Dali::CustomActorImpl::OnPropertySet( Property::Index index, Property::Value propertyValue )
 542    */
 543   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
 544
 545   /**
 546    * From CustomActorImpl; called after a touch-signal is received by the owning actor.
 547    *
 548    * We don't listen to these events as content within the contain may consume events.
 549    *
 550    * @param[in] event The touch event.
 551    * @return True if the event should be consumed.
 552    */
 553   virtual bool OnTouchEvent(const TouchEvent& event);
 554
 555   /**
 556    * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
 557    * @param[in] event The mouse wheel event.
 558    * @return True if the event should be consumed.
 559    */
 560   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 561
 562   /**
 563    * @copydoc Toolkit::Control::OnInitialize()
 564    */
 565   virtual void OnInitialize();
 566
 567   /**
 568    * @copydoc Toolkit::Control::OnControlStageConnection()
 569    */
 570   virtual void OnControlStageConnection();
 571
 572   /**
 573    * @copydoc Toolkit::Control::OnControlStageConnection()
 574    */
 575   virtual void OnControlStageDisconnection();
 576
 577   /**
 578    * @copydoc Toolkit::Control::OnAccessibilityPan()
 579    */
 580   virtual bool OnAccessibilityPan(PanGesture gesture);
 581
 582   /**
 583    * @copydoc Toolkit::Scrollable::SetOvershootEnabled()
 584    */
 585   virtual void SetOvershootEnabled(bool enable);
 586
 587 private:
 588
 589   /**
 590    * Start a timer which calls OnTouchDownTimeout()
 591    */
 592   void StartTouchDownTimer();
 593
 594   /**
 595    * Stop a timer which calls OnTouchDownTimeout()
 596    */
 597   void StopTouchDownTimer();
 598
 599   /**
 600    * Helper to detect when touch-point has been down (outside of pan gesture)
 601    */
 602   bool OnTouchDownTimeout();
 603
 604   /**
 605    * Called whenever a snap animation has completed
 606    * @param[in] source the Animation instance that has completed.
 607    * Resets all scrolling animations and states, leaving current scroll position at mPropertyPosition
 608    */
 609   void ResetScrolling();
 610
 611   /**
 612    * Updates mScrollInternalPosition, mScrollPrePosition and mScrollPostPosition from their property counterparts
 613    */
 614   void UpdateLocalScrollProperties();
 615
 616   /**
 617    * Makes sure scroll values are ready for animated scrolling
 618    */
 619   void PreAnimatedScrollSetup();
 620
 621   /**
 622    * Finish an animated scroll, ensuring all scroll properties are updated
 623    * and synchronised
 624    */
 625   void FinaliseAnimatedScroll();
 626
 627   /**
 628    * Animates the internal x property to the given value
 629    *
 630    * @param[in] position The X position to animate to
 631    * @param[in] duration The time in seconds for animation
 632    * @param[in] alpha The alpha function to use for animating
 633    */
 634   void AnimateInternalXTo( float position, float duration, AlphaFunction alpha );
 635
 636   /**
 637    * Animates the internal y property to the given value
 638    *
 639    * @param[in] position The Y position to animate to
 640    * @param[in] duration The time in seconds for animation
 641    * @param[in] alpha The alpha function to use for animating
 642    */
 643   void AnimateInternalYTo( float position, float duration, AlphaFunction alpha );
 644
 645   /**
 646    * Called whenever a snap animation on the x-axis has completed
 647    * @param[in] source the Animation instance that has completed.
 648    */
 649   void OnScrollAnimationFinished( Animation& source );
 650
 651   /**
 652    * Called when either the X or Y internal scroll positions have finished snapping back to mPropertyPrePosition
 653    *
 654    * @param[in] source the Animation instance that has completed.
 655    */
 656   void OnSnapInternalPositionFinished( Animation& source );
 657
 658   /**
 659    * Called whenever a snap animation on the x-axis has completed and we need to snap pre scroll
 660    * position to our clamped position
 661    * @param[in] position The x position to snap pre scroll property to
 662    */
 663   void SnapInternalXTo( float position );
 664
 665   /**
 666    * Called whenever a snap animation on the y-axis has completed and we need to snap pre scroll
 667    * position to our clamped position
 668    * @param[in] position The y position to snap pre scroll property to
 669    */
 670   void SnapInternalYTo( float position );
 671
 672   /**
 673    * This is called internally whenever the Scroll Rulers are
 674    * modified. This will update the properties: 'scroll-position-min'
 675    * and 'scroll-position-max' to reflect the changes.
 676    *
 677    * @param[in] size size of the visible scroll area (ScrollView control size)
 678    */
 679   void UpdatePropertyDomain(const Vector3& size);
 680
 681   /**
 682    * Called when the gesture starts.
 683    */
 684   void GestureStarted();
 685
 686   /**
 687    * Amalgamated Gesture Continuing event
 688    *
 689    * @param[in] panDelta average panning delta from base position (0)
 690    * @param[in] scaleDelta average scale delta from base scale (1)
 691    * @param[in] rotationDelta average rotation delta from base angle (0)
 692    */
 693   void GestureContinuing(const Vector2& panDelta, const Vector2& scaleDelta, float rotationDelta);
 694
 695   /**
 696    * Called upon pan gesture event.
 697    *
 698    * @param[in] gesture The gesture event.
 699    */
 700   void OnPan(PanGesture pan);
 701
 702   /**
 703    * Extension of the above gestures.
 704    *
 705    * @param[in] gesture The gesture event.
 706    */
 707   void OnGestureEx(Gesture::State state);
 708
 709   /**
 710    * Performs snapping while taking into account Velocity of gesture
 711    * (velocity in pixels/sec)
 712    *
 713    * @param[in] velocity velocity in pixels/sec
 714    */
 715   bool SnapWithVelocity(Vector2 velocity);
 716
 717   /**
 718    * Updates Container Transform based on Pan, Scale, and Rotation props.
 719    * (occurs when continuing gesture i.e. dragging/pinching.)
 720    */
 721   void UpdateTransform();
 722
 723   /**
 724    * Finishes Container Transform
 725    * (occurs upon finishing gesture i.e. releasing)
 726    */
 727   void FinishTransform();
 728
 729   /**
 730    * Returns overshoot vector based on current position
 731    *
 732    * Overshoot vector is defined as how far outside of bounds
 733    * the viewport is trying to view (prior to being clamped).
 734    *
 735    * an overshoot of (100,50), means user is in bottom right corner,
 736    * trying to pan +100 to the right, and +50 below. This can be used
 737    * to determine an effect, such as stretching.
 738    *
 739    * @param[in] position The position for which you wish to obtain overshoot vector
 740    */
 741   Vector3 GetOvershoot(Vector3& position) const;
 742
 743   /**
 744    * Clamps position within the domain set up by X/Y Rulers
 745    *
 746    * @param[in,out] position The position you wish to clamp
 747    */
 748   void ClampPosition(Vector3& position) const;
 749
 750   /**
 751    * Clamps position within the domain set up by X/Y Rulers
 752    *
 753    * @param[in,out] position The position you wish to clamp
 754    * @param[out] clamped The results of the clamping.
 755    */
 756   void ClampPosition(Vector3& position, ClampState3 &clamped) const;
 757
 758   /**
 759    * Wraps position within the domain set up by X/Y Rulers
 760    *
 761    * @note Only wraps if mWrapMode is enabled, and respective domains
 762    * are enabled.
 763    *
 764    * @param[in,out] position The position you wish to wrap
 765    */
 766   void WrapPosition(Vector3& position) const;
 767
 768   /**
 769    * Clamps scale within the domain set up by Scale-X/Scale-Y Rulers
 770    *
 771    * @param[in,out] scale The scale you wish to clamp
 772    */
 773   void ClampScale(Vector3& scale) const;
 774
 775   /**
 776    * Clamps scale within the domain set up by Scale-X/Scale-Y Rulers
 777    *
 778    * @param[in,out] scale The scale you wish to clamp
 779    * @param[out] clamped The results of the clamping.
 780    */
 781   void ClampScale(Vector3& scale, ClampState3 &clamped) const;
 782
 783   /**
 784    * Updates the main internal scroll constraints with new ruler and domain
 785    * values
 786    */
 787   void UpdateMainInternalConstraint();
 788
 789   /**
 790    * Enables/disables the overshoot constraints
 791    *
 792    * @param[in] enabled whether to enable or disable the overshoot constraints
 793    */
 794   void SetOvershootConstraintsEnabled(bool enabled);
 795
 796   /**
 797    * Sets internal constraints for this ScrollView.
 798    * Many of these internal constraints are based on properties within
 799    * ScrollView.
 800    */
 801   void SetInternalConstraints();
 802
 803 protected:
 804
 805   /**
 806    * Construct a new ScrollView.
 807    */
 808   ScrollView();
 809
 810   /**
 811    * A reference counted object may only be deleted by calling Unreference()
 812    */
 813   virtual ~ScrollView();
 814
 815 private:
 816
 817   /**
 818    * Searches this ScrollView, and attempts to Unbind
 819    * systematically this Actor from the ScrollView attached.
 820    *
 821    * @param[in] child The actor to be unbound.
 822    */
 823   virtual void FindAndUnbindActor(Actor child);
 824
 825   /**
 826    * Gets position property.
 827    *
 828    * @return The current position
 829    */
 830   Vector3 GetPropertyPrePosition() const;
 831
 832   /**
 833    * Gets position property.
 834    *
 835    * @return The current position
 836    */
 837   Vector3 GetPropertyPosition() const;
 838
 839   /**
 840    * Gets scale property.
 841    *
 842    * @return The current scale
 843    */
 844   Vector3 GetPropertyScale() const;
 845
 846   /**
 847    * Handles a Stopped animation. Its position/scale/rotation properties need to be
 848    * saved, and the animation flag switched off.
 849    */
 850   void HandleStoppedAnimation();
 851
 852   /**
 853    * Handles a Stopped animation (whether the animation completed, or was
 854    * manually stopped). Its position/scale/rotation properties need to be
 855    * saved, and the animation flag switched off.
 856    */
 857   void HandleSnapAnimationFinished();
 858
 859   /**
 860    * Helper to start the refresh timer.
 861    */
 862   void StartRefreshTimer();
 863
 864   /**
 865    * Helper to cancel the refresh timer.
 866    */
 867   void CancelRefreshTimer();
 868
 869   /**
 870    * Refresh the ScrollView (used when animating to update application developer of changes)
 871    * @return True if the refresh timer should be kept running.
 872    */
 873   bool OnRefreshTick();
 874
 875 private:
 876
 877   // Undefined
 878   ScrollView(const ScrollView&);
 879
 880   // Undefined
 881   ScrollView& operator=(const ScrollView& rhs);
 882
 883 private:
 884
 885   unsigned long mTouchDownTime;         ///< The touch down time
 886
 887   int mGestureStackDepth;               ///< How many gestures are currently occuring.
 888   Vector2 mGestureReferencePosition;    ///< Point where scaling should occur from.
 889   Vector2 mPinchGestureLastPosition;
 890   Vector2 mPinchGestureLastScale;
 891
 892   Vector3 mPanDelta;                    ///< Amount currently panned.
 893   Vector3 mScaleDelta;                  ///< Amount currently scaled.
 894   float mRotationDelta;                 ///< Amount currently rotated.
 895
 896   unsigned int mScrollStateFlags;       ///< flags indicating current state of scrolling
 897   // Scroll delegate pre and post position/scale/rotation properties...
 898   Vector3 mScrollPrePosition;           ///< Wrapped scroll position, but not clamped
 899   Vector3 mScrollPostPosition;          ///< Wrapped and clamped, this is the final scroll position used
 900   Vector3 mScrollTargetPosition;        ///< Final target position for an animated scroll
 901   Vector3 mScrollPreScale;              ///< Scroll delegate pre-scale
 902   Vector3 mScrollPostScale;             ///< Scroll delegate post-scale (affected by current touch)
 903   float mScrollPreRotation;             ///< Scroll delegate pre-rotation
 904   float mScrollPostRotation;            ///< Scroll delegate post-rotation (affected by current touch)
 905   Vector3 mDomainOffset;                ///< Domain offset (this keeps track of the domain boundaries that scroll positions traverses)
 906
 907   // Rulers for each axes...
 908   RulerPtr mRulerX;
 909   RulerPtr mRulerY;
 910   RulerPtr mRulerScaleX;
 911   RulerPtr mRulerScaleY;
 912   RulerPtr mRulerRotation;
 913
 914   unsigned int mMinTouchesForPanning;   ///< Minimum number of touches for panning to be used.
 915   unsigned int mMaxTouchesForPanning;   ///< Maximum number of touches for panning to be used.
 916
 917   Animation mSnapAnimation;             ///< Used to animate rotation and scaling of scroll properties
 918   Animation mInternalXAnimation;        ///< Animates mPropertyX to a snap position or application requested scroll position
 919   Animation mInternalYAnimation;        ///< Animates mPropertyY to a snap position or application requested scroll position
 920
 921
 922   Vector2 mLastVelocity;                ///< Record the last velocity from PanGesture (Finish event doesn't have correct velocity)
 923   LockAxis mLockAxis;
 924
 925   Timer mTouchDownTimer;                ///< Used to interrupt snap-animation. This cannot be done in OnTouchEvent without breaking fast flick behavior.
 926   Timer mOvershootRefreshTimer;
 927   Timer mRefreshTimer;                  ///< Refresh timer is used to provide the Application developer with updates as animations run.
 928   int mRefreshIntervalMilliseconds;     ///< Refresh timer interval.
 929
 930   Actor mInternalActor;                 ///< Internal actor (we keep internal actors in here e.g. scrollbars, so we can ignore it in searches)
 931
 932   ScrollViewEffectContainer mEffects;   ///< Container keeping track of all the applied effects.
 933
 934   float     mOvershootDelay;                    ///< Time to wait for input before reducing overshoot back to 0
 935   Vector2   mMaxOvershoot;                      ///< Number of scrollable pixels that will take overshoot from 0.0f to 1.0f
 936   Vector2   mUserMaxOvershoot;                  ///< Set by user, allows overriding of default max overshoot for the scroll indicator
 937   float     mSnapOvershootDuration;             ///< Duration for overshoot snapping back to Vector3::ZERO
 938   AlphaFunction mSnapOvershootAlphaFunction;    ///< AlphaFunction to be used for this overshoot.
 939
 940   float mSnapDuration;                          ///< Time for the snap animation to take (in seconds).
 941   AlphaFunction mSnapAlphaFunction;             ///< AlphaFunction to be used for the Snap Animation.
 942
 943   float mFlickDuration;                         ///< Time for the flick animation to take (in seconds).
 944   AlphaFunction mFlickAlphaFunction;            ///< AlphaFunction to be used for the Flick Animation.
 945
 946   float mAxisAutoLockGradient;                  ///< Axis Auto-lock gradient threshold. Above this gradient and it will lock scrolling to closest axis.
 947   float mFrictionCoefficient;                   ///< Friction coefficient. Amount of friction to apply to free panning flick animation. in stage.lengths/sec
 948   float mFlickSpeedCoefficient;                 ///< Flick velocity coefficient. Input touch velocity is multiplied by this.
 949   float mMaxFlickSpeed;                         ///< Maximum flick speed. Maximum speed of flick in stage.lengths/sec.
 950
 951   Vector2 mMouseWheelScrollDistanceStep;        ///< The step of scroll distance in actor coordinates in X and Y axes for each mouse wheel event received.
 952
 953   //ScrollInternalConstraintsPtr mScrollInternalConstraints;
 954   ActiveConstraint mScrollMainInternalPrePositionConstraint;
 955   ActiveConstraint mScrollMainInternalPositionConstraint;
 956   ActiveConstraint mScrollMainInternalXConstraint;
 957   ActiveConstraint mScrollMainInternalYConstraint;
 958   ActiveConstraint mScrollMainInternalOvershootXConstraint;
 959   ActiveConstraint mScrollMainInternalOvershootYConstraint;
 960   ActiveConstraint mScrollMainInternalDeltaConstraint;
 961   ActiveConstraint mScrollMainInternalFinalConstraint;
 962   ActiveConstraint mScrollMainInternalRelativeConstraint;
 963
 964   ScrollOvershootIndicatorPtr mOvershootIndicator;
 965
 966   Toolkit::ScrollView::SnapStartedSignalV2 mSnapStartedSignalV2;
 967
 968   bool mInAccessibilityPan : 1;           ///< With AccessibilityPan its easier to move between snap positions
 969   bool mInitialized:1;
 970   bool mScrolling:1;                      ///< Flag indicating whether the scroll view is being scrolled (by user or animation)
 971   bool mScrollInterrupted:1;              ///< Flag set for when a down event interrupts a scroll
 972   bool mPanning:1;                        ///< Whether scroll view is currently panning or not
 973   bool mSensitive:1;                      ///< Scroll Sensitivity Flag.
 974   bool mTouchDownTimeoutReached:1;        ///< Indicates when down event timeout occured without corresponding up event (touch still down)
 975   bool mActorAutoSnapEnabled:1;           ///< Whether to automatically snap to closest actor.
 976   bool mAutoResizeContainerEnabled:1;     ///< Whether to automatically resize container (affects RulerDomain's on X/Y axes)
 977   bool mWrapMode:1;                       ///< Whether to wrap contents based on container size.
 978   bool mAxisAutoLock:1;                   ///< Whether to automatically lock axis when panning.
 979   bool mAlterChild:1;                     ///< Internal flag to control behavior of OnChildAdd/OnChildRemove when Adding internal Actors.
 980   bool mDefaultMaxOvershoot:1;            ///< Whether to use default max overshoot or application defined one
 981   bool mUserSetPosition:1;                ///< SetScrollPosition has been called, return this position until internals get control of scroll position again
 982 };
 983
 984 } // namespace Internal
 985
 986 // Helpers for public-api forwarding methods
 987
 988 inline Toolkit::Internal::ScrollView& GetImpl(Toolkit::ScrollView& scrollView)
 989 {
 990   DALI_ASSERT_ALWAYS(scrollView);
 991
 992   Dali::RefObject& handle = scrollView.GetImplementation();
 993
 994   return static_cast<Toolkit::Internal::ScrollView&>(handle);
 995 }
 996
 997 inline const Toolkit::Internal::ScrollView& GetImpl(const Toolkit::ScrollView& scrollView)
 998 {
 999   DALI_ASSERT_ALWAYS(scrollView);
1000
1001   const Dali::RefObject& handle = scrollView.GetImplementation();
1002
1003   return static_cast<const Toolkit::Internal::ScrollView&>(handle);
1004 }
1005
1006 } // namespace Toolkit
1007
1008 } // namespace Dali
1009
1010 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__