base/dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-page-carousel-effect-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CAROUSEL_EFFECT_H__
   2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CAROUSEL_EFFECT_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 // INTERNAL INCLUDES
  21 #include <dali/public-api/animation/animation.h>
  22 #include <dali/public-api/animation/alpha-functions.h>
  23 #include <dali/public-api/animation/time-period.h>
  24 #include <dali/public-api/object/ref-object.h>
  25 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  26 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-carousel-effect.h>
  27 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-effect-impl.h>
  28
  29 namespace Dali
  30 {
  31
  32 class Animation;
  33
  34 namespace Toolkit
  35 {
  36
  37 class ScrollGroup;
  38 class ScrollView;
  39
  40 namespace Internal
  41 {
  42
  43 /**
  44  * @copydoc Toolkit::ScrollViewPageCarouselEffect
  45  */
  46 class ScrollViewPageCarouselEffect : public ScrollViewEffect
  47 {
  48
  49 public:
  50
  51   /**
  52    * Constructor
  53    */
  54   ScrollViewPageCarouselEffect();
  55
  56 public:
  57
  58   /**
  59    * @copydoc ScrollViewEffect::ApplyToActor
  60    */
  61   void ApplyToPage( Actor child, const Vector2& positionToPageSizeRatio );
  62
  63 public:
  64
  65   /**
  66    * @copydoc ScrollViewEffect::OnAttach
  67    */
  68   virtual void OnAttach( Toolkit::ScrollView& scrollView );
  69
  70   /**
  71    * @copydoc ScrollViewEffect::OnDetach
  72    */
  73   virtual void OnDetach( Toolkit::ScrollView& scrollView );
  74
  75 protected:
  76
  77   /**
  78    * A reference counted object may only be deleted by calling Unreference()
  79    */
  80   virtual ~ScrollViewPageCarouselEffect();
  81
  82 private:
  83
  84   Vector3 mPageSize; ///< The logical page size for the 3D effect.
  85 };
  86
  87 } // namespace Internal
  88
  89 // Helpers for public-api forwarding methods
  90
  91 inline Internal::ScrollViewPageCarouselEffect& GetImpl(Dali::Toolkit::ScrollViewPageCarouselEffect& obj)
  92 {
  93   DALI_ASSERT_ALWAYS(obj);
  94
  95   Dali::RefObject& handle = obj.GetBaseObject();
  96
  97   return static_cast<Internal::ScrollViewPageCarouselEffect&>(handle);
  98 }
  99
 100 inline const Internal::ScrollViewPageCarouselEffect& GetImpl(const Dali::Toolkit::ScrollViewPageCarouselEffect& obj)
 101 {
 102   DALI_ASSERT_ALWAYS(obj);
 103
 104   const Dali::RefObject& handle = obj.GetBaseObject();
 105
 106   return static_cast<const Internal::ScrollViewPageCarouselEffect&>(handle);
 107 }
 108
 109 } // namespace Toolkit
 110
 111 } // namespace Dali
 112
 113 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CAROUSEL_EFFECT_H__