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