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

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