Class GLTFLoader

Asset loader for gl Transfer Format files.

Authors

Matthias Roming, HFU, 2022 | Jonas Plotzky, HFU, 2023

Index

Accessors

Methods

getAnimation getCamera getCameraByIndex getGraph getMaterial getMesh getNode getNodeByIndex getSkeleton getSkeletonByIndex getTexture loadResources toString LOAD

Accessors

name

get name(): string
Returns the glTF file name.

Returns string
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:235

Methods

getAnimation

getAnimation(_name): Promise<Animation>
Returns the first Animation with the given animation name.
Parameters
- _name: string
Returns Promise<Animation>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:485
getAnimation(_iAnimation): Promise<Animation>
Returns the Animation for the given animation index.
Parameters
- _iAnimation: number
Returns Promise<Animation>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:489

getCamera

getCamera(_name): Promise<ComponentCamera>
Returns the first ComponentCamera with the given camera name.
Parameters
- _name: string
Returns Promise<ComponentCamera>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:444

getCameraByIndex

getCameraByIndex(_iCamera): Promise<ComponentCamera>
Returns the ComponentCamera for the given camera index.
Parameters
- _iCamera: number
Returns Promise<ComponentCamera>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:454

getGraph

getGraph(_name?): Promise<Graph>
Returns a Graph for the given scene name or the default scene if no name is given.
Parameters
- Optional _name: string
Returns Promise<Graph>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:277
getGraph(_iScene?): Promise<Graph>
Returns a Graph for the given scene index or the default scene if no index is given.
Parameters
- Optional _iScene: number
Returns Promise<Graph>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:281

getMaterial

getMaterial(_name): Promise<Material>
Returns the first MaterialGLTF with the given material name.
Parameters
- _name: string
Returns Promise<Material>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:709
getMaterial(_iMaterial): Promise<Material>
Returns the Material for the given material index.
Parameters
- _iMaterial: number
Returns Promise<Material>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:713

getMesh

getMesh(_name, _iPrimitive?): Promise<Mesh>
Returns the first MeshGLTF with the given name.
Parameters
- _name: string
- Optional _iPrimitive: number
Returns Promise<Mesh>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:548
getMesh(_iMesh, _iPrimitive?): Promise<Mesh>
Returns the MeshGLTF for the given mesh index and primitive index.
Parameters
- _iMesh: number
- Optional _iPrimitive: number
Returns Promise<Mesh>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:552

getNode

getNode(_name): Promise<Node>
Returns the first Node with the given name.
Parameters
- _name: string
Returns Promise<Node>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:338

getNodeByIndex

getNodeByIndex(_iNode): Promise<Node>
Returns the Node for the given index.
Parameters
- _iNode: number
Returns Promise<Node>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:348

getSkeleton

getSkeleton(_name): Promise<ComponentSkeleton>
Returns the first ComponentSkeleton with the given skeleton name.
Parameters
- _name: string
Returns Promise<ComponentSkeleton>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:871

getSkeletonByIndex

getSkeletonByIndex(_iSkeleton): Promise<ComponentSkeleton>
Returns the ComponentSkeleton for the given skeleton index.
Parameters
- _iSkeleton: number
Returns Promise<ComponentSkeleton>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:881

getTexture

getTexture(_iTexture): Promise<Texture>
Returns the Texture for the given texture index.
Parameters
- _iTexture: number
Returns Promise<Texture>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:802

loadResources

loadResources<T>(_class): Promise<T[]>
Returns new instances of all resources of the given type.
Type Parameters
- T extends SerializableResourceExternal
Parameters
- _class: (new () => T)
  - - new (): T
    - Returns T
Returns Promise<T[]>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:242

toString

toString(): string
Returns string
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:913

`Static` LOAD

LOAD(_url, _registerResources?): Promise<GLTFLoader>
Returns a GLTFLoader instance for the given url or null if the url can't be resolved.
Parameters
- _url: string
- _registerResources: boolean = false
Returns Promise<GLTFLoader>
- Defined in Source/Core/Serialization/GLTF/GLTFLoader.ts:104

Class GLTFLoader

Authors

Index

Accessors

Methods

Accessors

name

Returns string

Methods

getAnimation

Parameters

Returns Promise<Animation>

Parameters

Returns Promise<Animation>

getCamera

Parameters

Returns Promise<ComponentCamera>

getCameraByIndex

Parameters

Returns Promise<ComponentCamera>

getGraph

Parameters

Returns Promise<Graph>

Parameters

Returns Promise<Graph>

getMaterial

Parameters

Returns Promise<Material>

Parameters

Returns Promise<Material>

getMesh

Parameters

Returns Promise<Mesh>

Parameters

Returns Promise<Mesh>

getNode

Parameters

Returns Promise<Node>

getNodeByIndex

Parameters

Returns Promise<Node>

getSkeleton

Parameters

Returns Promise<ComponentSkeleton>

getSkeletonByIndex

Parameters

Returns Promise<ComponentSkeleton>

getTexture

Parameters

Returns Promise<Texture>

loadResources

Type Parameters

Parameters

Returns T

Returns Promise<T[]>

toString

Returns string

Static LOAD

Parameters

Returns Promise<GLTFLoader>

Settings

Member Visibility

Theme

On This Page

`Static` LOAD