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