dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
   2 #define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   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
  10 //
  11 //     http://floralicense.org/license/
  12 //
  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.
  18 //
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/dali.h>
  22
  23 // INTERNAL INCLUDES
  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>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal
  39 {
  40
  41 class ItemView;
  42
  43 typedef IntrusivePtr<ItemView> ItemViewPtr;
  44
  45 /**
  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.
  49  */
  50 class ItemView : public Scrollable
  51 {
  52 public:
  53
  54   /**
  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.
  58    */
  59   static Dali::Toolkit::ItemView New(ItemFactory& factory);
  60
  61   /**
  62    * @copydoc Toolkit::ItemView::GetScrollConnector
  63    */
  64   Dali::Toolkit::ScrollConnector GetScrollConnector() const;
  65
  66   /**
  67    * @copydoc Toolkit::ItemView::GetLayoutCount
  68    */
  69   unsigned int GetLayoutCount() const;
  70
  71   /**
  72    * @copydoc Toolkit::ItemView::AddLayout
  73    */
  74   void AddLayout(ItemLayout& layout);
  75
  76   /**
  77    * @copydoc Toolkit::ItemView::RemoveLayout
  78    */
  79   void RemoveLayout(unsigned int layoutIndex);
  80
  81   /**
  82    * @copydoc Toolkit::ItemView::GetLayout
  83    */
  84   ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
  85
  86   /**
  87    * @copydoc Toolkit::ItemView::GetActiveLayout
  88    */
  89   ItemLayoutPtr GetActiveLayout() const;
  90
  91   /**
  92    * @copydoc Toolkit::ItemView::GetCurrentLayoutPosition
  93    */
  94   float GetCurrentLayoutPosition(unsigned int itemId) const;
  95
  96   /**
  97    * @copydoc Toolkit::ItemView::ActivateLayout
  98    */
  99   void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
 100
 101   /**
 102    * @copydoc Toolkit::ItemView::SetDefaultAlphaFunction
 103    */
 104   void SetDefaultAlphaFunction(AlphaFunction func);
 105
 106   /**
 107    * @copydoc Toolkit::ItemView::GetDefaultAlphaFunction
 108    */
 109   AlphaFunction GetDefaultAlphaFunction() const;
 110
 111   /**
 112    * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
 113    */
 114   void DeactivateCurrentLayout();
 115
 116   /**
 117    * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
 118    */
 119   void SetMinimumSwipeSpeed(float speed);
 120
 121   /**
 122    * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
 123    */
 124   float GetMinimumSwipeSpeed() const;
 125
 126   /**
 127    * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
 128    */
 129   void SetMinimumSwipeDistance(float distance);
 130
 131   /**
 132    * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
 133    */
 134   float GetMinimumSwipeDistance() const;
 135
 136   /**
 137    * @copydoc Toolkit::ItemView::SetMouseWheelScrollDistanceStep
 138    */
 139   void SetMouseWheelScrollDistanceStep(float step);
 140
 141   /**
 142    * @copydoc Toolkit::ItemView::GetMouseWheelScrollDistanceStep
 143    */
 144   float GetMouseWheelScrollDistanceStep() const;
 145
 146   /**
 147    * @copydoc Toolkit::ItemView::SetAnchoring
 148    */
 149   void SetAnchoring(bool enabled);
 150
 151   /**
 152    * @copydoc Toolkit::ItemView::GetAnchoring
 153    */
 154   bool GetAnchoring() const;
 155
 156   /**
 157    * @copydoc Toolkit::ItemView::SetAnchoringDuration
 158    */
 159   void SetAnchoringDuration(float durationSeconds);
 160
 161   /**
 162    * @copydoc Toolkit::ItemView::GetAnchoringDuration
 163    */
 164   float GetAnchoringDuration() const;
 165
 166   /**
 167    * @copydoc Toolkit::ItemView::ScrollToItem
 168    */
 169   void ScrollToItem(unsigned int itemId, float durationSeconds);
 170
 171   /**
 172    * @copydoc Toolkit::ItemView::SetRefreshInterval
 173    */
 174   void SetRefreshInterval(float intervalLayoutPositions);
 175
 176   /**
 177    * @copydoc Toolkit::ItemView::GetRefreshInterval
 178    */
 179   float GetRefreshInterval() const;
 180
 181   /**
 182    * @copydoc Toolkit::ItemView::GetItem
 183    */
 184   Actor GetItem(unsigned int itemId) const;
 185
 186   /**
 187    * @copydoc Toolkit::ItemView::GetItemId
 188    */
 189   unsigned int GetItemId(Actor actor) const;
 190
 191   /**
 192    * @copydoc Toolkit::ItemView::InsertItem
 193    */
 194   void InsertItem(Item newItem, float durationSeconds);
 195
 196   /**
 197    * @copydoc Toolkit::ItemView::InsertItem
 198    */
 199   void InsertItems(const ItemContainer& newItems, float durationSeconds);
 200
 201   /**
 202    * @copydoc Toolkit::ItemView::RemoveItem
 203    */
 204   void RemoveItem(ItemId itemId, float durationSeconds);
 205
 206   /**
 207    * @copydoc Toolkit::ItemView::InsertItem
 208    */
 209   void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
 210
 211   /**
 212    * @copydoc Toolkit::ItemView::InsertItem
 213    */
 214   void ReplaceItem(Item replacementItem, float durationSeconds);
 215
 216   /**
 217    * @copydoc Toolkit::ItemView::InsertItem
 218    */
 219   void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
 220
 221   /**
 222    * @copydoc Toolkit::Scrollable::GetDomainSize
 223    */
 224   Vector3 GetDomainSize() const;
 225
 226   /**
 227    * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
 228    */
 229   Vector3 GetCurrentScrollPosition() const;
 230
 231   /**
 232    * @copydoc Toolkit::Scrollable::AddOverlay()
 233    */
 234   void AddOverlay(Actor actor);
 235
 236   /**
 237    * @copydoc Toolkit::Scrollable::RemoveOverlay()
 238    */
 239   void RemoveOverlay(Actor actor);
 240
 241   /**
 242    * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration)
 243    */
 244   void ScrollTo(const Vector3& position, float duration);
 245
 246 private:
 247
 248   /**
 249    * Remove an Actor if found in the ItemPool.
 250    * @param[in] itemId The item to remove.
 251    * @return True if an actor was removed.
 252    */
 253   bool RemoveActor( unsigned int itemId );
 254
 255   /**
 256    * Remove any Actors outside a given range.
 257    * @param[in] @param[in] range The range of required items.
 258    */
 259   void RemoveActorsOutsideRange( ItemRange range );
 260
 261   /**
 262    * Add a range of Actors, if they are not already in the ItemPool.
 263    * @param[in] range The range of Item IDs to associate with the new actors.
 264    * @param[in] durationSeconds The time taken to fully constrain the newly added actor.
 265    */
 266   void AddActorsWithinRange( ItemRange range, float durationSeconds );
 267
 268   /**
 269    * Add a new Actor, if not already in the ItemPool.
 270    * @param[in] item The ID for the new item.
 271    * @param[in] durationSeconds The time taken to fully constrain the new actor.
 272    */
 273   void AddNewActor( ItemId item, float durationSeconds );
 274
 275   /**
 276    * Apply the constraints etc. that are required for ItemView children.
 277    * @param[in] item The item to setup.
 278    * @param[in] durationSeconds The time taken to fully constrain the actor.
 279    */
 280   void SetupActor( Item item, float durationSeconds );
 281
 282 private: // From CustomActorImpl
 283
 284   /**
 285    * From CustomActorImpl; called after a child has been added to the owning actor.
 286    * @param[in] child The child which has been added.
 287    */
 288   virtual void OnChildAdd(Actor& child);
 289
 290   /**
 291    * From CustomActorImpl; called after a touch-signal is received by the owning actor.
 292    * @param[in] event The touch event.
 293    * @return True if the event should be consumed.
 294    */
 295   virtual bool OnTouchEvent(const TouchEvent& event);
 296
 297   /**
 298    * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor.
 299    * @param[in] event The mouse wheel event.
 300    * @return True if the event should be consumed.
 301    */
 302   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 303
 304 private: // From ControlImpl
 305
 306   /**
 307    * @copydoc Toolkit::Control::OnInitialize()
 308    */
 309   virtual void OnInitialize();
 310
 311   /**
 312    * @copydoc Toolkit::Control::OnAccessibilityPan()
 313    */
 314   virtual bool OnAccessibilityPan(PanGesture gesture);
 315
 316   /**
 317    * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
 318    */
 319   virtual Actor GetNextKeyboardFocusableActor(Actor actor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
 320
 321   /**
 322    * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
 323    */
 324   virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
 325
 326 protected:
 327
 328   /**
 329    * Construct a new ItemView.
 330    * @param[in] factory The factory which provides ItemView with items.
 331    */
 332   ItemView(ItemFactory& factory);
 333
 334   /**
 335    * A reference counted object may only be deleted by calling Unreference()
 336    */
 337   virtual ~ItemView();
 338
 339 private:
 340
 341   // Undefined
 342   ItemView(const ItemView&);
 343
 344   // Undefined
 345   ItemView& operator=(const ItemView& rhs);
 346
 347   /**
 348    * Helper to apply constraints to an actor.
 349    * @param[in] actor The actor to constrain.
 350    * @param[in] layout The active layout.
 351    * @param[in] itemId The ID of the item represented by the actor.
 352    * @param[in] durationSeconds The time taken to fully constrain the actors.
 353    */
 354   void ApplyConstraints(Actor& actor, ItemLayout& layout, unsigned int itemId, float durationSeconds);
 355
 356   /**
 357    * Helper to re-apply all the constraints after items have been inserted, removed etc.
 358    * @param[in] durationSeconds The time taken to fully constrain the actors.
 359    */
 360   void ReapplyAllConstraints( float durationSeconds );
 361
 362   /**
 363    * Helper to remove items outside a given range.
 364    * @param[in] range The range of required items.
 365    */
 366   void RemoveItems(ItemRange range);
 367
 368   /**
 369    * Helper to add a range of items, if not already in the ItemPool.
 370    * @param[in] layout The layout used to position the new items.
 371    * @param[in] layoutSize The current size of the layout.
 372    * @param[in] range The range of required items.
 373    */
 374   void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
 375
 376   /**
 377    * Helper to find the range of items to populate with.
 378    * @param[in] layout The current layout.
 379    * @param[in] range The range of items.
 380    * @param[in] reserveExtra True if reserve items should be included.
 381    */
 382   ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, bool reserveExtra);
 383
 384   // Input Handling
 385
 386   /**
 387    * Helper to handle pressed (Down) events.
 388    * @param[in] x The X coordinate of the touch event.
 389    * @param[in] y The Y coordinate of the touch event.
 390    * @param[in] timeMs The time-stamp of the touch event.
 391    */
 392   void OnPressed(float x, float y, unsigned long timeMs);
 393
 394   /**
 395    * Helper to clamp the first-item position when dragging/swiping.
 396    * @param[in] targetPosition The target position of the drag etc.
 397    * @param[in] targetSize The target ItemView & layout size.
 398    * @param[in] layout The current layout.
 399    * @return The clamped first-item position.
 400    */
 401   float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout);
 402
 403   /**
 404    * Called upon pan gesture event.
 405    *
 406    * @param[in] gesture The gesture event.
 407    */
 408   void OnPan(PanGesture pan);
 409
 410   /**
 411    * Helper to handle anchoring animations.
 412    * @return The animation, or an uninitialized handle if not necessary.
 413    */
 414   Animation DoAnchoring();
 415
 416   /**
 417    * Callback from scroll animations
 418    * @param[in] animation The scroll-animation which has finished.
 419    */
 420   void OnScrollFinished(Animation& animation);
 421
 422   /**
 423    * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
 424    *
 425    * @param[in] animation the animation that has finished
 426    */
 427   void OnOvershootOnFinished(Animation& animation);
 428
 429   /**
 430    * This is called after a timeout when no new mouse wheel event is received for a certain period of time.
 431    * @return will return false; one-shot timer.
 432    */
 433   bool OnMouseWheelEventFinished();
 434
 435   /**
 436    * Stops and removes animation if exists.
 437    * @param[in,out] animation The animation handle to be removed.
 438    */
 439   void RemoveAnimation(Animation& animation);
 440
 441   /**
 442    * Helper to apply constraints to the overshoot overlay actor.
 443    */
 444   void ApplyOvershootOverlayConstraints();
 445
 446   /**
 447    * Helper to calculate the scroll overshoot according to the pan gesture displacement.
 448    * @return The scroll overshoot.
 449    */
 450   float CalculateScrollOvershoot();
 451
 452   /**
 453    * Helper to calculate the scroll overshoot according to the pan gesture displacement.
 454    *
 455    * @param[in] overshootAmount amount to animate to
 456    * @param[in] animateBack whether to animate back to zero immediately after
 457    * @return The scroll overshoot.
 458    */
 459   void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
 460
 461   /**
 462    * Gets the scroll position in pixels according to the logical layout position.
 463    * @param[in] layoutSize The current size of the layout.
 464    */
 465   float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
 466
 467   /**
 468    * Calculates the minimum and maximum positions for each axis to scroll to.
 469    * @param[in] layoutSize The current size of the layout.
 470    */
 471   void CalculateDomainSize(const Vector3& layoutSize);
 472
 473   /**
 474    * Calculates whether we want to allow current item view to scroll.
 475    * @param[in] layoutSize The current size of the layout.
 476    * @return    true if itemview is scrollable
 477    */
 478   bool IsLayoutScrollable(const Vector3& layoutSize);
 479
 480   /**
 481    * Callback when the current layout position of ItemView changes in both positive
 482    * and negative directions by the specified amount. Refresh the ItemView to create
 483    * newly visible items.
 484    * @param[in] source the property notification that triggered this callback
 485    */
 486   void OnRefreshNotification(PropertyNotification& source);
 487
 488 private:
 489
 490   ItemFactory& mItemFactory;
 491
 492   typedef std::map<unsigned int, Actor> ItemPool;
 493   typedef ItemPool::iterator            ItemPoolIter;
 494   typedef ItemPool::const_iterator      ConstItemPoolIter;
 495
 496   ItemPool mItemPool;
 497
 498   ItemLayoutContainer mLayouts;
 499   ItemLayout* mActiveLayout;
 500   Vector3 mActiveLayoutTargetSize;
 501
 502   AlphaFunction mDefaultAlphaFunction;
 503
 504   Animation mResizeAnimation;
 505   Animation mScrollAnimation;
 506   Animation mScrollSpeedAnimation;
 507   Animation mScrollOvershootAnimation;
 508   bool      mAnimatingOvershootOn;          ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
 509   bool      mAnimateOvershootOff;         ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
 510
 511   bool mAnchoringEnabled;
 512   float mAnchoringDuration;
 513
 514   float mRefreshIntervalLayoutPositions;  ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
 515   PropertyNotification mRefreshNotification; // stores the property notification used for item view refresh
 516   bool mRefreshOrderHint; ///< True if scrolling towards the last item
 517
 518   // Input handling
 519
 520   float mMinimumSwipeSpeed;
 521   float mMinimumSwipeDistance;
 522   float mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each mouse wheel event received.
 523
 524   float mScrollDistance;
 525   float mScrollSpeed;
 526   Vector2 mTotalPanDisplacement;
 527
 528   float mScrollOvershoot;
 529   bool mIsFlicking;
 530
 531   Timer mMouseWheelEventFinishedTimer; ///< The timer to determine whether there is no mouse wheel event received for a certain period of time.
 532
 533   Dali::Gesture::State mGestureState;
 534
 535   ImageActor mOvershootOverlay;           ///< The overlay actor for overshoot effect
 536   OvershootRippleEffect mOvershootEffect; ///< The vertex/fragment shader used to display the overshoot ripple effect
 537
 538   Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars
 539   Constrainable   mScrollPositionObject;     ///< From mScrollConnector
 540
 541   bool mAddingItems;
 542
 543   Property::Index mPropertyPosition; ///< The physical position of the first item within the layout
 544   Property::Index mPropertyMinimumLayoutPosition; ///< The minimum valid layout position in the layout.
 545   Property::Index mPropertyScrollSpeed; ///< The current scroll speed of item view
 546 };
 547
 548 } // namespace Internal
 549
 550 // Helpers for public-api forwarding methods
 551
 552 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
 553 {
 554   DALI_ASSERT_ALWAYS(itemView);
 555
 556   Dali::RefObject& handle = itemView.GetImplementation();
 557
 558   return static_cast<Toolkit::Internal::ItemView&>(handle);
 559 }
 560
 561 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
 562 {
 563   DALI_ASSERT_ALWAYS(itemView);
 564
 565   const Dali::RefObject& handle = itemView.GetImplementation();
 566
 567   return static_cast<const Toolkit::Internal::ItemView&>(handle);
 568 }
 569
 570 } // namespace Toolkit
 571
 572 } // namespace Dali
 573
 574 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__