Class GLTFLoader

_babylonLights

Static ReadonlyDefaultSampler

babylonScene

• get babylonScene(): Scene

  The Babylon scene when loading the asset.

  Returns Scene

bin

• get bin(): Nullable<IDataBuffer>

  The BIN chunk of a binary glTF.

  Returns Nullable<IDataBuffer>

gltf

• get gltf(): IGLTF

  The object that represents the glTF JSON.

  Returns IGLTF

parent

• get parent(): GLTFFileLoader

  The parent file loader.

  Returns GLTFFileLoader

rootBabylonMesh

• get rootBabylonMesh(): Nullable<TransformNode>

  The root Babylon node when loading the asset.

  Returns Nullable<TransformNode>

rootUrl

• get rootUrl(): Nullable<string>

  The root url when loading the asset.

  Returns Nullable<string>

createMaterial

• createMaterial(
      context: string,
      material: IMaterial,
      babylonDrawMode: number,
  ): Material

  Creates a Babylon material from a glTF material.

  Parameters

  • context: string

    The context when loading the asset

  • material: IMaterial

    The glTF material property

  • babylonDrawMode: number

    The draw mode for the Babylon material

  Returns Material

  The Babylon material

endPerformanceCounter

• endPerformanceCounter(counterName: string): void

  Ends a performance counter.

  Parameters

  • counterName: string

    The name of the performance counter

  Returns void

isExtensionUsed

• isExtensionUsed(name: string): boolean

  Checks for presence of an extension.

  Parameters

  • name: string

    The name of the extension to check

  Returns boolean

  A boolean indicating the presence of the given extension name in extensionsUsed

isMatchingMaterialType

• isMatchingMaterialType(material: Nullable<Material>): boolean

  Test if the given material is an instance of any PBR material type known to this loader.

  Parameters

  • material: Nullable<Material>

    The material to test

  Returns boolean

  true if the material matches one of the loaded PBR implementations

loadAnimationAsync

• loadAnimationAsync(
      context: string,
      animation: IAnimation,
  ): Promise<AnimationGroup>

  Loads a glTF animation.

  Parameters

  • context: string

    The context when loading the asset

  • animation: IAnimation

    The glTF animation property

  Returns Promise<AnimationGroup>

  A promise that resolves with the loaded Babylon animation group when the load is complete

loadBufferAsync

• loadBufferAsync(
      context: string,
      buffer: IBuffer,
      byteOffset: number,
      byteLength: number,
  ): Promise<ArrayBufferView<ArrayBufferLike>>

  Loads a glTF buffer.

  Parameters

  • context: string

    The context when loading the asset

  • buffer: IBuffer

    The glTF buffer property

  • byteOffset: number

    The byte offset to use

  • byteLength: number

    The byte length to use

  Returns Promise<ArrayBufferView<ArrayBufferLike>>

  A promise that resolves with the loaded data when the load is complete

loadBufferViewAsync

• loadBufferViewAsync(
      context: string,
      bufferView: IBufferView,
  ): Promise<ArrayBufferView<ArrayBufferLike>>

  Loads a glTF buffer view.

  Parameters

  • context: string

    The context when loading the asset

  • bufferView: IBufferView

    The glTF buffer view property

  Returns Promise<ArrayBufferView<ArrayBufferLike>>

  A promise that resolves with the loaded data when the load is complete

loadCameraAsync

• loadCameraAsync(
      context: string,
      camera: ICamera,
      assign?: (babylonCamera: Camera) => void,
  ): Promise<Camera>

  Loads a glTF camera.

  Parameters

  • context: string

    The context when loading the asset

  • camera: ICamera

    The glTF camera property

  • assign: (babylonCamera: Camera) => void = ...

    A function called synchronously after parsing the glTF properties

  Returns Promise<Camera>

  A promise that resolves with the loaded Babylon camera when the load is complete

loadImageAsync

• loadImageAsync(
      context: string,
      image: GLTF2.IImage,
  ): Promise<ArrayBufferView<ArrayBufferLike>>

  Loads a glTF image.

  Parameters

  • context: string

    The context when loading the asset

  • image: GLTF2.IImage

    The glTF image property

  Returns Promise<ArrayBufferView<ArrayBufferLike>>

  A promise that resolves with the loaded data when the load is complete

loadMaterialAlphaProperties

• loadMaterialAlphaProperties(
      context: string,
      material: IMaterial,
      babylonMaterial: Material,
  ): void

  Loads the alpha properties from a glTF material into a Babylon material. Must be called after the setting the albedo texture of the Babylon material when the material has an albedo texture.

  Parameters

  • context: string

    The context when loading the asset

  • material: IMaterial

    The glTF material property

  • babylonMaterial: Material

    The Babylon material

  Returns void

loadMaterialBasePropertiesAsync

• loadMaterialBasePropertiesAsync(
      context: string,
      material: IMaterial,
      babylonMaterial: Material,
  ): Promise<void>

  Loads the normal, occlusion, and emissive properties from a glTF material into a Babylon material.

  Parameters

  • context: string

    The context when loading the asset

  • material: IMaterial

    The glTF material property

  • babylonMaterial: Material

    The Babylon material

  Returns Promise<void>

  A promise that resolves when the load is complete

loadMaterialPropertiesAsync

• loadMaterialPropertiesAsync(
      context: string,
      material: IMaterial,
      babylonMaterial: Material,
  ): Promise<void>

  Loads properties from a glTF material into a Babylon material.

  Parameters

  • context: string

    The context when loading the asset

  • material: IMaterial

    The glTF material property

  • babylonMaterial: Material

    The Babylon material

  Returns Promise<void>

  A promise that resolves when the load is complete

loadNodeAsync

• loadNodeAsync(
      context: string,
      node: GLTF2.INode,
      assign?: (babylonTransformNode: TransformNode) => void,
  ): Promise<TransformNode>

  Loads a glTF node.

  Parameters

  • context: string

    The context when loading the asset

  • node: GLTF2.INode

    The glTF node property

  • assign: (babylonTransformNode: TransformNode) => void = ...

    A function called synchronously after parsing the glTF properties

  Returns Promise<TransformNode>

  A promise that resolves with the loaded Babylon mesh when the load is complete

loadSceneAsync

• loadSceneAsync(context: string, scene: IScene): Promise<void>

  Loads a glTF scene.

  Parameters

  • context: string

    The context when loading the asset

  • scene: IScene

    The glTF scene property

  Returns Promise<void>

  A promise that resolves when the load is complete

loadTextureInfoAsync

• loadTextureInfoAsync(
      context: string,
      textureInfo: ITextureInfo,
      assign?: (babylonTexture: BaseTexture) => void,
  ): Promise<BaseTexture>

  Loads a glTF texture info.

  Parameters

  • context: string

    The context when loading the asset

  • textureInfo: ITextureInfo

    The glTF texture info property

  • assign: (babylonTexture: BaseTexture) => void = ...

    A function called synchronously after parsing the glTF properties

  Returns Promise<BaseTexture>

  A promise that resolves with the loaded Babylon texture when the load is complete

loadUriAsync

• loadUriAsync(
      context: string,
      property: IProperty,
      uri: string,
  ): Promise<ArrayBufferView<ArrayBufferLike>>

  Loads a glTF uri.

  Parameters

  • context: string

    The context when loading the asset

  • property: IProperty

    The glTF property associated with the uri

  • uri: string

    The base64 or relative uri

  Returns Promise<ArrayBufferView<ArrayBufferLike>>

  A promise that resolves with the loaded data when the load is complete

log

• log(message: string): void

  Logs a message

  Parameters

  • message: string

    The message to log

  Returns void

logClose

• logClose(): void

  Decrements the indentation level.

  Returns void

logOpen

• logOpen(message: string): void

  Increments the indentation level and logs a message.

  Parameters

  • message: string

    The message to log

  Returns void

startPerformanceCounter

• startPerformanceCounter(counterName: string): void

  Starts a performance counter.

  Parameters

  • counterName: string

    The name of the performance counter

  Returns void

StaticAddPointerMetadata

• AddPointerMetadata(babylonObject: IWithMetadata, pointer: string): void

  Adds a JSON pointer to the _internalMetadata of the Babylon object at <object>._internalMetadata.gltf.pointers.

  Parameters

  • babylonObject: IWithMetadata

    the Babylon object with _internalMetadata

  • pointer: string

    the JSON pointer

  Returns void

StaticLoadExtensionAsync

• LoadExtensionAsync<TExtension = unknown, TResult = void>(
      context: string,
      property: IProperty,
      extensionName: string,
      actionAsync: (
          extensionContext: string,
          extension: TExtension,
      ) => Nullable<Promise<TResult>>,
  ): Nullable<Promise<TResult>>

  Helper method called by a loader extension to load an glTF extension.

  Type Parameters

  • TExtension = unknown
  • TResult = void

  Parameters

  • context: string

    The context when loading the asset

  • property: IProperty

    The glTF property to load the extension from

  • extensionName: string

    The name of the extension to load

  • actionAsync: (extensionContext: string, extension: TExtension) => Nullable<Promise<TResult>>

    The action to run

  Returns Nullable<Promise<TResult>>

  The promise returned by actionAsync or null if the extension does not exist

StaticLoadExtraAsync

• LoadExtraAsync<TExtra = unknown, TResult = void>(
      context: string,
      property: IProperty,
      extensionName: string,
      actionAsync: (
          extraContext: string,
          extra: TExtra,
      ) => Nullable<Promise<TResult>>,
  ): Nullable<Promise<TResult>>

  Helper method called by a loader extension to load a glTF extra.

  Type Parameters

  • TExtra = unknown
  • TResult = void

  Parameters

  • context: string

    The context when loading the asset

  • property: IProperty

    The glTF property to load the extra from

  • extensionName: string

    The name of the extension to load

  • actionAsync: (extraContext: string, extra: TExtra) => Nullable<Promise<TResult>>

    The action to run

  Returns Nullable<Promise<TResult>>

  The promise returned by actionAsync or null if the extra does not exist

StaticRegisterExtension

• RegisterExtension(name: string, factory: GLTFExtensionFactory): void

  Registers a loader extension.

  Parameters

  • name: string

    The name of the loader extension.

  • factory: GLTFExtensionFactory

    The factory function that creates the loader extension.

  Returns void

  Deprecated

  Please use registerGLTFExtension instead.

StaticUnregisterExtension

• UnregisterExtension(name: string): boolean

  Unregisters a loader extension.

  Parameters

  • name: string

    The name of the loader extension.

  Returns boolean

  A boolean indicating whether the extension has been unregistered

  Deprecated

  Please use unregisterGLTFExtension instead.