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.
18 using Tizen.NUI.BaseComponents;
19 using System.ComponentModel;
25 /// Layers provide a mechanism for overlaying groups of actors on top of each other.
27 /// <since_tizen> 3 </since_tizen>
28 public class Layer : Container
30 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
32 internal Layer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.Layer_SWIGUpcast(cPtr), cMemoryOwn)
34 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
37 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Layer obj)
39 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
42 /// From the Container base class.
45 /// Adds a child view to this layer.
47 /// <seealso cref="Container.Add">
49 /// <since_tizen> 4 </since_tizen>
50 public override void Add(View child)
52 NDalicPINVOKE.Actor_Add(swigCPtr, View.getCPtr(child));
53 if (NDalicPINVOKE.SWIGPendingException.Pending)
54 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
60 /// Removes a child view from this layer. If the view was not a child of this layer, this is a no-op.
62 /// <seealso cref="Container.Remove">
64 /// <since_tizen> 4 </since_tizen>
65 public override void Remove(View child)
67 NDalicPINVOKE.Actor_Remove(swigCPtr, View.getCPtr(child));
68 if (NDalicPINVOKE.SWIGPendingException.Pending)
69 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
71 Children.Remove(child);
75 /// Retrieves a child view by the index.
77 /// <pre>The view has been initialized.</pre>
78 /// <param name="index">The index of the child to retrieve.</param>
79 /// <returns>The view for the given index or empty handle if children not initialized.</returns>
80 /// <since_tizen> 4 </since_tizen>
81 public override View GetChildAt(uint index)
83 if (index < Children.Count)
85 return Children[Convert.ToInt32(index)];
95 /// Get parent of the layer.
97 /// <returns>The view's container</returns>
98 /// <since_tizen> 4 </since_tizen>
99 public override Container GetParent()
105 /// Get the child count of the layer.
107 /// <returns>The child count of the layer.</returns>
108 /// <since_tizen> 4 </since_tizen>
109 public override uint GetChildCount()
111 return Convert.ToUInt32(Children.Count);
117 /// <since_tizen> 3 </since_tizen>
118 protected override void Dispose(DisposeTypes type)
125 if(type == DisposeTypes.Explicit)
128 //Release your own managed resources here.
129 //You should release all of your own disposable objects here.
132 //Release your own unmanaged resources here.
133 //You should not access any managed member here except static instance.
134 //because the execution order of Finalizes is non-deterministic.
136 if (swigCPtr.Handle != global::System.IntPtr.Zero)
141 NDalicPINVOKE.delete_Layer(swigCPtr);
143 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
151 internal class Property
153 internal static readonly int BEHAVIOR = NDalicPINVOKE.Layer_Property_BEHAVIOR_get();
157 /// Creates a Layer object.
159 /// <since_tizen> 3 </since_tizen>
160 public Layer() : this(NDalicPINVOKE.Layer_New(), true)
162 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
163 if(Window.Instance != null)
165 this.SetAnchorPoint(Tizen.NUI.PivotPoint.TopLeft);
166 this.SetResizePolicy(ResizePolicyType.FillToParent, DimensionType.AllDimensions);
169 internal void SetAnchorPoint(Vector3 anchorPoint)
171 NDalicPINVOKE.Actor_SetAnchorPoint(swigCPtr, Vector3.getCPtr(anchorPoint));
172 if (NDalicPINVOKE.SWIGPendingException.Pending)
173 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
175 internal void SetResizePolicy(ResizePolicyType policy, DimensionType dimension)
177 NDalicPINVOKE.Actor_SetResizePolicy(swigCPtr, (int)policy, (int)dimension);
178 if (NDalicPINVOKE.SWIGPendingException.Pending)
179 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
184 /// Downcasts a handle to layer handle.
186 /// <since_tizen> 3 </since_tizen>
187 /// Please do not use! this will be deprecated!
188 /// Instead please use as keyword.
189 [Obsolete("Please DO NOT use! This will be deprecated, instead please USE as keyword.")]
190 [EditorBrowsable(EditorBrowsableState.Never)]
191 public static Layer DownCast(BaseHandle handle)
193 Layer ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Layer;
194 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
199 /// Search through this layer's hierarchy for a view with the given unique ID.
201 /// <pre>This layer (the parent) has been initialized.</pre>
202 /// <remarks>The actor itself is also considered in the search.</remarks>
203 /// <param name="id">The id of the child to find</param>
204 /// <returns> A handle to the view if found, or an empty handle if not. </returns>
205 /// <since_tizen> 3 </since_tizen>
206 public View FindChildById(uint id)
208 IntPtr cPtr = NDalicPINVOKE.Actor_FindChildById(swigCPtr, id);
209 View ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as View;
211 if (NDalicPINVOKE.SWIGPendingException.Pending)
212 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
217 /// Queries the depth of the layer.<br />
218 /// 0 is the bottommost layer, higher number is on the top.<br />
220 /// <since_tizen> 3 </since_tizen>
229 internal uint GetDepth()
231 uint ret = NDalicPINVOKE.Layer_GetDepth(swigCPtr);
232 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
237 /// Increments the depth of the layer.
239 /// <since_tizen> 3 </since_tizen>
242 NDalicPINVOKE.Layer_Raise(swigCPtr);
243 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
247 /// Decrements the depth of the layer.
249 /// <since_tizen> 3 </since_tizen>
252 NDalicPINVOKE.Layer_Lower(swigCPtr);
253 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
256 internal void RaiseAbove(Layer target)
258 NDalicPINVOKE.Layer_RaiseAbove(swigCPtr, Layer.getCPtr(target));
259 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
262 internal void LowerBelow(Layer target)
264 NDalicPINVOKE.Layer_LowerBelow(swigCPtr, Layer.getCPtr(target));
265 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
269 /// Raises the layer to the top.
271 /// <since_tizen> 3 </since_tizen>
272 public void RaiseToTop()
274 NDalicPINVOKE.Layer_RaiseToTop(swigCPtr);
275 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
279 /// Lowers the layer to the bottom.
281 /// <since_tizen> 3 </since_tizen>
282 public void LowerToBottom()
284 NDalicPINVOKE.Layer_LowerToBottom(swigCPtr);
285 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
289 /// Moves the layer directly above the given layer.<br />
290 /// After the call, this layer's depth will be immediately above target.<br />
292 /// <param name="target">The layer to get on top of.</param>
293 /// <since_tizen> 3 </since_tizen>
294 public void MoveAbove(Layer target)
296 NDalicPINVOKE.Layer_MoveAbove(swigCPtr, Layer.getCPtr(target));
297 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
301 /// Moves the layer directly below the given layer.<br />
302 /// After the call, this layer's depth will be immediately below target.<br />
304 /// <param name="target">The layer to get below of.</param>
305 /// <since_tizen> 3 </since_tizen>
306 public void MoveBelow(Layer target)
308 NDalicPINVOKE.Layer_MoveBelow(swigCPtr, Layer.getCPtr(target));
309 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
312 private void SetBehavior(LayerBehavior behavior)
314 NDalicPINVOKE.Layer_SetBehavior(swigCPtr, (int)behavior);
315 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
318 private LayerBehavior GetBehavior()
320 Layer.LayerBehavior ret = (Layer.LayerBehavior)NDalicPINVOKE.Layer_GetBehavior(swigCPtr);
321 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
325 internal void SetSortFunction(SWIGTYPE_p_f_r_q_const__Dali__Vector3__float function)
327 NDalicPINVOKE.Layer_SetSortFunction(swigCPtr, SWIGTYPE_p_f_r_q_const__Dali__Vector3__float.getCPtr(function));
328 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
331 internal void SetTouchConsumed(bool consume)
333 NDalicPINVOKE.Layer_SetTouchConsumed(swigCPtr, consume);
334 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
337 internal bool IsTouchConsumed()
339 bool ret = NDalicPINVOKE.Layer_IsTouchConsumed(swigCPtr);
340 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
344 internal void SetHoverConsumed(bool consume)
346 NDalicPINVOKE.Layer_SetHoverConsumed(swigCPtr, consume);
347 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
350 internal bool IsHoverConsumed()
352 bool ret = NDalicPINVOKE.Layer_IsHoverConsumed(swigCPtr);
353 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
358 /// Enumeration for the behavior of the layer.
360 /// <since_tizen> 3 </since_tizen>
361 public enum LayerBehavior
364 /// UI control rendering mode.
366 /// <since_tizen> 3 </since_tizen>
369 /// UI control rendering mode (default mode).
370 /// This mode is designed for UI controls that can overlap. In this
371 /// mode renderer order will be respective to the tree hierarchy of
373 /// The rendering order is depth first, so for the following actor tree,
374 /// A will be drawn first, then B, D, E, then C, F. This ensures that
375 /// overlapping actors are drawn as expected (whereas, with breadth first
376 /// traversal, the actors would interleave).<br />
378 /// <since_tizen> 3 </since_tizen>
381 /// Layer will use depth test.
382 /// This mode is designed for a 3 dimensional scene where actors in front
383 /// of other actors will obscure them, i.e. the actors are sorted by the
384 /// distance from the camera.<br />
385 /// When using this mode, a depth test will be used. A depth clear will
386 /// happen for each layer, which means actors in a layer "above" other
387 /// layers will be rendered in front of actors in those layers regardless
388 /// of their Z positions (see Layer::Raise() and Layer::Lower()).<br />
389 /// Opaque renderers are drawn first and write to the depth buffer. Then
390 /// transparent renderers are drawn with depth test enabled but depth
391 /// write switched off. Transparent renderers are drawn based on their
392 /// distance from the camera. A renderer's DEPTH_INDEX property is used to
393 /// offset the distance to the camera when ordering transparent renderers.
394 /// This is useful if you want to define the draw order of two or more
395 /// transparent renderers that are equal distance from the camera. Unlike
396 /// LAYER_UI, parent-child relationship does not affect rendering order at
399 /// <since_tizen> 3 </since_tizen>
403 internal enum TreeDepthMultiplier
405 TREE_DEPTH_MULTIPLIER = 10000
409 /// Layer behavior, type String (Layer.LayerBehavior).
411 /// <since_tizen> 3 </since_tizen>
412 public Layer.LayerBehavior Behavior
416 return GetBehavior();
425 /// Internal only property to enable or disable clipping, type boolean.
426 /// By default, this is false, i.e., the viewport of the layer is the entire window.
428 internal bool ClippingEnabled
432 bool ret = NDalicPINVOKE.Layer_IsClipping(swigCPtr);
433 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
438 NDalicPINVOKE.Layer_SetClipping(swigCPtr, value);
439 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
444 /// Sets the viewport (in window coordinates), type rectangle.
445 /// The contents of the layer will not be visible outside this box, when ViewportEnabled is true.
447 /// <since_tizen> 4 </since_tizen>
448 public Rectangle Viewport
452 if( ClippingEnabled )
454 Rectangle ret = new Rectangle(NDalicPINVOKE.Layer_GetClippingBox(swigCPtr), true);
455 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
460 // Clipping not enabled so return the window size
461 Size2D windowSize = Window.Instance.Size;
462 Rectangle ret = new Rectangle(0, 0, windowSize.Width, windowSize.Height);
468 NDalicPINVOKE.Layer_SetClippingBox__SWIG_1(swigCPtr, Rectangle.getCPtr(value));
469 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
470 ClippingEnabled = true;
475 /// Retrieves and sets the layer's opacity.<br />
477 /// <since_tizen> 3 </since_tizen>
483 GetProperty(View.Property.OPACITY).Get(out temp);
488 SetProperty(View.Property.OPACITY, new Tizen.NUI.PropertyValue(value));
493 /// Retrieves and sets the layer's visibility.
495 /// <since_tizen> 3 </since_tizen>
496 public bool Visibility
501 GetProperty(View.Property.VISIBLE).Get(out temp);
506 SetProperty(View.Property.VISIBLE, new Tizen.NUI.PropertyValue(value));
511 /// Get the number of children held by the layer.
513 /// <since_tizen> 3 </since_tizen>
514 public new uint ChildCount
518 return Convert.ToUInt32(Children.Count);
523 /// Gets or sets the layer's name.
525 /// <since_tizen> 3 </since_tizen>
538 internal string GetName()
540 string ret = NDalicPINVOKE.Actor_GetName(swigCPtr);
541 if (NDalicPINVOKE.SWIGPendingException.Pending)
542 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
546 internal void SetName(string name)
548 NDalicPINVOKE.Actor_SetName(swigCPtr, name);
549 if (NDalicPINVOKE.SWIGPendingException.Pending)
550 throw NDalicPINVOKE.SWIGPendingException.Retrieve();