src/Tizen.NUI.Scene3D/src/public/Controls/SceneView.cs

   1 /*
   2  * Copyright(c) 2022 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 Tizen.NUI;
  22 using Tizen.NUI.Binding;
  23 using Tizen.NUI.BaseComponents;
  24
  25 namespace Tizen.NUI.Scene3D
  26 {
  27     /// <summary>
  28     /// SceneView is a Class to show multiple 3D objects in a single 2D screen.
  29     /// Each SceneView has its own 3D space, and 3D objects added to SceneView are positioned in the space.
  30     /// SceneView uses left-handed coordinate system same as NUI. X as right, Y as down, and Z as forward.
  31     ///
  32     /// SceneView has internal root container to control inner rendering process like depth test.
  33     /// When a View is added to the SceneView with <see cref="View.Add(View)"/> method, it is actually added on the root container.
  34     /// Therefore, the added Views exist in the sub tree of SceneView, but are not direct children.
  35     /// The sub tree of Views will be rendered with the SceneView's own Camera.
  36     ///
  37     /// SceneView has one built-in camera by default.
  38     /// The default Camera is not removed by using <see cref="RemoveCamera(Camera)"/> method.
  39     /// <see cref="GetCamera(uint)"/> method with index "0" returns the default camera,
  40     /// and the minimum value returned by <see cref="GetCameraCount()"/> method is 1.
  41     ///
  42     /// SceneView also provides multiple Camera and one of them can be used to render multiple objects.
  43     /// <see cref="AddCamera(Camera)"/>, <see cref="RemoveCamera(Camera)"/>, <see cref="GetCamera(uint)"/>,
  44     /// and <see cref="SelectCamera(uint)"/> are methods to manage Cameras of the SceneView.
  45     /// User can place multiple cameras in a scene to display the entire scene or to display individual objects.
  46     /// User can use the <see cref="SelectCamera(uint)"/> method to select the currently required camera.
  47     ///
  48     /// When the SceneView's size changes, some camera properties that depend on its size may also change.
  49     /// The changing properties are as follows: AspectRatio, LeftPlaneDistance, RightPlaneDistance, TopPlaneDistance, and BottomPlaneDistance.
  50     /// The Camera's FieldOfView is vertical fov. The horizontal fov is updated internally according to the SceneView size.
  51     ///
  52     /// The <see cref="SetImageBasedLightSource(string, string, float)"/> method sets the same IBL to all Model objects added to the SceneView.
  53     /// For the IBL, two cube map textures(diffuse and specular) are required.
  54     /// SceneView supports 4 types layout for Cube Map: Vertical/Horizontal Cross layouts, and Vertical/Horizontal Array layouts.
  55     /// And also, ktx format with cube map is supported.
  56     /// If a model already has an IBL, it is batch overridden with the IBL of the SceneView.
  57     /// If the SceneView has IBL, the IBL of newly added models is also overridden.
  58     ///
  59     /// The IBL textures start to be loaded asynchronously when <see cref="SetImageBasedLightSource(string, string, float)"/> method is called.
  60     /// ResourcesLoaded signal notifies that the loading of the IBL resources have been completed.
  61     ///
  62     /// If FBO is used, the rendering result of SceneView is drawn on the FBO and it is mapped on the plane of the SceneView.
  63     /// It could decreases performance slightly, but it is useful to show SceneView according to the rendering order with other Views.
  64     ///
  65     /// And since SceneView is a View, it can be placed together with other 2D UI components in the NUI window.
  66     /// </summary>
  67     /// <since_tizen> 10 </since_tizen>
  68     public class SceneView : View
  69     {
  70         private bool inCameraTransition = false;
  71         private Animation cameraTransition;
  72         private string skyboxUrl;
  73
  74         internal SceneView(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
  75         {
  76         }
  77
  78         /// <summary>
  79         /// Create an initialized SceneView.
  80         /// </summary>
  81         /// <since_tizen> 10 </since_tizen>
  82         public SceneView() : this(Interop.SceneView.SceneNew(), true)
  83         {
  84             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  85         }
  86
  87         /// <summary>
  88         /// Copy constructor.
  89         /// </summary>
  90         /// <param name="sceneView">The source object.</param>
  91         /// <since_tizen> 10 </since_tizen>
  92         public SceneView(SceneView sceneView) : this(Interop.SceneView.NewScene(SceneView.getCPtr(sceneView)), true)
  93         {
  94             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  95         }
  96
  97         /// <summary>
  98         /// Assignment operator.
  99         /// </summary>
 100         /// <param name="sceneView">Handle to an object.</param>
 101         /// <returns>Reference to this.</returns>
 102         internal SceneView Assign(SceneView sceneView)
 103         {
 104             SceneView ret = new SceneView(Interop.SceneView.SceneAssign(SwigCPtr, SceneView.getCPtr(sceneView)), false);
 105             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 106             return ret;
 107         }
 108
 109         /// <summary>
 110         /// An event emitted when Camera Transition is finished.
 111         /// </summary>
 112         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 113         [EditorBrowsable(EditorBrowsableState.Never)]
 114         public event EventHandler CameraTransitionFinished;
 115
 116         /// <summary>
 117         /// Set/Get the ImageBasedLight ScaleFactor.
 118         /// Scale factor controls light source intensity in [0.0f, 1.0f]
 119         /// </summary>
 120         /// <since_tizen> 10 </since_tizen>
 121         public float ImageBasedLightScaleFactor
 122         {
 123             set
 124             {
 125                 SetImageBasedLightScaleFactor(value);
 126             }
 127             get
 128             {
 129                 return GetImageBasedLightScaleFactor();
 130             }
 131         }
 132
 133         /// <summary>
 134         /// Set/Get the UseFramebuffer.
 135         /// If this property is true, rendering result of SceneView is drawn on FBO and it is mapping on this SceneView plane.
 136         /// If this property is false, each item in SceneView is rendered on window directly.
 137         /// Default is false.
 138         /// </summary>
 139         /// <remarks>
 140         /// If UseFramebuffer is true, it could decrease performance but entire rendering order is satisfied.
 141         /// If UseFramebuffer is false, the performance becomes better but SceneView is rendered on the top of the other 2D components regardless tree order.
 142         /// </remarks>
 143         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 144         [EditorBrowsable(EditorBrowsableState.Never)]
 145         public bool UseFramebuffer
 146         {
 147             set
 148             {
 149                 SetUseFramebuffer(value);
 150             }
 151             get
 152             {
 153                 return IsUsingFramebuffer();
 154             }
 155         }
 156
 157         /// <summary>
 158         /// Set/Get SkyboxUrl.
 159         /// If SkyboxUrl is set, the cube map image is loaded and skybox is attached on scene.
 160         /// Skybox texture is asynchronously loaded. When loading is finished, ResourcesLoaded is emitted.
 161         /// </summary>
 162         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 163         [EditorBrowsable(EditorBrowsableState.Never)]
 164         public string SkyboxUrl
 165         {
 166             set
 167             {
 168                 SetSkybox(value);
 169             }
 170             get
 171             {
 172                 return skyboxUrl;
 173             }
 174         }
 175
 176         /// <summary>
 177         /// Set/Get Skybox intensity.
 178         /// The skybox intensity is multiplied to the color of skybox texture.
 179         /// Default value is 1.0f.
 180         /// </summary>
 181         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 182         [EditorBrowsable(EditorBrowsableState.Never)]
 183         public float SkyboxIntensity
 184         {
 185             set
 186             {
 187                 SetSkyboxIntensity(value);
 188             }
 189             get
 190             {
 191                 return GetSkyboxIntensity();
 192             }
 193         }
 194
 195         /// <summary>
 196         /// Set/Get angle of orientation of the skybox.
 197         /// If orientation is set, the skybox will be rotate by the Radian orientation along YAxis.
 198         /// Default value is 0.0f.
 199         /// </summary>
 200         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 201         [EditorBrowsable(EditorBrowsableState.Never)]
 202         public Rotation SkyboxOrientation
 203         {
 204             set
 205             {
 206                 SetSkyboxOrientation(value);
 207             }
 208             get
 209             {
 210                 return GetSkyboxOrientation();
 211             }
 212         }
 213
 214         /// <summary>
 215         /// Adds a Camera to the SceneView at the end of the camera list of SceneView.
 216         /// The Camera can be used as a selected camera to render the scene by using <see cref="SelectCamera(uint)"/> or <see cref="SelectCamera(string)"/>
 217         /// </summary>
 218         /// <param name="camera">Camera added on this SceneView.</param>
 219         /// <remarks>
 220         /// Some properties of the Camera will be change depending on the Size of this SceneView.
 221         /// Those properties are as follows:
 222         /// AspectRatio, LeftPlaneDistance, RightPlaneDistance, TopPlaneDistance, and BottomPlaneDistance.
 223         ///
 224         /// The FieldOfView of Camera is for vertical fov.
 225         /// When the size of the SceneView is changed, the vertical fov is maintained
 226         /// and the horizontal fov is automatically calculated according to the SceneView's AspectRatio.
 227         /// </remarks>
 228         /// <since_tizen> 10 </since_tizen>
 229         public void AddCamera(Camera camera)
 230         {
 231             if(camera != null)
 232             {
 233                 Interop.SceneView.AddCamera(SwigCPtr, camera.SwigCPtr);
 234                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 235             }
 236         }
 237
 238         /// <summary>
 239         /// Removes a Camera from this SceneView.
 240         /// If removed Camera is selected Camera,
 241         /// first camera in the list becomes the selected Camera.
 242         /// </summary>
 243         /// <param name="camera"> camera Camera to be removed from this Camera.</param>
 244         /// <remarks>
 245         /// When Camera.Dispose() is called, the NUI object is disposed, but camera information is maintained internally.
 246         /// Therefore, even if Camera.Dispose() is called, RemoveCamera() or RemoveCamera() methods can be used.
 247         /// If RemoveCamera() is called too, all information is deleted together.
 248         /// </remarks>
 249         /// <since_tizen> 10 </since_tizen>
 250         public void RemoveCamera(Camera camera)
 251         {
 252             if(camera != null)
 253             {
 254                 Interop.SceneView.RemoveCamera(SwigCPtr, camera.SwigCPtr);
 255                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 256             }
 257         }
 258
 259         /// <summary>
 260         /// Retrieves the number of cameras.
 261         /// </summary>
 262         /// <returns>The number of Cameras.</returns>
 263         /// <since_tizen> 10 </since_tizen>
 264         public uint GetCameraCount()
 265         {
 266             uint count = Interop.SceneView.GetCameraCount(SwigCPtr);
 267             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 268             return count;
 269         }
 270
 271         /// <summary>
 272         /// Retrieves a Camera of the index.
 273         /// </summary>
 274         /// <param name="index"> Index of Camera to be retrieved.</param>
 275         /// <returns>Camera of the index.</returns>
 276         /// <since_tizen> 10 </since_tizen>
 277         public Camera GetCamera(uint index)
 278         {
 279             global::System.IntPtr cPtr = Interop.SceneView.GetCamera(SwigCPtr, index);
 280             Camera camera = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as Camera;
 281             if(camera == null)
 282             {
 283                 // Register new camera into Registry.
 284                 camera = new Camera(cPtr, true);
 285             }
 286             else
 287             {
 288                 // We found matched NUI camera. Reduce cPtr reference count.
 289                 HandleRef handle = new HandleRef(this, cPtr);
 290                 Interop.Camera.DeleteCameraProperty(handle);
 291                 handle = new HandleRef(null, IntPtr.Zero);
 292             }
 293             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 294             return camera;
 295         }
 296
 297         /// <summary>
 298         /// Retrieves a Camera of the input name.
 299         /// </summary>
 300         /// <param name="name"> string keyword of Camera to be retrieved.</param>
 301         /// <returns>Camera that has the name as a View.Name property</returns>
 302         /// <since_tizen> 10 </since_tizen>
 303         public Camera GetCamera(string name)
 304         {
 305             global::System.IntPtr cPtr = Interop.SceneView.GetCamera(SwigCPtr, name);
 306             Camera camera = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as Camera;
 307             if(camera == null)
 308             {
 309                 // Register new camera into Registry.
 310                 camera = new Camera(cPtr, true);
 311             }
 312             else
 313             {
 314                 // We found matched NUI camera. Reduce cPtr reference count.
 315                 HandleRef handle = new HandleRef(this, cPtr);
 316                 Interop.Camera.DeleteCameraProperty(handle);
 317                 handle = new HandleRef(null, IntPtr.Zero);
 318             }
 319             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 320             return camera;
 321         }
 322
 323         /// <summary>
 324         /// Makes SceneView use a Camera of index as a selected camera.
 325         /// </summary>
 326         /// <param name="index"> Index of Camera to be used as a selected camera.</param>
 327         /// <since_tizen> 10 </since_tizen>
 328         public void SelectCamera(uint index)
 329         {
 330             if(inCameraTransition)
 331             {
 332                 return;
 333             }
 334             Interop.SceneView.SelectCamera(SwigCPtr, index);
 335             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 336         }
 337
 338         /// <summary>
 339         /// Makes SceneView use a Camera of a name as a selected camera.
 340         /// </summary>
 341         /// <param name="name"> string keyword of Camera to be used as a selected camera.</param>
 342         /// <since_tizen> 10 </since_tizen>
 343         public void SelectCamera(string name)
 344         {
 345             if(inCameraTransition)
 346             {
 347                 return;
 348             }
 349             Interop.SceneView.SelectCamera(SwigCPtr, name);
 350             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 351         }
 352
 353         /// <summary>
 354         /// Starts camera transition from currently selected camera to a camera of index.
 355         /// Camera Position, Orientation and FieldOfView are smoothly animated.
 356         /// </summary>
 357         /// <remarks>
 358         /// The selected camera is switched to the Camera of the index when the transition is started.
 359         /// During camera transition, Selected Camera should not be changed by using SelectCamera() or CameraTransition() method.
 360         /// During camera transition, Camera properties of Selected Camera should not be changed.
 361         /// </remarks>
 362         /// <param name="index"> Index of destination Camera of Camera transition.</param>
 363         /// <param name="durationMilliSeconds">The duration in milliseconds.</param>
 364         /// <param name="alphaFunction">The alpha function to apply.</param>
 365         /// <since_tizen> 10 </since_tizen>
 366         public void CameraTransition(uint index, int durationMilliSeconds, AlphaFunction alphaFunction = null)
 367         {
 368             if(inCameraTransition || GetSelectedCamera() == GetCamera(index))
 369             {
 370                 return;
 371             }
 372             Camera source = GetSelectedCamera();
 373             SelectCamera(index);
 374             Camera destination = GetSelectedCamera();
 375             CameraTransition(source, destination, durationMilliSeconds, alphaFunction);
 376             source.Dispose();
 377             destination.Dispose();
 378         }
 379
 380         /// <summary>
 381         /// Starts camera transition from currently selected camera to a camera of input name.
 382         /// Camera Position, Orientation and FieldOfView are smoothly animated.
 383         /// </summary>
 384         /// <remarks>
 385         /// The selected camera is switched to the Camera of the input name when the transition is started.
 386         /// During camera transition, Selected Camera should not be changed by using SelectCamera() or CameraTransition() method.
 387         /// During camera transition, Camera properties of Selected Camera should not be changed.
 388         /// </remarks>
 389         /// <param name="name"> string keyword of destination Camera of Camera transition.</param>
 390         /// <param name="durationMilliSeconds">The duration in milliseconds.</param>
 391         /// <param name="alphaFunction">The alpha function to apply.</param>
 392         /// <since_tizen> 10 </since_tizen>
 393         public void CameraTransition(string name, int durationMilliSeconds, AlphaFunction alphaFunction = null)
 394         {
 395             if(inCameraTransition || GetSelectedCamera() == GetCamera(name))
 396             {
 397                 return;
 398             }
 399             Camera source = GetSelectedCamera();
 400             SelectCamera(name);
 401             Camera destination = GetSelectedCamera();
 402             CameraTransition(source, destination, durationMilliSeconds, alphaFunction);
 403             source.Dispose();
 404             destination.Dispose();
 405         }
 406
 407         /// <summary>
 408         /// Retrieves selected Camera.
 409         /// </summary>
 410         /// <returns> Camera currently used in SceneView as a selected Camera.</returns>
 411         /// <since_tizen> 10 </since_tizen>
 412         public Camera GetSelectedCamera()
 413         {
 414             global::System.IntPtr cPtr = Interop.SceneView.GetSelectedCamera(SwigCPtr);
 415             Camera camera = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as Camera;
 416             if(camera == null)
 417             {
 418                 // Register new camera into Registry.
 419                 camera = new Camera(cPtr, true);
 420             }
 421             else
 422             {
 423                 // We found matched NUI camera. Reduce cPtr reference count.
 424                 HandleRef handle = new HandleRef(this, cPtr);
 425                 Interop.Camera.DeleteCameraProperty(handle);
 426                 handle = new HandleRef(null, IntPtr.Zero);
 427             }
 428             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 429             return camera;
 430         }
 431
 432         /// <summary>
 433         /// Changes Image Based Light as the input textures.
 434         /// </summary>
 435         /// <param name="diffuseUrl">The path of Cube map image that can be used as a diffuse IBL source.</param>
 436         /// <param name="specularUrl">The path of Cube map image that can be used as a specular IBL source.</param>
 437         /// <param name="scaleFactor">Scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.</param>
 438         /// <remarks>
 439         /// http://tizen.org/privilege/mediastorage for local files in media storage.
 440         /// http://tizen.org/privilege/externalstorage for local files in external storage.
 441         /// </remarks>
 442         /// <since_tizen> 10 </since_tizen>
 443         public void SetImageBasedLightSource(string diffuseUrl, string specularUrl, float scaleFactor = 1.0f)
 444         {
 445             Interop.SceneView.SetImageBasedLightSource(SwigCPtr, diffuseUrl, specularUrl, scaleFactor);
 446             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 447         }
 448
 449         internal void SetUseFramebuffer(bool useFramebuffer)
 450         {
 451             Interop.SceneView.UseFramebuffer(SwigCPtr, useFramebuffer);
 452             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 453         }
 454
 455         internal bool IsUsingFramebuffer()
 456         {
 457             bool result = Interop.SceneView.IsUsingFramebuffer(SwigCPtr);
 458             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 459             return result;
 460         }
 461
 462         /// <summary>
 463         /// Set the ImageBasedLight ScaleFactor.
 464         /// </summary>
 465         /// <param name="scaleFactor">Scale factor that controls light source intensity in [0.0f, 1.0f].</param>
 466         private void SetImageBasedLightScaleFactor(float scaleFactor)
 467         {
 468             Interop.SceneView.SetImageBasedLightScaleFactor(SwigCPtr, scaleFactor);
 469             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 470         }
 471
 472         /// <summary>
 473         /// Get the ImageBasedLight ScaleFactor.
 474         /// </summary>
 475         /// <returns>ImageBasedLightScaleFactor that controls light source intensity.</returns>
 476         private float GetImageBasedLightScaleFactor()
 477         {
 478             float scaleFactor = Interop.SceneView.GetImageBasedLightScaleFactor(SwigCPtr);
 479             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 480             return scaleFactor;
 481         }
 482
 483         /// <summary>
 484         /// Set the Skybox from cube map image.
 485         /// Skybox texture is asynchronously loaded. When loading is finished, ResourcesLoaded is emitted.
 486         /// </summary>
 487         /// <param name="skyboxUrl">Cube map image url for skybox.</param>
 488         private void SetSkybox(string skyboxUrl)
 489         {
 490             this.skyboxUrl = skyboxUrl;
 491             Interop.SceneView.SetSkybox(SwigCPtr, skyboxUrl);
 492             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 493         }
 494
 495         /// <summary>
 496         /// Sets Skybox intensity.
 497         /// The skybox intensity is multiplied to the color of skybox texture.
 498         /// Default value is 1.0f.
 499         /// </summary>
 500         /// <param name="intensity">Intensity value to be multiplied to the cube map color.</param>
 501         private void SetSkyboxIntensity(float intensity)
 502         {
 503             Interop.SceneView.SetSkyboxIntensity(SwigCPtr, intensity);
 504             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 505         }
 506
 507         /// <summary>
 508         /// Gets Skybox intensity.
 509         /// Default value is 1.0f.
 510         /// </summary>
 511         /// <returns>skybox intensity.</returns>
 512         private float GetSkyboxIntensity()
 513         {
 514             float intensity = Interop.SceneView.GetSkyboxIntensity(SwigCPtr);
 515             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 516             return intensity;
 517         }
 518
 519         /// <summary>
 520         /// Sets orientation of the skybox.
 521         /// </summary>
 522         /// <param name="orientation">Rotation angle of the skybox along YAxis.</param>
 523         private void SetSkyboxOrientation(Rotation orientation)
 524         {
 525             Interop.SceneView.SetSkyboxOrientation(SwigCPtr, Rotation.getCPtr(orientation));
 526             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 527         }
 528
 529         /// <summary>
 530         /// Gets Skybox orientation.
 531         /// </summary>
 532         /// <returns>skybox orientation.</returns>
 533         private Rotation GetSkyboxOrientation()
 534         {
 535             global::System.IntPtr cPtr = Interop.SceneView.GetSkyboxOrientation(SwigCPtr);
 536             Rotation ret = (cPtr == global::System.IntPtr.Zero) ? null : new Rotation(cPtr, false);
 537             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 538             return ret;
 539         }
 540
 541         private void CameraTransition(Camera sourceCamera, Camera destinationCamera, int durationMilliSeconds, AlphaFunction alphaFunction)
 542         {
 543             inCameraTransition = true;
 544
 545             Position sourcePosition = sourceCamera.Position;
 546             Rotation sourceOrientation = sourceCamera.Orientation;
 547
 548             Position destinationPosition = destinationCamera.Position;
 549             Rotation destinationOrientation = destinationCamera.Orientation;
 550
 551             cameraTransition = new Animation(durationMilliSeconds);
 552
 553             KeyFrames positionKeyFrames = new KeyFrames();
 554             positionKeyFrames.Add(0.0f, sourcePosition);
 555             positionKeyFrames.Add(1.0f, destinationPosition);
 556
 557             KeyFrames orientationKeyFrames = new KeyFrames();
 558             orientationKeyFrames.Add(0.0f, sourceOrientation);
 559             orientationKeyFrames.Add(1.0f, destinationOrientation);
 560
 561             cameraTransition.AnimateBetween(destinationCamera, "Position", positionKeyFrames, Animation.Interpolation.Linear, alphaFunction);
 562             cameraTransition.AnimateBetween(destinationCamera, "Orientation", orientationKeyFrames, Animation.Interpolation.Linear, alphaFunction);
 563
 564             if(destinationCamera.ProjectionMode == Camera.ProjectionModeType.Perspective)
 565             {
 566                 Radian sourceFieldOfView = sourceCamera.FieldOfView;
 567                 Radian destinationFieldOfView = destinationCamera.FieldOfView;
 568
 569                 // If ProjectionDirection is not equal, match the value.
 570                 if (sourceCamera.ProjectionDirection != destinationCamera.ProjectionDirection)
 571                 {
 572                     float aspect = destinationCamera.AspectRatio;
 573                     if (destinationCamera.ProjectionDirection == Camera.ProjectionDirectionType.Vertical)
 574                     {
 575                         sourceFieldOfView = Camera.ConvertFovFromHorizontalToVertical(aspect, sourceFieldOfView);
 576                     }
 577                     else
 578                     {
 579                         sourceFieldOfView = Camera.ConvertFovFromVerticalToHorizontal(aspect, sourceFieldOfView);
 580                     }
 581                 }
 582
 583                 KeyFrames fieldOfViewKeyFrames = new KeyFrames();
 584                 fieldOfViewKeyFrames.Add(0.0f, sourceFieldOfView.ConvertToFloat());
 585                 fieldOfViewKeyFrames.Add(1.0f, destinationFieldOfView.ConvertToFloat());
 586                 cameraTransition.AnimateBetween(destinationCamera, "FieldOfView", fieldOfViewKeyFrames, Animation.Interpolation.Linear, alphaFunction);
 587
 588                 sourceFieldOfView.Dispose();
 589                 destinationFieldOfView.Dispose();
 590                 fieldOfViewKeyFrames.Dispose();
 591             }
 592             else
 593             {
 594                 float sourceOrthographicSize = sourceCamera.OrthographicSize;
 595                 float destinationOrthographicSize = destinationCamera.OrthographicSize;
 596
 597                 // If ProjectionDirection is not equal, match the value.
 598                 if (sourceCamera.ProjectionDirection != destinationCamera.ProjectionDirection)
 599                 {
 600                     float aspect = destinationCamera.AspectRatio;
 601                     if (destinationCamera.ProjectionDirection == Camera.ProjectionDirectionType.Vertical)
 602                     {
 603                         sourceOrthographicSize = sourceOrthographicSize / aspect;
 604                     }
 605                     else
 606                     {
 607                         sourceOrthographicSize = sourceOrthographicSize * aspect;
 608                     }
 609                 }
 610
 611                 KeyFrames orthographicSizeKeyFrames = new KeyFrames();
 612                 orthographicSizeKeyFrames.Add(0.0f, sourceOrthographicSize);
 613                 orthographicSizeKeyFrames.Add(1.0f, destinationOrthographicSize);
 614                 cameraTransition.AnimateBetween(destinationCamera, "OrthographicSize", orthographicSizeKeyFrames, Animation.Interpolation.Linear, alphaFunction);
 615
 616                 orthographicSizeKeyFrames.Dispose();
 617             }
 618
 619             float destinationNearPlaneDistance = destinationCamera.NearPlaneDistance;
 620             float destinationFarPlaneDistance = destinationCamera.FarPlaneDistance;
 621             destinationCamera.NearPlaneDistance = Math.Min(sourceCamera.NearPlaneDistance, destinationCamera.NearPlaneDistance);
 622             destinationCamera.FarPlaneDistance = Math.Max(sourceCamera.FarPlaneDistance, destinationCamera.FarPlaneDistance);
 623
 624             cameraTransition.Finished += (s, e) =>
 625             {
 626                 this.GetSelectedCamera().NearPlaneDistance = destinationNearPlaneDistance;
 627                 this.GetSelectedCamera().FarPlaneDistance = destinationFarPlaneDistance;
 628                 inCameraTransition = false;
 629                 CameraTransitionFinished?.Invoke(this, EventArgs.Empty);
 630             };
 631             cameraTransition.Play();
 632
 633             positionKeyFrames.Dispose();
 634             orientationKeyFrames.Dispose();
 635         }
 636
 637         /// <summary>
 638         /// Release swigCPtr.
 639         /// </summary>
 640         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
 641         [EditorBrowsable(EditorBrowsableState.Never)]
 642         protected override void ReleaseSwigCPtr(global::System.Runtime.InteropServices.HandleRef swigCPtr)
 643         {
 644             Interop.SceneView.DeleteScene(swigCPtr);
 645         }
 646     }
 647 }