X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscrollable%2Fitem-view%2Fitem-view-impl.h;h=16f0b0a158236ff2542106f9c04b6d524698b297;hp=00262f22693c799b4ec255af126fba34bccec9cd;hb=a78bb823aebc305823855ac35b3413aaff7bc684;hpb=e2eda444afbe82e9591fe198eef339227f90a616 diff --git a/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h b/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h index 00262f2..16f0b0a 100644 --- a/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h +++ b/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h @@ -1,24 +1,28 @@ #ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__ #define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__ -// -// Copyright (c) 2014 Samsung Electronics Co., Ltd. -// -// Licensed under the Flora License, Version 1.0 (the License); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://floralicense.org/license/ -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an AS IS BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// +/* + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ // EXTERNAL INCLUDES -#include +#include +#include +#include +#include // INTERNAL INCLUDES #include @@ -26,7 +30,6 @@ #include #include #include -#include namespace Dali { @@ -42,91 +45,6 @@ class ItemView; typedef IntrusivePtr ItemViewPtr; /** - * ItemPool is container of Actor/ID pairs stored by ItemView - */ -class ItemPool -{ -public: // types - - typedef std::pair IDKeyPair; - typedef std::map IDKeyContainer; - typedef IDKeyContainer::iterator IDKeyIter; - typedef IDKeyContainer::const_iterator IDKeyConstIter; - - typedef std::pair ActorKeyPair; - typedef std::map ActorKeyContainer; - typedef ActorKeyContainer::iterator ActorKeyIter; - typedef ActorKeyContainer::const_iterator ActorKeyConstIter; - -public: // Construction & Destruction - - /** - * Constructor - * @param[in] itemView A reference to the ItemView class that owns this. - */ - ItemPool(ItemView& itemView) - : mItemView(itemView) - { - } - -public: // Methods - - /** - * Returns a const reference to the IDKeyContainer whose key is based on the Item ID. - * @return Const reference to IDKeyContainer. - */ - const IDKeyContainer& GetIDKeyContainer() const - { - return mIdKeyContainer; - } - - /** - * Returns a const reference to the ActorKeyContainer whose key is based on the Actor. - * @return Const reference to IDKeyContainer. - */ - const ActorKeyContainer& GetActorKeyContainer() const - { - return mActorKeyContainer; - } - - /** - * Add a range of items to the ItemPool, if they are not already in the ItemPool. - * @param[in] scrollingTowardsLast Should be true if scrolling towards the last item in the range. - * @param[in] range The range of Item IDs to associate with the new actors. - * @param[in] targetSize The current size of the layout. - */ - void AddItems(bool scrollingTowardsLast, ItemRange range, const Vector3& targetSize); - - /** - * Remove items from the ItemPool that are outside the given range. - * @param[in] range The range of required items. - */ - void RemoveItems(ItemRange range); - - /** - * Remove an item from the ItemPool. - * @param[in] itemId The item to remove. - * @return Whether the item is found and removed or not. - */ - bool RemoveItem(unsigned int itemId); - -private: - - /** - * Adds an item, if not already in the ItemPool. - * @param[in] itemId The item to add. - * @param[in] targetSize The target size of the layout. - */ - void AddItem(unsigned int itemId, const Vector3& targetSize); - -private: - - IDKeyContainer mIdKeyContainer; - ActorKeyContainer mActorKeyContainer; - ItemView& mItemView; -}; - -/** * ItemView is a scrollable layout container. * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout. * Actor-ID pairs are provided from a shared ItemFactory, to display the currently visible items. @@ -203,14 +121,14 @@ public: float GetMinimumSwipeDistance() const; /** - * @copydoc Toolkit::ItemView::SetMouseWheelScrollDistanceStep + * @copydoc Toolkit::ItemView::SetWheelScrollDistanceStep */ - void SetMouseWheelScrollDistanceStep(float step); + void SetWheelScrollDistanceStep(float step); /** - * @copydoc Toolkit::ItemView::GetMouseWheelScrollDistanceStep + * @copydoc Toolkit::ItemView::GetWheelScrollDistanceStep */ - float GetMouseWheelScrollDistanceStep() const; + float GetWheelScrollDistanceStep() const; /** * @copydoc Toolkit::ItemView::SetAnchoring @@ -240,12 +158,17 @@ public: /** * @copydoc Toolkit::ItemView::SetRefreshInterval */ - void SetRefreshInterval(unsigned int intervalMilliseconds); + void SetRefreshInterval(float intervalLayoutPositions); /** * @copydoc Toolkit::ItemView::GetRefreshInterval */ - unsigned int GetRefreshInterval() const; + float GetRefreshInterval() const; + + /** + * @copydoc Toolkit::ItemView::Refresh + */ + void Refresh(); /** * @copydoc Toolkit::ItemView::GetItem @@ -258,19 +181,44 @@ public: unsigned int GetItemId(Actor actor) const; /** + * @copydoc Toolkit::ItemView::InsertItem + */ + void InsertItem(Item newItem, float durationSeconds); + + /** + * @copydoc Toolkit::ItemView::InsertItem + */ + void InsertItems(const ItemContainer& newItems, float durationSeconds); + + /** * @copydoc Toolkit::ItemView::RemoveItem */ - void RemoveItem(unsigned int itemId, float durationSeconds); + void RemoveItem(ItemId itemId, float durationSeconds); + + /** + * @copydoc Toolkit::ItemView::InsertItem + */ + void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds); + + /** + * @copydoc Toolkit::ItemView::InsertItem + */ + void ReplaceItem(Item replacementItem, float durationSeconds); + + /** + * @copydoc Toolkit::ItemView::InsertItem + */ + void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds); /** * @copydoc Toolkit::Scrollable::GetDomainSize */ - Vector3 GetDomainSize() const; + Vector2 GetDomainSize() const; /** * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition */ - Vector3 GetCurrentScrollPosition() const; + Vector2 GetCurrentScrollPosition() const; /** * @copydoc Toolkit::Scrollable::AddOverlay() @@ -283,38 +231,111 @@ public: void RemoveOverlay(Actor actor); /** - * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration) + * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration) */ - void ScrollTo(const Vector3& position, float duration); + void ScrollTo(const Vector2& position, float duration); -public: // Used By ItemPool + /** + * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor + */ + void SetOvershootEffectColor( const Vector4& color ); /** - * Called by the ItemPool when it wishes to create an actor from the ItemFactory with the - * specified ItemId. - * @param[in] itemId The Item ID of the actor to create. + * @brief Set whether to enable automatic refresh or not. When refresh is disabled, + * ItemView will not automatically refresh the cache in the given interval when the + * layout position is changed. This is useful in some cases, for example, automatic + * refresh is not needed during fast scrolling, otherwise it will cache unneeded + * items when the layout position changes quickly. + * + * @param[in] enabled True to enable automatic refresh or false to disable it. */ - Actor CreateActor(unsigned int itemId); + void SetRefreshEnabled(bool enabled); /** - * Called by the ItemPool when an actor is added to the ItemPool. - * @param[in] actor The actor that has been added. - * @param[in] itemId The associated Item ID. - * @param[in] targetSize The target size that was specified upon addition. + * @brief Helper to perform the refresh. + * + * @param[in] currentLayoutPosition The current layout position. + * @param[in] cacheExtra Whether to cache extra items during refresh. */ - void ActorAddedToItemPool(Actor actor, unsigned int itemId, const Vector3& targetSize); + void DoRefresh(float currentLayoutPosition, bool cacheExtra); /** - * Called by the ItemPool when an actor with the specified itemId is about to be removed from the - * ItemPool. - * @param[in] actor The actor about to be removed. - * @param[in] itemId The associated Item ID. + * @copydoc Toolkit::ItemView::SetItemsParentOrigin */ - void ActorRemovedFromItemPool(Actor actor, unsigned int itemId); + void SetItemsParentOrigin( const Vector3& parentOrigin ); + + /** + * @copydoc Toolkit::ItemView::GetItemsParentOrigin + */ + Vector3 GetItemsParentOrigin() const; + + /** + * @copydoc Toolkit::ItemView::SetItemsAnchorPoint + */ + void SetItemsAnchorPoint( const Vector3& anchorPoint ); + + /** + * @copydoc Toolkit::ItemView::GetItemsAnchorPoint + */ + Vector3 GetItemsAnchorPoint() const; + + /** + * @copydoc Toolkit::ItemView::GetItemsRange + */ + void GetItemsRange(ItemRange& range); + +private: + + /** + * Remove an Actor if found in the ItemPool. + * @param[in] itemId The item to remove. + * @return True if the remaining actors were reordered. + */ + bool RemoveActor( unsigned int itemId ); + + /** + * Remove any Actors outside a given range. + * @param[in] @param[in] range The range of required items. + */ + void RemoveActorsOutsideRange( ItemRange range ); + + /** + * Add a range of Actors, if they are not already in the ItemPool. + * @param[in] range The range of Item IDs to associate with the new actors. + * @param[in] layoutSize The layout-size. + */ + void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize ); + + /** + * Add a new Actor, if not already in the ItemPool. + * @param[in] item The ID for the new item. + * @param[in] layoutSize The layout-size. + */ + void AddNewActor( ItemId item, const Vector3& layoutSize ); + + /** + * Apply the constraints etc. that are required for ItemView children. + * @param[in] item The item to setup. + * @param[in] layoutSize The layout-size. + */ + void SetupActor( Item item, const Vector3& layoutSize ); + + /** + * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView. + * @param[in] item The ID for the item to be released. + * @param[in] actor The actor to be removed from ItemView. + */ + void ReleaseActor( ItemId item, Actor actor ); private: // From CustomActorImpl /** + * From CustomActorImpl; called after a child has been added to the owning actor. + * @param[in] child The child which has been added. + */ + virtual void OnChildAdd(Actor& child); + + /** * From CustomActorImpl; called after a touch-signal is received by the owning actor. * @param[in] event The touch event. * @return True if the event should be consumed. @@ -322,13 +343,13 @@ private: // From CustomActorImpl virtual bool OnTouchEvent(const TouchEvent& event); /** - * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor. - * @param[in] event The mouse wheel event. + * From CustomActorImpl; called after a wheel-event is received by the owning actor. + * @param[in] event The wheel event. * @return True if the event should be consumed. */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + virtual bool OnWheelEvent(const WheelEvent& event); -private: // From ControlImpl +private: // From Control /** * @copydoc Toolkit::Control::OnInitialize() @@ -343,7 +364,7 @@ private: // From ControlImpl /** * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor() */ - virtual Actor GetNextKeyboardFocusableActor(Actor actor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled); /** * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted() @@ -372,13 +393,15 @@ private: ItemView& operator=(const ItemView& rhs); /** - * Helper to apply constraints to an actor. - * @param[in] actor The actor to constrain. - * @param[in] layout The active layout. - * @param[in] itemId The ID of the item represented by the actor. + * Helper to re-apply all the constraints after items have been inserted, removed etc. * @param[in] durationSeconds The time taken to fully constrain the actors. */ - void ApplyConstraints(Actor& actor, ItemLayout& layout, unsigned int itemId, float durationSeconds); + void ReapplyAllConstraints(); + + /** + * Helper to relayout after item(s) are removed. + */ + void OnItemsRemoved(); /** * Helper to remove items outside a given range. @@ -400,7 +423,7 @@ private: * @param[in] range The range of items. * @param[in] reserveExtra True if reserve items should be included. */ - ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, bool reserveExtra); + ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra); // Input Handling @@ -426,7 +449,7 @@ private: * * @param[in] gesture The gesture event. */ - void OnPan(PanGesture pan); + void OnPan( const PanGesture& pan ); /** * Helper to handle anchoring animations. @@ -441,6 +464,12 @@ private: void OnScrollFinished(Animation& animation); /** + * Callback from layout activation scroll animations + * @param[in] animation The scroll-animation which has finished. + */ + void OnLayoutActivationScrollFinished(Animation& animation); + + /** * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f) * * @param[in] animation the animation that has finished @@ -448,27 +477,10 @@ private: void OnOvershootOnFinished(Animation& animation); /** - * Helper to start the refresh timer. - */ - void StartRefreshTimer(); - - /** - * Helper to cancel the refresh timer. - */ - void CancelRefreshTimer(); - - /** - * Refresh the ItemView; this is called after a timeout when scrolling. - * During a refresh, ItemFactory::NewItem() will be called to create newly visible items. - * @return True if the refresh timer should be kept running. - */ - bool OnRefreshTick(); - - /** - * This is called after a timeout when no new mouse wheel event is received for a certain period of time. + * This is called after a timeout when no new wheel event is received for a certain period of time. * @return will return false; one-shot timer. */ - bool OnMouseWheelEventFinished(); + bool OnWheelEventFinished(); /** * Stops and removes animation if exists. @@ -477,9 +489,9 @@ private: void RemoveAnimation(Animation& animation); /** - * Helper to apply constraints to the overshoot overlay actor. + * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot */ - void ApplyOvershootOverlayConstraints(); + virtual void EnableScrollOvershoot( bool enable ); /** * Helper to calculate the scroll overshoot according to the pan gesture displacement. @@ -508,7 +520,6 @@ private: */ void CalculateDomainSize(const Vector3& layoutSize); - /** * Calculates whether we want to allow current item view to scroll. * @param[in] layoutSize The current size of the layout. @@ -516,18 +527,36 @@ private: */ bool IsLayoutScrollable(const Vector3& layoutSize); + /** + * Callback when the current layout position of ItemView changes in both positive + * and negative directions by the specified amount. Refresh the ItemView to create + * newly visible items. + * @param[in] source the property notification that triggered this callback + */ + void OnRefreshNotification(PropertyNotification& source); + + /** + * This is called when the change of scroll position is notified by ScrollBar. + * @param[in] position The new scroll position + */ + void OnScrollPositionChanged( float position ); + private: ItemFactory& mItemFactory; + typedef std::map ItemPool; + typedef ItemPool::iterator ItemPoolIter; + typedef ItemPool::const_iterator ConstItemPoolIter; + ItemPool mItemPool; - ItemLayoutContainer mLayouts; + std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects ItemLayout* mActiveLayout; + Vector3 mActiveLayoutTargetSize; Animation mResizeAnimation; Animation mScrollAnimation; - Animation mScrollSpeedAnimation; Animation mScrollOvershootAnimation; bool mAnimatingOvershootOn; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off) bool mAnimateOvershootOff; ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off) @@ -535,15 +564,15 @@ private: bool mAnchoringEnabled; float mAnchoringDuration; - Timer mRefreshTimer; - int mRefreshIntervalMilliseconds; + float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions. + PropertyNotification mRefreshNotification; // stores the property notification used for item view refresh bool mRefreshOrderHint; ///< True if scrolling towards the last item // Input handling float mMinimumSwipeSpeed; float mMinimumSwipeDistance; - float mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each mouse wheel event received. + float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received. float mScrollDistance; float mScrollSpeed; @@ -552,18 +581,18 @@ private: float mScrollOvershoot; bool mIsFlicking; - Timer mMouseWheelEventFinishedTimer; ///< The timer to determine whether there is no mouse wheel event received for a certain period of time. + Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time. Dali::Gesture::State mGestureState; - ImageActor mOvershootOverlay; ///< The overlay actor for overshoot effect - OvershootRippleEffect mOvershootEffect; ///< The vertex/fragment shader used to display the overshoot ripple effect + Actor mOvershootOverlay; ///< The overlay actor for overshoot effect + + bool mAddingItems; + + bool mRefreshEnabled; ///< Whether to refresh the cache automatically - Property::Index mPropertyLayoutPosition; ///< The logical position of the first item within the layout - Property::Index mPropertyPosition; ///< The physical position of the first item within the layout - Property::Index mPropertyMinimumLayoutPosition; ///< The minimum valid layout position in the layout. - Property::Index mPropertyScrollSpeed; ///< The current scroll speed of item view - Property::Index mPropertyOvershoot; ///< The scroll overshoot (difference of the layout position before and after clamping) + Vector3 mItemsParentOrigin; + Vector3 mItemsAnchorPoint; }; } // namespace Internal