1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_PAGE_SPIRAL_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_PAGE_SPIRAL_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
32 namespace Internal DALI_INTERNAL
34 class ScrollViewPageSpiralEffect;
38 * @brief This effect cause each page in a scroll-view to move along a spiral.
40 * It should be used on the following Actor hierarchy:
46 * You should ensure ScrollView's default constraints have been removed,
47 * by calling ScrollView::RemoveConstraintsFromChildren() before applying
48 * this effect to ScrollView.
51 * ApplyToPage(...) method should be called on every page.
53 * Automatic operation:
56 class DALI_IMPORT_API ScrollViewPageSpiralEffect : public ScrollViewEffect
62 * @brief Create an initialized ScrollViewPageSpiralEffect.
64 * @return A handle to a newly allocated Dali resource.
66 static ScrollViewPageSpiralEffect New();
69 * @brief Create an uninitialized ScrollViewPageSpiralEffect; this can be initialized with ScrollViewPageSpiralEffect::New().
71 * Calling member functions with an uninitialized Toolkit::ScrollViewPageSpiralEffect is not allowed.
73 ScrollViewPageSpiralEffect();
76 * @brief Downcast an Object handle to ScrollViewPageSpiralEffect.
78 * If handle points to a ScrollViewPageSpiralEffect the
79 * downcast produces valid handle. If not the returned handle is left uninitialized.
80 * @param[in] handle Handle to an object
81 * @return handle to a ScrollViewPageSpiralEffect or an uninitialized handle
83 static ScrollViewPageSpiralEffect DownCast( BaseHandle handle );
86 * @brief Manually apply effect to a page in the scroll-view.
88 * @param[in] page The page to be affected by this effect.
89 * @param[in] spiralAngle The spirald angle (in radians).
91 * @note If the wrap mode of the scroll view is changed, then this needs to be called for every
92 * page again after removing the previous constraints.
94 void ApplyToPage( Actor page, const Vector2& spiralAngle );
99 * @brief This constructor is used by Dali New() methods.
101 * @param [in] impl A pointer to a newly allocated Dali resource
103 explicit DALI_INTERNAL ScrollViewPageSpiralEffect( Internal::ScrollViewPageSpiralEffect *impl );
107 } // namespace Toolkit
111 #endif // __DALI_TOOLKIT_SCROLL_VIEW_PAGE_SPIRAL_EFFECT_H__