• Public
  • Public/Protected
  • All

Interface ISceneLoaderPluginBase

Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync




extensionsSearch playground for extensions

extensions: string | ISceneLoaderPluginExtensions

The file extensions supported by this plugin.

nameSearch playground for name

name: string

The friendly name of this plugin.


Optional canDirectLoadSearch playground for canDirectLoad

  • canDirectLoad(data: string): boolean
  • The callback that returns true if the data can be directly loaded.


    • data: string

      string containing the file data

    Returns boolean

    if the data can be loaded directly

Optional directLoadSearch playground for directLoad

  • directLoad(scene: Scene, data: string): any
  • The callback that returns the data to pass to the plugin if the data can be directly loaded.


    • scene: Scene

      scene loading this data

    • data: string

      string containing the data

    Returns any

    data to pass to the plugin

Optional loadFileSearch playground for loadFile

  • loadFile(scene: Scene, fileOrUrl: File | string, onSuccess: (data: any, responseURL?: string) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest
  • The callback called when loading from a url.


    • scene: Scene

      scene loading this url

    • fileOrUrl: File | string

      file or url to load

    • onSuccess: (data: any, responseURL?: string) => void

      callback called when the file successfully loads

        • (data: any, responseURL?: string): void
        • Parameters

          • data: any
          • Optional responseURL: string

          Returns void

    • Optional onProgress: (ev: ISceneLoaderProgressEvent) => void

      callback called while file is loading (if the server supports this mode)

    • Optional useArrayBuffer: boolean

      defines a boolean indicating that date must be returned as ArrayBuffer

    • Optional onError: (request?: WebRequest, exception?: LoadFileError) => void

      callback called when the file fails to load

        • (request?: WebRequest, exception?: LoadFileError): void
        • Parameters

          • Optional request: WebRequest
          • Optional exception: LoadFileError

          Returns void

    Returns IFileRequest

    a file request object

Optional rewriteRootURLSearch playground for rewriteRootURL

  • rewriteRootURL(rootUrl: string, responseURL?: string): string
  • The callback that allows custom handling of the root url based on the response url.


    • rootUrl: string

      the original root url

    • Optional responseURL: string

      the response url if available

    Returns string

    the new root url


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method