1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__
5 * Copyright (c) 2014 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 * @copydoc Toolkit::ScrollView::SetScrollSensitive
196 void SetScrollSensitive(bool sensitive);
199 * @copydoc Toolkit::ScrollView::SetMaxOvershoot
201 void SetMaxOvershoot(float overshootX, float overshootY);
204 * @copydoc Toolkit::ScrollView::SetSnapOvershootAlphaFunction
206 void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
209 * @copydoc Toolkit::ScrollView::SetSnapOvershootDuration
211 void SetSnapOvershootDuration(float duration);
214 * @copydoc Toolkit::ScrollView::SetActorAutoSnap
216 void SetActorAutoSnap(bool enable);
219 * Enables or Disables Auto Resizing mode for ScrollView contents.
221 * When enabled, the ScrollView's X/Y Domains are restricted to the
222 * dimensions of the content's bounds, which may change as Actors are
223 * Added/Removed, and repositioned.
225 * @note This has been disabled for now, as this requires some fundamental
226 * changes to the way Actors positions and bounds are retrieved.
227 * (currently only constraints have these initial state knowledge)
229 * @param[in] enable Enables (true), or disables (false) Auto Resize.
231 void SetAutoResize(bool enable);
234 * Returns whether the wrap mode has been enabled (true) or not (false).
236 * @return Wrap Mode Enabled flag.
238 bool GetWrapMode() const;
241 * @copydoc Toolkit::ScrollView::SetWrapMode
243 void SetWrapMode(bool enable);
246 * @copydoc Toolkit::ScrollView::GetScrollupdateDistance
248 int GetScrollUpdateDistance() const;
251 * @copydoc Toolkit::ScrollView::SetScrollUpdateDistance
253 void SetScrollUpdateDistance(int distance);
256 * @copydoc Toolkit::ScrollView::GetAxisAutoLock
258 bool GetAxisAutoLock() const;
261 * @copydoc Toolkit::ScrollView::SetAxisAutoLock
263 void SetAxisAutoLock(bool enable);
266 * @copydoc Toolkit::ScrollView::GetAxisAutoLockGradient
268 float GetAxisAutoLockGradient() const;
271 * @copydoc Toolkit::ScrollView::SetAxisAutoLockGradient
273 void SetAxisAutoLockGradient(float gradient);
276 * @copydoc Toolkit::ScrollView::GetFrictionCoefficient
278 float GetFrictionCoefficient() const;
281 * @copydoc Toolkit::ScrollView::SetFrictionCoefficient
283 void SetFrictionCoefficient(float friction);
286 * @copydoc Toolkit::ScrollView::GetFlickSpeedCoefficient
288 float GetFlickSpeedCoefficient() const;
291 * @copydoc Toolkit::ScrollView::SetFlickSpeedCoefficient
293 void SetFlickSpeedCoefficient(float speed);
296 * @copydoc Toolkit::ScrollView::GetMinimumDistanceForFlick
298 Vector2 GetMinimumDistanceForFlick() const;
301 * @copydoc Toolkit::ScrollView::SetMinimumDistanceForFlick
303 void SetMinimumDistanceForFlick( const Vector2& distance );
306 * @copydoc Toolkit::ScrollView::GetMinimumSpeedForFlick
308 float GetMinimumSpeedForFlick() const;
311 * @copydoc Toolkit::ScrollView::SetMinimumSpeedForFlick
313 void SetMinimumSpeedForFlick( float speed );
316 * @copydoc Toolkit::ScrollView::GetMaxFlickSpeed
318 float GetMaxFlickSpeed() const;
321 * @copydoc Toolkit::ScrollView::SetMaxFlickSpeed
323 void SetMaxFlickSpeed(float speed);
326 * @copydoc Toolkit::ScrollView::GetMouseWheelScrollDistanceStep
328 Vector2 GetMouseWheelScrollDistanceStep() const;
331 * @copydoc Toolkit::ScrollView::SetMouseWheelScrollDistanceStep
333 void SetMouseWheelScrollDistanceStep(Vector2 step);
336 * @copydoc Toolkit::ScrollView::GetCurrentPage
338 unsigned int GetCurrentPage() const;
341 * @copydoc Toolkit::ScrollView::GetCurrentScrollPosition
343 Vector3 GetCurrentScrollPosition() const;
346 * @copydoc Toolkit::ScrollView::SetScrollPosition
348 void SetScrollPosition(const Vector3& position);
351 * @copydoc Toolkit::Scrollable::GetDomainSize
353 Vector3 GetDomainSize() const;
356 * @copydoc ScrollTo(const Vector3&)
358 void TransformTo(const Vector3& position,
359 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
362 * @copydoc ScrollTo(const Vector3&, float, AlhpaFunction, DirectionBias, DirectionBias)
364 void TransformTo(const Vector3& position, float duration, AlphaFunction alpha,
365 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone);
368 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position)
370 void ScrollTo(const Vector3 &position);
373 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
375 void ScrollTo(const Vector3& position, float duration);
378 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration, AlphaFunction alpha)
380 void ScrollTo(const Vector3& position, float duration, AlphaFunction alpha);
383 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
385 void ScrollTo(const Vector3& position, float duration,
386 DirectionBias horizontalBias, DirectionBias verticalBias);
389 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha, DirectionBias horizontalBias, DirectionBias verticalBias)
391 void ScrollTo(const Vector3& position, float duration, AlphaFunction alpha,
392 DirectionBias horizontalBias, DirectionBias verticalBias);
395 * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page)
397 void ScrollTo(unsigned int page);
400 * @copydoc Toolkit::ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
402 void ScrollTo(unsigned int page, float duration, DirectionBias bias = DirectionBiasNone);
405 * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor)
407 void ScrollTo(Actor &actor);
410 * @copydoc Toolkit::ScrollView::ScrollTo(Actor& actor, float duration)
412 void ScrollTo(Actor &actor, float duration);
415 * @copydoc Toolkit::ScrollView::SetScrollingDirection()
417 void SetScrollingDirection( Radian direction, Radian threshold );
420 * @copydoc Toolkit::ScrollView::RemoveScrollingDirection()
422 void RemoveScrollingDirection( Radian angle );
425 * Finds the closest Actor to the current center of the ScrollView.
427 * @return A handle to the actor if found, or an empty handle if not.
429 Actor FindClosestActor();
432 * Finds the closest Actor to position in ScrollView
434 * @param[in] position position within ScrollView.
435 * @param[in] dirX Whether to search only those elements that are Left,Right, or All
436 * @param[in] dirY Whether to search only those elements that are Up,Down, or All
437 * @param[in] dirZ Whether to search only those elements that are Out,In, or All
438 * @return A handle to the actor if found, or an empty handle if not.
440 Actor FindClosestActorToPosition(const Vector3& position, FindDirection dirX = All, FindDirection dirY = All, FindDirection dirZ = All);
443 * @copydoc Toolkit::ScrollView::ScrollToSnapPoint
445 bool ScrollToSnapPoint();
450 void StopAnimation(void);
453 * Stops the input animation
455 * @param[in] the animation to stop
457 void StopAnimation(Animation& animation);
460 * Animates to position transform.
462 * @param[in] position The position to animate to
463 * @param[in] positionDuration The number of seconds this animation should run for in each axis.
464 * @param[in] alpha The easing alpha function to use.
465 * @param[in] findShortcuts (optional) Whether to find the shortest route (in Wrap mode)
466 * @param[in] horizontalBias (optional) Whether to bias animation to left or right (or no biasing)
467 * @param[in] verticalBias (optional) Whether to bias animation to top or bottom (or no biasing)
468 * @return True if animation necessary and taking place to reach desired transform.
470 bool AnimateTo(const Vector3& position, const Vector3& positionDuration,
471 AlphaFunction alpha, bool findShortcuts = true,
472 DirectionBias horizontalBias = DirectionBiasNone, DirectionBias verticalBias = DirectionBiasNone,
473 SnapType snapType = Snap);
476 * @copydoc Toolkit::Scrollable::AddOverlay()
478 void AddOverlay(Actor actor);
481 * @copydoc Toolkit::Scrollable::RemoveOverlay()
483 void RemoveOverlay(Actor actor);
486 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
488 void SetOvershootEffectColor( const Vector4& color );
493 * @copydoc Dali::Toolkit::ScrollView::SnapStartedSignal()
495 Toolkit::ScrollView::SnapStartedSignalType& SnapStartedSignal();
498 * Connects a callback function with the object's signals.
499 * @param[in] object The object providing the signal.
500 * @param[in] tracker Used to disconnect the signal.
501 * @param[in] signalName The signal to connect to.
502 * @param[in] functor A newly allocated FunctorDelegate.
503 * @return True if the signal was connected.
504 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
506 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
508 private: // private overriden functions from CustomActorImpl and Controls
511 * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
513 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
516 * @copydoc Dali::Control::OnControlSizeSet(const Vector3&)
518 virtual void OnControlSizeSet( const Vector3& size );
521 * From CustomActorImpl; called after a child has been added to the owning actor.
522 * @param[in] child The child which has been added.
524 virtual void OnChildAdd(Actor& child);
527 * From CustomActorImpl; called shortly before a child is removed from the owning actor.
528 * @param[in] child The child being removed.
530 virtual void OnChildRemove(Actor& child);
533 * From CustomActorImpl; called after a touch-signal is received by the owning actor.
535 * We don't listen to these events as content within the contain may consume events.
537 * @param[in] event The touch event.
538 * @return True if the event should be consumed.
540 virtual bool OnTouchEvent(const TouchEvent& event);
543 * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
544 * @param[in] event The mouse wheel event.
545 * @return True if the event should be consumed.
547 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
550 * @copydoc Toolkit::Control::OnInitialize()
552 virtual void OnInitialize();
555 * @copydoc Toolkit::Control::OnControlStageConnection()
557 virtual void OnControlStageConnection();
560 * @copydoc Toolkit::Control::OnControlStageConnection()
562 virtual void OnControlStageDisconnection();
565 * @copydoc Toolkit::Control::OnAccessibilityPan()
567 virtual bool OnAccessibilityPan(PanGesture gesture);
570 * @copydoc Toolkit::Scrollable::SetOvershootEnabled()
572 virtual void SetOvershootEnabled(bool enable);
577 * Start a timer which calls OnTouchDownTimeout()
579 void StartTouchDownTimer();
582 * Stop a timer which calls OnTouchDownTimeout()
584 void StopTouchDownTimer();
587 * Helper to detect when touch-point has been down (outside of pan gesture)
589 bool OnTouchDownTimeout();
592 * Called whenever a snap animation has completed
593 * @param[in] source the Animation instance that has completed.
594 * Resets all scrolling animations and states, leaving current scroll position at SCROLL_POSITION
596 void ResetScrolling();
599 * Updates mScrollInternalPosition, mScrollPrePosition and mScrollPostPosition from their property counterparts
601 void UpdateLocalScrollProperties();
604 * Makes sure scroll values are ready for animated scrolling
606 void PreAnimatedScrollSetup();
609 * Finish an animated scroll, ensuring all scroll properties are updated
612 void FinaliseAnimatedScroll();
615 * Animates the internal x property to the given value
617 * @param[in] position The X position to animate to
618 * @param[in] duration The time in seconds for animation
619 * @param[in] alpha The alpha function to use for animating
621 void AnimateInternalXTo( float position, float duration, AlphaFunction alpha );
624 * Animates the internal y property to the given value
626 * @param[in] position The Y position to animate to
627 * @param[in] duration The time in seconds for animation
628 * @param[in] alpha The alpha function to use for animating
630 void AnimateInternalYTo( float position, float duration, AlphaFunction alpha );
633 * Called whenever a snap animation on the x-axis has completed
634 * @param[in] source the Animation instance that has completed.
636 void OnScrollAnimationFinished( Animation& source );
639 * Called when either the X or Y internal scroll positions have finished snapping back to SCROLL_PRE_POSITION
641 * @param[in] source the Animation instance that has completed.
643 void OnSnapInternalPositionFinished( Animation& source );
646 * Called whenever a snap animation on the x-axis has completed and we need to snap pre scroll
647 * position to our clamped position
648 * @param[in] position The x position to snap pre scroll property to
650 void SnapInternalXTo( float position );
653 * Called whenever a snap animation on the y-axis has completed and we need to snap pre scroll
654 * position to our clamped position
655 * @param[in] position The y position to snap pre scroll property to
657 void SnapInternalYTo( float position );
660 * This is called internally whenever the Scroll Rulers are
661 * modified. This will update the properties: 'scroll-position-min'
662 * and 'scroll-position-max' to reflect the changes.
664 * @param[in] size size of the visible scroll area (ScrollView control size)
666 void UpdatePropertyDomain(const Vector3& size);
669 * Called when the gesture starts.
671 void GestureStarted();
674 * Amalgamated Gesture Continuing event
676 * @param[in] panDelta average panning delta from base position (0)
678 void GestureContinuing(const Vector2& panDelta);
681 * Called upon pan gesture event.
683 * @param[in] gesture The gesture event.
685 void OnPan( const PanGesture& pan);
688 * Extension of the above gestures.
690 * @param[in] gesture The gesture event.
692 void OnGestureEx(Gesture::State state);
695 * Performs snapping while taking into account Velocity of gesture
696 * (velocity in pixels/sec)
698 * @param[in] velocity velocity in pixels/sec
700 bool SnapWithVelocity(Vector2 velocity);
703 * Finishes Container Transform
704 * (occurs upon finishing gesture i.e. releasing)
706 void FinishTransform();
709 * Returns overshoot vector based on current position
711 * Overshoot vector is defined as how far outside of bounds
712 * the viewport is trying to view (prior to being clamped).
714 * an overshoot of (100,50), means user is in bottom right corner,
715 * trying to pan +100 to the right, and +50 below. This can be used
716 * to determine an effect, such as stretching.
718 * @param[in] position The position for which you wish to obtain overshoot vector
720 Vector3 GetOvershoot(Vector3& position) const;
723 * Clamps position within the domain set up by X/Y Rulers
725 * @param[in,out] position The position you wish to clamp
727 void ClampPosition(Vector3& position) const;
730 * Clamps position within the domain set up by X/Y Rulers
732 * @param[in,out] position The position you wish to clamp
733 * @param[out] clamped The results of the clamping.
735 void ClampPosition(Vector3& position, ClampState3D &clamped) const;
738 * Wraps position within the domain set up by X/Y Rulers
740 * @note Only wraps if mWrapMode is enabled, and respective domains
743 * @param[in,out] position The position you wish to wrap
745 void WrapPosition(Vector3& position) const;
748 * Updates the main internal scroll constraints with new ruler and domain
751 void UpdateMainInternalConstraint();
754 * Enables/disables the overshoot constraints
756 * @param[in] enabled whether to enable or disable the overshoot constraints
758 void SetOvershootConstraintsEnabled(bool enabled);
761 * Sets internal constraints for this ScrollView.
762 * Many of these internal constraints are based on properties within
765 void SetInternalConstraints();
770 * Construct a new ScrollView.
775 * A reference counted object may only be deleted by calling Unreference()
777 virtual ~ScrollView();
782 * Searches this ScrollView, and attempts to Unbind
783 * systematically this Actor from the ScrollView attached.
785 * @param[in] child The actor to be unbound.
787 virtual void FindAndUnbindActor(Actor child);
790 * Gets position property.
792 * @return The current position
794 Vector3 GetPropertyPrePosition() const;
797 * Gets position property.
799 * @return The current position
801 Vector3 GetPropertyPosition() const;
804 * Handles a Stopped animation. Its position properties need to be saved, and the animation flag
807 void HandleStoppedAnimation();
810 * Handles a Stopped animation (whether the animation completed, or was
811 * manually stopped). Its position properties need to be saved, and the
812 * animation flag switched off.
814 void HandleSnapAnimationFinished();
817 * Checks if the property notifications are active and adds them if not
819 void SetScrollUpdateNotification( bool enabled );
822 * Refresh the ScrollView (used when animating to update application developer of changes)
823 * @return True if the refresh timer should be kept running.
825 void OnScrollUpdateNotification(Dali::PropertyNotification& source);
830 ScrollView(const ScrollView&);
833 ScrollView& operator=(const ScrollView& rhs);
837 unsigned long mTouchDownTime; ///< The touch down time
839 int mGestureStackDepth; ///< How many gestures are currently occuring.
840 Vector2 mPanStartPosition; ///< Where the pan gesture's touch down occured
841 Vector3 mPanDelta; ///< Amount currently panned.
843 unsigned int mScrollStateFlags; ///< flags indicating current state of scrolling
844 // Scroll delegate pre and post position properties...
845 Vector3 mScrollPrePosition; ///< Wrapped scroll position, but not clamped
846 Vector3 mScrollPostPosition; ///< Wrapped and clamped, this is the final scroll position used
847 Vector3 mScrollTargetPosition; ///< Final target position for an animated scroll
848 Vector3 mDomainOffset; ///< Domain offset (this keeps track of the domain boundaries that scroll positions traverses)
850 // Rulers for each axes...
854 // Last property values set to ScrollView
858 Animation mInternalXAnimation; ///< Animates mPropertyX to a snap position or application requested scroll position
859 Animation mInternalYAnimation; ///< Animates mPropertyY to a snap position or application requested scroll position
862 Vector2 mLastVelocity; ///< Record the last velocity from PanGesture (Finish event doesn't have correct velocity)
865 Timer mTouchDownTimer; ///< Used to interrupt snap-animation. This cannot be done in OnTouchEvent without breaking fast flick behavior.
867 float mScrollUpdateDistance; ///< Distance for scrolling to travel for the scroll update notifications
868 Dali::PropertyNotification mScrollXUpdateNotification; ///< scroll x position update notification
869 Dali::PropertyNotification mScrollYUpdateNotification; ///< scroll y position update notification
871 Actor mInternalActor; ///< Internal actor (we keep internal actors in here e.g. scrollbars, so we can ignore it in searches)
873 ScrollViewEffectContainer mEffects; ///< Container keeping track of all the applied effects.
875 Vector2 mMaxOvershoot; ///< Number of scrollable pixels that will take overshoot from 0.0f to 1.0f
876 Vector2 mUserMaxOvershoot; ///< Set by user, allows overriding of default max overshoot for the scroll indicator
877 float mSnapOvershootDuration; ///< Duration for overshoot snapping back to Vector3::ZERO
878 AlphaFunction mSnapOvershootAlphaFunction; ///< AlphaFunction to be used for this overshoot.
880 float mSnapDuration; ///< Time for the snap animation to take (in seconds).
881 AlphaFunction mSnapAlphaFunction; ///< AlphaFunction to be used for the Snap Animation.
883 Vector2 mMinFlickDistance; ///< Minimum pan distance required for a flick
884 float mFlickSpeedThreshold; ///< Minimum pan speed required for a flick in pixels/ms
885 float mFlickDuration; ///< Time for the flick animation to take (in seconds).
886 AlphaFunction mFlickAlphaFunction; ///< AlphaFunction to be used for the Flick Animation.
888 float mAxisAutoLockGradient; ///< Axis Auto-lock gradient threshold. Above this gradient and it will lock scrolling to closest axis.
889 float mFrictionCoefficient; ///< Friction coefficient. Amount of friction to apply to free panning flick animation. in stage.lengths/sec
890 float mFlickSpeedCoefficient; ///< Flick velocity coefficient. Input touch velocity is multiplied by this.
891 float mMaxFlickSpeed; ///< Maximum flick speed. Maximum speed of flick in stage.lengths/sec.
893 Vector2 mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates in X and Y axes for each mouse wheel event received.
895 //ScrollInternalConstraintsPtr mScrollInternalConstraints;
896 Constraint mScrollMainInternalPrePositionConstraint;
897 Constraint mScrollMainInternalPositionConstraint;
898 Constraint mScrollMainInternalOvershootXConstraint;
899 Constraint mScrollMainInternalOvershootYConstraint;
900 Constraint mScrollMainInternalDeltaConstraint;
901 Constraint mScrollMainInternalFinalConstraint;
902 Constraint mScrollMainInternalRelativeConstraint;
904 ScrollOvershootIndicatorPtr mOvershootIndicator;
906 Toolkit::ScrollView::SnapStartedSignalType mSnapStartedSignal;
908 bool mInAccessibilityPan : 1; ///< With AccessibilityPan its easier to move between snap positions
910 bool mScrolling:1; ///< Flag indicating whether the scroll view is being scrolled (by user or animation)
911 bool mScrollInterrupted:1; ///< Flag set for when a down event interrupts a scroll
912 bool mPanning:1; ///< Whether scroll view is currently panning or not
913 bool mSensitive:1; ///< Scroll Sensitivity Flag.
914 bool mTouchDownTimeoutReached:1; ///< Indicates when down event timeout occured without corresponding up event (touch still down)
915 bool mActorAutoSnapEnabled:1; ///< Whether to automatically snap to closest actor.
916 bool mAutoResizeContainerEnabled:1; ///< Whether to automatically resize container (affects RulerDomain's on X/Y axes)
917 bool mWrapMode:1; ///< Whether to wrap contents based on container size.
918 bool mAxisAutoLock:1; ///< Whether to automatically lock axis when panning.
919 bool mAlterChild:1; ///< Internal flag to control behavior of OnChildAdd/OnChildRemove when Adding internal Actors.
920 bool mDefaultMaxOvershoot:1; ///< Whether to use default max overshoot or application defined one
921 bool mCanScrollHorizontal:1; ///< Local value of our property to check against
922 bool mCanScrollVertical:1; ///< Local value of our property to check against
925 } // namespace Internal
927 // Helpers for public-api forwarding methods
929 inline Toolkit::Internal::ScrollView& GetImpl(Toolkit::ScrollView& scrollView)
931 DALI_ASSERT_ALWAYS(scrollView);
933 Dali::RefObject& handle = scrollView.GetImplementation();
935 return static_cast<Toolkit::Internal::ScrollView&>(handle);
938 inline const Toolkit::Internal::ScrollView& GetImpl(const Toolkit::ScrollView& scrollView)
940 DALI_ASSERT_ALWAYS(scrollView);
942 const Dali::RefObject& handle = scrollView.GetImplementation();
944 return static_cast<const Toolkit::Internal::ScrollView&>(handle);
947 } // namespace Toolkit
951 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_H__