1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__
5 * Copyright (c) 2018 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>
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
36 namespace Internal DALI_INTERNAL
38 class ScrollViewPagePathEffect;
41 * @addtogroup dali_toolkit_controls_scroll_view
46 * @brief ScrollView Page Path Effect.
48 * This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
49 * the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
50 * to 0.0 at the end of the path.
57 * You should ensure ScrollView's default constraints have been removed,
58 * by calling ScrollView::RemoveConstraintsFromChildren() before applying
59 * this effect to ScrollView.
62 * ApplyToPage(...) method should be called on every page.
64 * Automatic operation:
68 class DALI_TOOLKIT_API ScrollViewPagePathEffect : public ScrollViewEffect
74 * @brief Creates an initialized ScrollViewPagePathEffect.
76 * @param[in] path The path that will be used by the scroll effect
77 * @param[in] forward Vector in page object space which will be aligned with the tangent of the path
78 * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path
79 * @param[in] pageSize Size of a page in the scrollview
80 * @param[in] pageCount Total number of pages in the scrollview
81 * @return A handle to a newly allocated Dali resource
83 static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& pageSize, unsigned int pageCount);
86 * @brief Creates an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New().
87 * Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.
90 ScrollViewPagePathEffect();
93 * @brief Downcasts a handle to ScrollViewPagePathEffect handle.
95 * If handle points to a ScrollViewPagePathEffect, the downcast produces valid handle.
96 * If not, the returned handle is left uninitialized.
98 * @param[in] handle Handle to an object
99 * @return Handle to a ScrollViewPagePathEffect or an uninitialized handle
101 static ScrollViewPagePathEffect DownCast( BaseHandle handle );
104 * @brief Manually apply effect to a page in the scroll-view.
106 * @param[in] page The page to be affected by this effect
107 * @param[in] pageOrder The order of the page in the scroll view
109 void ApplyToPage( Actor page, unsigned int pageOrder );
115 * @brief This constructor is used by Dali New() methods.
117 * @param[in] impl A pointer to a newly allocated Dali resource
119 explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl );
127 } // namespace Toolkit
131 #endif // __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__