2 * Copyright(c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 using System.ComponentModel;
18 using Tizen.NUI.BaseComponents;
23 /// ScrollView Page Path Effect.
24 /// This effect causes Views to follow a given path. The opacity of the view will be 0.0 at
25 /// the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
26 /// to 0.0 at the end of the path.
28 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
29 [EditorBrowsable(EditorBrowsableState.Never)]
30 public class ScrollViewPagePathEffect : ScrollViewEffect
33 internal ScrollViewPagePathEffect(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.ScrollView.ScrollViewPagePathEffectUpcast(cPtr), cMemoryOwn)
38 /// This will not be public opened.
39 [EditorBrowsable(EditorBrowsableState.Never)]
40 protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
42 Interop.ScrollView.DeleteScrollViewPagePathEffect(swigCPtr);
46 /// Creates an initialized ScrollViewPagePathEffect.
48 /// <param name="path">The path that will be used by the scroll effect.</param>
49 /// <param name="forward">Vector in page object space which will be aligned with the tangent of the path.</param>
50 /// <param name="inputPropertyIndex">Index of a property of the scroll-view which will be used as the input for the path.</param>
51 /// <param name="pageSize">Size of a page in the scrollview.</param>
52 /// <param name="pageCount">Total number of pages in the scrollview.</param>
53 /// <returns>A handle to a newly allocated Dali resource.</returns>
54 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
55 [EditorBrowsable(EditorBrowsableState.Never)]
56 public ScrollViewPagePathEffect(Path path, Vector3 forward, int inputPropertyIndex, Vector3 pageSize, uint pageCount) : this(Interop.ScrollView.ScrollViewPagePathEffectNew(Path.getCPtr(path), Vector3.getCPtr(forward), inputPropertyIndex, Vector3.getCPtr(pageSize), pageCount), true)
58 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
61 internal static ScrollViewPagePathEffect DownCast(BaseHandle handle)
63 ScrollViewPagePathEffect ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as ScrollViewPagePathEffect;
64 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
69 /// Manually apply effect to a page in the scroll-view.
71 /// <param name="page">The page to be affected by this effect.</param>
72 /// <param name="pageOrder">The order of the page in the scroll view.</param>
73 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
74 [EditorBrowsable(EditorBrowsableState.Never)]
75 public void ApplyToPage(View page, uint pageOrder)
77 Interop.ScrollView.ScrollViewPagePathEffectApplyToPage(SwigCPtr, View.getCPtr(page), pageOrder);
78 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();