3b003dc843263f71299084150e237143b61bbc4b
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / transition-effects / cube-transition-fold-effect-impl.h
1 #ifndef __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_FOLD_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_FOLD_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 // EXTERNAL INCLUDES
21
22 // INTERNAL INCLUDES
23 #include <dali-toolkit/public-api/transition-effects/cube-transition-fold-effect.h>
24 #include <dali-toolkit/internal/transition-effects/cube-transition-effect-impl.h>
25
26 namespace Dali
27 {
28
29 namespace Toolkit
30 {
31
32 class CubeTransitionFoldEffect;
33
34 namespace Internal
35 {
36
37 class CubeTransitionEffect;
38
39 class CubeTransitionFoldEffect : public CubeTransitionEffect
40 {
41
42 public:
43
44   /**
45    * @copydoc Toolkit::CubeTransitionFoldEffect::New
46    */
47   static Toolkit::CubeTransitionFoldEffect New(unsigned int numRows, unsigned int numColumns, Size viewAreaSize);
48
49 protected:
50
51    /**
52     * @copydoc Toolkit::CubeTransitionEffect::OnInitialize
53     */
54    virtual void OnInitialize();
55
56    /**
57     * @copydoc Toolkit::CubeTransitionEffect::OnStartTransition
58     */
59    virtual void OnStartTransition( Vector2 panPosition, Vector2 panDisplacement );
60
61    /**
62     * @copydoc Toolkit::Internal::CubeTransitionEffect::OnStopTransition
63     */
64    virtual void OnStopTransition();
65 private:
66
67    /**
68     * Construct a new CubeTransitionFoldEffect object
69     * @param[in] numRows How many rows of cubes
70     * @param[in] numColumns How many columns of cubes
71     * @param[in] viewAreaSize The size of view area for this transition effect
72     */
73    CubeTransitionFoldEffect( unsigned int numRows, unsigned int numColumns, Size viewAreaSize );
74
75    /**
76     * Set up animation to an Actor
77     * @param[in] actorIndex The index of the cube in the cube array
78     * @param[in] angle The angle of the rotation animation
79     * @param[in] resetTranslation The translation used to reset the actor position before animation
80     */
81
82    void SetupAnimation( unsigned int actorIndex, float angle, Vector3 resetTranslation );
83
84 private:
85
86    static const float  mDisplacementRatio;
87
88 }; //class CubeTransitionFoldEffect
89
90 } // namespace Internal
91
92 // Helpers for public-api forwarding methods
93
94 inline Internal::CubeTransitionFoldEffect& GetImpl(Dali::Toolkit::CubeTransitionFoldEffect& obj)
95 {
96   DALI_ASSERT_ALWAYS(obj);
97
98   Dali::BaseObject& handle = obj.GetBaseObject();
99
100   return static_cast<Internal::CubeTransitionFoldEffect&>(handle);
101 }
102
103 inline const Internal::CubeTransitionFoldEffect& GetImpl(const Dali::Toolkit::CubeTransitionFoldEffect& obj)
104 {
105   DALI_ASSERT_ALWAYS(obj);
106
107   const Dali::BaseObject& handle = obj.GetBaseObject();
108
109   return static_cast<const Internal::CubeTransitionFoldEffect&>(handle);
110 }
111
112 } // namespace Toolkit
113
114 } // namespace Dali
115
116 #endif /* __DALI_TOOLKIT_INTERNAL_CUBE_TRANSITION_FOLD_EFFECT_H_ */