1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__
5 * Copyright (c) 2015 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>
33 namespace Internal DALI_INTERNAL
35 class ScrollViewPagePathEffect;
39 * ScrollView Page Path Effect.
40 * This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
41 * the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
42 * to 0.0 at the end of the path
49 * You should ensure ScrollView's default constraints have been removed,
50 * by calling ScrollView::RemoveConstraintsFromChildren() before applying
51 * this effect to ScrollView.
54 * ApplyToPage(...) method should be called on every page.
56 * Automatic operation:
59 class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect
65 * Create an initialized ScrollViewPagePathEffect.
66 * @param[in] path The path that will be used by the scroll effect
67 * @param[in] forward Vector in page object space which will be aligned with the tangent of the path
68 * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path.
69 * @param[in] pageSize Size of a page in the scrollview
70 * @param[in] pageCount Total number of pages in the scrollview
71 * @return A handle to a newly allocated Dali resource.
73 static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& pageSize, unsigned int pageCount);
76 * Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New()
77 * Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.
79 ScrollViewPagePathEffect();
82 * Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect the
83 * downcast produces valid handle. If not the returned handle is left uninitialized.
84 * @param[in] handle Handle to an object
85 * @return handle to a ScrollViewPagePathEffect or an uninitialized handle
87 static ScrollViewPagePathEffect DownCast( BaseHandle handle );
90 * Manually apply effect to a page in the scroll-view.
91 * @param[in] page The page to be affected by this effect.
92 * @param[in] pageOrder The order of the page in the scroll-view
94 void ApplyToPage( Actor page, unsigned int pageOrder );
99 * This constructor is used by Dali New() methods.
100 * @param [in] impl A pointer to a newly allocated Dali resource
102 explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl );
106 } // namespace Toolkit
110 #endif // __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__