1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_H__
5 * Copyright (c) 2017 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/animation/alpha-function.h>
25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
33 namespace Internal DALI_INTERNAL
38 * @addtogroup dali_toolkit_controls_scroll_view
43 * @brief Enumeration for how axes/rotation or scale are clamped.
48 NotClamped, ///< The quantity isn't clamped @SINCE_1_0.0
49 ClampedToMin, ///< The quantity is clamped to the min value @SINCE_1_0.0
50 ClampedToMax ///< The quantity is clamped to the max value @SINCE_1_0.0
54 * @brief A 2 dimensional clamp.
59 ClampState x; ///< The clamp state of the x axis
60 ClampState y; ///< The clamp state of the y axis
64 * @brief Enumeration for the snap type.
69 Snap, ///< Snap @SINCE_1_0.0
70 Flick ///< Flick @SINCE_1_0.0
74 * @brief Enumeration for DirectionBias types.
79 DirectionBiasLeft = -1, ///< Bias scroll snap to Left @SINCE_1_0.0
80 DirectionBiasNone = 0, ///< Don't bias scroll snap @SINCE_1_0.0
81 DirectionBiasRight = 1 ///< Bias scroll snap to Right @SINCE_1_0.0
85 * @brief Used for specifying minimum/maximum extents of a ruler.
88 class DALI_IMPORT_API RulerDomain
93 * @brief Creates Ruler domain allowing a point to traverse between min and max extents.
96 * @param[in] min Minimum extent (point cannot traverse less than this)
97 * @param[in] max Maximum extent (point cannot traverse greater than this)
98 * @param[in] enabled Whether domain has been enabled or not
100 explicit RulerDomain(float min, float max, bool enabled = true);
104 float min; ///< Minimum extent (point cannot traverse less than this)
105 float max; ///< Maximum extent (point cannot traverse greater than this)
106 bool enabled; ///< Whether domain has been enabled or not.
109 * @brief Clamps value (x) from (min) to (max).
111 * An optional length parameter can be specified to suggest that the
112 * subject is not a point but a line to that should be clamped.
115 * @param[in] x X point to be clamped between (min) and (max) extents
116 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped
117 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
118 * @return The clamped value
120 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
123 * @brief Clamps value (x) from (min) to (max).
125 * An optional length parameter can be specified to suggest that the
126 * subject is not a point but a line to that should be clamped.
129 * @param[in] x X point to be clamped between (min) and (max) extents
130 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped
131 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
132 * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
133 * @return The clamped value
135 float Clamp(float x, float length, float scale, ClampState &clamped) const;
138 * @brief Returns (max-min) size of ruler.
141 * @return The size of the ruler from min to max
143 float GetSize() const;
147 // Forward declare future extension interface
148 class RulerExtension;
151 * @brief Abstracts class to define scroll axes.
153 * It can specify whether they are traversable,
154 * where their snap points are and their domain.
157 class DALI_IMPORT_API Ruler : public RefObject
160 /// @brief The type of the ruler
162 Fixed, ///< A fixed ruler @SINCE_1_0.0
163 Free ///< A free ruler @SINCE_1_0.0
169 * @brief Constructs ruler, enabled by default, with limitless domain.
175 * @brief Snaps (x) in accordance to the ruler settings.
178 * @param[in] x The input value on the ruler to be snapped
179 * @param[in] bias (optional) The biasing employed for snapping
180 * 0 floor input (floor x) "Used for Flick Left"
181 * 0.5 round input (floor x + 0.5) "Used for Release"
182 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
183 * @return The position of the one dimensional point passed in once snapped.
185 virtual float Snap(float x, float bias = 0.5f) const = 0;
188 * @brief Returns position from page, based on whatever the ruler
191 * If (wrap) is true, then will set volume to the number of
192 * times page has exceeded the domain's volume (volume being the
193 * number of pages within the domain), while wrapping the position
197 * @param[in] page The page index
198 * @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled)
199 * @param[in] wrap Enable wrap mode
200 * @return The position representing this page point
202 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const = 0;
205 * @brief Returns page from position, based on whatever the ruler
208 * If (wrap) is true, then will return a page wrapped within the domain.
211 * @param[in] position The position on the domain
212 * @param[in] wrap Enable wrap mode
213 * @return The page where this position resides
215 virtual unsigned int GetPageFromPosition(float position, bool wrap) const = 0;
218 * @brief Returns the total number of pages within this Ruler.
221 * @return The number of pages in the Ruler
223 virtual unsigned int GetTotalPages() const = 0;
226 * @brief Gets the extension interface of the Ruler.
229 * @return The extension interface of the Ruler
231 virtual RulerExtension* GetExtension() { return NULL; }
236 * @brief Gets the ruler type.
239 * @return The ruler type
241 Ruler::RulerType GetType() const;
244 * @brief Returns whether this axis has been enabled or not.
247 * @return true if axis is enabled
249 bool IsEnabled() const;
252 * @brief Enables ruler (ruler must be enabled in order to traverse along it).
258 * @brief Disables ruler.
264 * @brief Sets the Domain.
267 * @param[in] domain Ruler domain object
269 void SetDomain(RulerDomain domain);
272 * @brief Gets the Domain.
277 const RulerDomain &GetDomain() const;
280 * @brief Disables Domain (minimum/maximum extents for this axis).
283 void DisableDomain();
286 * @brief Clamps value (x) from (min) to (max).
288 * An optional length parameter can be specified to suggest that the
289 * subject is not a point but a line that should be clamped.
292 * @param[in] x X point to be clamped between (min) and (max) extents
293 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped
294 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
295 * @return The clamped value
297 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
301 * @brief Clamps value (x) from (min) to (max).
303 * An optional length parameter can be specified to suggest that the
304 * subject is not a point but a line to that should be clamped.
307 * @param[in] x X point to be clamped between (min) and (max) extents
308 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped
309 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
310 * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
311 * @return The clamped value
313 float Clamp(float x, float length, float scale, ClampState &clamped) const;
316 * @brief Snaps and Clamps (x) in accordance to ruler settings.
319 * @param[in] x X value to be snapped in accordance to ruler snap value,
320 * and clamped in accordance to the ruler's domain (if set)
321 * @param[in] bias (optional) The biasing employed for snapping
322 * 0 floor input (floor x) "Used for Flick Left"
323 * 0.5 round input (floor x + 0.5) "Used for Release"
324 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
325 * @param[in] length (optional) The Length of the line from (x) to (x + length)
327 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
328 * @return The clamped value after snapping
330 float SnapAndClamp(float x, float bias = 0.5f, float length = 0.0f, float scale = 1.0f) const;
333 * @brief Snaps and Clamps (x) in accordance to ruler settings.
336 * @param[in] x X value to be snapped in accordance to ruler snap value,
337 * and clamped in accordance to the ruler's domain (if set)
338 * @param[in] bias (optional) The biasing employed for snapping
339 * 0 floor input (floor x) "Used for Flick Left"
340 * 0.5 round input (floor x + 0.5) "Used for Release"
341 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
342 * @param[in] length (optional) The Length of the line from (x) to (x + length)
344 * @param[in] scale Scaling parameter which treats domain as scaled in calculations
345 * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
346 * @return The clamped value after snapping
348 float SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const;
353 * @brief Destructor - A reference counted object may only be deleted by calling Unreference().
360 RulerType mType; ///< Type of Ruler (Fixed or Free).
361 bool mEnabled; ///< If the ruler is enabled.
362 RulerDomain mDomain; ///< The domain of the ruler.
366 typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object @SINCE_1_0.0
369 * @brief Concrete implementation of Ruler that has no snapping and has one single page.
372 class DALI_IMPORT_API DefaultRuler : public Ruler
376 * @brief DefaultRuler constructor.
382 * @copydoc Toolkit::Ruler::Snap
384 virtual float Snap(float x, float bias) const;
387 * @copydoc Toolkit::Ruler::GetPositionFromPage
389 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
392 * @copydoc Toolkit::Ruler::GetPageFromPosition
394 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
397 * @copydoc Toolkit::Ruler::GetTotalPages
399 virtual unsigned int GetTotalPages() const;
403 * @brief Concrete implementation of Ruler that has fixed snapping.
406 class DALI_IMPORT_API FixedRuler : public Ruler
410 * @brief Constructor.
413 * @param[in] spacing The spacing between each interval on this ruler
415 FixedRuler(float spacing = 1.0f);
418 * @copydoc Toolkit::Ruler::Snap
420 virtual float Snap(float x, float bias) const;
423 * @copydoc Toolkit::Ruler::GetPositionFromPage
425 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
428 * @copydoc Toolkit::Ruler::GetPageFromPosition
430 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
433 * @copydoc Toolkit::Ruler::GetTotalPages
435 virtual unsigned int GetTotalPages() const;
438 float mSpacing; ///< The spacing between each interval
441 class ScrollViewEffect;
445 * @brief ScrollView contains actors that can be scrolled manually (via touch)
449 * | %Signal Name | Method |
450 * |-------------------|----------------------------|
451 * | snap-started | @ref SnapStartedSignal() |
454 class DALI_IMPORT_API ScrollView : public Scrollable
460 * @brief Clamps signal event's data.
465 ClampState2D scale; ///< Clamp information for scale axes
466 ClampState2D position; ///< Clamp information for position axes
467 ClampState rotation; ///< Clamp information for rotation
471 * @brief Snaps signal event's data.
476 SnapType type; ///< Current snap commencing
477 Vector2 position; ///< Target snap position
478 float duration; ///< Duration of snap animation.
482 * @brief Enumeration for the start and end property ranges for this control.
487 PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
488 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18
490 ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
491 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
495 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
501 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
506 ///////////////////////////////////////////////////////////////////////////////
507 // Event side (non-animatable) properties
508 ///////////////////////////////////////////////////////////////////////////////
511 * @brief Whether wrapping is enabled.
512 * @details Name "wrapEnabled", type Property::BOOLEAN.
516 WRAP_ENABLED = PROPERTY_START_INDEX,
519 * @brief Whether panning is enabled.
520 * @details Name "panningEnabled", type Property::BOOLEAN.
522 * @see SetScrollSensitive()
527 * @brief Whether the Axis Auto Lock mode for panning within the ScrollView is enabled.
528 * @details Name "axisAutoLockEnabled", type Property::BOOLEAN.
530 * @see SetAxisAutoLock()
532 AXIS_AUTO_LOCK_ENABLED,
535 * @brief The step of scroll distance in actor coordinates for each wheel event received in free panning mode.
536 * @details Name "wheelScrollDistanceStep", type Property::VECTOR2.
538 * @see SetWheelScrollDistanceStep()
540 WHEEL_SCROLL_DISTANCE_STEP,
543 * @brief The scroll mode.
544 * @details Name "scrollMode", type Property::MAP.
545 * The scroll mode map is a frontend for the Ruler helper class, containing the following keys:
547 * | %Property Name | Type | Required | Description |
548 * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
549 * | xAxisScrollEnabled | BOOLEAN | No | True if the content can be scrolled in X axis or false if not. |
550 * | xAxisSnapToInterval | FLOAT | No | When set, causes scroll view to snap to multiples of the value of the interval in the X axis while flicking. (by default no snapping) |
551 * | xAxisScrollBoundary | FLOAT | No | When set, causes scroll view unable to scroll beyond the value of the boundary in the X axis (by default no boundary) |
552 * | yAxisScrollEnabled | BOOLEAN | No | True if the content can be scrolled in Y axis or false if not. |
553 * | yAxisSnapToInterval | FLOAT | No | When set, causes scroll view to snap to multiples of the value of the interval in the Y axis while flicking. (by default no snapping) |
554 * | yAxisScrollBoundary | FLOAT | No | When set, causes scroll view unable to scroll beyond the value of the boundary in the Y axis (by default no boundary) |
556 * Alternatively, one can use the keys defined in the Dali::Toolkit::ScrollMode::Type enumeration.
561 ///////////////////////////////////////////////////////////////////////////////
562 // Animatable Properties
563 ///////////////////////////////////////////////////////////////////////////////
566 * @brief The current scroll position.
567 * @details Name "scrollPosition", type Property::VECTOR2.
570 SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX,
573 * @brief The position before we set the clamp at scroll boundaries.
574 * @details Name "scrollPrePosition", type Property::VECTOR2.
580 * @brief The X component of SCROLL_PRE_POSITION.
581 * @details Name "scrollPrePositionX", type Property::FLOAT.
584 SCROLL_PRE_POSITION_X,
587 * @brief The Y component of SCROLL_PRE_POSITION.
588 * @details Name "scrollPrePositionY", type Property::VECTOR2.
591 SCROLL_PRE_POSITION_Y,
594 * @brief The maximum value that SCROLL_PRE_POSITION can be.
595 * @details Name "scrollPrePositionMax", type Property::VECTOR2.
598 SCROLL_PRE_POSITION_MAX,
601 * @brief The X component of SCROLL_PRE_POSITION_MAX.
602 * @details Name "scrollPrePositionMaxX", type Property::FLOAT.
605 SCROLL_PRE_POSITION_MAX_X,
608 * @brief The Y component of SCROLL_PRE_POSITION_MAX.
609 * @details Name "scrollPrePositionMaxY", type Property::FLOAT.
612 SCROLL_PRE_POSITION_MAX_Y,
615 * @brief The amount that we can scroll beyond the boundary along the X axis.
616 * @details Name "overshootX", type Property::FLOAT.
622 * @brief The amount that we can scroll beyond the boundary along the Y axis.
623 * @details Name "overshootY", type Property::FLOAT.
629 * @brief The position after the overshoot value has been considered in the calculation.
630 * @details Name "scrollFinal", type Property::VECTOR2.
636 * @brief The X component of SCROLL_FINAL.
637 * @details Name "scrollFinalX", type Property::FLOAT.
643 * @brief The Y component of SCROLL_FINAL.
644 * @details Name "scrollFinalY", type Property::FLOAT.
650 * @brief Whether scrolling wraps.
651 * @details Name "wrap", type Property::BOOLEAN.
657 * @brief Whether we are currently panning.
658 * @details Name "panning", type Property::BOOLEAN.
664 * @brief Whether we are currently scrolling.
665 * @details Name "scrolling", type Property::BOOLEAN.
671 * @brief The size of the scrolling domain.
672 * @details Name "scrollDomainSize", type Property::VECTOR2.
678 * @brief The X component of SCROLL_DOMAIN_SIZE.
679 * @details Name "scrollDomainSizeX", type Property::FLOAT.
682 SCROLL_DOMAIN_SIZE_X,
685 * @brief The Y component of SCROLL_DOMAIN_SIZE.
686 * @details Name "scrollDomainSizeY", type Property::FLOAT.
689 SCROLL_DOMAIN_SIZE_Y,
692 * @brief The offset of the scroll domain.
693 * @details Name "scrollDomainOffset", type Property::VECTOR2.
696 SCROLL_DOMAIN_OFFSET,
699 * @brief The delta in the position when scrolling.
700 * @details Name "scrollPositionDelta", type Property::VECTOR2.
703 SCROLL_POSITION_DELTA,
706 * @brief The starting page position.
707 * @details Name "startPagePosition", type Property::VECTOR3.
716 typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type @SINCE_1_0.0
721 * @brief Creates an empty ScrollView handle.
727 * @brief Copy constructor.
729 * Creates another handle that points to the same real object.
732 * @param[in] handle Handle to copy from
734 ScrollView( const ScrollView& handle );
737 * @brief Assignment operator.
739 * Changes this handle to point to another real object.
741 * @param[in] handle The handle to copy from
742 * @return A reference to this
744 ScrollView& operator=( const ScrollView& handle );
749 * This is non-virtual since derived Handle types must not contain data or virtual methods.
755 * @brief Creates an initialized ScrollView.
758 * @return A handle to a newly allocated Dali resource
760 static ScrollView New();
763 * @brief Downcasts a handle to ScrollView handle.
765 * If handle points to a ScrollView, the downcast produces valid handle.
766 * If not, the returned handle is left uninitialized.
769 * @param[in] handle Handle to an object
770 * @return A handle to a ScrollView or an uninitialized handle
772 static ScrollView DownCast( BaseHandle handle );
777 * @brief Gets snap-animation's AlphaFunction.
780 * @return Current easing alpha function of the snap animation
782 AlphaFunction GetScrollSnapAlphaFunction() const;
785 * @brief Sets snap-animation's AlphaFunction.
788 * @param[in] alpha Easing alpha function of the snap animation
790 void SetScrollSnapAlphaFunction(AlphaFunction alpha);
793 * @brief Gets flick-animation's AlphaFunction.
796 * @return Current easing alpha function of the flick animation
798 AlphaFunction GetScrollFlickAlphaFunction() const;
801 * @brief Sets flick-animation's AlphaFunction.
804 * @param[in] alpha Easing alpha function of the flick animation
806 void SetScrollFlickAlphaFunction(AlphaFunction alpha);
809 * @brief Gets the time for the scroll snap-animation.
811 * This animation occurs when the user drags, and releases.
814 * @return The time in seconds for the animation to take
816 float GetScrollSnapDuration() const;
819 * @brief Sets the time for the scroll snap-animation.
821 * This animation occurs when the user drags, and releases.
824 * @param[in] time The time in seconds for the animation to take
826 void SetScrollSnapDuration(float time);
829 * @brief Gets the time for the scroll flick-animation.
831 * This animation occurs when the user flicks scroll view.
834 * @return The time in seconds for the animation to take
836 float GetScrollFlickDuration() const;
839 * @brief Sets the time for the scroll flick-animation.
841 * This animation occurs when the user flicks scroll view.
844 * @param[in] time The time in seconds for the animation to take
846 void SetScrollFlickDuration(float time);
849 * @brief Sets X axis ruler.
851 * Defines how scrolling horizontally is snapped, and
852 * the boundary (domain) in which the ScrollView can pan.
855 * @param[in] ruler The ruler to be used for the X axis
857 void SetRulerX(RulerPtr ruler);
860 * @brief Sets Y axis ruler.
862 * Defines how scrolling vertically is snapped, and the boundary
863 * (domain) in which the ScrollView can pan.
866 * @param[in] ruler The ruler to be used for the Y axis
868 void SetRulerY(RulerPtr ruler);
871 * @brief Sets scroll sensitivity of pan gesture.
874 * @param[in] sensitive @c true to enable scroll, @c false to disable scrolling
875 * @note Unlike Actor::SetSensitive(), this determines whether this ScrollView
876 * should react (e.g. pan), without disrupting the sensitivity of its children.
879 void SetScrollSensitive(bool sensitive);
882 * @brief Sets maximum overshoot amount.
884 * The final overshoot value is within 0.0f to 1.0f, but the maximum
885 * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
886 * edge of a scrollable area and the maximum overshoot is 100 then
887 * the final overshoot value will be 0.75f).
890 * @param[in] overshootX The maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
891 * @param[in] overshootY The maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
893 void SetMaxOvershoot(float overshootX, float overshootY);
896 * @brief Sets Snap Overshoot animation's AlphaFunction.
899 * @param[in] alpha Easing alpha function of the overshoot snap animation
901 void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
904 * @brief Sets Snap Overshoot animation's Duration.
907 * @param[in] duration The duration of the overshoot snap animation
908 * @note Set duration to 0 seconds to disable Animation.
911 void SetSnapOvershootDuration(float duration);
914 * @brief Enables or Disables Actor Auto-Snap mode.
916 * When Actor Auto-Snap mode has been enabled, ScrollView will automatically
917 * snap to the closest actor (The closest actor will appear in the center of
921 * @param[in] enable Enables (true), or disables (false) Actor AutoSnap
923 void SetActorAutoSnap(bool enable);
926 * @brief Enables or Disables Wrap mode for ScrollView contents.
928 * When enabled, the ScrollView contents are wrapped over the X/Y Domain.
931 * @param[in] enable Enables (true), or disables (false) Wrap Mode
932 * @note You must apply a position constraint that causes Wrapping
936 void SetWrapMode(bool enable);
939 * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted.
942 * @return Current scroll update distance
944 int GetScrollUpdateDistance() const;
947 * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted.
949 * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
950 * Each time the ScrollView crosses this distance the signal will be emitted.
953 * @param[in] distance The distance for ScrollView to move before emitting update signal
955 void SetScrollUpdateDistance(int distance);
958 * @brief Returns state of Axis Auto Lock mode.
961 * @return Whether Axis Auto Lock mode has been enabled or not
963 bool GetAxisAutoLock() const;
966 * @brief Enables or Disables Axis Auto Lock mode for panning within the ScrollView.
968 * When enabled, any pan gesture that appears mostly horizontal or mostly
969 * vertical, will be automatically restricted to horizontal only or vertical
970 * only panning, until the pan gesture has completed.
973 * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode
975 void SetAxisAutoLock(bool enable);
978 * @brief Gets the gradient threshold at which a panning gesture
979 * should be locked to the Horizontal or Vertical axis.
982 * @return The gradient, a value between 0.0 and 1.0f
984 float GetAxisAutoLockGradient() const;
987 * @brief Sets the gradient threshold at which a panning gesture should be locked to the
988 * Horizontal or Vertical axis.
990 * By default, this is 0.36 (0.36:1) which means angles less than 20
991 * degrees to an axis will lock to that axis.
994 * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
995 * @note Specifying a value of 1.0 (the maximum value accepted) indicates that
996 * all panning gestures will auto-lock either to the horizontal or vertical axis.
999 void SetAxisAutoLockGradient(float gradient);
1002 * @brief Gets the friction coefficient setting for ScrollView when
1003 * flicking in free panning mode.
1005 * This is a value in stage-diagonals per second^2.
1006 * stage-diagonal = Length( stage.width, stage.height )
1008 * @return Friction coefficient is returned
1010 float GetFrictionCoefficient() const;
1013 * @brief Sets the friction coefficient for ScrollView when flicking
1014 * in free panning mode.
1016 * This is a value in stage-diagonals per second^2.
1017 * stage-diagonal = Length( stage.width, stage.height ).
1019 * A stage 480x800 in size has a diagonal length of 933.
1020 * Friction coefficient of 1.0 means the swipe velocity will
1021 * reduce by 1.0 * 933 pixels/sec^2.
1023 * @param[in] friction Friction coefficient must be greater than 0.0 (default = 1.0)
1025 void SetFrictionCoefficient(float friction);
1028 * @brief Gets the flick speed coefficient for ScrollView when
1029 * flicking in free panning mode.
1031 * This is a constant which multiplies the input touch
1032 * flick velocity to determine the actual velocity at
1033 * which to move the scrolling area.
1035 * @return The flick speed coefficient is returned
1037 float GetFlickSpeedCoefficient() const;
1040 * @brief Sets the flick speed coefficient for ScrollView when
1041 * flicking in free panning mode.
1043 * This is a constant which multiplies the input touch
1044 * flick velocity to determine the actual velocity at
1045 * which to move the scrolling area.
1047 * @param[in] speed The flick speed coefficient (default = 1.0)
1049 void SetFlickSpeedCoefficient(float speed);
1052 * @brief Returns the minimum pan distance required for a flick gesture in pixels.
1055 * @return Minimum pan distance vector with separate x and y distance
1057 Vector2 GetMinimumDistanceForFlick() const;
1060 * @brief Sets the minimum pan distance required for a flick in pixels.
1062 * 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.
1065 * @param[in] distance The minimum pan distance for a flick
1067 void SetMinimumDistanceForFlick( const Vector2& distance );
1070 * @brief Returns the minimum pan speed required for a flick gesture in pixels per second.
1073 * @return Minimum pan speed
1075 float GetMinimumSpeedForFlick() const;
1078 * @brief Sets the minimum pan speed required for a flick in pixels per second.
1081 * @param[in] speed The minimum pan speed for a flick
1083 void SetMinimumSpeedForFlick( float speed );
1086 * @brief Gets the maximum flick speed setting for ScrollView when
1087 * flicking in free panning mode.
1089 * This is a value in stage-diagonals per second.
1090 * stage-diagonal = Length( stage.width, stage.height )
1092 * @return Maximum flick speed is returned
1094 float GetMaxFlickSpeed() const;
1097 * @brief Sets the maximum flick speed for the ScrollView when
1098 * flicking in free panning mode.
1100 * This is a value in stage-diagonals per second.
1101 * stage-diagonal = Length( stage.width, stage.height )
1103 * A stage 480x800 in size has a diagonal length of 933.
1104 * Max Flick speed of 1.0 means the maximum velocity of
1105 * a swipe can be 1.0 * 933 pixels/sec.
1107 * @param[in] speed Maximum flick speed (default = 3.0)
1109 void SetMaxFlickSpeed(float speed);
1112 * @brief Gets the step of scroll distance in actor coordinates for
1113 * each wheel event received in free panning mode.
1116 * @return The step of scroll distance(pixel) in X and Y axes
1118 Vector2 GetWheelScrollDistanceStep() const;
1121 * @brief Sets the step of scroll distance in actor coordinates for
1122 * each wheel event received in free panning mode.
1125 * @param[in] step The step of scroll distance(pixel) in X and Y axes
1127 * @note If snap points are defined in the rulers, it will always
1128 * scroll to the next snap point towards the scroll direction while
1129 * receiving the wheel events.
1132 void SetWheelScrollDistanceStep(Vector2 step);
1135 * @brief Retrieves current scroll position.
1138 * @return The current scroll position
1140 Vector2 GetCurrentScrollPosition() const;
1143 * @brief Retrieves current scroll page based on ScrollView
1144 * dimensions being the size of one page, and all pages laid out in
1145 * a grid fashion, increasing from left to right until the end of
1149 * @note Pages start from 0 as the first page, not 1.
1151 * @return The Current page
1153 unsigned int GetCurrentPage() const;
1156 * @brief Scrolls View to position specified (contents will scroll to this position).
1158 * Position 0,0 is the origin. Increasing X scrolls contents left, while
1159 * increasing Y scrolls contents up.
1160 * - If Rulers have been applied to the axes, then the contents will scroll until
1161 * reaching the domain boundary.
1163 * @param[in] position The position to scroll to
1164 * @note Contents will not snap to ruler snap points.
1167 void ScrollTo(const Vector2& position);
1170 * @brief Scrolls View to position specified (contents will scroll to this position).
1172 * Position 0,0 is the origin. Increasing X scrolls contents left, while
1173 * increasing Y scrolls contents up.
1174 * - If Rulers have been applied to the axes, then the contents will scroll until
1175 * reaching the domain boundary.
1177 * @param[in] position The position to scroll to
1178 * @param[in] duration The duration of the animation in seconds
1179 * @note Contents will not snap to ruler snap points.
1182 void ScrollTo(const Vector2& position, float duration);
1185 * @brief Scrolls View to position specified (contents will scroll to this position).
1187 * Position 0,0 is the origin. Increasing X scrolls contents left, while
1188 * increasing Y scrolls contents up.
1189 * - If Rulers have been applied to the axes, then the contents will scroll until
1190 * reaching the domain boundary.
1192 * @param[in] position The position to scroll to
1193 * @param[in] duration The duration of the animation in seconds
1194 * @param[in] alpha The alpha function to use
1195 * @note Contents will not snap to ruler snap points.
1198 void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha);
1201 * @brief Scrolls View to position specified (contents will scroll to this position).
1203 * Position 0,0 is the origin. Increasing X scrolls contents left, while
1204 * increasing Y scrolls contents up.
1205 * - If Rulers have been applied to the axes, then the contents will scroll until
1206 * reaching the domain boundary.
1208 * @param[in] position The position to scroll to
1209 * @param[in] duration The duration of the animation in seconds
1210 * @param[in] horizontalBias Whether to bias scrolling to left or right
1211 * @param[in] verticalBias Whether to bias scrolling to top or bottom
1212 * @note Contents will not snap to ruler snap points.
1213 * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
1214 * wrap mode, the application developer can decide whether to scroll left or right
1215 * to get to the target page.
1218 void ScrollTo(const Vector2& position, float duration,
1219 DirectionBias horizontalBias, DirectionBias verticalBias);
1222 * @brief Scrolls View to position specified (contents will scroll to this position).
1224 * Position 0,0 is the origin. Increasing X scrolls contents left, while
1225 * increasing Y scrolls contents up.
1226 * - If Rulers have been applied to the axes, then the contents will scroll until
1227 * reaching the domain boundary.
1229 * @param[in] position The position to scroll to
1230 * @param[in] duration The duration of the animation in seconds
1231 * @param[in] horizontalBias Whether to bias scrolling to left or right
1232 * @param[in] verticalBias Whether to bias scrolling to top or bottom
1233 * @param[in] alpha Alpha function to use
1234 * @note Contents will not snap to ruler snap points.
1235 * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
1236 * wrap mode, the application developer can decide whether to scroll left or right
1237 * to get to the target page.
1240 void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha,
1241 DirectionBias horizontalBias, DirectionBias verticalBias);
1244 * @brief Scrolls View to page currently based on assumption that each page is
1245 * "(page) * ScrollViewSize.width, 0".
1248 * @param[in] page The page to scroll to
1249 * @note Should probably be upgraded so that page is an abstract class, that can be
1250 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1251 * orchestrated in a 2D grid fashion, or variable width.
1254 void ScrollTo(unsigned int page);
1257 * @brief Scrolls View to page currently based on assumption that each page is
1258 * "(page) * ScrollViewSize.width, 0".
1261 * @param[in] page The page to scroll to
1262 * @param[in] duration The duration of the animation in seconds
1263 * @note Should probably be upgraded so that page is an abstract class, that can be
1264 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1265 * orchestrated in a 2D grid fashion, or variable width.
1268 void ScrollTo(unsigned int page, float duration);
1271 * @brief Scrolls View to page currently based on assumption that each page is
1272 * "(page) * ScrollViewSize.width, 0".
1275 * @param[in] page The page to scroll to
1276 * @param[in] duration The duration of the animation in seconds
1277 * @param[in] bias Whether to bias scrolling to left or right
1278 * @note Should probably be upgraded so that page is an abstract class, that can be
1279 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
1280 * orchestrated in a 2D grid fashion, or variable width.
1281 * A biasing parameter is provided such that in scenarios with 2 pages in wrap mode,
1282 * the application developer can decide whether to scroll left or right to get to
1286 void ScrollTo(unsigned int page, float duration, DirectionBias bias);
1289 * @brief Scrolls View such that actor appears in the center of the ScrollView.
1292 * @param[in] actor The actor to center in on (via Scrolling)
1293 * @note Actor must be a direct child of ScrollView, otherwise will
1294 * cause an assertion failure.
1296 void ScrollTo(Actor& actor);
1299 * @brief Scrolls View such that actor appears in the center of the ScrollView.
1302 * @param[in] actor The actor to center in on (via Scrolling)
1303 * @param[in] duration The duration of the animation in seconds
1304 * @note Actor must be a direct child of ScrollView, otherwise will
1305 * cause an assertion failure.
1307 void ScrollTo(Actor& actor, float duration);
1310 * @brief Scrolls View to the nearest snap points as specified by the Rulers.
1312 * If already at snap points, then will return false, and not scroll.
1315 * @return True if Snapping necessary
1317 bool ScrollToSnapPoint();
1320 * @brief Applies a constraint that will affect the children of ScrollView.
1323 * @param[in] constraint The constraint to apply
1324 * @note This affects all existing and future Actors that are added to scrollview.
1326 void ApplyConstraintToChildren(Constraint constraint);
1329 * @brief Removes all constraints that will affect the children of ScrollView.
1332 * @note This removes all constraints from actors that have been added
1335 void RemoveConstraintsFromChildren();
1338 * @brief Applies Effect to ScrollView.
1341 * @param[in] effect The effect to apply to scroll view
1343 void ApplyEffect(ScrollViewEffect effect);
1346 * @brief Removes Effect from ScrollView.
1349 * @param[in] effect The effect to remove
1351 void RemoveEffect(ScrollViewEffect effect);
1354 * @brief Remove All Effects from ScrollView.
1357 void RemoveAllEffects();
1360 * @brief Binds actor to this ScrollView.
1362 * Once an actor is bound to a ScrollView, it will be subject to
1363 * that ScrollView's properties.
1366 * @param[in] child The actor to add to this ScrollView
1368 void BindActor(Actor child);
1371 * @brief Unbinds Actor from this ScrollView.
1373 * Once Unbound, this ScrollView will not affect the actor.
1375 * @param[in] child The actor to be unbound
1376 * @note This does not remove the child from the ScrollView container
1379 void UnbindActor(Actor child);
1382 * @brief Allows the user to constrain the scroll view in a particular direction.
1385 * @param[in] direction The axis to constrain the scroll-view to.
1386 * Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1387 * @param[in] threshold The threshold to apply around the axis
1388 * @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
1390 void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
1393 * @brief Removes a direction constraint from the scroll view.
1396 * @param[in] direction The axis to stop constraining to.
1397 * Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1399 void RemoveScrollingDirection( Radian direction );
1404 * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
1405 * position, scale, rotation for the snap or flick).
1407 * A callback of the following type may be connected:
1409 * void YourCallbackName(const SnapEvent& event);
1412 * @return The signal to connect to
1413 * @pre The Object has been initialized.
1415 SnapStartedSignalType& SnapStartedSignal();
1417 public: // Not intended for application developers
1421 * @brief Creates a handle using the Toolkit::Internal implementation.
1424 * @param[in] implementation The Control implementation
1426 DALI_INTERNAL ScrollView(Internal::ScrollView& implementation);
1429 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
1432 * @param[in] internal A pointer to the internal CustomActor
1434 explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
1441 } // namespace Toolkit
1445 #endif // __DALI_TOOLKIT_SCROLL_VIEW_H__