src/Tizen.NUI.Scene3D/src/public/ModelComponents/ModelNode.cs

   1 /*
   2  * Copyright(c) 2023 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 using System;
  19 using System.Runtime.InteropServices;
  20 using System.ComponentModel;
  21 using System.Collections.Generic;
  22 using Tizen.NUI;
  23 using Tizen.NUI.Binding;
  24 using Tizen.NUI.BaseComponents;
  25
  26 namespace Tizen.NUI.Scene3D
  27 {
  28     /// <summary>
  29     /// ModelNode is a class for representing the Node of Model in Scene3D.
  30     /// </summary>
  31     ///
  32     /// <remarks>
  33     /// ModelNode contains multiple ModelPrimitives and allows easy access and
  34     /// modification of Material information that ModelPrimitive has. If a 3D
  35     /// format file is loaded by Model, ModelNode is created internally to
  36     /// construct the model. In addition, you can create a Custom ModelNode
  37     /// using ModelPrimitive and Material directly and add it to Model.
  38     ///
  39     /// <code>
  40     /// ModelNode modelNode = new ModelNode();
  41     /// ModelPrimitive modelPrimitive = new ModelPrimitive();
  42     /// modelNode.AddModelPrimitive(modelPrimitive);
  43     ///
  44     /// Material material = new Material;
  45     /// modelPrimitive.Material = material;
  46     /// </code>
  47     /// </remarks>
  48     [EditorBrowsable(EditorBrowsableState.Never)]
  49     public class ModelNode : View
  50     {
  51         internal ModelNode(global::System.IntPtr cPtr, bool cMemoryOwn) : this(cPtr, cMemoryOwn, cMemoryOwn)
  52         {
  53         }
  54
  55         internal ModelNode(global::System.IntPtr cPtr, bool cMemoryOwn, bool cRegister) : base(cPtr, cMemoryOwn, true, cRegister)
  56         {
  57         }
  58
  59         /// <summary>
  60         /// Create an initialized ModelNode.
  61         /// </summary>
  62         [EditorBrowsable(EditorBrowsableState.Never)]
  63         public ModelNode() : this(Interop.ModelNode.ModelNodeNew(), true)
  64         {
  65             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  66             this.PositionUsesPivotPoint = true;
  67         }
  68
  69         /// <summary>
  70         /// Copy constructor.
  71         /// </summary>
  72         /// <param name="modelNode">Source object to copy.</param>
  73         [EditorBrowsable(EditorBrowsableState.Never)]
  74         public ModelNode(ModelNode modelNode) : this(Interop.ModelNode.NewModelNode(ModelNode.getCPtr(modelNode)), true, false)
  75         {
  76             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  77         }
  78
  79         /// <summary>
  80         /// Assignment operator.
  81         /// </summary>
  82         /// <param name="modelNode">Source object to be assigned.</param>
  83         /// <returns>Reference to this.</returns>
  84         internal ModelNode Assign(ModelNode modelNode)
  85         {
  86             ModelNode ret = new ModelNode(Interop.ModelNode.ModelNodeAssign(SwigCPtr, ModelNode.getCPtr(modelNode)), false);
  87             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  88             ret.PositionUsesPivotPoint = modelNode.PositionUsesPivotPoint;
  89             return ret;
  90         }
  91
  92         /// <summary>
  93         /// Get the number of ModelPrimitive of this ModelNode.
  94         /// </summary>
  95         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
  96         [EditorBrowsable(EditorBrowsableState.Never)]
  97         public uint ModelPrimitiveCount
  98         {
  99             get
 100             {
 101                 return GetModelPrimitiveCount();
 102             }
 103         }
 104
 105         /// <summary>
 106         /// Adds a ModelPrimitive object to the ModelNode object.
 107         /// </summary>
 108         /// <param name="modelPrimitive">The ModelPrimitive object to add.</param>
 109         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 110         [EditorBrowsable(EditorBrowsableState.Never)]
 111         public void AddModelPrimitive(ModelPrimitive modelPrimitive)
 112         {
 113             Interop.ModelNode.AddModelPrimitive(SwigCPtr, ModelPrimitive.getCPtr(modelPrimitive));
 114             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 115         }
 116
 117         /// <summary>
 118         /// Removes a ModelPrimitive object from the ModelNode object.
 119         /// </summary>
 120         /// <param name="modelPrimitive">The ModelPrimitive object to remove.</param>
 121         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 122         [EditorBrowsable(EditorBrowsableState.Never)]
 123         public void RemoveModelPrimitive(ModelPrimitive modelPrimitive)
 124         {
 125             Interop.ModelNode.RemoveModelPrimitive(SwigCPtr, ModelPrimitive.getCPtr(modelPrimitive));
 126             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 127         }
 128
 129         /// <summary>
 130         /// Removes a ModelPrimitive object from the ModelNode object at the specified index.
 131         /// </summary>
 132         /// <param name="index">The index of the ModelPrimitive object to remove.</param>
 133         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 134         [EditorBrowsable(EditorBrowsableState.Never)]
 135         public void RemoveModelPrimitive(uint index)
 136         {
 137             Interop.ModelNode.RemoveModelPrimitive(SwigCPtr, index);
 138             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 139         }
 140
 141         /// <summary>
 142         /// Gets the ModelPrimitive object at the specified index.
 143         /// </summary>
 144         /// <param name="index">The index of the ModelPrimitive object to get.</param>
 145         /// <returns>The ModelPrimitive object at the specified index.</returns>
 146         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 147         [EditorBrowsable(EditorBrowsableState.Never)]
 148         public ModelPrimitive GetModelPrimitive(uint index)
 149         {
 150             global::System.IntPtr cPtr = Interop.ModelNode.GetModelPrimitive(SwigCPtr, index);
 151             ModelPrimitive ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as ModelPrimitive;
 152             if (ret == null)
 153             {
 154                 // Register new animatable into Registry.
 155                 ret = new ModelPrimitive(cPtr, true);
 156             }
 157             else
 158             {
 159                 // We found matched NUI animatable. Reduce cPtr reference count.
 160                 HandleRef handle = new HandleRef(this, cPtr);
 161                 Tizen.NUI.Interop.BaseHandle.DeleteBaseHandle(handle);
 162                 handle = new HandleRef(null, IntPtr.Zero);
 163             }
 164             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 165             return ret;
 166         }
 167
 168         /// <summary>
 169         /// Returns a child ModelNode object with a name that matches nodeName.
 170         /// </summary>
 171         /// <param name="nodeName">The name of the child ModelNode object you want to find.</param>
 172         /// <returns>Child ModelNode that has nodeName as name.</returns>
 173         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 174         [EditorBrowsable(EditorBrowsableState.Never)]
 175         public ModelNode FindChildModelNodeByName(string nodeName)
 176         {
 177             global::System.IntPtr cPtr = Interop.Model.FindChildModelNodeByName(SwigCPtr, nodeName);
 178             ModelNode ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as ModelNode;
 179             if (ret == null)
 180             {
 181                 // Store the value of PositionUsesAnchorPoint from dali object (Since View object automatically change PositionUsesPivotPoint value as false, we need to keep value.)
 182                 HandleRef handle = new HandleRef(this, cPtr);
 183                 bool originalPositionUsesAnchorPoint = Object.InternalGetPropertyBool(handle, View.Property.PositionUsesAnchorPoint);
 184                 handle = new HandleRef(null, IntPtr.Zero);
 185
 186                 // Register new animatable into Registry.
 187                 ret = new ModelNode(cPtr, true);
 188                 ret.PositionUsesPivotPoint = originalPositionUsesAnchorPoint;
 189             }
 190             else
 191             {
 192                 // We found matched NUI animatable. Reduce cPtr reference count.
 193                 HandleRef handle = new HandleRef(this, cPtr);
 194                 Tizen.NUI.Interop.BaseHandle.DeleteBaseHandle(handle);
 195                 handle = new HandleRef(null, IntPtr.Zero);
 196             }
 197             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 198             return ret;
 199         }
 200
 201         /// <summary>
 202         /// Gets the number of ModelPrimitive objects in the ModelNode object.
 203         /// </summary>
 204         /// <returns>The number of ModelPrimitive objects in the ModelNode object.</returns>
 205         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 206         [EditorBrowsable(EditorBrowsableState.Never)]
 207         private uint GetModelPrimitiveCount()
 208         {
 209             uint ret = Interop.ModelNode.GetModelPrimitiveCount(SwigCPtr);
 210             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 211             return ret;
 212         }
 213
 214         /// <summary>
 215         /// Build C# ModelNode Tree
 216         /// </summary>
 217         [EditorBrowsable(EditorBrowsableState.Never)]
 218         internal void Build()
 219         {
 220             List<ModelNode> childModelNodes = new List<ModelNode>();
 221             uint childModelNodeCount = GetChildModelNodeCount();
 222             for(uint i = 0; i < childModelNodeCount; ++i)
 223             {
 224                 ModelNode modelNode = GetChildModelNodeAt(i);
 225                 childModelNodes.Add(modelNode);
 226                 modelNode.Build();
 227             }
 228
 229             foreach(ModelNode node in childModelNodes)
 230             {
 231                 this.Add(node);
 232             }
 233         }
 234
 235         /// <summary>
 236         /// Gets the number of child objects in the ModelNode object.
 237         /// </summary>
 238         /// <returns>The number of childchild objects in the ModelNode object.</returns>
 239         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 240         [EditorBrowsable(EditorBrowsableState.Never)]
 241         private uint GetChildModelNodeCount()
 242         {
 243             uint ret = Interop.ModelNode.GetChildModelNodeCount(SwigCPtr);
 244             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 245             return ret;
 246         }
 247
 248         /// <summary>
 249         /// Returns a child ModelNode object at the index.
 250         /// </summary>
 251         /// <param name="index">The index of child ModelNode object you want to find.</param>
 252         /// <returns>Child ModelNode</returns>
 253         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 254         [EditorBrowsable(EditorBrowsableState.Never)]
 255         private ModelNode GetChildModelNodeAt(uint index)
 256         {
 257             global::System.IntPtr cPtr = Interop.ModelNode.GetChildModelNodeAt(SwigCPtr, index);
 258             ModelNode ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as ModelNode;
 259             if (ret == null)
 260             {
 261                 // Store the value of PositionUsesAnchorPoint from dali object (Since View object automatically change PositionUsesPivotPoint value as false, we need to keep value.)
 262                 HandleRef handle = new HandleRef(this, cPtr);
 263                 bool originalPositionUsesAnchorPoint = Object.InternalGetPropertyBool(handle, View.Property.PositionUsesAnchorPoint);
 264                 handle = new HandleRef(null, IntPtr.Zero);
 265
 266                 // Register new animatable into Registry.
 267                 ret = new ModelNode(cPtr, true);
 268                 ret.PositionUsesPivotPoint = originalPositionUsesAnchorPoint;
 269             }
 270             else
 271             {
 272                 // We found matched NUI animatable. Reduce cPtr reference count.
 273                 HandleRef handle = new HandleRef(this, cPtr);
 274                 Tizen.NUI.Interop.BaseHandle.DeleteBaseHandle(handle);
 275                 handle = new HandleRef(null, IntPtr.Zero);
 276             }
 277             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 278             return ret;
 279         }
 280
 281         /// <summary>
 282         /// Release swigCPtr.
 283         /// </summary>
 284         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 285         [EditorBrowsable(EditorBrowsableState.Never)]
 286         protected override void ReleaseSwigCPtr(global::System.Runtime.InteropServices.HandleRef swigCPtr)
 287         {
 288             Interop.ModelNode.DeleteModelNode(swigCPtr);
 289         }
 290     }
 291 }