@zappar/zappar-threejs
Options
All
  • Public
  • Public/Protected
  • All
Menu

Loader for library itself. This library uses some additional resources (e.g web workers and WebAssembly) - this loader resolves once the library has fully loaded these resources. If you're using the LoadingManager included in this library you don't need to explicitly use this yourself as one is automatically created.

Hierarchy

  • Loader
    • LibraryLoader

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional manager: LoadingManager

    Returns LibraryLoader

Properties

crossOrigin

crossOrigin: string
default

'anonymous'

manager

manager: LoadingManager

path

path: string
default

''

requestHeader

requestHeader: {}
default

{}

Type declaration

  • [header: string]: string

resourcePath

resourcePath: string
default

''

withCredentials

withCredentials: boolean
default:

false

Methods

load

  • load(onLoad?: () => void, onProgress?: () => void, onError?: () => void): void

  • Resolves once the library is loaded and ready to process data.

    Parameters

    • Optional onLoad: () => void

      Callback which runs once the library is fully loaded.

        • (): void

        • Returns void

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

        • Returns void

    • Optional onError: () => void

      Callback which is called if there's an error loading library.

        • (): void

        • Returns void

    Returns void

loadAsync

  • loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<any>

  • Parameters

    • url: string
    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void
        • (event: ProgressEvent<EventTarget>): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<any>

setCrossOrigin

  • Parameters

    • crossOrigin: string

    Returns LibraryLoader

setPath

  • Parameters

    • path: string

    Returns LibraryLoader

setRequestHeader

  • Parameters

    • requestHeader: {}
      • [header: string]: string

    Returns LibraryLoader

setResourcePath

  • Parameters

    • resourcePath: string

    Returns LibraryLoader

setWithCredentials

  • Parameters

    • value: boolean

    Returns LibraryLoader

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property

Generated using TypeDoc