Class GltfAssetBase

Base component for code-less loading of glTF files

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
GltfAssetBase
GltfAsset
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: GLTFast
Assembly: glTFast.dll
Syntax
public abstract class GltfAssetBase : MonoBehaviour

Properties

CurrentSceneId

Scene ID of the recently instantiated scene. Null if there was no scene instantiated (successfully).

Declaration
public int? CurrentSceneId { get; protected set; }
Property Value
Type Description
int?

ImportSettings

glTF import settings

Declaration
public ImportSettings ImportSettings { get; set; }
Property Value
Type Description
ImportSettings

Importer

Instance used for loading the glTF's content

Declaration
public GltfImport Importer { get; protected set; }
Property Value
Type Description
GltfImport

IsDone

Indicates whether the glTF was loaded (no matter if successfully or not)

Declaration
public bool IsDone { get; }
Property Value
Type Description
bool

True when loading routine ended, false otherwise.

SceneCount

Number of scenes loaded

Declaration
public int SceneCount { get; }
Property Value
Type Description
int

SceneNames

Array of scenes' names (entries can be null, if not specified)

Declaration
public string[] SceneNames { get; }
Property Value
Type Description
string[]

Methods

ClearScenes()

Removes previously instantiated scene(s)

Declaration
public abstract void ClearScenes()

Dispose()

Releases previously allocated resources.

Declaration
public void Dispose()

GetDefaultInstantiator(ICodeLogger)

Returns an instance of the default instantiator

Declaration
protected abstract IInstantiator GetDefaultInstantiator(ICodeLogger logger)
Parameters
Type Name Description
ICodeLogger logger

Custom logger to use with the instantiator
Returns
Type Description
IInstantiator

Default instantiator instance

GetMaterial(int)

Returns an imported glTF material. Note: Asset has to have finished loading before!

Declaration
public Material GetMaterial(int index = 0)
Parameters
Type Name Description
int index

Index of material in glTF file.
Returns
Type Description
Material

glTF material if it was loaded successfully and index is correct, null otherwise.

Instantiate(ICodeLogger)

Creates an instance of the main scene

Declaration
public Task<bool> Instantiate(ICodeLogger logger = null)
Parameters
Type Name Description
ICodeLogger logger

Used for message reporting
Returns
Type Description
Task<bool>

True if instantiation was successful.

InstantiateScene(int, GameObjectInstantiator)

Creates an instance of the scene specified by the scene index.

Declaration
protected Task<bool> InstantiateScene(int sceneIndex, GameObjectInstantiator instantiator)
Parameters
Type Name Description
int sceneIndex

Index of the scene to be instantiated
GameObjectInstantiator instantiator

Receives scene construction calls
Returns
Type Description
Task<bool>

True if instantiation was successful.

InstantiateScene(int, ICodeLogger)

Creates an instance of the scene specified by the scene index.

Declaration
public virtual Task<bool> InstantiateScene(int sceneIndex, ICodeLogger logger = null)
Parameters
Type Name Description
int sceneIndex

Index of the scene to be instantiated
ICodeLogger logger

Used for message reporting
Returns
Type Description
Task<bool>

True if instantiation was successful.

Load(string, IDownloadProvider, IDeferAgent, IMaterialGenerator, ICodeLogger)

Method for manual loading with custom IDownloadProvider and IDeferAgent.

Declaration
public virtual Task<bool> Load(string gltfUrl, IDownloadProvider downloadProvider = null, IDeferAgent deferAgent = null, IMaterialGenerator materialGenerator = null, ICodeLogger logger = null)
Parameters
Type Name Description
string gltfUrl

URL of the glTF file.
IDownloadProvider downloadProvider

Download Provider for custom loading (e.g. caching or HTTP authorization)
IDeferAgent deferAgent

Defer Agent takes care of interrupting the loading procedure in order to keep the frame rate responsive.
IMaterialGenerator materialGenerator

Used to convert glTF materials to Material instances
ICodeLogger logger

Used for message reporting
Returns
Type Description
Task<bool>

Async Task that loads the glTF's contents

OnDestroy()

Called before GameObject is destroyed

Declaration
protected virtual void OnDestroy()

PostInstantiation(IInstantiator, bool)

Callback that is called after instantiation

Declaration
protected virtual void PostInstantiation(IInstantiator instantiator, bool success)
Parameters
Type Name Description
IInstantiator instantiator

instantiator that was used
bool success

True if instantiation was successful, false otherwise