1 #ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
21 #include <dali/dali.h>
24 #include <dali-toolkit/public-api/controls/control-impl.h>
25 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
26 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
27 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
28 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
29 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
30 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-overshoot-indicator-impl.h>
43 typedef IntrusivePtr<ItemView> ItemViewPtr;
46 * ItemView is a scrollable layout container.
47 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
48 * Actor-ID pairs are provided from a shared ItemFactory, to display the currently visible items.
50 class ItemView : public Scrollable
55 * Create a new ItemView.
56 * @param[in] factory The factory which provides ItemView with items.
57 * @return A public handle to the newly allocated ItemView.
59 static Dali::Toolkit::ItemView New(ItemFactory& factory);
62 * @copydoc Toolkit::ItemView::GetScrollConnector
64 Dali::Toolkit::ScrollConnector GetScrollConnector() const;
67 * @copydoc Toolkit::ItemView::GetLayoutCount
69 unsigned int GetLayoutCount() const;
72 * @copydoc Toolkit::ItemView::AddLayout
74 void AddLayout(ItemLayout& layout);
77 * @copydoc Toolkit::ItemView::RemoveLayout
79 void RemoveLayout(unsigned int layoutIndex);
82 * @copydoc Toolkit::ItemView::GetLayout
84 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
87 * @copydoc Toolkit::ItemView::GetActiveLayout
89 ItemLayoutPtr GetActiveLayout() const;
92 * @copydoc Toolkit::ItemView::GetCurrentLayoutPosition
94 float GetCurrentLayoutPosition(unsigned int itemId) const;
97 * @copydoc Toolkit::ItemView::ActivateLayout
99 void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
102 * @copydoc Toolkit::ItemView::SetDefaultAlphaFunction
104 void SetDefaultAlphaFunction(AlphaFunction func);
107 * @copydoc Toolkit::ItemView::GetDefaultAlphaFunction
109 AlphaFunction GetDefaultAlphaFunction() const;
112 * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
114 void DeactivateCurrentLayout();
117 * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
119 void SetMinimumSwipeSpeed(float speed);
122 * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
124 float GetMinimumSwipeSpeed() const;
127 * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
129 void SetMinimumSwipeDistance(float distance);
132 * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
134 float GetMinimumSwipeDistance() const;
137 * @copydoc Toolkit::ItemView::SetMouseWheelScrollDistanceStep
139 void SetMouseWheelScrollDistanceStep(float step);
142 * @copydoc Toolkit::ItemView::GetMouseWheelScrollDistanceStep
144 float GetMouseWheelScrollDistanceStep() const;
147 * @copydoc Toolkit::ItemView::SetAnchoring
149 void SetAnchoring(bool enabled);
152 * @copydoc Toolkit::ItemView::GetAnchoring
154 bool GetAnchoring() const;
157 * @copydoc Toolkit::ItemView::SetAnchoringDuration
159 void SetAnchoringDuration(float durationSeconds);
162 * @copydoc Toolkit::ItemView::GetAnchoringDuration
164 float GetAnchoringDuration() const;
167 * @copydoc Toolkit::ItemView::ScrollToItem
169 void ScrollToItem(unsigned int itemId, float durationSeconds);
172 * @copydoc Toolkit::ItemView::SetRefreshInterval
174 void SetRefreshInterval(float intervalLayoutPositions);
177 * @copydoc Toolkit::ItemView::GetRefreshInterval
179 float GetRefreshInterval() const;
182 * @copydoc Toolkit::ItemView::GetItem
184 Actor GetItem(unsigned int itemId) const;
187 * @copydoc Toolkit::ItemView::GetItemId
189 unsigned int GetItemId(Actor actor) const;
192 * @copydoc Toolkit::ItemView::InsertItem
194 void InsertItem(Item newItem, float durationSeconds);
197 * @copydoc Toolkit::ItemView::InsertItem
199 void InsertItems(const ItemContainer& newItems, float durationSeconds);
202 * @copydoc Toolkit::ItemView::RemoveItem
204 void RemoveItem(ItemId itemId, float durationSeconds);
207 * @copydoc Toolkit::ItemView::InsertItem
209 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
212 * @copydoc Toolkit::ItemView::InsertItem
214 void ReplaceItem(Item replacementItem, float durationSeconds);
217 * @copydoc Toolkit::ItemView::InsertItem
219 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
222 * @copydoc Toolkit::Scrollable::GetDomainSize
224 Vector3 GetDomainSize() const;
227 * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
229 Vector3 GetCurrentScrollPosition() const;
232 * @copydoc Toolkit::Scrollable::AddOverlay()
234 void AddOverlay(Actor actor);
237 * @copydoc Toolkit::Scrollable::RemoveOverlay()
239 void RemoveOverlay(Actor actor);
242 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
244 void ScrollTo(const Vector3& position, float duration);
247 * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
248 * ItemView will not automatically refresh the cache in the given interval when the
249 * layout position is changed. This is useful in some cases, for example, automatic
250 * refresh is not needed during fast scrolling, otherwise it will cache unneeded
251 * items when the layout position changes quickly.
253 * @param[in] enabled True to enable automatic refresh or false to disable it.
255 void SetRefreshEnabled(bool enabled);
258 * @brief Helper to perform the refresh.
260 * @param[in] currentLayoutPosition The current layout position.
261 * @param[in] cacheExtra Whether to cache extra items during refresh.
263 void DoRefresh(float currentLayoutPosition, bool cacheExtra);
268 * Remove an Actor if found in the ItemPool.
269 * @param[in] itemId The item to remove.
270 * @return True if an actor was removed.
272 bool RemoveActor( unsigned int itemId );
275 * Remove any Actors outside a given range.
276 * @param[in] @param[in] range The range of required items.
278 void RemoveActorsOutsideRange( ItemRange range );
281 * Add a range of Actors, if they are not already in the ItemPool.
282 * @param[in] range The range of Item IDs to associate with the new actors.
283 * @param[in] durationSeconds The time taken to fully constrain the newly added actor.
285 void AddActorsWithinRange( ItemRange range, float durationSeconds );
288 * Add a new Actor, if not already in the ItemPool.
289 * @param[in] item The ID for the new item.
290 * @param[in] durationSeconds The time taken to fully constrain the new actor.
292 void AddNewActor( ItemId item, float durationSeconds );
295 * Apply the constraints etc. that are required for ItemView children.
296 * @param[in] item The item to setup.
297 * @param[in] durationSeconds The time taken to fully constrain the actor.
299 void SetupActor( Item item, float durationSeconds );
301 private: // From CustomActorImpl
304 * From CustomActorImpl; called after a child has been added to the owning actor.
305 * @param[in] child The child which has been added.
307 virtual void OnChildAdd(Actor& child);
310 * From CustomActorImpl; called after a touch-signal is received by the owning actor.
311 * @param[in] event The touch event.
312 * @return True if the event should be consumed.
314 virtual bool OnTouchEvent(const TouchEvent& event);
317 * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
318 * @param[in] event The mouse wheel event.
319 * @return True if the event should be consumed.
321 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
323 private: // From ControlImpl
326 * @copydoc Toolkit::Control::OnInitialize()
328 virtual void OnInitialize();
331 * @copydoc Toolkit::Control::OnAccessibilityPan()
333 virtual bool OnAccessibilityPan(PanGesture gesture);
336 * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
338 virtual Actor GetNextKeyboardFocusableActor(Actor actor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
341 * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
343 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
348 * Construct a new ItemView.
349 * @param[in] factory The factory which provides ItemView with items.
351 ItemView(ItemFactory& factory);
354 * A reference counted object may only be deleted by calling Unreference()
361 ItemView(const ItemView&);
364 ItemView& operator=(const ItemView& rhs);
367 * Helper to apply constraints to an actor.
368 * @param[in] actor The actor to constrain.
369 * @param[in] layout The active layout.
370 * @param[in] itemId The ID of the item represented by the actor.
371 * @param[in] durationSeconds The time taken to fully constrain the actors.
373 void ApplyConstraints(Actor& actor, ItemLayout& layout, unsigned int itemId, float durationSeconds);
376 * Helper to re-apply all the constraints after items have been inserted, removed etc.
377 * @param[in] durationSeconds The time taken to fully constrain the actors.
379 void ReapplyAllConstraints( float durationSeconds );
382 * Helper to remove items outside a given range.
383 * @param[in] range The range of required items.
385 void RemoveItems(ItemRange range);
388 * Helper to add a range of items, if not already in the ItemPool.
389 * @param[in] layout The layout used to position the new items.
390 * @param[in] layoutSize The current size of the layout.
391 * @param[in] range The range of required items.
393 void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
396 * Helper to find the range of items to populate with.
397 * @param[in] layout The current layout.
398 * @param[in] range The range of items.
399 * @param[in] reserveExtra True if reserve items should be included.
401 ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
406 * Helper to handle pressed (Down) events.
407 * @param[in] x The X coordinate of the touch event.
408 * @param[in] y The Y coordinate of the touch event.
409 * @param[in] timeMs The time-stamp of the touch event.
411 void OnPressed(float x, float y, unsigned long timeMs);
414 * Helper to clamp the first-item position when dragging/swiping.
415 * @param[in] targetPosition The target position of the drag etc.
416 * @param[in] targetSize The target ItemView & layout size.
417 * @param[in] layout The current layout.
418 * @return The clamped first-item position.
420 float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout);
423 * Called upon pan gesture event.
425 * @param[in] gesture The gesture event.
427 void OnPan(PanGesture pan);
430 * Helper to handle anchoring animations.
431 * @return The animation, or an uninitialized handle if not necessary.
433 Animation DoAnchoring();
436 * Callback from scroll animations
437 * @param[in] animation The scroll-animation which has finished.
439 void OnScrollFinished(Animation& animation);
442 * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
444 * @param[in] animation the animation that has finished
446 void OnOvershootOnFinished(Animation& animation);
449 * This is called after a timeout when no new mouse wheel event is received for a certain period of time.
450 * @return will return false; one-shot timer.
452 bool OnMouseWheelEventFinished();
455 * Stops and removes animation if exists.
456 * @param[in,out] animation The animation handle to be removed.
458 void RemoveAnimation(Animation& animation);
461 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEnabled
463 virtual void SetOvershootEnabled( bool enable );
466 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
467 * @return The scroll overshoot.
469 float CalculateScrollOvershoot();
472 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
474 * @param[in] overshootAmount amount to animate to
475 * @param[in] animateBack whether to animate back to zero immediately after
476 * @return The scroll overshoot.
478 void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
481 * Gets the scroll position in pixels according to the logical layout position.
482 * @param[in] layoutSize The current size of the layout.
484 float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
487 * Calculates the minimum and maximum positions for each axis to scroll to.
488 * @param[in] layoutSize The current size of the layout.
490 void CalculateDomainSize(const Vector3& layoutSize);
493 * Calculates whether we want to allow current item view to scroll.
494 * @param[in] layoutSize The current size of the layout.
495 * @return true if itemview is scrollable
497 bool IsLayoutScrollable(const Vector3& layoutSize);
500 * Callback when the current layout position of ItemView changes in both positive
501 * and negative directions by the specified amount. Refresh the ItemView to create
502 * newly visible items.
503 * @param[in] source the property notification that triggered this callback
505 void OnRefreshNotification(PropertyNotification& source);
509 ItemFactory& mItemFactory;
511 typedef std::map<unsigned int, Actor> ItemPool;
512 typedef ItemPool::iterator ItemPoolIter;
513 typedef ItemPool::const_iterator ConstItemPoolIter;
517 ItemLayoutContainer mLayouts;
518 ItemLayout* mActiveLayout;
519 Vector3 mActiveLayoutTargetSize;
521 AlphaFunction mDefaultAlphaFunction;
523 Animation mResizeAnimation;
524 Animation mScrollAnimation;
525 Animation mScrollSpeedAnimation;
526 Animation mScrollOvershootAnimation;
527 bool mAnimatingOvershootOn; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
528 bool mAnimateOvershootOff; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
530 bool mAnchoringEnabled;
531 float mAnchoringDuration;
533 float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
534 PropertyNotification mRefreshNotification; // stores the property notification used for item view refresh
535 bool mRefreshOrderHint; ///< True if scrolling towards the last item
539 float mMinimumSwipeSpeed;
540 float mMinimumSwipeDistance;
541 float mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each mouse wheel event received.
543 float mScrollDistance;
545 Vector2 mTotalPanDisplacement;
547 float mScrollOvershoot;
550 Timer mMouseWheelEventFinishedTimer; ///< The timer to determine whether there is no mouse wheel event received for a certain period of time.
552 Dali::Gesture::State mGestureState;
554 ImageActor mOvershootOverlay; ///< The overlay actor for overshoot effect
555 OvershootRippleEffect mOvershootEffect; ///< The vertex/fragment shader used to display the overshoot ripple effect
557 Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars
558 Constrainable mScrollPositionObject; ///< From mScrollConnector
562 Property::Index mPropertyPosition; ///< The physical position of the first item within the layout
563 Property::Index mPropertyMinimumLayoutPosition; ///< The minimum valid layout position in the layout.
564 Property::Index mPropertyScrollSpeed; ///< The current scroll speed of item view
566 bool mRefreshEnabled; ///< Whether to refresh the cache automatically
569 } // namespace Internal
571 // Helpers for public-api forwarding methods
573 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
575 DALI_ASSERT_ALWAYS(itemView);
577 Dali::RefObject& handle = itemView.GetImplementation();
579 return static_cast<Toolkit::Internal::ItemView&>(handle);
582 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
584 DALI_ASSERT_ALWAYS(itemView);
586 const Dali::RefObject& handle = itemView.GetImplementation();
588 return static_cast<const Toolkit::Internal::ItemView&>(handle);
591 } // namespace Toolkit
595 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__