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