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! Please use as keyword instead!")]
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 var parentChildren = Window.Instance.LayersChildren;
232 if(parentChildren != null)
234 int idx = parentChildren.IndexOf(this);
237 return Convert.ToUInt32(idx); ;
244 /// Increments the depth of the layer.
246 /// <since_tizen> 3 </since_tizen>
249 var parentChildren = Window.Instance.LayersChildren;
250 if (parentChildren != null)
252 int currentIdx = parentChildren.IndexOf(this);
254 if (currentIdx != parentChildren.Count - 1)
256 RaiseAbove(parentChildren[currentIdx + 1]);
258 Layer temp = parentChildren[currentIdx + 1];
259 parentChildren[currentIdx + 1] = this;
260 parentChildren[currentIdx] = temp;
266 /// Decrements the depth of the layer.
268 /// <since_tizen> 3 </since_tizen>
271 var parentChildren = Window.Instance.LayersChildren;
272 if (parentChildren != null)
274 int currentIdx = parentChildren.IndexOf(this);
278 LowerBelow(parentChildren[currentIdx - 1]);
280 Layer temp = parentChildren[currentIdx - 1];
281 parentChildren[currentIdx - 1] = this;
282 parentChildren[currentIdx] = temp;
288 internal void RaiseAbove(Layer target)
290 NDalicPINVOKE.Layer_RaiseAbove(swigCPtr, Layer.getCPtr(target));
291 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
294 internal void LowerBelow(Layer target)
296 NDalicPINVOKE.Layer_LowerBelow(swigCPtr, Layer.getCPtr(target));
297 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
301 /// Raises the layer to the top.
303 /// <since_tizen> 3 </since_tizen>
304 public void RaiseToTop()
306 var parentChildren = Window.Instance.LayersChildren;
308 if (parentChildren != null)
310 parentChildren.Remove(this);
311 parentChildren.Add(this);
313 NDalicPINVOKE.Layer_RaiseToTop(swigCPtr);
314 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
318 /// Lowers the layer to the bottom.
320 /// <since_tizen> 3 </since_tizen>
321 public void LowerToBottom()
323 var parentChildren = Window.Instance.LayersChildren;
325 if (parentChildren != null)
327 parentChildren.Remove(this);
328 parentChildren.Insert(0, this);
331 NDalicPINVOKE.Layer_LowerToBottom(swigCPtr);
332 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
336 /// Moves the layer directly above the given layer.<br />
337 /// After the call, this layer's depth will be immediately above target.<br />
339 /// <param name="target">The layer to get on top of.</param>
340 /// <since_tizen> 3 </since_tizen>
341 public void MoveAbove(Layer target)
343 NDalicPINVOKE.Layer_MoveAbove(swigCPtr, Layer.getCPtr(target));
344 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
348 /// Moves the layer directly below the given layer.<br />
349 /// After the call, this layer's depth will be immediately below target.<br />
351 /// <param name="target">The layer to get below of.</param>
352 /// <since_tizen> 3 </since_tizen>
353 public void MoveBelow(Layer target)
355 NDalicPINVOKE.Layer_MoveBelow(swigCPtr, Layer.getCPtr(target));
356 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
359 private void SetBehavior(LayerBehavior behavior)
361 NDalicPINVOKE.Layer_SetBehavior(swigCPtr, (int)behavior);
362 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
365 private LayerBehavior GetBehavior()
367 Layer.LayerBehavior ret = (Layer.LayerBehavior)NDalicPINVOKE.Layer_GetBehavior(swigCPtr);
368 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
372 internal void SetSortFunction(SWIGTYPE_p_f_r_q_const__Dali__Vector3__float function)
374 NDalicPINVOKE.Layer_SetSortFunction(swigCPtr, SWIGTYPE_p_f_r_q_const__Dali__Vector3__float.getCPtr(function));
375 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
378 internal void SetTouchConsumed(bool consume)
380 NDalicPINVOKE.Layer_SetTouchConsumed(swigCPtr, consume);
381 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
384 internal bool IsTouchConsumed()
386 bool ret = NDalicPINVOKE.Layer_IsTouchConsumed(swigCPtr);
387 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
391 internal void SetHoverConsumed(bool consume)
393 NDalicPINVOKE.Layer_SetHoverConsumed(swigCPtr, consume);
394 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
397 internal bool IsHoverConsumed()
399 bool ret = NDalicPINVOKE.Layer_IsHoverConsumed(swigCPtr);
400 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
405 /// Enumeration for the behavior of the layer.
407 /// <since_tizen> 3 </since_tizen>
408 public enum LayerBehavior
411 /// UI control rendering mode.
413 /// <since_tizen> 3 </since_tizen>
416 /// UI control rendering mode (default mode).
417 /// This mode is designed for UI controls that can overlap. In this
418 /// mode renderer order will be respective to the tree hierarchy of
420 /// The rendering order is depth first, so for the following actor tree,
421 /// A will be drawn first, then B, D, E, then C, F. This ensures that
422 /// overlapping actors are drawn as expected (whereas, with breadth first
423 /// traversal, the actors would interleave).<br />
425 /// <since_tizen> 3 </since_tizen>
428 /// Layer will use depth test.
429 /// This mode is designed for a 3 dimensional scene where actors in front
430 /// of other actors will obscure them, i.e. the actors are sorted by the
431 /// distance from the camera.<br />
432 /// When using this mode, a depth test will be used. A depth clear will
433 /// happen for each layer, which means actors in a layer "above" other
434 /// layers will be rendered in front of actors in those layers regardless
435 /// of their Z positions (see Layer::Raise() and Layer::Lower()).<br />
436 /// Opaque renderers are drawn first and write to the depth buffer. Then
437 /// transparent renderers are drawn with depth test enabled but depth
438 /// write switched off. Transparent renderers are drawn based on their
439 /// distance from the camera. A renderer's DEPTH_INDEX property is used to
440 /// offset the distance to the camera when ordering transparent renderers.
441 /// This is useful if you want to define the draw order of two or more
442 /// transparent renderers that are equal distance from the camera. Unlike
443 /// LAYER_UI, parent-child relationship does not affect rendering order at
446 /// <since_tizen> 3 </since_tizen>
450 internal enum TreeDepthMultiplier
452 TREE_DEPTH_MULTIPLIER = 10000
456 /// Layer behavior, type String (Layer.LayerBehavior).
458 /// <since_tizen> 3 </since_tizen>
459 public Layer.LayerBehavior Behavior
463 return GetBehavior();
472 /// Internal only property to enable or disable clipping, type boolean.
473 /// By default, this is false, i.e., the viewport of the layer is the entire window.
475 internal bool ClippingEnabled
479 bool ret = NDalicPINVOKE.Layer_IsClipping(swigCPtr);
480 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
485 NDalicPINVOKE.Layer_SetClipping(swigCPtr, value);
486 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
491 /// Sets the viewport (in window coordinates), type rectangle.
492 /// The contents of the layer will not be visible outside this box, when ViewportEnabled is true.
494 /// <since_tizen> 4 </since_tizen>
495 public Rectangle Viewport
499 if( ClippingEnabled )
501 Rectangle ret = new Rectangle(NDalicPINVOKE.Layer_GetClippingBox(swigCPtr), true);
502 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
507 // Clipping not enabled so return the window size
508 Size2D windowSize = Window.Instance.Size;
509 Rectangle ret = new Rectangle(0, 0, windowSize.Width, windowSize.Height);
515 NDalicPINVOKE.Layer_SetClippingBox__SWIG_1(swigCPtr, Rectangle.getCPtr(value));
516 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
517 ClippingEnabled = true;
522 /// Retrieves and sets the layer's opacity.<br />
524 /// <since_tizen> 3 </since_tizen>
530 GetProperty(View.Property.OPACITY).Get(out temp);
535 SetProperty(View.Property.OPACITY, new Tizen.NUI.PropertyValue(value));
540 /// Retrieves and sets the layer's visibility.
542 /// <since_tizen> 3 </since_tizen>
543 public bool Visibility
548 GetProperty(View.Property.VISIBLE).Get(out temp);
553 SetProperty(View.Property.VISIBLE, new Tizen.NUI.PropertyValue(value));
558 /// Get the number of children held by the layer.
560 /// <since_tizen> 3 </since_tizen>
561 public new uint ChildCount
565 return Convert.ToUInt32(Children.Count);
570 /// Gets or sets the layer's name.
572 /// <since_tizen> 3 </since_tizen>
585 internal string GetName()
587 string ret = NDalicPINVOKE.Actor_GetName(swigCPtr);
588 if (NDalicPINVOKE.SWIGPendingException.Pending)
589 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
593 internal void SetName(string name)
595 NDalicPINVOKE.Actor_SetName(swigCPtr, name);
596 if (NDalicPINVOKE.SWIGPendingException.Pending)
597 throw NDalicPINVOKE.SWIGPendingException.Retrieve();