Class GltfLoader

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

Hierarchy (View Summary)

AbstractLoader<Object3D>
- GltfLoader

Index

Constructors

constructor

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

Properties

`Protected`_assetManager

_assetManager: AssetManager

The AssetManager this loader fetches/caches resources through. Private per instance unless options.assetManager was passed -- never the deprecated process-wide singleton.

`Protected`_gltfOptions

_gltfOptions: GltfLoaderOptions

basePath

basePath: string = ""

The base path for resource URLs.

Methods

`Protected`_parseMaterial

_parseMaterial(
    m: {
        alphaCutoff?: number;
        alphaMode?: "OPAQUE" | "MASK" | "BLEND";
        doubleSided?: boolean;
        emissiveFactor?: number[];
        emissiveTexture?: { index: number };
        extensions?: {
            KHR_materials_clearcoat?: {
                clearcoatFactor?: number;
                clearcoatNormalTexture?: { index: number; scale?: number };
                clearcoatRoughnessFactor?: number;
                clearcoatRoughnessTexture?: { index: number };
                clearcoatTexture?: { index: number };
            };
            KHR_materials_emissive_strength?: { emissiveStrength?: number };
            KHR_materials_ior?: { ior?: number };
            KHR_materials_sheen?: {
                sheenColorFactor?: number[];
                sheenColorTexture?: { index: number };
                sheenRoughnessFactor?: number;
                sheenRoughnessTexture?: { index: number };
            };
            KHR_materials_transmission?: {
                transmissionFactor?: number;
                transmissionTexture?: { index: number };
            };
            KHR_materials_volume?: {
                attenuationColor?: number[];
                attenuationDistance?: number;
                thicknessFactor?: number;
                thicknessTexture?: { index: number };
            };
            [key: string]: unknown;
        };
        normalTexture?: { index: number; scale?: number };
        occlusionTexture?: { index: number; strength?: number };
        pbrMetallicRoughness?: {
            baseColorFactor?: number[];
            baseColorTexture?: { index: number };
            metallicFactor?: number;
            metallicRoughnessTexture?: { index: number };
            roughnessFactor?: number;
        };
    },
    json: GltfJson,
    folderPath: string,
    buffers: ArrayBuffer[],
): Promise<StandardMaterial>
Parameters
- m: {
      alphaCutoff?: number;
      alphaMode?: "OPAQUE" | "MASK" | "BLEND";
      doubleSided?: boolean;
      emissiveFactor?: number[];
      emissiveTexture?: { index: number };
      extensions?: {
          KHR_materials_clearcoat?: {
              clearcoatFactor?: number;
              clearcoatNormalTexture?: { index: number; scale?: number };
              clearcoatRoughnessFactor?: number;
              clearcoatRoughnessTexture?: { index: number };
              clearcoatTexture?: { index: number };
          };
          KHR_materials_emissive_strength?: { emissiveStrength?: number };
          KHR_materials_ior?: { ior?: number };
          KHR_materials_sheen?: {
              sheenColorFactor?: number[];
              sheenColorTexture?: { index: number };
              sheenRoughnessFactor?: number;
              sheenRoughnessTexture?: { index: number };
          };
          KHR_materials_transmission?: {
              transmissionFactor?: number;
              transmissionTexture?: { index: number };
          };
          KHR_materials_volume?: {
              attenuationColor?: number[];
              attenuationDistance?: number;
              thicknessFactor?: number;
              thicknessTexture?: { index: number };
          };
          [key: string]: unknown;
      };
      normalTexture?: { index: number; scale?: number };
      occlusionTexture?: { index: number; strength?: number };
      pbrMetallicRoughness?: {
          baseColorFactor?: number[];
          baseColorTexture?: { index: number };
          metallicFactor?: number;
          metallicRoughnessTexture?: { index: number };
          roughnessFactor?: number;
      };
  }
- json: GltfJson
- folderPath: string
- buffers: ArrayBuffer[]
Returns Promise<StandardMaterial>
- Defined in loaders/GltfLoader.ts:333

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:40

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:50

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:36

loadAnimations

loadAnimations(url: string): Promise<AnimationClip[]>
Loads standalone animation clips from a .glb or .gltf file.
Parameters
- url: string
Returns Promise<AnimationClip[]>
- Defined in loaders/GltfLoader.ts:129

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:45

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:34

`Static`decodeDataUri

decodeDataUri(uri: string): ArrayBuffer
Decodes a data:...;base64,... URI into raw bytes -- public/static so callers that parse a glTF JSON document themselves (ProjectBinding, rather than load()/_loadJson()) can decode its embedded buffers before handing the document to _parse().
Parameters
- uri: string
Returns ArrayBuffer
- Defined in loaders/GltfLoader.ts:117

`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:68

Class GltfLoader

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GltfLoader

Properties

Protected_assetManager

Protected_gltfOptions

basePath

Methods

Protected_parseMaterial

Parameters

Returns Promise<StandardMaterial>

addEventListener

Parameters

Returns void

dispatchEvent

Parameters

Returns void

load

Parameters

Returns Promise<Object3D>

loadAnimations

Parameters

Returns Promise<AnimationClip[]>

removeEventListener

Parameters

Returns void

setBasePath

Parameters

Returns this

StaticdecodeDataUri

Parameters

Returns ArrayBuffer

Protected StaticgetFolderPath

Parameters

Returns string

Settings

On This Page

`Protected`_assetManager

`Protected`_gltfOptions

`Protected`_parseMaterial

`Static`decodeDataUri

`Protected` `Static`getFolderPath