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 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/dali.h>
25 #include <dali-toolkit/public-api/controls/control-impl.h>
26 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
27 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
28 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
29 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
30 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.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::DeactivateCurrentLayout
104 void DeactivateCurrentLayout();
107 * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
109 void SetMinimumSwipeSpeed(float speed);
112 * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
114 float GetMinimumSwipeSpeed() const;
117 * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
119 void SetMinimumSwipeDistance(float distance);
122 * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
124 float GetMinimumSwipeDistance() const;
127 * @copydoc Toolkit::ItemView::SetMouseWheelScrollDistanceStep
129 void SetMouseWheelScrollDistanceStep(float step);
132 * @copydoc Toolkit::ItemView::GetMouseWheelScrollDistanceStep
134 float GetMouseWheelScrollDistanceStep() const;
137 * @copydoc Toolkit::ItemView::SetAnchoring
139 void SetAnchoring(bool enabled);
142 * @copydoc Toolkit::ItemView::GetAnchoring
144 bool GetAnchoring() const;
147 * @copydoc Toolkit::ItemView::SetAnchoringDuration
149 void SetAnchoringDuration(float durationSeconds);
152 * @copydoc Toolkit::ItemView::GetAnchoringDuration
154 float GetAnchoringDuration() const;
157 * @copydoc Toolkit::ItemView::ScrollToItem
159 void ScrollToItem(unsigned int itemId, float durationSeconds);
162 * @copydoc Toolkit::ItemView::SetRefreshInterval
164 void SetRefreshInterval(float intervalLayoutPositions);
167 * @copydoc Toolkit::ItemView::GetRefreshInterval
169 float GetRefreshInterval() const;
172 * @copydoc Toolkit::ItemView::GetItem
174 Actor GetItem(unsigned int itemId) const;
177 * @copydoc Toolkit::ItemView::GetItemId
179 unsigned int GetItemId(Actor actor) const;
182 * @copydoc Toolkit::ItemView::InsertItem
184 void InsertItem(Item newItem, float durationSeconds);
187 * @copydoc Toolkit::ItemView::InsertItem
189 void InsertItems(const ItemContainer& newItems, float durationSeconds);
192 * @copydoc Toolkit::ItemView::RemoveItem
194 void RemoveItem(ItemId itemId, float durationSeconds);
197 * @copydoc Toolkit::ItemView::InsertItem
199 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
202 * @copydoc Toolkit::ItemView::InsertItem
204 void ReplaceItem(Item replacementItem, float durationSeconds);
207 * @copydoc Toolkit::ItemView::InsertItem
209 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
212 * @copydoc Toolkit::Scrollable::GetDomainSize
214 Vector3 GetDomainSize() const;
217 * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
219 Vector3 GetCurrentScrollPosition() const;
222 * @copydoc Toolkit::Scrollable::AddOverlay()
224 void AddOverlay(Actor actor);
227 * @copydoc Toolkit::Scrollable::RemoveOverlay()
229 void RemoveOverlay(Actor actor);
232 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
234 void ScrollTo(const Vector3& position, float duration);
237 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
239 void SetOvershootEffectColor( const Vector4& color );
242 * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
243 * ItemView will not automatically refresh the cache in the given interval when the
244 * layout position is changed. This is useful in some cases, for example, automatic
245 * refresh is not needed during fast scrolling, otherwise it will cache unneeded
246 * items when the layout position changes quickly.
248 * @param[in] enabled True to enable automatic refresh or false to disable it.
250 void SetRefreshEnabled(bool enabled);
253 * @brief Helper to perform the refresh.
255 * @param[in] currentLayoutPosition The current layout position.
256 * @param[in] cacheExtra Whether to cache extra items during refresh.
258 void DoRefresh(float currentLayoutPosition, bool cacheExtra);
261 * @copydoc Toolkit::ItemView::SetItemsParentOrigin
263 void SetItemsParentOrigin( const Vector3& parentOrigin );
266 * @copydoc Toolkit::ItemView::GetItemsParentOrigin
268 Vector3 GetItemsParentOrigin() const;
271 * @copydoc Toolkit::ItemView::SetItemsAnchorPoint
273 void SetItemsAnchorPoint( const Vector3& anchorPoint );
276 * @copydoc Toolkit::ItemView::GetItemsAnchorPoint
278 Vector3 GetItemsAnchorPoint() const;
281 * @copydoc Toolkit::ItemView::GetItemsRange
283 void GetItemsRange(ItemRange& range);
288 * Remove an Actor if found in the ItemPool.
289 * @param[in] itemId The item to remove.
290 * @return True if an actor was removed.
292 bool RemoveActor( unsigned int itemId );
295 * Remove any Actors outside a given range.
296 * @param[in] @param[in] range The range of required items.
298 void RemoveActorsOutsideRange( ItemRange range );
301 * Add a range of Actors, if they are not already in the ItemPool.
302 * @param[in] range The range of Item IDs to associate with the new actors.
303 * @param[in] durationSeconds The time taken to fully constrain the newly added actor.
305 void AddActorsWithinRange( ItemRange range, float durationSeconds );
308 * Add a new Actor, if not already in the ItemPool.
309 * @param[in] item The ID for the new item.
310 * @param[in] durationSeconds The time taken to fully constrain the new actor.
312 void AddNewActor( ItemId item, float durationSeconds );
315 * Apply the constraints etc. that are required for ItemView children.
316 * @param[in] item The item to setup.
317 * @param[in] durationSeconds The time taken to fully constrain the actor.
319 void SetupActor( Item item, float durationSeconds );
322 * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView.
323 * @param[in] item The ID for the item to be released.
324 * @param[in] actor The actor to be removed from ItemView.
326 void ReleaseActor( ItemId item, Actor actor );
328 private: // From CustomActorImpl
331 * From CustomActorImpl; called after a child has been added to the owning actor.
332 * @param[in] child The child which has been added.
334 virtual void OnChildAdd(Actor& child);
337 * From CustomActorImpl; called after a touch-signal is received by the owning actor.
338 * @param[in] event The touch event.
339 * @return True if the event should be consumed.
341 virtual bool OnTouchEvent(const TouchEvent& event);
344 * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
345 * @param[in] event The mouse wheel event.
346 * @return True if the event should be consumed.
348 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
350 private: // From Control
353 * @copydoc Toolkit::Control::OnInitialize()
355 virtual void OnInitialize();
358 * @copydoc Toolkit::Control::OnAccessibilityPan()
360 virtual bool OnAccessibilityPan(PanGesture gesture);
363 * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
365 virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
368 * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
370 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
375 * Construct a new ItemView.
376 * @param[in] factory The factory which provides ItemView with items.
378 ItemView(ItemFactory& factory);
381 * A reference counted object may only be deleted by calling Unreference()
388 ItemView(const ItemView&);
391 ItemView& operator=(const ItemView& rhs);
394 * Helper to re-apply all the constraints after items have been inserted, removed etc.
395 * @param[in] durationSeconds The time taken to fully constrain the actors.
397 void ReapplyAllConstraints( float durationSeconds );
400 * Helper to remove items outside a given range.
401 * @param[in] range The range of required items.
403 void RemoveItems(ItemRange range);
406 * Helper to add a range of items, if not already in the ItemPool.
407 * @param[in] layout The layout used to position the new items.
408 * @param[in] layoutSize The current size of the layout.
409 * @param[in] range The range of required items.
411 void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
414 * Helper to find the range of items to populate with.
415 * @param[in] layout The current layout.
416 * @param[in] range The range of items.
417 * @param[in] reserveExtra True if reserve items should be included.
419 ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
424 * Helper to handle pressed (Down) events.
425 * @param[in] x The X coordinate of the touch event.
426 * @param[in] y The Y coordinate of the touch event.
427 * @param[in] timeMs The time-stamp of the touch event.
429 void OnPressed(float x, float y, unsigned long timeMs);
432 * Helper to clamp the first-item position when dragging/swiping.
433 * @param[in] targetPosition The target position of the drag etc.
434 * @param[in] targetSize The target ItemView & layout size.
435 * @param[in] layout The current layout.
436 * @return The clamped first-item position.
438 float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout);
441 * Called upon pan gesture event.
443 * @param[in] gesture The gesture event.
445 void OnPan(PanGesture pan);
448 * Helper to handle anchoring animations.
449 * @return The animation, or an uninitialized handle if not necessary.
451 Animation DoAnchoring();
454 * Callback from scroll animations
455 * @param[in] animation The scroll-animation which has finished.
457 void OnScrollFinished(Animation& animation);
460 * Callback from layout activation scroll animations
461 * @param[in] animation The scroll-animation which has finished.
463 void OnLayoutActivationScrollFinished(Animation& animation);
466 * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
468 * @param[in] animation the animation that has finished
470 void OnOvershootOnFinished(Animation& animation);
473 * This is called after a timeout when no new mouse wheel event is received for a certain period of time.
474 * @return will return false; one-shot timer.
476 bool OnMouseWheelEventFinished();
479 * Stops and removes animation if exists.
480 * @param[in,out] animation The animation handle to be removed.
482 void RemoveAnimation(Animation& animation);
485 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEnabled
487 virtual void SetOvershootEnabled( bool enable );
490 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
491 * @return The scroll overshoot.
493 float CalculateScrollOvershoot();
496 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
498 * @param[in] overshootAmount amount to animate to
499 * @param[in] animateBack whether to animate back to zero immediately after
500 * @return The scroll overshoot.
502 void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
505 * Gets the scroll position in pixels according to the logical layout position.
506 * @param[in] layoutSize The current size of the layout.
508 float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
511 * Calculates the minimum and maximum positions for each axis to scroll to.
512 * @param[in] layoutSize The current size of the layout.
514 void CalculateDomainSize(const Vector3& layoutSize);
517 * Calculates whether we want to allow current item view to scroll.
518 * @param[in] layoutSize The current size of the layout.
519 * @return true if itemview is scrollable
521 bool IsLayoutScrollable(const Vector3& layoutSize);
524 * Callback when the current layout position of ItemView changes in both positive
525 * and negative directions by the specified amount. Refresh the ItemView to create
526 * newly visible items.
527 * @param[in] source the property notification that triggered this callback
529 void OnRefreshNotification(PropertyNotification& source);
532 * This is called when scroll position has been changed by ScrollConnector::SetScrollPosition.
533 * @param[in] position The new scroll position
535 void OnScrollPositionChanged( float position );
539 ItemFactory& mItemFactory;
541 typedef std::map<unsigned int, Actor> ItemPool;
542 typedef ItemPool::iterator ItemPoolIter;
543 typedef ItemPool::const_iterator ConstItemPoolIter;
547 ItemLayoutContainer mLayouts;
548 ItemLayout* mActiveLayout;
549 Vector3 mActiveLayoutTargetSize;
551 Animation mResizeAnimation;
552 Animation mScrollAnimation;
553 Animation mScrollOvershootAnimation;
554 bool mAnimatingOvershootOn; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
555 bool mAnimateOvershootOff; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
557 bool mAnchoringEnabled;
558 float mAnchoringDuration;
560 float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
561 PropertyNotification mRefreshNotification; // stores the property notification used for item view refresh
562 bool mRefreshOrderHint; ///< True if scrolling towards the last item
566 float mMinimumSwipeSpeed;
567 float mMinimumSwipeDistance;
568 float mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each mouse wheel event received.
570 float mScrollDistance;
572 Vector2 mTotalPanDisplacement;
574 float mScrollOvershoot;
577 Timer mMouseWheelEventFinishedTimer; ///< The timer to determine whether there is no mouse wheel event received for a certain period of time.
579 Dali::Gesture::State mGestureState;
581 Actor mOvershootOverlay; ///< The overlay actor for overshoot effect
583 Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars
584 Constrainable mScrollPositionObject; ///< From mScrollConnector
588 Property::Index mPropertyPosition; ///< The physical position of the first item within the layout
589 Property::Index mPropertyMinimumLayoutPosition; ///< The minimum valid layout position in the layout.
590 Property::Index mPropertyScrollSpeed; ///< The current scroll speed of item view
592 bool mRefreshEnabled; ///< Whether to refresh the cache automatically
594 Vector3 mItemsParentOrigin;
595 Vector3 mItemsAnchorPoint;
598 } // namespace Internal
600 // Helpers for public-api forwarding methods
602 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
604 DALI_ASSERT_ALWAYS(itemView);
606 Dali::RefObject& handle = itemView.GetImplementation();
608 return static_cast<Toolkit::Internal::ItemView&>(handle);
611 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
613 DALI_ASSERT_ALWAYS(itemView);
615 const Dali::RefObject& handle = itemView.GetImplementation();
617 return static_cast<const Toolkit::Internal::ItemView&>(handle);
620 } // namespace Toolkit
624 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__