1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_H__
2 #define __DALI_TOOLKIT_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-toolkit/public-api/controls/scrollable/scrollable.h>
24 namespace Dali DALI_IMPORT_API
30 namespace Internal DALI_INTERNAL
36 * @brief The snap type
45 * @brief DirectionBias types.
49 DirectionBiasLeft = -1, ///< Bias scroll snap to Left
50 DirectionBiasNone = 0, ///< Don't bias scroll snap
51 DirectionBiasRight = 1 ///< Bias scroll snap to Right
55 * @brief Used for specifying minimum/maximum extents of a ruler.
62 * @brief Creates Ruler domain allowing a point to traverse between min and max extents.
64 * @param[in] min Minimum extent (point cannot traverse less than this)
65 * @param[in] max Maximum extent (point cannot traverse greater than this)
66 * @param[in] enabled Whether domain has been enabled or not.
68 explicit RulerDomain(float min, float max, bool enabled = true);
72 float min; ///< Minimum extent (point cannot traverse less than this)
73 float max; ///< Maximum extent (point cannot traverse greater than this)
74 bool enabled; ///< Whether domain has been enabled or not.
77 * @brief Clamps value (x) from (min) to (max).
79 * An optional length parameter can be specified to suggest that the
80 * subject is not a point but a line to that should be clamped.
82 * @param[in] x X point to be clamped between (min) and (max) extents.
83 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
84 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
85 * @return The clamped value.
87 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
90 * @brief Clamps value (x) from (min) to (max).
92 * An optional length parameter can be specified to suggest that the
93 * subject is not a point but a line to that should be clamped.
95 * @param[in] x X point to be clamped between (min) and (max) extents.
96 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
97 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
98 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
99 * @return The clamped value.
101 float Clamp(float x, float length, float scale, ClampState &clamped) const;
104 * @brief Returns (max-min) size of ruler.
106 * @return The size of the ruler from min to max.
108 float GetSize() const;
113 * @brief Abstract class to define scroll axes.
115 * It can specify whether they are traversable, where their snap
116 * points are and their domain.
118 class Ruler : public RefObject
121 /// @brief The type of the ruler
123 Fixed, ///< A fixed ruler
124 Free ///< A free ruler
130 * @brief Constructs ruler, default enabled, with limitless domain.
135 * @brief Snaps (x) in accordance to the ruler settings.
137 * @param[in] x The input value on the ruler to be snapped.
138 * @param[in] bias (optional) The biasing employed for snapping
139 * 0 floor input (floor x) "Used for Flick Left"
140 * 0.5 round input (floor x + 0.5) "Used for Release"
141 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
142 * @return The position of the one dimensional point passed in once snapped.
144 virtual float Snap(float x, float bias = 0.5f) const = 0;
147 * @brief Returns position from page, based on whatever the ruler
150 * If (wrap) is true, then will set volume to the number of
151 * times page has exceeded the domain's volume (volume being the
152 * number of pages within the domain), while wrapping the position
155 * @param[in] page The page index
156 * @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled)
157 * @param[in] wrap Enable wrap mode
158 * @return The position representing this page point.
160 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const = 0;
163 * @brief Returns page from position, based on whatever the ruler
166 * If (wrap) is true, then will return a page wrapped within the domain.
168 * @param[in] position The position on the domain
169 * @param[in] wrap Enable wrap mode
170 * @return The page where this position resides.
172 virtual unsigned int GetPageFromPosition(float position, bool wrap) const = 0;
175 * @brief Returns the total number of pages within this Ruler.
177 * @return The number of pages in the Ruler.
179 virtual unsigned int GetTotalPages() const = 0;
184 * @brief Gets the ruler type.
186 * @return The ruler type.
188 Ruler::RulerType GetType() const;
191 * @brief Returns whether this axis has been enabled or not.
193 * @return true if axis is enabled
195 bool IsEnabled() const;
198 * @brief Enables ruler (ruler must be enabled in order to traverse along it).
203 * @brief Disables ruler.
208 * @brief Sets Domain.
210 * @param[in] domain Ruler domain object.
212 void SetDomain(RulerDomain domain);
215 * @brief Gets Domain.
219 const RulerDomain &GetDomain() const;
222 * @brief Disables Domain (minimum/maximum extents for this axis).
224 void DisableDomain();
227 * @brief Clamps value (x) from (min) to (max).
229 * An optional length parameter can be specified to suggest that the
230 * subject is not a point but a line that should be clamped.
232 * @param[in] x X point to be clamped between (min) and (max) extents.
233 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
234 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
235 * @return The clamped value.
237 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
241 * @brief Clamps value (x) from (min) to (max).
243 * An optional length parameter can be specified to suggest that the
244 * subject is not a point but a line to that should be clamped.
246 * @param[in] x X point to be clamped between (min) and (max) extents.
247 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
248 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
249 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
250 * @return The clamped value.
252 float Clamp(float x, float length, float scale, ClampState &clamped) const;
255 * @brief Snaps and Clamps (x) in accordance to ruler settings.
257 * @param[in] x value to be snapped in accordance to ruler snap value,
258 * and clamped in accordance to the ruler's domain (if set).
259 * @param[in] bias (optional) The biasing employed for snapping
260 * 0 floor input (floor x) "Used for Flick Left"
261 * 0.5 round input (floor x + 0.5) "Used for Release"
262 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
263 * @param[in] length (optional) The Length of the line from (x) to (x + length)
265 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
266 * @return the clamped value after snapping
268 float SnapAndClamp(float x, float bias = 0.5f, float length = 0.0f, float scale = 1.0f) const;
271 * @brief Snaps and Clamps (x) in accordance to ruler settings.
273 * @param[in] x value to be snapped in accordance to ruler snap value,
274 * and clamped in accordance to the ruler's domain (if set).
275 * @param[in] bias (optional) The biasing employed for snapping
276 * 0 floor input (floor x) "Used for Flick Left"
277 * 0.5 round input (floor x + 0.5) "Used for Release"
278 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
279 * @param[in] length (optional) The Length of the line from (x) to (x + length)
281 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
282 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
283 * @return The clamped value after snapping
285 float SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const;
290 * @brief Destructor - A reference counted object may only be deleted by calling Unreference().
296 RulerType mType; ///< Type of Ruler (Fixed or Free).
297 bool mEnabled; ///< If the ruler is enabled.
298 RulerDomain mDomain; ///< The domain of the ruler.
302 typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object
305 * @brief Concrete implementation of Ruler that has no snapping and has one single page.
307 class DefaultRuler : public Ruler
311 * @brief DefaultRuler constructor.
316 * @copydoc Toolkit::Ruler::Snap
318 virtual float Snap(float x, float bias) const;
321 * @copydoc Toolkit::Ruler::GetPositionFromPage
323 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
326 * @copydoc Toolkit::Ruler::GetPageFromPosition
328 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
331 * @copydoc Toolkit::Ruler::GetTotalPages
333 virtual unsigned int GetTotalPages() const;
337 * @brief Concrete implementation of Ruler that has fixed snapping.
339 class FixedRuler : public Ruler
345 * @param[in] spacing The spacing between each interval on this ruler.
347 FixedRuler(float spacing = 1.0f);
350 * @copydoc Toolkit::Ruler::Snap
352 virtual float Snap(float x, float bias) const;
355 * @copydoc Toolkit::Ruler::GetPositionFromPage
357 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
360 * @copydoc Toolkit::Ruler::GetPageFromPosition
362 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
365 * @copydoc Toolkit::Ruler::GetTotalPages
367 virtual unsigned int GetTotalPages() const;
370 float mSpacing; ///< The spacing between each interval
373 class ScrollViewEffect;
377 * @brief ScrollView contains actors that can be scrolled manually (via touch)
380 class ScrollView : public Scrollable
383 /// Page effect types
386 PageEffectNone, ///< No Effect (Standard ScrollView)
387 PageEffectOuterCube, ///< 3D Rotating Cube Effect
388 PageEffectDepth, ///< Depth Effect
389 PageEffectInnerCube, ///< Page Cube Effect
390 PageEffectCarousel, ///< Page Carousel Effect
391 PageEffectSpiral, ///< Page Spiral Effect
393 Total ///< The total number of effect types
398 static const std::string SCROLL_PAGE_CURRENT; ///< Property, name "scroll-page-current", type INT
399 static const std::string SCROLL_TIME_PROPERTY_NAME; ///< Property, name "scroll-time", type FLOAT
400 static const std::string SCROLL_POSITION_PROPERTY_NAME; ///< Property, name "scroll-position", type VECTOR3
401 static const std::string SCROLL_PRE_POSITION_PROPERTY_NAME; ///< Property, name "scroll-pre-position", type VECTOR3
402 static const std::string SCROLL_OVERSHOOT_X_PROPERTY_NAME; ///< Property, name "scroll-overshoot-x", type float
403 static const std::string SCROLL_OVERSHOOT_Y_PROPERTY_NAME; ///< Property, name "scroll-overshoot-y", type float
404 static const std::string SCROLL_FINAL_PROPERTY_NAME; ///< Property, name "scroll-final", type VECTOR3
405 static const std::string SCROLL_SCALE_PROPERTY_NAME; ///< Property, name "scroll-scale", type VECTOR3
406 static const std::string SCROLL_WRAP_PROPERTY_NAME; ///< Property, name "scroll-wrap", type BOOLEAN
407 static const std::string SCROLL_PANNING_PROPERTY_NAME; ///< Property, name "scroll-panning", type BOOLEAN
408 static const std::string SCROLL_SCROLLING_PROPERTY_NAME; ///< Property, name "scroll-scrolling", type BOOLEAN
409 static const std::string SCROLL_POSITION_DELTA_PROPERTY_NAME; ///< Property, name "scroll-position-delta" type VECTOR3
410 static const std::string SCROLL_START_PAGE_POSITION_PROPERTY_NAME; ///< Property, name "scroll-start-page-position" type VECTOR3
414 static const float DEFAULT_SLOW_SNAP_ANIMATION_DURATION; ///< Default Drag-Release animation time.
415 static const float DEFAULT_FAST_SNAP_ANIMATION_DURATION; ///< Default Drag-Flick animation time.
416 static const float DEFAULT_SNAP_OVERSHOOT_DURATION; ///< Default Overshoot snapping animation time.
417 static const float DEFAULT_MAX_OVERSHOOT; ///< Default maximum allowed overshoot
419 static const float DEFAULT_AXIS_AUTO_LOCK_GRADIENT; ///< Default Axis-AutoLock gradient threshold. default is 0.36:1 (20 degrees)
420 static const float DEFAULT_FRICTION_COEFFICIENT; ///< Default Friction Co-efficient. (in stage diagonals per second)
421 static const float DEFAULT_FLICK_SPEED_COEFFICIENT; ///< Default Flick speed coefficient (multiples input touch velocity)
422 static const float DEFAULT_MAX_FLICK_SPEED; ///< Default Maximum flick speed. (in stage diagonals per second)
425 static const char* const SIGNAL_SNAP_STARTED; ///< Name "snap-started"
427 /// Direction of transitions
430 DirectionFlagLeft = 0x01,
431 DirectionFlagRight = 0x02,
432 DirectionFlagUp = 0x04,
433 DirectionFlagDown = 0x08,
434 DirectionFlagTransitionOn = 0x10, ///< doesnt mean a page is moving towards centre, it affects whether the current page is using values for moving onto screen or off screen, if the user changes scroll direction we dont want things to flip over when in view
435 DirectionFlagTransitionOff = 0x20,
436 DirectionFlagMask_Direction = DirectionFlagLeft | DirectionFlagRight | DirectionFlagUp | DirectionFlagDown,
437 DirectionFlagMask_Transition = DirectionFlagTransitionOn | DirectionFlagTransitionOff
443 * @brief Snap signal event's data.
447 SnapType type; ///< Current snap commencing
448 Vector3 position; ///< Target snap position
449 float duration; ///< Duration of snap animation.
452 typedef SignalV2< void ( const SnapEvent& ) > SnapStartedSignalV2; ///< SnapStarted signal type
455 * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
456 * position, scale, rotation for the snap or flick)
458 SnapStartedSignalV2& SnapStartedSignal();
463 * @brief Creates an empty ScrollView handle.
468 * @brief Copy constructor.
470 * Creates another handle that points to the same real object
472 * @param[in] handle to copy from
474 ScrollView( const ScrollView& handle );
477 * @brief Assignment operator.
479 * Changes this handle to point to another real object
480 * @param[in] handle The handle to copy from
481 * @return A reference to this
483 ScrollView& operator=( const ScrollView& handle );
488 * This is non-virtual since derived Handle types must not contain data or virtual methods.
493 * @brief Create an initialized ScrollView.
495 * @return A handle to a newly allocated Dali resource.
497 static ScrollView New();
500 * @brief Downcast an Object handle to ScrollView.
502 * If handle points to a ScrollView the downcast produces valid
503 * handle. If not the returned handle is left uninitialized.
505 * @param[in] handle Handle to an object
506 * @return handle to a ScrollView or an uninitialized handle
508 static ScrollView DownCast( BaseHandle handle );
513 * @brief Get snap-animation's AlphaFunction.
515 * @return Current easing alpha function of the snap animation.
517 AlphaFunction GetScrollSnapAlphaFunction() const;
520 * @brief Set snap-animation's AlphaFunction.
522 * @param[in] alpha Easing alpha function of the snap animation.
524 void SetScrollSnapAlphaFunction(AlphaFunction alpha);
527 * @brief Get flick-animation's AlphaFunction.
529 * @return Current easing alpha function of the flick animation.
531 AlphaFunction GetScrollFlickAlphaFunction() const;
534 * @brief Set flick-animation's AlphaFunction.
536 * @param[in] alpha Easing alpha function of the flick animation.
538 void SetScrollFlickAlphaFunction(AlphaFunction alpha);
541 * @brief Gets the time for the scroll snap-animation.
543 * This animation occurs when the user drags, and releases.
545 * @return The time in seconds for the animation to take.
547 float GetScrollSnapDuration() const;
550 * @brief Sets the time for the scroll snap-animation.
552 * This animation occurs when the user drags, and releases.
554 * @param[in] time The time in seconds for the animation to take.
556 void SetScrollSnapDuration(float time);
559 * @brief Gets the time for the scroll flick-animation.
561 * This animation occurs when the user flicks scroll view.
563 * @return The time in seconds for the animation to take.
565 float GetScrollFlickDuration() const;
568 * @brief Sets the time for the scroll flick-animation.
570 * This animation occurs when the user flicks scroll view.
572 * @param[in] time The time in seconds for the animation to take.
574 void SetScrollFlickDuration(float time);
577 * @brief Set X axis ruler.
579 * Defines how scrolling horizontally is snapped, and
580 * the boundary (domain) in which the ScrollView can pan.
582 * @param[in] ruler The ruler to be used for the X axis
584 void SetRulerX(RulerPtr ruler);
587 * @brief Set Y axis ruler.
589 * Defines how scrolling vertically is snapped, and the boundary
590 * (domain) in which the ScrollView can pan.
592 * @param[in] ruler The ruler to be used for the Y axis
594 void SetRulerY(RulerPtr ruler);
597 * @brief Set Scroll's touch sensitivity.
599 * @note Unlike SetSensitive(), this determines whether this ScrollView
600 * should react (e.g. pan), without disrupting the sensitivity of it's children.
602 * @param[in] sensitive true to enable scroll, false to disable scrolling
604 void SetScrollSensitive(bool sensitive);
607 * @brief Set maximum overshoot amount.
609 * The final overshoot value is within 0.0f to 1.0f, but the maximum
610 * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
611 * edge of a scrollable area and the maximum overshoot is 100 then
612 * the final overshoot value will be 0.75f)
614 * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
615 * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
617 void SetMaxOvershoot(float overshootX, float overshootY);
620 * @brief Set Snap Overshoot animation's AlphaFunction.
622 * @param[in] alpha Easing alpha function of the overshoot snap animation.
624 void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
627 * @brief Set Snap Overshoot animation's Duration.
629 * @note Set duration to 0 seconds, to disable Animation.
631 * @param[in] duration The duration of the overshoot snap animation.
633 void SetSnapOvershootDuration(float duration);
636 * @brief Sets Touches required for pan gestures.
638 * Panning requires number of touches to be within (minTouches) and
641 * If (endOutside) is true, then outside this range of touches,
642 * the pan gesture will end and thus will snap.
644 * If (endOutside) is false, then outside this range of touches,
645 * the pan gesture will pause. but will not end until touches = 0.
647 * @param[in] minTouches Minimum touches for panning to occur.
648 * @param[out] maxTouches Maxiumum touches for panning to occur.
649 * @param[in] endOutside Whether to end the panning gesture outside of touch range
651 void SetTouchesRequiredForPanning(unsigned int minTouches = 1, unsigned int maxTouches = 1, bool endOutside = true);
654 * @brief Enables or Disables Actor Auto-Snap mode.
656 * When Actor Auto-Snap mode has been enabled, ScrollView will automatically
657 * snap to the closest actor (The closest actor will appear in the center of
660 * @param[in] enable Enables (true), or disables (false) Actor AutoSnap
662 void SetActorAutoSnap(bool enable);
665 * @brief Enables or Disables Wrap mode for ScrollView contents.
667 * When enabled, the ScrollView contents are wrapped over the X/Y Domain.
669 * @note You must apply a position constraint that causes Wrapping
672 * @param[in] enable Enables (true), or disables (false) Wrap Mode.
674 void SetWrapMode(bool enable);
677 * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
679 * @return Current scroll update distance
681 int GetScrollUpdateDistance() const;
684 * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted
686 * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
687 * Each time the ScrollView crosses this distance the signal will be emitted
689 * @param[in] distance The distance for ScrollView to move before emitting update signal
691 void SetScrollUpdateDistance(int distance);
694 * @brief Returns state of Axis Auto Lock mode.
696 * @return Whether Axis Auto Lock mode has been enabled or not.
698 bool GetAxisAutoLock() const;
701 * @brief Enables or Disables Axis Auto Lock mode for panning within the ScrollView.
703 * When enabled, any pan gesture that appears mostly horizontal or mostly
704 * vertical, will be automatically restricted to horizontal only or vertical
705 * only panning, until the pan gesture has completed.
707 * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
709 void SetAxisAutoLock(bool enable);
712 * @brief Gets the gradient threshold at which a panning gesture
713 * should be locked to the Horizontal or Vertical axis.
715 * @return The gradient, a value between 0.0 and 1.0f.
717 float GetAxisAutoLockGradient() const;
720 * @brief Sets the gradient threshold at which a panning gesture should be locked to the
721 * Horizontal or Vertical axis.
723 * By default this is 0.36 (0.36:1) which means angles less than 20
724 * degrees to an axis will lock to that axis.
726 * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
727 * all panning gestures will auto-lock. Either to the horizontal or vertical axis.
729 * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
731 void SetAxisAutoLockGradient(float gradient);
734 * @brief Gets the friction coefficient setting for ScrollView when
735 * flicking in free panning mode.
737 * This is a value in stage-diagonals per second^2.
738 * stage-diagonal = Length( stage.width, stage.height )
739 * @return Friction coefficient is returned.
741 float GetFrictionCoefficient() const;
744 * @brief Sets the friction coefficient for ScrollView when flicking
745 * in free panning mode.
747 * This is a value in stage-diagonals per second^2.
748 * stage-diagonal = Length( stage.width, stage.height ).
750 * A stage 480x800 in size has a diagonal length of 933.
751 * Friction coefficient of 1.0 means the swipe velocity will
752 * reduce by 1.0 * 933 pixels/sec^2.
753 * @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0)
755 void SetFrictionCoefficient(float friction);
758 * @brief Gets the flick speed coefficient for ScrollView when
759 * flicking in free panning mode.
761 * This is a constant which multiplies the input touch
762 * flick velocity to determine the actual velocity at
763 * which to move the scrolling area.
764 * @return The flick speed coefficient is returned.
766 float GetFlickSpeedCoefficient() const;
769 * @brief Sets the flick speed coefficient for ScrollView when
770 * flicking in free panning mode.
772 * This is a constant which multiplies the input touch
773 * flick velocity to determine the actual velocity at
774 * which to move the scrolling area.
775 * @param[in] speed The flick speed coefficient (default = 1.0).
777 void SetFlickSpeedCoefficient(float speed);
780 * @brief Returns the minimum pan distance required for a flick gesture in pixels
782 * @return Minimum pan distance vector with separate x and y distance
784 Vector2 GetMinimumDistanceForFlick() const;
787 * @brief Sets the minimum pan distance required for a flick in pixels
789 * Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed
791 * @param[in] distance The minimum pan distance for a flick
793 void SetMinimumDistanceForFlick( const Vector2& distance );
796 * @brief Returns the minimum pan speed required for a flick gesture in pixels per second
798 * @return Minimum pan speed
800 float GetMinimumSpeedForFlick() const;
803 * @brief Sets the minimum pan speed required for a flick in pixels per second
805 * @param[in] speed The minimum pan speed for a flick
807 void SetMinimumSpeedForFlick( float speed );
810 * @brief Gets the maximum flick speed setting for ScrollView when
811 * flicking in free panning mode.
813 * This is a value in stage-diagonals per second.
814 * stage-diagonal = Length( stage.width, stage.height )
815 * @return Maximum flick speed is returned
817 float GetMaxFlickSpeed() const;
820 * @brief Sets the maximum flick speed for the ScrollView when
821 * flicking in free panning mode.
823 * This is a value in stage-diagonals per second.
824 * stage-diagonal = Length( stage.width, stage.height )
826 * A stage 480x800 in size has a diagonal length of 933.
827 * Max Flick speed of 1.0 means the maximum velocity of
828 * a swipe can be 1.0 * 933 pixels/sec.
829 * @param[in] speed Maximum flick speed (default = 3.0)
831 void SetMaxFlickSpeed(float speed);
834 * @brief Gets the step of scroll distance in actor coordinates for
835 * each mouse wheel event received in free panning mode.
837 * @return The step of scroll distance(pixel) in X and Y axes.
839 Vector2 GetMouseWheelScrollDistanceStep() const;
842 * @brief Sets the step of scroll distance in actor coordinates for
843 * each mouse wheel event received in free panning mode.
845 * @param[in] step The step of scroll distance(pixel) in X and Y axes.
847 * @note: If snap points are defined in the rulers, it will always
848 * scroll to the next snap point towards the scroll direction while
849 * receiving the mouse wheel events.
852 void SetMouseWheelScrollDistanceStep(Vector2 step);
855 * @brief Retrieves current scroll position.
857 * @returns The current scroll position.
859 Vector3 GetCurrentScrollPosition() const;
862 * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place
863 * SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function.
865 * @param[in] position The new scroll position to set.
867 void SetScrollPosition(const Vector3& position);
870 * @brief Retrieves current scroll page based on ScrollView
871 * dimensions being the size of one page, and all pages laid out in
872 * a grid fashion, increasing from left to right until the end of
875 * @note: Pages start from 0 as the first page, not 1.
877 * @returns The Current page.
879 unsigned int GetCurrentPage() const;
882 * @brief Scrolls View to position specified (contents will scroll to this position).
884 * Position 0,0 is the origin. Increasing X scrolls contents left, while
885 * increasing Y scrolls contents up.
886 * - If Rulers have been applied to the axes, then the contents will scroll until
887 * reaching the domain boundary.
888 * @note Contents will not snap to ruler snap points.
890 * @param[in] position The position to scroll to.
892 void ScrollTo(const Vector3 &position);
895 * @brief Scrolls View to position specified (contents will scroll to this position).
897 * Position 0,0 is the origin. Increasing X scrolls contents left, while
898 * increasing Y scrolls contents up.
899 * - If Rulers have been applied to the axes, then the contents will scroll until
900 * reaching the domain boundary.
901 * @note Contents will not snap to ruler snap points.
903 * @param[in] position The position to scroll to.
904 * @param[in] duration The duration of the animation in seconds
906 void ScrollTo(const Vector3 &position, float duration);
909 * @brief Scrolls View to position specified (contents will scroll to this position).
911 * Position 0,0 is the origin. Increasing X scrolls contents left, while
912 * increasing Y scrolls contents up.
913 * - If Rulers have been applied to the axes, then the contents will scroll until
914 * reaching the domain boundary.
915 * @note Contents will not snap to ruler snap points.
916 * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
917 * wrap mode, the application developer can decide whether to scroll left or right
918 * to get to the target page
920 * @param[in] position The position to scroll to.
921 * @param[in] duration The duration of the animation in seconds
922 * @param[in] horizontalBias Whether to bias scrolling to left or right.
923 * @param[in] verticalBias Whether to bias scrolling to top or bottom.
925 void ScrollTo(const Vector3 &position, float duration,
926 DirectionBias horizontalBias, DirectionBias verticalBias);
929 * @brief Scrolls View to page currently based on assumption that each page is
930 * "(page) * ScrollViewSize.width, 0".
932 * @note Should probably be upgraded so that page is an abstract class, that can be
933 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
934 * orchestrated in a 2D grid fashion, or variable width.
936 * @param[in] page to scroll to
938 void ScrollTo(unsigned int page);
941 * @brief Scrolls View to page currently based on assumption that each page is
942 * "(page) * ScrollViewSize.width, 0".
944 * @note Should probably be upgraded so that page is an abstract class, that can be
945 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
946 * orchestrated in a 2D grid fashion, or variable width.
948 * @param[in] page to scroll to
949 * @param[in] duration The duration of the animation in seconds
951 void ScrollTo(unsigned int page, float duration);
954 * @brief Scrolls View to page currently based on assumption that each page is
955 * "(page) * ScrollViewSize.width, 0".
957 * @note Should probably be upgraded so that page is an abstract class, that can be
958 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
959 * orchestrated in a 2D grid fashion, or variable width.
960 * A biasing parameter is provided such that in scenarios with 2 pages in wrap mode,
961 * the application developer can decide whether to scroll left or right to get to
964 * @param[in] page to scroll to
965 * @param[in] duration The duration of the animation in seconds
966 * @param[in] bias Whether to bias scrolling to left or right.
968 void ScrollTo(unsigned int page, float duration, DirectionBias bias);
971 * @brief Scrolls View such that actor appears in the center of the ScrollView.
973 * @note Actor must be a direct child of ScrollView, otherwise will
974 * cause an assertion failure.
975 * @param[in] actor The actor to center in on (via Scrolling).
977 void ScrollTo(Actor& actor);
980 * @brief Scrolls View such that actor appears in the center of the ScrollView.
982 * @note Actor must be a direct child of ScrollView, otherwise will
983 * cause an assertion failure.
984 * @param[in] actor The actor to center in on (via Scrolling).
985 * @param[in] duration The duration of the animation in seconds
987 void ScrollTo(Actor& actor, float duration);
990 * @brief Scrolls View to the nearest snap points as specified by the Rulers.
992 * If already at snap points, then will return false, and not scroll.
994 * @return True if Snapping necessary.
996 bool ScrollToSnapPoint();
999 * @brief Applies a constraint that will affect the children of ScrollView.
1001 * @note this affects all existing and future Actors that are added to scrollview.
1002 * @param[in] constraint The constraint to apply
1004 void ApplyConstraintToChildren(Constraint constraint);
1007 * @brief Removes all constraints that will affect the children of ScrollView.
1009 * @note this removes all constraints from actors that have been added
1012 void RemoveConstraintsFromChildren();
1015 * @brief Apply Effect to ScrollView.
1017 * @param[in] effect The effect to apply to scroll view
1019 void ApplyEffect(ScrollViewEffect effect);
1022 * @brief ApplyEffect Applies a predefined effect.
1024 * @param[in] effect enum for the predefined effect
1025 * @return The scrollview effect that was applied
1027 ScrollViewEffect ApplyEffect(ScrollView::PageEffect effect);
1030 * @brief Remove Effect from ScrollView.
1032 * @param[in] effect The effect to remove.
1034 void RemoveEffect(ScrollViewEffect effect);
1037 * @brief Remove All Effects from ScrollView.
1039 void RemoveAllEffects();
1042 * @brief Binds actor to this ScrollView.
1044 * Once an actor is bound to a ScrollView, it will be subject to
1045 * that ScrollView's properties.
1047 * @param[in] child The actor to add to this ScrollView.
1049 void BindActor(Actor child);
1052 * @brief Unbind Actor from this ScrollView.
1054 * Once Unbound, this ScrollView will not affect the actor.
1055 * @note this does not remove the child from the ScrollView container
1057 * @param[in] child The actor to be unbound.
1059 void UnbindActor(Actor child);
1062 * @brief Allows the user to constrain the scroll view in a particular direction.
1064 * @param[in] direction The axis to constrain the scroll-view to.
1065 * Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1066 * @param[in] threshold The threshold to apply around the axis.
1067 * @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
1069 void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
1072 * @brief Remove a direction constraint from the scroll view.
1074 * @param[in] direction The axis to stop constraining to.
1075 * Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1077 void RemoveScrollingDirection( Radian direction );
1079 public: // Not intended for application developers
1082 * @brief Creates a handle using the Toolkit::Internal implementation.
1084 * @param[in] implementation The Control implementation.
1086 ScrollView(Internal::ScrollView& implementation);
1089 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
1091 * @param[in] internal A pointer to the internal CustomActor.
1093 ScrollView( Dali::Internal::CustomActor* internal );
1096 } // namespace Toolkit
1100 #endif // __DALI_TOOLKIT_SCROLL_VIEW_H__