Class Model

View Source

Definition

Namespace:
Tizen.NUI.Scene3D
Assembly:
Tizen.NUI.Scene3D.dll
API Level:
10

Model is a Class to show 3D mesh objects. Model supports glTF 2.0 and DLI model formats. Physically Based Rendering with Image Based Lighting is also supported.


                
C#

                

                    
Copy

                    

                

            
public class Model : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
System.Object
BindableObject
Tizen.NUI.Binding.Element
BaseHandle
Animatable
Container
View
Model
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Remarks

Since NUI uses a left-handed coordinate system, loaded models are transformed into a left-handed coordinate system with Y pointing down. The Animations defined in the glTF or DLI are also loaded and can be retrieved by using GetAnimation(UInt32) and GetAnimation(String) methods. The number of animation is also retrieved by GetAnimationCount() method.

Model also supports Physically Based Rendering(PBR) with Image Based Lighting(IBL). For the IBL, two cube map textures(diffuse and specular) are required. Model supports 4 types layout for Cube Map: Vertical/Horizontal Cross layouts, and Vertical/Horizontal Array layouts. And also, ktx format with cube map is supported.

The model and IBL textures start to be loaded asynchronously when the Model object is on Window. ResourcesLoaded signal notifies that the loading of the model and IBL resources have been completed. If Model or IBL is requested to be loaded before the other loading is completed, the ResourcesLoaded signal is called after all resources are loaded. GetAnimation(UInt32) and GetAnimation(String) methods can be used after the model loading is finished.

By default, the loaded mesh has its own size and PivotPoint inferred from position of vertices. The PivotPoint can be modified after model loading is finished. If user set size property, the mesh will be scaled to the input size. Default value of ParentOrigin of the Model is Center.

Examples

                

                

                    
Copy

                    

                

            
Model model = new Model(modelUrl)
{
    Size = new Size(width, height),
};
model.ResourcesLoaded += (s, e) =>
{
    model.PivotPoint = new Vector3(0.5f, 0.5f, 0.5f); // Use center as a Pivot.

    int animationCount = model.GetAnimationCount();
    if(animationCount > 0)
    {
        // Play an Animation of index 0.
        model.GetAnimation(0).Play();
    }
};
model.SetImageBasedLightSource(diffuseUrl, specularUrl, scaleFactor);
window.Add(model);

Constructors

View Source

Model(String, String)

Create an initialized Model.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Model(string modelUrl, string resourceDirectoryUrl = "")
Parameters
Type Name Description
System.String modelUrl

model file url.(e.g. glTF, and DLI).
System.String resourceDirectoryUrl

The url to derectory containing resources: binary, image etc.
Remarks

If resourceDirectoryUrl is empty, the parent directory url of modelUrl is used for resource url.

http://tizen.org/privilege/mediastorage for local files in media storage. http://tizen.org/privilege/externalstorage for local files in external storage.

API Level: 10
View Source

Model(Model)

Copy constructor.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Model(Model model)
Parameters
Type Name Description
Model model

Source object to copy.
API Level: 10

Methods

View Source

Dispose(DisposeTypes)

To make transitionSet instance be disposed.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Overrides
View Source

GetAnimation(String)

Retrieves animation with the given name. Note: This method should be called after Model load finished.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Animation GetAnimation(string name)
Parameters
Type Name Description
System.String name

String name of animation to be retrieved.
Returns
Type Description
Animation

Animation that has the given name.
API Level: 10
View Source

GetAnimation(UInt32)

Gets animation at the index.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Animation GetAnimation(uint index)
Parameters
Type Name Description
System.UInt32 index

Index of animation to be retrieved.
Returns
Type Description
Animation

Animation at the index.
Remarks

This method should be called after Model load has been finished.

API Level: 10
View Source

GetAnimationCount()

Gets number of animations that has been loaded from model file.

Declaration

                
C#

                

                    
Copy

                    

                

            
public uint GetAnimationCount()
Returns
Type Description
System.UInt32

The number of loaded animations.
Remarks

This method should be called after Model load has been finished.

API Level: 10
View Source

SetImageBasedLightSource(String, String, Single)

Changes Image Based Light according to the given input textures.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetImageBasedLightSource(string diffuseUrl, string specularUrl, float scaleFactor = 1F)
Parameters
Type Name Description
System.String diffuseUrl

The path of Cube map image that will be used as a diffuse IBL source.
System.String specularUrl

The path of Cube map image that will be used as a specular IBL source.
System.Single scaleFactor

Scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.
Remarks

http://tizen.org/privilege/mediastorage for local files in media storage. http://tizen.org/privilege/externalstorage for local files in external storage.

API Level: 10

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable