1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
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>
42 typedef IntrusivePtr<ScrollView> ScrollViewPtr;
44 class ScrollInternalConstraints;
45 typedef IntrusivePtr<ScrollInternalConstraints> ScrollInternalConstraintsPtr;
47 class ScrollOvershootIndicator;
48 typedef IntrusivePtr<ScrollOvershootIndicator> ScrollOvershootIndicatorPtr;
51 * @copydoc Toolkit::ScrollView
53 class ScrollView : public ScrollBase
58 * FindDirection specifies how searching is conducted within the Find... routines.
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 (>)
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).
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
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;
95 typedef std::vector<Dali::Toolkit::ScrollViewEffect> ScrollViewEffectContainer; ///< Container of Dali::Toolkit::ScrollViewEffect
96 typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer
101 * Create a new ScrollView.
102 * @return A public handle to the newly allocated ScrollView.
104 static Dali::Toolkit::ScrollView New();
109 * @copydoc Toolkit::ScrollView::GetScrollSnapAlphaFunction
111 AlphaFunction GetScrollSnapAlphaFunction() const;
114 * @copydoc Toolkit::ScrollView::SetScrollSnapAlphaFunction
116 void SetScrollSnapAlphaFunction(AlphaFunction alpha);
119 * @copydoc Toolkit::ScrollView::GetScrollFlickAlphaFunction
121 AlphaFunction GetScrollFlickAlphaFunction() const;
124 * @copydoc Toolkit::ScrollView::SetScrollFlickAlphaFunction
126 void SetScrollFlickAlphaFunction(AlphaFunction alpha);
129 * @copydoc Toolkit::ScrollView::GetScrollSnapDuration
131 float GetScrollSnapDuration() const;
134 * @copydoc Toolkit::ScrollView::SetScrollSnapDuration
136 void SetScrollSnapDuration(float time);
139 * @copydoc Toolkit::ScrollView::GetScrollFlickDuration
141 float GetScrollFlickDuration() const;
144 * @copydoc Toolkit::ScrollView::SetScrollFlickDuration
146 void SetScrollFlickDuration(float time);
149 * @copydoc Toolkit::ScrollView::ApplyEffect
151 void ApplyEffect(Toolkit::ScrollViewEffect effect);
154 * @copydoc Toolkit::ScrollView::RemoveEffect
156 void RemoveEffect(Toolkit::ScrollViewEffect effect);
159 * @copydoc Toolkit::ScrollView::RemoveAllEffects
161 void RemoveAllEffects();
164 * @copydoc Toolkit::ScrollView::ApplyConstraintToChildren
166 void ApplyConstraintToChildren(Constraint constraint);
169 * @copydoc Toolkit::ScrollView::RemoveConstraintsFromChildren
171 void RemoveConstraintsFromChildren();
174 * @copydoc Toolkit::ScrollView::GetRulerX
176 const RulerPtr GetRulerX() const;
179 * @copydoc Toolkit::ScrollView::GetRulerY
181 const RulerPtr GetRulerY() const;
184 * @copydoc Toolkit::ScrollView::SetRulerX
186 void SetRulerX(RulerPtr ruler);
189 * @copydoc Toolkit::ScrollView::SetRulerY
191 void SetRulerY(RulerPtr ruler);
194 * Retrieve the touch sensitivity.
196 * @return whether the touch sensitivity is true or false.
198 bool GetScrollSensitive();
201 * @copydoc Toolkit::ScrollView::SetScrollSensitive
203 void SetScrollSensitive(bool sensitive);
206 * @copydoc Toolkit::ScrollView::SetMaxOvershoot
208 void SetMaxOvershoot(float overshootX, float overshootY);
211 * @copydoc Toolkit::ScrollView::SetSnapOvershootAlphaFunction
213 void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
216 * Retrieve the duartion of Snap Overshoot animation
218 * @return the duration.
220 float GetSnapOvershootDuration();
223 * @copydoc Toolkit::ScrollView::SetSnapOvershootDuration
225 void SetSnapOvershootDuration(float duration);
228 * Retrieve whether Actor Auto-Snap mode is enabled or not.
230 * @return Actor Auto-Snap mode Enabled flag.
232 bool GetActorAutoSnap();
235 * @copydoc Toolkit::ScrollView::SetActorAutoSnap
237 void SetActorAutoSnap(bool enable);
240 * Enables or Disables Auto Resizing mode for ScrollView contents.
242 * When enabled, the ScrollView's X/Y Domains are restricted to the
243 * dimensions of the content's bounds, which may change as Actors are
244 * Added/Removed, and repositioned.
246 * @note This has been disabled for now, as this requires some fundamental
247 * changes to the way Actors positions and bounds are retrieved.
248 * (currently only constraints have these initial state knowledge)
250 * @param[in] enable Enables (true), or disables (false) Auto Resize.
252 void SetAutoResize(bool enable);
255 * Returns whether the wrap mode has been enabled (true) or not (false).
257 * @return Wrap Mode Enabled flag.
259 bool GetWrapMode() const;
262 * @copydoc Toolkit::ScrollView::SetWrapMode
264 void SetWrapMode(bool enable);
267 * @copydoc Toolkit::ScrollView::GetScrollupdateDistance
269 int GetScrollUpdateDistance() const;
272 * @copydoc Toolkit::ScrollView::SetScrollUpdateDistance
274 void SetScrollUpdateDistance(int distance);
277 * @copydoc Toolkit::ScrollView::GetAxisAutoLock
279 bool GetAxisAutoLock() const;
282 * @copydoc Toolkit::ScrollView::SetAxisAutoLock
284 void SetAxisAutoLock(bool enable);
287 * @copydoc Toolkit::ScrollView::GetAxisAutoLockGradient
289 float GetAxisAutoLockGradient() const;
292 * @copydoc Toolkit::ScrollView::SetAxisAutoLockGradient
294 void SetAxisAutoLockGradient(float gradient);
297 * @copydoc Toolkit::ScrollView::GetFrictionCoefficient
299 float GetFrictionCoefficient() const;
302 * @copydoc Toolkit::ScrollView::SetFrictionCoefficient
304 void SetFrictionCoefficient(float friction);
307 * @copydoc Toolkit::ScrollView::GetFlickSpeedCoefficient
309 float GetFlickSpeedCoefficient() const;
312 * @copydoc Toolkit::ScrollView::SetFlickSpeedCoefficient
314 void SetFlickSpeedCoefficient(float speed);
317 * @copydoc Toolkit::ScrollView::GetMinimumDistanceForFlick
319 Vector2 GetMinimumDistanceForFlick() const;
322 * @copydoc Toolkit::ScrollView::SetMinimumDistanceForFlick
324 void SetMinimumDistanceForFlick( const Vector2& distance );
327 * @copydoc Toolkit::ScrollView::GetMinimumSpeedForFlick
329 float GetMinimumSpeedForFlick() const;
332 * @copydoc Toolkit::ScrollView::SetMinimumSpeedForFlick
334 void SetMinimumSpeedForFlick( float speed );
337 * @copydoc Toolkit::ScrollView::GetMaxFlickSpeed
339 float GetMaxFlickSpeed() const;
342 * @copydoc Toolkit::ScrollView::SetMaxFlickSpeed
344 void SetMaxFlickSpeed(float speed);
347 * @copydoc Toolkit::ScrollView::GetWheelScrollDistanceStep
349 Vector2 GetWheelScrollDistanceStep() const;
352 * @copydoc Toolkit::ScrollView::SetWheelScrollDistanceStep
354 void SetWheelScrollDistanceStep(Vector2 step);
357 * @copydoc Toolkit::ScrollView::GetCurrentPage
359 unsigned int GetCurrentPage() const;
362 * @copydoc Toolkit::ScrollView::GetCurrentScrollPosition
364 Vector2 GetCurrentScrollPosition() const;
367 * @copydoc ScrollTo(const Vector2&)
369 void TransformTo(const Vector2& position,
370 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
373 * @copydoc ScrollTo(const Vector2&, float, AlhpaFunction, DirectionBias, DirectionBias)
375 void TransformTo(const Vector2& position, float duration, AlphaFunction alpha,
376 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
379 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector2 &position)
381 void ScrollTo(const Vector2 &position);
384 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration)
386 void ScrollTo(const Vector2& position, float duration);
389 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration, AlphaFunction alpha)
391 void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha);
394 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector2 &position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
396 void ScrollTo(const Vector2& position, float duration,
397 DirectionBias horizontalBias, DirectionBias verticalBias);
400 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector2 &position, float duration, AlphaFunction alpha, DirectionBias horizontalBias, DirectionBias verticalBias)
402 void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha,
403 DirectionBias horizontalBias, DirectionBias verticalBias);
406 * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page)
408 void ScrollTo(unsigned int page);
411 * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
413 void ScrollTo(unsigned int page, float duration, DirectionBias bias = DirectionBiasNone);
416 * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor)
418 void ScrollTo(Actor &actor);
421 * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor, float duration)
423 void ScrollTo(Actor &actor, float duration);
426 * @copydoc Toolkit::ScrollView::SetScrollingDirection()
428 void SetScrollingDirection( Radian direction, Radian threshold );
431 * @copydoc Toolkit::ScrollView::RemoveScrollingDirection()
433 void RemoveScrollingDirection( Radian angle );
436 * Finds the closest Actor to the current center of the ScrollView.
438 * @return A handle to the actor if found, or an empty handle if not.
440 Actor FindClosestActor();
443 * Finds the closest Actor to position in ScrollView
445 * @param[in] position position within ScrollView.
446 * @param[in] dirX Whether to search only those elements that are Left,Right, or All
447 * @param[in] dirY Whether to search only those elements that are Up,Down, or All
448 * @param[in] dirZ Whether to search only those elements that are Out,In, or All
449 * @return A handle to the actor if found, or an empty handle if not.
451 Actor FindClosestActorToPosition(const Vector3& position, FindDirection dirX = All, FindDirection dirY = All, FindDirection dirZ = All);
454 * @copydoc Toolkit::ScrollView::ScrollToSnapPoint
456 bool ScrollToSnapPoint();
461 void StopAnimation(void);
464 * Stops the input animation
466 * @param[in] the animation to stop
468 void StopAnimation(Animation& animation);
471 * Animates to position transform.
473 * @param[in] position The position to animate to
474 * @param[in] positionDuration 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.
481 bool AnimateTo(const Vector2& position, const Vector2& positionDuration,
482 AlphaFunction alpha, bool findShortcuts = true,
483 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone,
484 SnapType snapType = Snap);
487 * @copydoc Toolkit::Scrollable::AddOverlay()
489 void AddOverlay(Actor actor);
492 * @copydoc Toolkit::Scrollable::RemoveOverlay()
494 void RemoveOverlay(Actor actor);
497 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
499 void SetOvershootEffectColor( const Vector4& color );
504 * Called when a property of an object of this type is set.
505 * @param[in] object The object whose property is set.
506 * @param[in] index The property index.
507 * @param[in] value The new property value.
509 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
512 * Called to retrieve a property of an object of this type.
513 * @param[in] object The object whose property is to be retrieved.
514 * @param[in] index The property index.
515 * @return The current value of the property.
517 static Property::Value GetProperty( BaseObject* object, Property::Index index );
522 * @copydoc Dali::Toolkit::ScrollView::SnapStartedSignal()
524 Toolkit::ScrollView::SnapStartedSignalType& SnapStartedSignal();
527 * Connects a callback function with the object's signals.
528 * @param[in] object The object providing the signal.
529 * @param[in] tracker Used to disconnect the signal.
530 * @param[in] signalName The signal to connect to.
531 * @param[in] functor A newly allocated FunctorDelegate.
532 * @return True if the signal was connected.
533 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
535 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
537 private: // private overridden functions from CustomActorImpl and Controls
540 * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
542 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
545 * @copydoc CustomActorImpl::OnSizeSet(const Vector3&)
547 virtual void OnSizeSet( const Vector3& size );
550 * From CustomActorImpl; called after a child has been added to the owning actor.
551 * @param[in] child The child which has been added.
553 virtual void OnChildAdd(Actor& child);
556 * From CustomActorImpl; called shortly before a child is removed from the owning actor.
557 * @param[in] child The child being removed.
559 virtual void OnChildRemove(Actor& child);
562 * From CustomActorImpl; called after a wheelEvent is received by the owning actor.
563 * @param[in] event The wheel event.
564 * @return True if the event should be consumed.
566 virtual bool OnWheelEvent(const WheelEvent& event);
569 * @copydoc Toolkit::Control::OnInitialize()
571 virtual void OnInitialize();
574 * @copydoc CustomActorImpl::OnStageConnection()
576 virtual void OnStageConnection( int depth );
579 * @copydoc CustomActorImpl::OnStageDisconnection()
581 virtual void OnStageDisconnection();
584 * @copydoc Toolkit::Control::OnAccessibilityPan()
586 virtual bool OnAccessibilityPan(PanGesture gesture);
589 * @copydoc Toolkit::Scrollable::EnableScrollOvershoot()
591 virtual void EnableScrollOvershoot(bool enable);
596 * Called after a touchSignal is received by the owning actor.
598 * We don't consume these events as content within the container may consume events.
600 * @param[in] actor The touched actor.
601 * @param[in] touch The touch information.
602 * @return True if the event should be consumed.
604 bool OnTouch( Actor actor, const TouchData& touch );
607 * Start a timer which calls OnTouchDownTimeout()
609 void StartTouchDownTimer();
612 * Stop a timer which calls OnTouchDownTimeout()
614 void StopTouchDownTimer();
617 * Helper to detect when touch-point has been down (outside of pan gesture)
619 bool OnTouchDownTimeout();
622 * Called whenever a snap animation has completed
623 * @param[in] source the Animation instance that has completed.
624 * Resets all scrolling animations and states, leaving current scroll position at SCROLL_POSITION
626 void ResetScrolling();
629 * Updates mScrollInternalPosition, mScrollPrePosition and mScrollPostPosition from their property counterparts
631 void UpdateLocalScrollProperties();
634 * Makes sure scroll values are ready for animated scrolling
636 void PreAnimatedScrollSetup();
639 * Finish an animated scroll, ensuring all scroll properties are updated
642 void FinaliseAnimatedScroll();
645 * Animates the internal x property to the given value
647 * @param[in] position The X position to animate to
648 * @param[in] duration The time in seconds for animation
649 * @param[in] alpha The alpha function to use for animating
651 void AnimateInternalXTo( float position, float duration, AlphaFunction alpha );
654 * Animates the internal y property to the given value
656 * @param[in] position The Y position to animate to
657 * @param[in] duration The time in seconds for animation
658 * @param[in] alpha The alpha function to use for animating
660 void AnimateInternalYTo( float position, float duration, AlphaFunction alpha );
663 * Called whenever a snap animation on the x-axis has completed
664 * @param[in] source the Animation instance that has completed.
666 void OnScrollAnimationFinished( Animation& source );
669 * Called when either the X or Y internal scroll positions have finished snapping back to SCROLL_PRE_POSITION
671 * @param[in] source the Animation instance that has completed.
673 void OnSnapInternalPositionFinished( Animation& source );
676 * Called whenever a snap animation on the x-axis has completed and we need to snap pre scroll
677 * position to our clamped position
678 * @param[in] position The x position to snap pre scroll property to
680 void SnapInternalXTo( float position );
683 * Called whenever a snap animation on the y-axis has completed and we need to snap pre scroll
684 * position to our clamped position
685 * @param[in] position The y position to snap pre scroll property to
687 void SnapInternalYTo( float position );
690 * This is called internally whenever the Scroll Rulers are
691 * modified. This will update the properties: 'scrollPositionMin'
692 * and 'scrollPositionMax' to reflect the changes.
694 void UpdatePropertyDomain();
697 * Called when the gesture starts.
699 void GestureStarted();
702 * Amalgamated Gesture Continuing event
704 * @param[in] panDelta average panning delta from base position (0)
706 void GestureContinuing(const Vector2& panDelta);
709 * Called upon pan gesture event.
711 * @param[in] gesture The gesture event.
713 void OnPan( const PanGesture& pan);
716 * Extension of the above gestures.
718 * @param[in] gesture The gesture event.
720 void OnGestureEx(Gesture::State state);
723 * Performs snapping while taking into account Velocity of gesture
724 * (velocity in pixels/sec)
726 * @param[in] velocity velocity in pixels/sec
728 bool SnapWithVelocity(Vector2 velocity);
731 * Finishes Container Transform
732 * (occurs upon finishing gesture i.e. releasing)
734 void FinishTransform();
737 * Returns overshoot vector based on current position
739 * Overshoot vector is defined as how far outside of bounds
740 * the viewport is trying to view (prior to being clamped).
742 * an overshoot of (100,50), means user is in bottom right corner,
743 * trying to pan +100 to the right, and +50 below. This can be used
744 * to determine an effect, such as stretching.
746 * @param[in] position The position for which you wish to obtain overshoot vector
748 Vector2 GetOvershoot(Vector2& position) const;
751 * Clamps position within the domain set up by X/Y Rulers
753 * @param[in,out] position The position you wish to clamp
755 void ClampPosition(Vector2& position) const;
758 * Clamps position within the domain set up by X/Y Rulers
760 * @param[in,out] position The position you wish to clamp
761 * @param[out] clamped The results of the clamping.
763 void ClampPosition(Vector2& position, ClampState2D &clamped) const;
766 * Wraps position within the domain set up by X/Y Rulers
768 * @note Only wraps if mWrapMode is enabled, and respective domains
771 * @param[in,out] position The position you wish to wrap
773 void WrapPosition(Vector2& position) const;
776 * Updates the main internal scroll constraints with new ruler and domain
779 void UpdateMainInternalConstraint();
782 * Enables/disables the overshoot constraints
784 * @param[in] enabled whether to enable or disable the overshoot constraints
786 void SetOvershootConstraintsEnabled(bool enabled);
789 * Sets internal constraints for this ScrollView.
790 * Many of these internal constraints are based on properties within
793 void SetInternalConstraints();
798 * Construct a new ScrollView.
803 * A reference counted object may only be deleted by calling Unreference()
805 virtual ~ScrollView();
810 * Searches this ScrollView, and attempts to Unbind
811 * systematically this Actor from the ScrollView attached.
813 * @param[in] child The actor to be unbound.
815 virtual void FindAndUnbindActor(Actor child);
818 * Gets position property.
820 * @return The current position
822 Vector2 GetPropertyPrePosition() const;
825 * Gets position property.
827 * @return The current position
829 Vector2 GetPropertyPosition() const;
832 * Handles a Stopped animation. Its position properties need to be saved, and the animation flag
835 void HandleStoppedAnimation();
838 * Handles a Stopped animation (whether the animation completed, or was
839 * manually stopped). Its position properties need to be saved, and the
840 * animation flag switched off.
842 void HandleSnapAnimationFinished();
845 * Checks if the property notifications are active and adds them if not
847 void SetScrollUpdateNotification( bool enabled );
850 * Refresh the ScrollView (used when animating to update application developer of changes)
851 * @return True if the refresh timer should be kept running.
853 void OnScrollUpdateNotification(Dali::PropertyNotification& source);
858 ScrollView(const ScrollView&);
861 ScrollView& operator=(const ScrollView& rhs);
865 unsigned long mTouchDownTime; ///< The touch down time
867 int mGestureStackDepth; ///< How many gestures are currently occuring.
868 Vector2 mPanStartPosition; ///< Where the pan gesture's touch down occured
869 Vector2 mPanDelta; ///< Amount currently panned.
871 unsigned int mScrollStateFlags; ///< flags indicating current state of scrolling
872 // Scroll delegate pre and post position properties...
873 Vector2 mScrollPrePosition; ///< Wrapped scroll position, but not clamped
874 Vector2 mScrollPostPosition; ///< Wrapped and clamped, this is the final scroll position used
875 Vector2 mScrollTargetPosition; ///< Final target position for an animated scroll
876 Vector2 mDomainOffset; ///< Domain offset (this keeps track of the domain boundaries that scroll positions traverses)
878 // Rulers for each axes...
882 // Last property values set to ScrollView
886 Animation mInternalXAnimation; ///< Animates mPropertyX to a snap position or application requested scroll position
887 Animation mInternalYAnimation; ///< Animates mPropertyY to a snap position or application requested scroll position
890 Vector2 mLastVelocity; ///< Record the last velocity from PanGesture (Finish event doesn't have correct velocity)
893 Timer mTouchDownTimer; ///< Used to interrupt snap-animation. This cannot be done in OnTouch without breaking fast flick behavior.
895 float mScrollUpdateDistance; ///< Distance for scrolling to travel for the scroll update notifications
896 Dali::PropertyNotification mScrollXUpdateNotification; ///< scroll x position update notification
897 Dali::PropertyNotification mScrollYUpdateNotification; ///< scroll y position update notification
899 Actor mInternalActor; ///< Internal actor (we keep internal actors in here e.g. scrollbars, so we can ignore it in searches)
901 ScrollViewEffectContainer mEffects; ///< Container keeping track of all the applied effects.
903 Vector2 mMaxOvershoot; ///< Number of scrollable pixels that will take overshoot from 0.0f to 1.0f
904 Vector2 mUserMaxOvershoot; ///< Set by user, allows overriding of default max overshoot for the scroll indicator
905 float mSnapOvershootDuration; ///< Duration for overshoot snapping back to Vector2::ZERO
906 AlphaFunction mSnapOvershootAlphaFunction; ///< AlphaFunction to be used for this overshoot.
908 float mSnapDuration; ///< Time for the snap animation to take (in seconds).
909 AlphaFunction mSnapAlphaFunction; ///< AlphaFunction to be used for the Snap Animation.
911 Vector2 mMinFlickDistance; ///< Minimum pan distance required for a flick
912 float mFlickSpeedThreshold; ///< Minimum pan speed required for a flick in pixels/ms
913 float mFlickDuration; ///< Time for the flick animation to take (in seconds).
914 AlphaFunction mFlickAlphaFunction; ///< AlphaFunction to be used for the Flick Animation.
916 float mAxisAutoLockGradient; ///< Axis Auto-lock gradient threshold. Above this gradient and it will lock scrolling to closest axis.
917 float mFrictionCoefficient; ///< Friction coefficient. Amount of friction to apply to free panning flick animation. in stage.lengths/sec
918 float mFlickSpeedCoefficient; ///< Flick velocity coefficient. Input touch velocity is multiplied by this.
919 float mMaxFlickSpeed; ///< Maximum flick speed. Maximum speed of flick in stage.lengths/sec.
921 Vector2 mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates in X and Y axes for each wheel event received.
923 //ScrollInternalConstraintsPtr mScrollInternalConstraints;
924 Constraint mScrollMainInternalPrePositionConstraint;
925 Constraint mScrollMainInternalPositionConstraint;
926 Constraint mScrollMainInternalOvershootXConstraint;
927 Constraint mScrollMainInternalOvershootYConstraint;
928 Constraint mScrollMainInternalDeltaConstraint;
929 Constraint mScrollMainInternalFinalConstraint;
930 Constraint mScrollMainInternalRelativeConstraint;
931 Constraint mScrollMainInternalDomainConstraint;
932 Constraint mScrollMainInternalPrePositionMaxConstraint;
934 ScrollOvershootIndicatorPtr mOvershootIndicator;
936 Toolkit::ScrollView::SnapStartedSignalType mSnapStartedSignal;
938 bool mInAccessibilityPan:1; ///< With AccessibilityPan its easier to move between snap positions
939 bool mScrolling:1; ///< Flag indicating whether the scroll view is being scrolled (by user or animation)
940 bool mScrollInterrupted:1; ///< Flag set for when a down event interrupts a scroll
941 bool mPanning:1; ///< Whether scroll view is currently panning or not
942 bool mSensitive:1; ///< Scroll Sensitivity Flag.
943 bool mTouchDownTimeoutReached:1; ///< Indicates when down event timeout occured without corresponding up event (touch still down)
944 bool mActorAutoSnapEnabled:1; ///< Whether to automatically snap to closest actor.
945 bool mAutoResizeContainerEnabled:1; ///< Whether to automatically resize container (affects RulerDomain's on X/Y axes)
946 bool mWrapMode:1; ///< Whether to wrap contents based on container size.
947 bool mAxisAutoLock:1; ///< Whether to automatically lock axis when panning.
948 bool mAlterChild:1; ///< Internal flag to control behavior of OnChildAdd/OnChildRemove when Adding internal Actors.
949 bool mDefaultMaxOvershoot:1; ///< Whether to use default max overshoot or application defined one
950 bool mCanScrollHorizontal:1; ///< Local value of our property to check against
951 bool mCanScrollVertical:1; ///< Local value of our property to check against
954 } // namespace Internal
956 // Helpers for public-api forwarding methods
958 inline Toolkit::Internal::ScrollView& GetImpl(Toolkit::ScrollView& scrollView)
960 DALI_ASSERT_ALWAYS(scrollView);
962 Dali::RefObject& handle = scrollView.GetImplementation();
964 return static_cast<Toolkit::Internal::ScrollView&>(handle);
967 inline const Toolkit::Internal::ScrollView& GetImpl(const Toolkit::ScrollView& scrollView)
969 DALI_ASSERT_ALWAYS(scrollView);
971 const Dali::RefObject& handle = scrollView.GetImplementation();
973 return static_cast<const Toolkit::Internal::ScrollView&>(handle);
976 } // namespace Toolkit
980 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__