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/public-api/adaptor-framework/timer.h>
23 #include <dali/public-api/animation/animation.h>
24 #include <dali/public-api/object/property-notification.h>
25 #include <dali/devel-api/common/map-wrapper.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
30 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
31 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
32 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
45 typedef IntrusivePtr<ItemView> ItemViewPtr;
48 * ItemView is a scrollable layout container.
49 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
50 * Actor-ID pairs are provided from a shared ItemFactory, to display the currently visible items.
52 class ItemView : public Scrollable
57 typedef Toolkit::ItemView::LayoutActivatedSignalType LayoutActivatedSignalType;
62 * Create a new ItemView.
63 * @param[in] factory The factory which provides ItemView with items.
64 * @return A public handle to the newly allocated ItemView.
66 static Dali::Toolkit::ItemView New(ItemFactory& factory);
69 * @copydoc Toolkit::ItemView::GetLayoutCount
71 unsigned int GetLayoutCount() const;
74 * @copydoc Toolkit::ItemView::AddLayout
76 void AddLayout(ItemLayout& layout);
79 * @copydoc Toolkit::ItemView::RemoveLayout
81 void RemoveLayout(unsigned int layoutIndex);
84 * @copydoc Toolkit::ItemView::GetLayout
86 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
89 * @copydoc Toolkit::ItemView::GetActiveLayout
91 ItemLayoutPtr GetActiveLayout() const;
94 * @copydoc Toolkit::ItemView::GetCurrentLayoutPosition
96 float GetCurrentLayoutPosition(unsigned int itemId) const;
99 * @copydoc Toolkit::ItemView::ActivateLayout
101 void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
104 * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
106 void DeactivateCurrentLayout();
109 * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
111 void SetMinimumSwipeSpeed(float speed);
114 * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
116 float GetMinimumSwipeSpeed() const;
119 * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
121 void SetMinimumSwipeDistance(float distance);
124 * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
126 float GetMinimumSwipeDistance() const;
129 * @copydoc Toolkit::ItemView::SetWheelScrollDistanceStep
131 void SetWheelScrollDistanceStep(float step);
134 * @copydoc Toolkit::ItemView::GetWheelScrollDistanceStep
136 float GetWheelScrollDistanceStep() const;
139 * @copydoc Toolkit::ItemView::SetAnchoring
141 void SetAnchoring(bool enabled);
144 * @copydoc Toolkit::ItemView::GetAnchoring
146 bool GetAnchoring() const;
149 * @copydoc Toolkit::ItemView::SetAnchoringDuration
151 void SetAnchoringDuration(float durationSeconds);
154 * @copydoc Toolkit::ItemView::GetAnchoringDuration
156 float GetAnchoringDuration() const;
159 * @copydoc Toolkit::ItemView::ScrollToItem
161 void ScrollToItem(unsigned int itemId, float durationSeconds);
164 * @copydoc Toolkit::ItemView::SetRefreshInterval
166 void SetRefreshInterval(float intervalLayoutPositions);
169 * @copydoc Toolkit::ItemView::GetRefreshInterval
171 float GetRefreshInterval() const;
174 * @copydoc Toolkit::ItemView::Refresh
179 * @copydoc Toolkit::ItemView::GetItem
181 Actor GetItem(unsigned int itemId) const;
184 * @copydoc Toolkit::ItemView::GetItemId
186 unsigned int GetItemId(Actor actor) const;
189 * @copydoc Toolkit::ItemView::InsertItem
191 void InsertItem(Item newItem, float durationSeconds);
194 * @copydoc Toolkit::ItemView::InsertItem
196 void InsertItems(const ItemContainer& newItems, float durationSeconds);
199 * @copydoc Toolkit::ItemView::RemoveItem
201 void RemoveItem(ItemId itemId, float durationSeconds);
204 * @copydoc Toolkit::ItemView::InsertItem
206 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
209 * @copydoc Toolkit::ItemView::InsertItem
211 void ReplaceItem(Item replacementItem, float durationSeconds);
214 * @copydoc Toolkit::ItemView::InsertItem
216 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
219 * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
221 Vector2 GetCurrentScrollPosition() const;
224 * @copydoc Toolkit::Scrollable::AddOverlay()
226 void AddOverlay(Actor actor);
229 * @copydoc Toolkit::Scrollable::RemoveOverlay()
231 void RemoveOverlay(Actor actor);
234 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration)
236 void ScrollTo(const Vector2& position, float duration);
239 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
241 void SetOvershootEffectColor( const Vector4& color );
244 * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
245 * ItemView will not automatically refresh the cache in the given interval when the
246 * layout position is changed. This is useful in some cases, for example, automatic
247 * refresh is not needed during fast scrolling, otherwise it will cache unneeded
248 * items when the layout position changes quickly.
250 * @param[in] enabled True to enable automatic refresh or false to disable it.
252 void SetRefreshEnabled(bool enabled);
255 * @brief Helper to perform the refresh.
257 * @param[in] currentLayoutPosition The current layout position.
258 * @param[in] cacheExtra Whether to cache extra items during refresh.
260 void DoRefresh(float currentLayoutPosition, bool cacheExtra);
263 * @copydoc Toolkit::ItemView::SetItemsParentOrigin
265 void SetItemsParentOrigin( const Vector3& parentOrigin );
268 * @copydoc Toolkit::ItemView::GetItemsParentOrigin
270 Vector3 GetItemsParentOrigin() const;
273 * @copydoc Toolkit::ItemView::SetItemsAnchorPoint
275 void SetItemsAnchorPoint( const Vector3& anchorPoint );
278 * @copydoc Toolkit::ItemView::GetItemsAnchorPoint
280 Vector3 GetItemsAnchorPoint() const;
283 * @copydoc Toolkit::ItemView::GetItemsRange
285 void GetItemsRange(ItemRange& range);
288 * @copydoc Toolkit::ItemView::LayoutActivatedSignal()
290 LayoutActivatedSignalType& LayoutActivatedSignal()
292 return mLayoutActivatedSignal;
296 * Connects a callback function with the object's signals.
297 * @param[in] object The object providing the signal.
298 * @param[in] tracker Used to disconnect the signal.
299 * @param[in] signalName The signal to connect to.
300 * @param[in] functor A newly allocated FunctorDelegate.
301 * @return True if the signal was connected.
302 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
304 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
309 * Called when a property of an object of this type is set.
310 * @param[in] object The object whose property is set.
311 * @param[in] index The property index.
312 * @param[in] value The new property value.
314 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
317 * Called to retrieve a property of an object of this type.
318 * @param[in] object The object whose property is to be retrieved.
319 * @param[in] index The property index.
320 * @return The current value of the property.
322 static Property::Value GetProperty( BaseObject* object, Property::Index index );
325 * Performs actions as requested using the action name.
326 * @param[in] object The object on which to perform the action.
327 * @param[in] actionName The action to perform.
328 * @param[in] attributes The attributes with which to perfrom this action.
329 * @return true if action has been accepted by this control
331 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes );
334 * Helper for DoAction( ACTION_STOP_SCROLLING ).
336 void DoStopScrolling();
341 * Remove an Actor if found in the ItemPool.
342 * @param[in] itemId The item to remove.
343 * @return True if the remaining actors were reordered.
345 bool RemoveActor( unsigned int itemId );
348 * Remove any Actors outside a given range.
349 * @param[in] @param[in] range The range of required items.
351 void RemoveActorsOutsideRange( ItemRange range );
354 * Add a range of Actors, if they are not already in the ItemPool.
355 * @param[in] range The range of Item IDs to associate with the new actors.
356 * @param[in] layoutSize The layout-size.
358 void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize );
361 * Add a new Actor, if not already in the ItemPool.
362 * @param[in] item The ID for the new item.
363 * @param[in] layoutSize The layout-size.
365 void AddNewActor( ItemId item, const Vector3& layoutSize );
368 * Apply the constraints etc. that are required for ItemView children.
369 * @param[in] item The item to setup.
370 * @param[in] layoutSize The layout-size.
372 void SetupActor( Item item, const Vector3& layoutSize );
375 * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView.
376 * @param[in] item The ID for the item to be released.
377 * @param[in] actor The actor to be removed from ItemView.
379 void ReleaseActor( ItemId item, Actor actor );
381 private: // From CustomActorImpl
384 * From CustomActorImpl; called after a child has been added to the owning actor.
385 * @param[in] child The child which has been added.
387 virtual void OnChildAdd(Actor& child);
390 * From CustomActorImpl; called after a wheel-event is received by the owning actor.
391 * @param[in] event The wheel event.
392 * @return True if the event should be consumed.
394 virtual bool OnWheelEvent(const WheelEvent& event);
396 private: // From Control
399 * @copydoc Toolkit::Control::OnInitialize()
401 virtual void OnInitialize();
404 * @copydoc Toolkit::Control::OnAccessibilityPan()
406 virtual bool OnAccessibilityPan(PanGesture gesture);
409 * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
411 virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
414 * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
416 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
421 * Construct a new ItemView.
422 * @param[in] factory The factory which provides ItemView with items.
424 ItemView(ItemFactory& factory);
427 * A reference counted object may only be deleted by calling Unreference()
434 ItemView(const ItemView&);
437 ItemView& operator=(const ItemView& rhs);
440 * Helper to re-apply all the constraints after items have been inserted, removed etc.
441 * @param[in] durationSeconds The time taken to fully constrain the actors.
443 void ReapplyAllConstraints();
446 * Helper to relayout after item(s) are removed.
448 void OnItemsRemoved();
451 * Helper to remove items outside a given range.
452 * @param[in] range The range of required items.
454 void RemoveItems(ItemRange range);
457 * Helper to add a range of items, if not already in the ItemPool.
458 * @param[in] layout The layout used to position the new items.
459 * @param[in] layoutSize The current size of the layout.
460 * @param[in] range The range of required items.
462 void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
465 * Helper to find the range of items to populate with.
466 * @param[in] layout The current layout.
467 * @param[in] range The range of items.
468 * @param[in] reserveExtra True if reserve items should be included.
470 ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
475 * Helper to clamp the first-item position when dragging/swiping.
476 * @param[in] targetPosition The target position of the drag etc.
477 * @param[in] targetSize The target ItemView & layout size.
478 * @param[in] layout The current layout.
479 * @param[in] updateOvershoot False stops the current overshoot value from being clamped also.
480 * @return The clamped first-item position.
482 float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout, bool updateOvershoot = true);
485 * Called after a touch-signal is received by the owning actor.
486 * @param[in] actor The touched actor.
487 * @param[in] touch The touch information.
488 * @return True if the event should be consumed.
490 bool OnTouch( Actor actor, const TouchData& touch );
493 * Called upon pan gesture event.
495 * @param[in] gesture The gesture event.
497 void OnPan( const PanGesture& pan );
500 * Helper to handle anchoring animations.
501 * @return The animation, or an uninitialized handle if not necessary.
503 Animation DoAnchoring();
506 * Callback from scroll animations
507 * @param[in] animation The scroll-animation which has finished.
509 void OnScrollFinished(Animation& animation);
512 * Callback from layout activation scroll animations
513 * @param[in] animation The scroll-animation which has finished.
515 void OnLayoutActivationScrollFinished(Animation& animation);
518 * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
520 * @param[in] animation the animation that has finished
522 void OnOvershootOnFinished(Animation& animation);
525 * This is called after a timeout when no new wheel event is received for a certain period of time.
526 * @return will return false; one-shot timer.
528 bool OnWheelEventFinished();
531 * Stops and removes animation if exists.
532 * @param[in,out] animation The animation handle to be removed.
534 void RemoveAnimation(Animation& animation);
537 * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot
539 virtual void EnableScrollOvershoot( bool enable );
542 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
543 * @return The scroll overshoot.
545 float CalculateScrollOvershoot();
548 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
550 * @param[in] overshootAmount amount to animate to
551 * @param[in] animateBack whether to animate back to zero immediately after
552 * @return The scroll overshoot.
554 void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
557 * Gets the scroll position in pixels according to the logical layout position.
558 * @param[in] layoutSize The current size of the layout.
560 float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
563 * Calculates the minimum and maximum positions for each axis to scroll to.
564 * @param[in] layoutSize The current size of the layout.
566 void CalculateDomainSize(const Vector3& layoutSize);
569 * Calculates whether we want to allow current item view to scroll.
570 * @param[in] layoutSize The current size of the layout.
571 * @return true if itemview is scrollable
573 bool IsLayoutScrollable(const Vector3& layoutSize);
576 * Callback when the current layout position of ItemView changes in both positive
577 * and negative directions by the specified amount. Refresh the ItemView to create
578 * newly visible items.
579 * @param[in] source the property notification that triggered this callback
581 void OnRefreshNotification(PropertyNotification& source);
585 typedef std::map<unsigned int, Actor> ItemPool;
586 typedef ItemPool::iterator ItemPoolIter;
587 typedef ItemPool::const_iterator ConstItemPoolIter;
590 ItemFactory& mItemFactory;
591 std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects
592 Actor mOvershootOverlay; ///< The overlay actor for overshoot effect
593 Animation mResizeAnimation;
594 Animation mScrollAnimation;
595 Animation mScrollOvershootAnimation;
596 Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time.
597 PropertyNotification mRefreshNotification; ///< Stores the property notification used for item view refresh
598 LayoutActivatedSignalType mLayoutActivatedSignal;
599 Vector3 mActiveLayoutTargetSize;
600 Vector3 mItemsParentOrigin;
601 Vector3 mItemsAnchorPoint;
602 Vector2 mTotalPanDisplacement;
603 ItemLayout* mActiveLayout;
605 float mAnchoringDuration;
606 float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
607 float mMinimumSwipeSpeed;
608 float mMinimumSwipeDistance;
609 float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received.
610 float mScrollDistance;
612 float mScrollOvershoot;
614 Dali::Gesture::State mGestureState : 3;
615 bool mAnimatingOvershootOn : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
616 bool mAnimateOvershootOff : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
617 bool mAnchoringEnabled : 1;
618 bool mRefreshOrderHint : 1; ///< True if scrolling towards the last item
619 bool mIsFlicking : 1;
620 bool mAddingItems : 1;
621 bool mRefreshEnabled : 1; ///< Whether to refresh the cache automatically
622 bool mInAnimation : 1; ///< Keeps track of whether an animation is controlling the overshoot property.
625 } // namespace Internal
627 // Helpers for public-api forwarding methods
629 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
631 DALI_ASSERT_ALWAYS(itemView);
633 Dali::RefObject& handle = itemView.GetImplementation();
635 return static_cast<Toolkit::Internal::ItemView&>(handle);
638 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
640 DALI_ASSERT_ALWAYS(itemView);
642 const Dali::RefObject& handle = itemView.GetImplementation();
644 return static_cast<const Toolkit::Internal::ItemView&>(handle);
647 } // namespace Toolkit
651 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__