Class GltfLoader

Loader for glTF 2.0 assets (.gltf and .glb).

Hierarchy (View Summary)

AbstractLoader<Object3D>
- GltfLoader

Index

Constructors

Properties

Methods

addEventListener dispatchEvent load removeEventListener setBasePath getFolderPath

Constructors

constructor

new GltfLoader(options?: LoaderOptions): GltfLoader
Parameters
- options: LoaderOptions = {}
Returns GltfLoader
Overrides AbstractLoader.constructor
- Defined in loaders/GltfLoader.ts:70

Properties

basePath

basePath: string = ""

The base path for resource URLs.

Methods

addEventListener

addEventListener(type: string, listener: EventHandler): void
Registers an event listener.
Parameters
- type: string
  The event type.
- listener: EventHandler
  The callback function.
Returns void
Inherited from AbstractLoader.addEventListener
- Defined in loaders/AbstractLoader.ts:33

dispatchEvent

dispatchEvent(type: string, eventData?: Record<string, unknown>): void
Dispatches an event.
Parameters
- type: string
  The event type.
- eventData: Record<string, unknown> = {}
  Optional data associated with the event.
Returns void
Inherited from AbstractLoader.dispatchEvent
- Defined in loaders/AbstractLoader.ts:43

load

load(url: string): Promise<Object3D>
Loads a resource from the given URL.
Parameters
- url: string
  The relative URL to the resource.
Returns Promise<Object3D>
A promise resolving to the loaded resource.
Overrides AbstractLoader.load
- Defined in loaders/GltfLoader.ts:74

removeEventListener

removeEventListener(type: string, listener: EventHandler): void
Removes a registered event listener.
Parameters
- type: string
  The event type.
- listener: EventHandler
  The callback function to remove.
Returns void
Inherited from AbstractLoader.removeEventListener
- Defined in loaders/AbstractLoader.ts:38

setBasePath

setBasePath(path: string): this
Sets the base path for the loader.
Parameters
- path: string
  The base path string.
Returns this
this
Inherited from AbstractLoader.setBasePath
- Defined in loaders/AbstractLoader.ts:27

`Protected` `Static`getFolderPath

getFolderPath(url: string): string
Derives the folder path (everything up to and including the last /) from a URL, so sibling resources (materials, textures, buffers) can be resolved relative to it.
Parameters
- url: string
  The URL to derive the folder path from.
Returns string
The folder path, including a trailing slash.
Inherited from AbstractLoader.getFolderPath
- Defined in loaders/AbstractLoader.ts:61