src/Tizen.NUI/src/public/VisualBase.cs

   1 /** Copyright (c) 2017 Samsung Electronics Co., Ltd.
   2 *
   3 * Licensed under the Apache License, Version 2.0 (the "License");
   4 * you may not use this file except in compliance with the License.
   5 * You may obtain a copy of the License at
   6 *
   7 * http://www.apache.org/licenses/LICENSE-2.0
   8 *
   9 * Unless required by applicable law or agreed to in writing, software
  10 * distributed under the License is distributed on an "AS IS" BASIS,
  11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 * See the License for the specific language governing permissions and
  13 * limitations under the License.
  14 *
  15 */
  16
  17 using System;
  18 using System.Runtime.InteropServices;
  19
  20 namespace Tizen.NUI
  21 {
  22
  23     /// <summary>
  24     /// Sets whether the actor should be focusable by keyboard navigation.<br>
  25     /// Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on-window.<br>
  26     /// Each visual also responds to actor size and color change, and provides clipping at the renderer level.<br>
  27     /// </summary>
  28     public class VisualBase : BaseHandle
  29     {
  30         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  31
  32         internal VisualBase(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.VisualBase_SWIGUpcast(cPtr), cMemoryOwn)
  33         {
  34             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  35         }
  36
  37         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(VisualBase obj)
  38         {
  39             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  40         }
  41
  42         protected override void Dispose(DisposeTypes type)
  43         {
  44             if(disposed)
  45             {
  46                 return;
  47             }
  48
  49             if(type == DisposeTypes.Explicit)
  50             {
  51                 //Called by User
  52                 //Release your own managed resources here.
  53                 //You should release all of your own disposable objects here.
  54             }
  55
  56             //Release your own unmanaged resources here.
  57             //You should not access any managed member here except static instance.
  58             //because the execution order of Finalizes is non-deterministic.
  59
  60             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  61             {
  62                 if (swigCMemOwn)
  63                 {
  64                     swigCMemOwn = false;
  65                     NDalicPINVOKE.delete_VisualBase(swigCPtr);
  66                 }
  67                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  68             }
  69
  70             base.Dispose(type);
  71         }
  72
  73         /// <summary>
  74         /// Create an empty Visual Handle
  75         /// </summary>
  76         public VisualBase() : this(NDalicPINVOKE.new_VisualBase__SWIG_0(), true)
  77         {
  78             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  79         }
  80
  81         internal VisualBase(VisualBase handle) : this(NDalicPINVOKE.new_VisualBase__SWIG_1(VisualBase.getCPtr(handle)), true)
  82         {
  83             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  84         }
  85
  86         /// <summary>
  87         /// name of the visual
  88         /// </summary>
  89         public string Name
  90         {
  91             set
  92             {
  93                 SetName(value);
  94             }
  95             get
  96             {
  97                 return GetName();
  98             }
  99         }
 100
 101         internal void SetName(string name)
 102         {
 103             NDalicPINVOKE.VisualBase_SetName(swigCPtr, name);
 104             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 105         }
 106
 107         internal string GetName()
 108         {
 109             string ret = NDalicPINVOKE.VisualBase_GetName(swigCPtr);
 110             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 111             return ret;
 112         }
 113
 114         /// <summary>
 115         /// Sets the transform and the control size
 116         /// </summary>
 117         /// <param name="transform">A property map describing the transform</param>
 118         /// <param name="controlSize">The size of the parent control for visuals that need to scale internally.</param>
 119         public void SetTransformAndSize(PropertyMap transform, Vector2 controlSize)
 120         {
 121             NDalicPINVOKE.VisualBase_SetTransformAndSize(swigCPtr, PropertyMap.getCPtr(transform), Vector2.getCPtr(controlSize));
 122             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 123         }
 124
 125         /// <summary>
 126         /// Returns the height for a given width.
 127         /// </summary>
 128         /// <param name="width">Width to use.</param>
 129         /// <returns>The height based on the width.</returns>
 130         public float GetHeightForWidth(float width)
 131         {
 132             float ret = NDalicPINVOKE.VisualBase_GetHeightForWidth(swigCPtr, width);
 133             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 134             return ret;
 135         }
 136
 137         /// <summary>
 138         /// Returns the width for a given height.
 139         /// </summary>
 140         /// <param name="height">Height to use.</param>
 141         /// <returns>The width based on the height.</returns>
 142         public float GetWidthForHeight(float height)
 143         {
 144             float ret = NDalicPINVOKE.VisualBase_GetWidthForHeight(swigCPtr, height);
 145             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 146             return ret;
 147         }
 148
 149         /// <summary>
 150         /// Return the natural size of the visual.<br>
 151         /// Deriving classes stipulate the natural size and by default a visual has a ZERO natural size.<br>
 152         /// A visual may not actually have a natural size until it has been placed on window and acquired all it's resources.<br>
 153         /// </summary>
 154         /// <param name="naturalSize">The visual's natural size</param>
 155         public void GetNaturalSize(Size2D naturalSize)
 156         {
 157             NDalicPINVOKE.VisualBase_GetNaturalSize(swigCPtr, Size2D.getCPtr(naturalSize));
 158             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 159         }
 160
 161         /// <summary>
 162         /// the depth index of this visual.
 163         /// </summary>
 164         public int DepthIndex
 165         {
 166             set
 167             {
 168                 SetDepthIndex(value);
 169             }
 170             get
 171             {
 172                 return GetDepthIndex();
 173             }
 174         }
 175         internal void SetDepthIndex(int index)
 176         {
 177             NDalicPINVOKE.VisualBase_SetDepthIndex(swigCPtr, index);
 178             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 179         }
 180
 181         internal int GetDepthIndex()
 182         {
 183             int ret = NDalicPINVOKE.VisualBase_GetDepthIndex(swigCPtr);
 184             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 185             return ret;
 186         }
 187
 188         /// <summary>
 189         /// Create the property map representing this visual.
 190         /// </summary>
 191         [Obsolete("Please be caution! this will be readonly.")]
 192         public PropertyMap Creation
 193         {
 194             set
 195             {
 196                 CreatePropertyMap(value);
 197             }
 198             get
 199             {
 200                 PropertyMap map = new PropertyMap();
 201                 CreatePropertyMap(map);
 202                 return map;
 203             }
 204         }
 205
 206         internal void CreatePropertyMap(PropertyMap map)
 207         {
 208             NDalicPINVOKE.VisualBase_CreatePropertyMap(swigCPtr, PropertyMap.getCPtr(map));
 209             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 210         }
 211
 212         internal VisualBase(SWIGTYPE_p_Dali__Toolkit__Internal__Visual__Base impl) : this(NDalicPINVOKE.new_VisualBase__SWIG_2(SWIGTYPE_p_Dali__Toolkit__Internal__Visual__Base.getCPtr(impl)), true)
 213         {
 214             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 215         }
 216
 217     }
 218
 219 }