Split dali-toolkit into Base & Optional
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / scrollable / scroll-view / scroll-view-page-cube-effect-impl.h
1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CUBE_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CUBE_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-cube-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::ScrollViewPageCubeEffect
45  */
46 class ScrollViewPageCubeEffect : public ScrollViewEffect
47 {
48
49 public:
50
51   /**
52    * Constructor
53    */
54   ScrollViewPageCubeEffect();
55
56 public:
57
58   /**
59    * @copydoc ScrollViewEffect::ApplyToActor
60    */
61   void ApplyToPage( Actor child,
62                    const Vector2& angleSwing );
63
64 public:
65
66   /**
67    * @copydoc ScrollViewEffect::OnAttach
68    */
69   virtual void OnAttach( Toolkit::ScrollView& scrollView );
70
71   /**
72    * @copydoc ScrollViewEffect::OnDetach
73    */
74   virtual void OnDetach( Toolkit::ScrollView& scrollView );
75
76 protected:
77
78   /**
79    * A reference counted object may only be deleted by calling Unreference()
80    */
81   virtual ~ScrollViewPageCubeEffect();
82
83 private:
84
85   Vector3 mPageSize; ///< The logical page size for the 3D effect.
86 };
87
88 } // namespace Internal
89
90 // Helpers for public-api forwarding methods
91
92 inline Internal::ScrollViewPageCubeEffect& GetImpl(Dali::Toolkit::ScrollViewPageCubeEffect& obj)
93 {
94   DALI_ASSERT_ALWAYS(obj);
95
96   Dali::RefObject& handle = obj.GetBaseObject();
97
98   return static_cast<Internal::ScrollViewPageCubeEffect&>(handle);
99 }
100
101 inline const Internal::ScrollViewPageCubeEffect& GetImpl(const Dali::Toolkit::ScrollViewPageCubeEffect& obj)
102 {
103   DALI_ASSERT_ALWAYS(obj);
104
105   const Dali::RefObject& handle = obj.GetBaseObject();
106
107   return static_cast<const Internal::ScrollViewPageCubeEffect&>(handle);
108 }
109
110 } // namespace Toolkit
111
112 } // namespace Dali
113
114 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_PAGE_CUBE_EFFECT_H__