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>
30 namespace Internal DALI_INTERNAL
36 * @brief How axes/rotation or scale are clamped
40 NotClamped, ///< The quantity isn't clamped
41 ClampedToMin, ///< The quantity is clamped to the min value
42 ClampedToMax ///< The quantity is clamped to the max value
46 * @brief A 3 dimensional clamp
50 ClampState x; ///< The clamp state of the x axis
51 ClampState y; ///< The clamp state of the y axis
52 ClampState z; ///< The clamp state of the z axis
56 * @brief The snap type
65 * @brief DirectionBias types.
69 DirectionBiasLeft = -1, ///< Bias scroll snap to Left
70 DirectionBiasNone = 0, ///< Don't bias scroll snap
71 DirectionBiasRight = 1 ///< Bias scroll snap to Right
75 * @brief Used for specifying minimum/maximum extents of a ruler.
77 class DALI_IMPORT_API RulerDomain
82 * @brief Creates Ruler domain allowing a point to traverse between min and max extents.
84 * @param[in] min Minimum extent (point cannot traverse less than this)
85 * @param[in] max Maximum extent (point cannot traverse greater than this)
86 * @param[in] enabled Whether domain has been enabled or not.
88 explicit RulerDomain(float min, float max, bool enabled = true);
92 float min; ///< Minimum extent (point cannot traverse less than this)
93 float max; ///< Maximum extent (point cannot traverse greater than this)
94 bool enabled; ///< Whether domain has been enabled or not.
97 * @brief Clamps value (x) from (min) to (max).
99 * An optional length parameter can be specified to suggest that the
100 * subject is not a point but a line to that should be clamped.
102 * @param[in] x X point to be clamped between (min) and (max) extents.
103 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
104 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
105 * @return The clamped value.
107 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
110 * @brief Clamps value (x) from (min) to (max).
112 * An optional length parameter can be specified to suggest that the
113 * 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 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
119 * @return The clamped value.
121 float Clamp(float x, float length, float scale, ClampState &clamped) const;
124 * @brief Returns (max-min) size of ruler.
126 * @return The size of the ruler from min to max.
128 float GetSize() const;
133 * @brief Abstract class to define scroll axes.
135 * It can specify whether they are traversable, where their snap
136 * points are and their domain.
138 class DALI_IMPORT_API Ruler : public RefObject
141 /// @brief The type of the ruler
143 Fixed, ///< A fixed ruler
144 Free ///< A free ruler
150 * @brief Constructs ruler, default enabled, with limitless domain.
155 * @brief Snaps (x) in accordance to the ruler settings.
157 * @param[in] x The input value on the ruler to be snapped.
158 * @param[in] bias (optional) The biasing employed for snapping
159 * 0 floor input (floor x) "Used for Flick Left"
160 * 0.5 round input (floor x + 0.5) "Used for Release"
161 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
162 * @return The position of the one dimensional point passed in once snapped.
164 virtual float Snap(float x, float bias = 0.5f) const = 0;
167 * @brief Returns position from page, based on whatever the ruler
170 * If (wrap) is true, then will set volume to the number of
171 * times page has exceeded the domain's volume (volume being the
172 * number of pages within the domain), while wrapping the position
175 * @param[in] page The page index
176 * @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled)
177 * @param[in] wrap Enable wrap mode
178 * @return The position representing this page point.
180 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const = 0;
183 * @brief Returns page from position, based on whatever the ruler
186 * If (wrap) is true, then will return a page wrapped within the domain.
188 * @param[in] position The position on the domain
189 * @param[in] wrap Enable wrap mode
190 * @return The page where this position resides.
192 virtual unsigned int GetPageFromPosition(float position, bool wrap) const = 0;
195 * @brief Returns the total number of pages within this Ruler.
197 * @return The number of pages in the Ruler.
199 virtual unsigned int GetTotalPages() const = 0;
204 * @brief Gets the ruler type.
206 * @return The ruler type.
208 Ruler::RulerType GetType() const;
211 * @brief Returns whether this axis has been enabled or not.
213 * @return true if axis is enabled
215 bool IsEnabled() const;
218 * @brief Enables ruler (ruler must be enabled in order to traverse along it).
223 * @brief Disables ruler.
228 * @brief Sets Domain.
230 * @param[in] domain Ruler domain object.
232 void SetDomain(RulerDomain domain);
235 * @brief Gets Domain.
239 const RulerDomain &GetDomain() const;
242 * @brief Disables Domain (minimum/maximum extents for this axis).
244 void DisableDomain();
247 * @brief Clamps value (x) from (min) to (max).
249 * An optional length parameter can be specified to suggest that the
250 * subject is not a point but a line that should be clamped.
252 * @param[in] x X point to be clamped between (min) and (max) extents.
253 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
254 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
255 * @return The clamped value.
257 float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
261 * @brief Clamps value (x) from (min) to (max).
263 * An optional length parameter can be specified to suggest that the
264 * subject is not a point but a line to that should be clamped.
266 * @param[in] x X point to be clamped between (min) and (max) extents.
267 * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
268 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
269 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
270 * @return The clamped value.
272 float Clamp(float x, float length, float scale, ClampState &clamped) const;
275 * @brief Snaps and Clamps (x) in accordance to ruler settings.
277 * @param[in] x value to be snapped in accordance to ruler snap value,
278 * and clamped in accordance to the ruler's domain (if set).
279 * @param[in] bias (optional) The biasing employed for snapping
280 * 0 floor input (floor x) "Used for Flick Left"
281 * 0.5 round input (floor x + 0.5) "Used for Release"
282 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
283 * @param[in] length (optional) The Length of the line from (x) to (x + length)
285 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
286 * @return the clamped value after snapping
288 float SnapAndClamp(float x, float bias = 0.5f, float length = 0.0f, float scale = 1.0f) const;
291 * @brief Snaps and Clamps (x) in accordance to ruler settings.
293 * @param[in] x value to be snapped in accordance to ruler snap value,
294 * and clamped in accordance to the ruler's domain (if set).
295 * @param[in] bias (optional) The biasing employed for snapping
296 * 0 floor input (floor x) "Used for Flick Left"
297 * 0.5 round input (floor x + 0.5) "Used for Release"
298 * 1 ceil input (floor x + 1.0) "Used for Flick Right"
299 * @param[in] length (optional) The Length of the line from (x) to (x + length)
301 * @param[in] scale Scaling parameter which treats domain as scaled in calculations.
302 * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
303 * @return The clamped value after snapping
305 float SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const;
310 * @brief Destructor - A reference counted object may only be deleted by calling Unreference().
316 RulerType mType; ///< Type of Ruler (Fixed or Free).
317 bool mEnabled; ///< If the ruler is enabled.
318 RulerDomain mDomain; ///< The domain of the ruler.
322 typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object
325 * @brief Concrete implementation of Ruler that has no snapping and has one single page.
327 class DALI_IMPORT_API DefaultRuler : public Ruler
331 * @brief DefaultRuler constructor.
336 * @copydoc Toolkit::Ruler::Snap
338 virtual float Snap(float x, float bias) const;
341 * @copydoc Toolkit::Ruler::GetPositionFromPage
343 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
346 * @copydoc Toolkit::Ruler::GetPageFromPosition
348 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
351 * @copydoc Toolkit::Ruler::GetTotalPages
353 virtual unsigned int GetTotalPages() const;
357 * @brief Concrete implementation of Ruler that has fixed snapping.
359 class DALI_IMPORT_API FixedRuler : public Ruler
365 * @param[in] spacing The spacing between each interval on this ruler.
367 FixedRuler(float spacing = 1.0f);
370 * @copydoc Toolkit::Ruler::Snap
372 virtual float Snap(float x, float bias) const;
375 * @copydoc Toolkit::Ruler::GetPositionFromPage
377 virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const;
380 * @copydoc Toolkit::Ruler::GetPageFromPosition
382 virtual unsigned int GetPageFromPosition(float position, bool wrap) const;
385 * @copydoc Toolkit::Ruler::GetTotalPages
387 virtual unsigned int GetTotalPages() const;
390 float mSpacing; ///< The spacing between each interval
393 class ScrollViewEffect;
397 * @brief ScrollView contains actors that can be scrolled manually (via touch)
401 * | %Signal Name | Method |
402 * |-------------------|----------------------------|
403 * | snap-started | @ref SnapStartedSignal() |
405 class DALI_IMPORT_API ScrollView : public Scrollable
411 static const std::string SCROLL_TIME_PROPERTY_NAME; ///< Property, name "scroll-time", type FLOAT
412 static const std::string SCROLL_POSITION_PROPERTY_NAME; ///< Property, name "scroll-position", type VECTOR3
413 static const std::string SCROLL_PRE_POSITION_PROPERTY_NAME; ///< Property, name "scroll-pre-position", type VECTOR3
414 static const std::string SCROLL_OVERSHOOT_X_PROPERTY_NAME; ///< Property, name "scroll-overshoot-x", type float
415 static const std::string SCROLL_OVERSHOOT_Y_PROPERTY_NAME; ///< Property, name "scroll-overshoot-y", type float
416 static const std::string SCROLL_FINAL_PROPERTY_NAME; ///< Property, name "scroll-final", type VECTOR3
417 static const std::string SCROLL_WRAP_PROPERTY_NAME; ///< Property, name "scroll-wrap", type BOOLEAN
418 static const std::string SCROLL_PANNING_PROPERTY_NAME; ///< Property, name "scroll-panning", type BOOLEAN
419 static const std::string SCROLL_SCROLLING_PROPERTY_NAME; ///< Property, name "scroll-scrolling", type BOOLEAN
420 static const std::string SCROLL_POSITION_DELTA_PROPERTY_NAME; ///< Property, name "scroll-position-delta" type VECTOR3
421 static const std::string SCROLL_START_PAGE_POSITION_PROPERTY_NAME; ///< Property, name "scroll-start-page-position" type VECTOR3
425 static const float DEFAULT_SLOW_SNAP_ANIMATION_DURATION; ///< Default Drag-Release animation time.
426 static const float DEFAULT_FAST_SNAP_ANIMATION_DURATION; ///< Default Drag-Flick animation time.
427 static const float DEFAULT_SNAP_OVERSHOOT_DURATION; ///< Default Overshoot snapping animation time.
428 static const float DEFAULT_MAX_OVERSHOOT; ///< Default maximum allowed overshoot
430 static const float DEFAULT_AXIS_AUTO_LOCK_GRADIENT; ///< Default Axis-AutoLock gradient threshold. default is 0.36:1 (20 degrees)
431 static const float DEFAULT_FRICTION_COEFFICIENT; ///< Default Friction Co-efficient. (in stage diagonals per second)
432 static const float DEFAULT_FLICK_SPEED_COEFFICIENT; ///< Default Flick speed coefficient (multiples input touch velocity)
433 static const float DEFAULT_MAX_FLICK_SPEED; ///< Default Maximum flick speed. (in stage diagonals per second)
438 * @brief Clamp signal event's data
442 ClampState3D scale; ///< Clamp information for scale axes
443 ClampState3D position; ///< Clamp information for position axes
444 ClampState rotation; ///< Clamp information for rotation
448 * @brief Snap signal event's data.
452 SnapType type; ///< Current snap commencing
453 Vector3 position; ///< Target snap position
454 float duration; ///< Duration of snap animation.
457 typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type
460 * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
461 * position, scale, rotation for the snap or flick)
463 SnapStartedSignalType& SnapStartedSignal();
468 * @brief Creates an empty ScrollView handle.
473 * @brief Copy constructor.
475 * Creates another handle that points to the same real object
477 * @param[in] handle to copy from
479 ScrollView( const ScrollView& handle );
482 * @brief Assignment operator.
484 * Changes this handle to point to another real object
485 * @param[in] handle The handle to copy from
486 * @return A reference to this
488 ScrollView& operator=( const ScrollView& handle );
493 * This is non-virtual since derived Handle types must not contain data or virtual methods.
498 * @brief Create an initialized ScrollView.
500 * @return A handle to a newly allocated Dali resource.
502 static ScrollView New();
505 * @brief Downcast an Object handle to ScrollView.
507 * If handle points to a ScrollView the downcast produces valid
508 * handle. If not the returned handle is left uninitialized.
510 * @param[in] handle Handle to an object
511 * @return handle to a ScrollView or an uninitialized handle
513 static ScrollView DownCast( BaseHandle handle );
518 * @brief Get snap-animation's AlphaFunction.
520 * @return Current easing alpha function of the snap animation.
522 AlphaFunction GetScrollSnapAlphaFunction() const;
525 * @brief Set snap-animation's AlphaFunction.
527 * @param[in] alpha Easing alpha function of the snap animation.
529 void SetScrollSnapAlphaFunction(AlphaFunction alpha);
532 * @brief Get flick-animation's AlphaFunction.
534 * @return Current easing alpha function of the flick animation.
536 AlphaFunction GetScrollFlickAlphaFunction() const;
539 * @brief Set flick-animation's AlphaFunction.
541 * @param[in] alpha Easing alpha function of the flick animation.
543 void SetScrollFlickAlphaFunction(AlphaFunction alpha);
546 * @brief Gets the time for the scroll snap-animation.
548 * This animation occurs when the user drags, and releases.
550 * @return The time in seconds for the animation to take.
552 float GetScrollSnapDuration() const;
555 * @brief Sets the time for the scroll snap-animation.
557 * This animation occurs when the user drags, and releases.
559 * @param[in] time The time in seconds for the animation to take.
561 void SetScrollSnapDuration(float time);
564 * @brief Gets the time for the scroll flick-animation.
566 * This animation occurs when the user flicks scroll view.
568 * @return The time in seconds for the animation to take.
570 float GetScrollFlickDuration() const;
573 * @brief Sets the time for the scroll flick-animation.
575 * This animation occurs when the user flicks scroll view.
577 * @param[in] time The time in seconds for the animation to take.
579 void SetScrollFlickDuration(float time);
582 * @brief Set X axis ruler.
584 * Defines how scrolling horizontally is snapped, and
585 * the boundary (domain) in which the ScrollView can pan.
587 * @param[in] ruler The ruler to be used for the X axis
589 void SetRulerX(RulerPtr ruler);
592 * @brief Set Y axis ruler.
594 * Defines how scrolling vertically is snapped, and the boundary
595 * (domain) in which the ScrollView can pan.
597 * @param[in] ruler The ruler to be used for the Y axis
599 void SetRulerY(RulerPtr ruler);
602 * @brief Set Scroll's touch sensitivity.
604 * @note Unlike SetSensitive(), this determines whether this ScrollView
605 * should react (e.g. pan), without disrupting the sensitivity of it's children.
607 * @param[in] sensitive true to enable scroll, false to disable scrolling
609 void SetScrollSensitive(bool sensitive);
612 * @brief Set maximum overshoot amount.
614 * The final overshoot value is within 0.0f to 1.0f, but the maximum
615 * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
616 * edge of a scrollable area and the maximum overshoot is 100 then
617 * the final overshoot value will be 0.75f)
619 * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
620 * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
622 void SetMaxOvershoot(float overshootX, float overshootY);
625 * @brief Set Snap Overshoot animation's AlphaFunction.
627 * @param[in] alpha Easing alpha function of the overshoot snap animation.
629 void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
632 * @brief Set Snap Overshoot animation's Duration.
634 * @note Set duration to 0 seconds, to disable Animation.
636 * @param[in] duration The duration of the overshoot snap animation.
638 void SetSnapOvershootDuration(float duration);
641 * @brief Enables or Disables Actor Auto-Snap mode.
643 * When Actor Auto-Snap mode has been enabled, ScrollView will automatically
644 * snap to the closest actor (The closest actor will appear in the center of
647 * @param[in] enable Enables (true), or disables (false) Actor AutoSnap
649 void SetActorAutoSnap(bool enable);
652 * @brief Enables or Disables Wrap mode for ScrollView contents.
654 * When enabled, the ScrollView contents are wrapped over the X/Y Domain.
656 * @note You must apply a position constraint that causes Wrapping
659 * @param[in] enable Enables (true), or disables (false) Wrap Mode.
661 void SetWrapMode(bool enable);
664 * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
666 * @return Current scroll update distance
668 int GetScrollUpdateDistance() const;
671 * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted
673 * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
674 * Each time the ScrollView crosses this distance the signal will be emitted
676 * @param[in] distance The distance for ScrollView to move before emitting update signal
678 void SetScrollUpdateDistance(int distance);
681 * @brief Returns state of Axis Auto Lock mode.
683 * @return Whether Axis Auto Lock mode has been enabled or not.
685 bool GetAxisAutoLock() const;
688 * @brief Enables or Disables Axis Auto Lock mode for panning within the ScrollView.
690 * When enabled, any pan gesture that appears mostly horizontal or mostly
691 * vertical, will be automatically restricted to horizontal only or vertical
692 * only panning, until the pan gesture has completed.
694 * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
696 void SetAxisAutoLock(bool enable);
699 * @brief Gets the gradient threshold at which a panning gesture
700 * should be locked to the Horizontal or Vertical axis.
702 * @return The gradient, a value between 0.0 and 1.0f.
704 float GetAxisAutoLockGradient() const;
707 * @brief Sets the gradient threshold at which a panning gesture should be locked to the
708 * Horizontal or Vertical axis.
710 * By default this is 0.36 (0.36:1) which means angles less than 20
711 * degrees to an axis will lock to that axis.
713 * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
714 * all panning gestures will auto-lock. Either to the horizontal or vertical axis.
716 * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
718 void SetAxisAutoLockGradient(float gradient);
721 * @brief Gets the friction coefficient setting for ScrollView when
722 * flicking in free panning mode.
724 * This is a value in stage-diagonals per second^2.
725 * stage-diagonal = Length( stage.width, stage.height )
726 * @return Friction coefficient is returned.
728 float GetFrictionCoefficient() const;
731 * @brief Sets the friction coefficient for ScrollView when flicking
732 * in free panning mode.
734 * This is a value in stage-diagonals per second^2.
735 * stage-diagonal = Length( stage.width, stage.height ).
737 * A stage 480x800 in size has a diagonal length of 933.
738 * Friction coefficient of 1.0 means the swipe velocity will
739 * reduce by 1.0 * 933 pixels/sec^2.
740 * @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0)
742 void SetFrictionCoefficient(float friction);
745 * @brief Gets the flick speed coefficient for ScrollView when
746 * flicking in free panning mode.
748 * This is a constant which multiplies the input touch
749 * flick velocity to determine the actual velocity at
750 * which to move the scrolling area.
751 * @return The flick speed coefficient is returned.
753 float GetFlickSpeedCoefficient() const;
756 * @brief Sets the flick speed coefficient for ScrollView when
757 * flicking in free panning mode.
759 * This is a constant which multiplies the input touch
760 * flick velocity to determine the actual velocity at
761 * which to move the scrolling area.
762 * @param[in] speed The flick speed coefficient (default = 1.0).
764 void SetFlickSpeedCoefficient(float speed);
767 * @brief Returns the minimum pan distance required for a flick gesture in pixels
769 * @return Minimum pan distance vector with separate x and y distance
771 Vector2 GetMinimumDistanceForFlick() const;
774 * @brief Sets the minimum pan distance required for a flick in pixels
776 * 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
778 * @param[in] distance The minimum pan distance for a flick
780 void SetMinimumDistanceForFlick( const Vector2& distance );
783 * @brief Returns the minimum pan speed required for a flick gesture in pixels per second
785 * @return Minimum pan speed
787 float GetMinimumSpeedForFlick() const;
790 * @brief Sets the minimum pan speed required for a flick in pixels per second
792 * @param[in] speed The minimum pan speed for a flick
794 void SetMinimumSpeedForFlick( float speed );
797 * @brief Gets the maximum flick speed setting for ScrollView when
798 * flicking in free panning mode.
800 * This is a value in stage-diagonals per second.
801 * stage-diagonal = Length( stage.width, stage.height )
802 * @return Maximum flick speed is returned
804 float GetMaxFlickSpeed() const;
807 * @brief Sets the maximum flick speed for the ScrollView when
808 * flicking in free panning mode.
810 * This is a value in stage-diagonals per second.
811 * stage-diagonal = Length( stage.width, stage.height )
813 * A stage 480x800 in size has a diagonal length of 933.
814 * Max Flick speed of 1.0 means the maximum velocity of
815 * a swipe can be 1.0 * 933 pixels/sec.
816 * @param[in] speed Maximum flick speed (default = 3.0)
818 void SetMaxFlickSpeed(float speed);
821 * @brief Gets the step of scroll distance in actor coordinates for
822 * each mouse wheel event received in free panning mode.
824 * @return The step of scroll distance(pixel) in X and Y axes.
826 Vector2 GetMouseWheelScrollDistanceStep() const;
829 * @brief Sets the step of scroll distance in actor coordinates for
830 * each mouse wheel event received in free panning mode.
832 * @param[in] step The step of scroll distance(pixel) in X and Y axes.
834 * @note: If snap points are defined in the rulers, it will always
835 * scroll to the next snap point towards the scroll direction while
836 * receiving the mouse wheel events.
839 void SetMouseWheelScrollDistanceStep(Vector2 step);
842 * @brief Retrieves current scroll position.
844 * @returns The current scroll position.
846 Vector3 GetCurrentScrollPosition() const;
849 * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place
850 * SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function.
852 * @param[in] position The new scroll position to set.
854 void SetScrollPosition(const Vector3& position);
857 * @brief Retrieves current scroll page based on ScrollView
858 * dimensions being the size of one page, and all pages laid out in
859 * a grid fashion, increasing from left to right until the end of
862 * @note: Pages start from 0 as the first page, not 1.
864 * @returns The Current page.
866 unsigned int GetCurrentPage() const;
869 * @brief Scrolls View to position specified (contents will scroll to this position).
871 * Position 0,0 is the origin. Increasing X scrolls contents left, while
872 * increasing Y scrolls contents up.
873 * - If Rulers have been applied to the axes, then the contents will scroll until
874 * reaching the domain boundary.
875 * @note Contents will not snap to ruler snap points.
877 * @param[in] position The position to scroll to.
879 void ScrollTo(const Vector3 &position);
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.
891 * @param[in] duration The duration of the animation in seconds
893 void ScrollTo(const Vector3 &position, float duration);
896 * @brief Scrolls View to position specified (contents will scroll to this position)
898 * Position 0,0 is the origin. Increasing X scrolls contents left, while
899 * increasing Y scrolls contents up.
900 * - If Rulers have been applied to the axes, then the contents will scroll until
901 * reaching the domain boundary.
902 * @note Contents will not snap to ruler snap points.
904 * @param[in] position The position to scroll to.
905 * @param[in] duration The duration of the animation in seconds
906 * @param[in] alpha The alpha function to use
908 void ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha);
911 * @brief Scrolls View to position specified (contents will scroll to this position).
913 * Position 0,0 is the origin. Increasing X scrolls contents left, while
914 * increasing Y scrolls contents up.
915 * - If Rulers have been applied to the axes, then the contents will scroll until
916 * reaching the domain boundary.
917 * @note Contents will not snap to ruler snap points.
918 * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
919 * wrap mode, the application developer can decide whether to scroll left or right
920 * to get to the target page
922 * @param[in] position The position to scroll to.
923 * @param[in] duration The duration of the animation in seconds
924 * @param[in] horizontalBias Whether to bias scrolling to left or right.
925 * @param[in] verticalBias Whether to bias scrolling to top or bottom.
927 void ScrollTo(const Vector3 &position, float duration,
928 DirectionBias horizontalBias, DirectionBias verticalBias);
931 * @brief Scrolls View to position specified (contents will scroll to this position)
933 * Position 0,0 is the origin. Increasing X scrolls contents left, while
934 * increasing Y scrolls contents up.
935 * - If Rulers have been applied to the axes, then the contents will scroll until
936 * reaching the domain boundary.
937 * @note Contents will not snap to ruler snap points.
938 * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
939 * wrap mode, the application developer can decide whether to scroll left or right
940 * to get to the target page
942 * @param[in] position The position to scroll to.
943 * @param[in] duration The duration of the animation in seconds
944 * @param[in] horizontalBias Whether to bias scrolling to left or right.
945 * @param[in] verticalBias Whether to bias scrolling to top or bottom.
946 * @param[in] alpha Alpha function to use
948 void ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha,
949 DirectionBias horizontalBias, DirectionBias verticalBias);
952 * @brief Scrolls View to page currently based on assumption that each page is
953 * "(page) * ScrollViewSize.width, 0".
955 * @note Should probably be upgraded so that page is an abstract class, that can be
956 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
957 * orchestrated in a 2D grid fashion, or variable width.
959 * @param[in] page to scroll to
961 void ScrollTo(unsigned int page);
964 * @brief Scrolls View to page currently based on assumption that each page is
965 * "(page) * ScrollViewSize.width, 0".
967 * @note Should probably be upgraded so that page is an abstract class, that can be
968 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
969 * orchestrated in a 2D grid fashion, or variable width.
971 * @param[in] page to scroll to
972 * @param[in] duration The duration of the animation in seconds
974 void ScrollTo(unsigned int page, float duration);
977 * @brief Scrolls View to page currently based on assumption that each page is
978 * "(page) * ScrollViewSize.width, 0".
980 * @note Should probably be upgraded so that page is an abstract class, that can be
981 * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
982 * orchestrated in a 2D grid fashion, or variable width.
983 * A biasing parameter is provided such that in scenarios with 2 pages in wrap mode,
984 * the application developer can decide whether to scroll left or right to get to
987 * @param[in] page to scroll to
988 * @param[in] duration The duration of the animation in seconds
989 * @param[in] bias Whether to bias scrolling to left or right.
991 void ScrollTo(unsigned int page, float duration, DirectionBias bias);
994 * @brief Scrolls View such that actor appears in the center of the ScrollView.
996 * @note Actor must be a direct child of ScrollView, otherwise will
997 * cause an assertion failure.
998 * @param[in] actor The actor to center in on (via Scrolling).
1000 void ScrollTo(Actor& actor);
1003 * @brief Scrolls View such that actor appears in the center of the ScrollView.
1005 * @note Actor must be a direct child of ScrollView, otherwise will
1006 * cause an assertion failure.
1007 * @param[in] actor The actor to center in on (via Scrolling).
1008 * @param[in] duration The duration of the animation in seconds
1010 void ScrollTo(Actor& actor, float duration);
1013 * @brief Scrolls View to the nearest snap points as specified by the Rulers.
1015 * If already at snap points, then will return false, and not scroll.
1017 * @return True if Snapping necessary.
1019 bool ScrollToSnapPoint();
1022 * @brief Applies a constraint that will affect the children of ScrollView.
1024 * @note this affects all existing and future Actors that are added to scrollview.
1025 * @param[in] constraint The constraint to apply
1027 void ApplyConstraintToChildren(Constraint constraint);
1030 * @brief Removes all constraints that will affect the children of ScrollView.
1032 * @note this removes all constraints from actors that have been added
1035 void RemoveConstraintsFromChildren();
1038 * @brief Apply Effect to ScrollView.
1040 * @param[in] effect The effect to apply to scroll view
1042 void ApplyEffect(ScrollViewEffect effect);
1045 * @brief Remove Effect from ScrollView.
1047 * @param[in] effect The effect to remove.
1049 void RemoveEffect(ScrollViewEffect effect);
1052 * @brief Remove All Effects from ScrollView.
1054 void RemoveAllEffects();
1057 * @brief Binds actor to this ScrollView.
1059 * Once an actor is bound to a ScrollView, it will be subject to
1060 * that ScrollView's properties.
1062 * @param[in] child The actor to add to this ScrollView.
1064 void BindActor(Actor child);
1067 * @brief Unbind Actor from this ScrollView.
1069 * Once Unbound, this ScrollView will not affect the actor.
1070 * @note this does not remove the child from the ScrollView container
1072 * @param[in] child The actor to be unbound.
1074 void UnbindActor(Actor child);
1077 * @brief Allows the user to constrain the scroll view in a particular direction.
1079 * @param[in] direction The axis to constrain the scroll-view to.
1080 * Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1081 * @param[in] threshold The threshold to apply around the axis.
1082 * @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
1084 void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
1087 * @brief Remove a direction constraint from the scroll view.
1089 * @param[in] direction The axis to stop constraining to.
1090 * Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
1092 void RemoveScrollingDirection( Radian direction );
1094 public: // Not intended for application developers
1097 * @brief Creates a handle using the Toolkit::Internal implementation.
1099 * @param[in] implementation The Control implementation.
1101 DALI_INTERNAL ScrollView(Internal::ScrollView& implementation);
1104 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
1106 * @param[in] internal A pointer to the internal CustomActor.
1108 explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
1111 } // namespace Toolkit
1115 #endif // __DALI_TOOLKIT_SCROLL_VIEW_H__