1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_CUBE_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_CUBE_EFFECT_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 // http://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
26 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
28 namespace Dali DALI_IMPORT_API
36 class ScrollViewEffect;
38 namespace Internal DALI_INTERNAL
40 class ScrollViewCubeEffect;
44 * @brief This effect causes Actors to appear to rotate around a 3D cube.
46 * It should be used on the following Actor hierarchy:
54 * You should ensure ScrollView's default constraints have been removed,
55 * by calling ScrollView::RemoveConstraintsFromChildren() before applying
56 * this effect to ScrollView.
59 * upon adding children to pages, the ApplyToActor(...) method should be called.
61 * Automatic operation:
64 class ScrollViewCubeEffect : public ScrollViewEffect
70 * @brief Create an initialized ScrollViewCubeEffect.
72 * @return A handle to a newly allocated Dali resource.
74 static ScrollViewCubeEffect New();
77 * @brief Create an uninitialized ScrollViewCubeEffect; this can be initialized with ScrollViewCubeEffect::New().
79 * Calling member functions with an uninitialized Toolkit::ScrollViewCubeEffect is not allowed.
81 ScrollViewCubeEffect();
84 * @brief Downcast an Object handle to ScrollViewCubeEffect.
86 * If handle points to a ScrollViewCubeEffect the downcast produces
87 * valid handle. If not the returned handle is left uninitialized.
89 * @param[in] handle Handle to an object
90 * @return handle to a ScrollViewCubeEffect or an uninitialized handle
92 static ScrollViewCubeEffect DownCast( BaseHandle handle );
95 * @brief Manually apply effect to an Actor.
97 * @param[in] child The child Actor to be affected by this effect.
98 * @param[in] anchor The anchor point that the child actor should
99 * rotate around when scrolling
100 * @param[in] angleSwing The maximum amount the child actor should
101 * rotate in radians for each axis (X and Y) as the page is scrolled.
102 * @param[in] positionSwing The maximum amount the child actor should
103 * move for each axis (X and Y) as the page is scrolled.
105 void ApplyToActor(Actor child,
106 const Vector3& anchor,
107 const Vector2& angleSwing,
108 const Vector2& positionSwing);
111 * @brief Manually apply effect to an Actor.
113 * @param[in] child The child Actor to be affected by this effect.
114 * @param[in] parentPage The parent page Actor to be used by this effect.
115 * @param[in] anchor The anchor point that the child actor should
116 * rotate around when scrolling
117 * @param[in] angleSwing The maximum amount the child actor should
118 * rotate in radians for each axis (X and Y) as the page is scrolled.
119 * @param[in] positionSwing The maximum amount the child actor should
120 * move for each axis (X and Y) as the page is scrolled.
122 void ApplyToActor(Actor child,
124 const Vector3& anchor,
125 const Vector2& angleSwing,
126 const Vector2& positionSwing);
131 * @brief This constructor is used by Dali New() methods.
133 * @param [in] impl A pointer to a newly allocated Dali resource
135 ScrollViewCubeEffect(Internal::ScrollViewCubeEffect *impl);
139 } // namespace Toolkit
146 #endif // __DALI_TOOLKIT_SCROLL_VIEW_CUBE_EFFECT_H__