Merge remote-tracking branch 'origin/tizen' into devel/new_mesh
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / scrollable / scroll-view / scroll-view-carousel-effect-impl.h
1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_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-function.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-effect.h>
30 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-carousel-effect.h>
31
32 namespace Dali
33 {
34
35 class Animation;
36
37 namespace Toolkit
38 {
39
40 class ScrollView;
41
42 namespace Internal
43 {
44
45 class ScrollViewEffect;
46
47 /**
48  * @copydoc Toolkit::ScrollViewCarouselEffect
49  */
50 class ScrollViewCarouselEffect : public ScrollViewEffect
51 {
52
53 public:
54
55   /**
56    * Constructor
57    */
58   ScrollViewCarouselEffect();
59
60 public:
61
62   /**
63    * @copydoc ScrollViewEffect::ApplyToActor
64    */
65   void ApplyToActor(Actor child, const Vector2& angleSwing);
66
67 public:
68
69   /**
70    * @copydoc ScrollViewEffect::OnAttach
71    */
72   virtual void OnAttach(Toolkit::ScrollView& scrollView);
73
74   /**
75    * @copydoc ScrollViewEffect::OnDetach
76    */
77   virtual void OnDetach(Toolkit::ScrollView& scrollView);
78
79 protected:
80
81   /**
82    * A reference counted object may only be deleted by calling Unreference()
83    */
84   virtual ~ScrollViewCarouselEffect();
85
86 private:
87
88   Property::Index mPropertyActivate;                      ///< Activation property (0.0 - deactivated, 1.0 - fully activated)
89
90 };
91
92 } // namespace Internal
93
94 // Helpers for public-api forwarding methods
95
96 inline Internal::ScrollViewCarouselEffect& GetImpl(Dali::Toolkit::ScrollViewCarouselEffect& obj)
97 {
98   DALI_ASSERT_ALWAYS(obj);
99
100   Dali::RefObject& handle = obj.GetBaseObject();
101
102   return static_cast<Internal::ScrollViewCarouselEffect&>(handle);
103 }
104
105 inline const Internal::ScrollViewCarouselEffect& GetImpl(const Dali::Toolkit::ScrollViewCarouselEffect& obj)
106 {
107   DALI_ASSERT_ALWAYS(obj);
108
109   const Dali::RefObject& handle = obj.GetBaseObject();
110
111   return static_cast<const Internal::ScrollViewCarouselEffect&>(handle);
112 }
113
114 } // namespace Toolkit
115
116 } // namespace Dali
117
118 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__