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

A LoadingManager with a user friendly interface.

see

https://docs.zap.works/universal-ar/web-libraries/threejs/loading-manager/

Hierarchy

  • LoadingManager
    • LoadingManager

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LoadingManager(options?: { onError?: OnError; onLoad?: OnLoad; onProgress?: OnProgress; style?: LoaderStyle }): LoadingManager

  • Constructs a new LoadingManager.

    Parameters

    • Optional options: { onError?: OnError; onLoad?: OnLoad; onProgress?: OnProgress; style?: LoaderStyle }

      Styling may be defined here, as well as any event callbacks.

      • Optional onError?: OnError
      • Optional onLoad?: OnLoad
      • Optional onProgress?: OnProgress
      • Optional style?: LoaderStyle

    Returns LoadingManager

Properties

onError

onError: (url: string) => void

Will be called when item loading fails. The default is a function with empty body.

param

The url of the item that errored.

Type declaration

    • (url: string): void

    • Parameters

      • url: string

      Returns void

onLoad

onLoad: () => void

Will be called when all items finish loading. The default is a function with empty body.

Type declaration

    • (): void

    • Returns void

onProgress

onProgress: (url: string, loaded: number, total: number) => void

Will be called for each loaded item. The default is a function with empty body.

param

The url of the item just loaded.

param

The number of items already loaded so far.

param

The total amount of items to be loaded.

Type declaration

    • (url: string, loaded: number, total: number): void

    • Parameters

      • url: string
      • loaded: number
      • total: number

      Returns void

ui

ui: UI = ...

Methods

_onStart

  • _onStart(callback: Function): void

  • Calls provided function when loading begins.

    Parameters

    • callback: Function

      Function that is called when loading starts.

    Returns void

addHandler

  • Parameters

    • regex: RegExp
    • loader: Loader

    Returns LoadingManager

dispose

  • dispose(): void

getHandler

  • getHandler(file: string): null | Loader

  • Parameters

    • file: string

    Returns null | Loader

itemEnd

  • itemEnd(url: string): void

  • Parameters

    • url: string

    Returns void

itemError

  • itemError(url: string): void

  • Parameters

    • url: string

    Returns void

itemStart

  • itemStart(url: string): void

  • Parameters

    • url: string

    Returns void

removeHandler

  • Parameters

    • regex: RegExp

    Returns LoadingManager

resolveURL

  • resolveURL(url: string): string

  • Given a URL, uses the URL modifier callback (if any) and returns a resolved URL. If no URL modifier is set, returns the original URL.

    Parameters

    • url: string

      the url to load

    Returns string

setURLModifier

  • If provided, the callback will be passed each resource URL before a request is sent. The callback may return the original URL, or a new URL to override loading behavior. This behavior can be used to load assets from .ZIP files, drag-and-drop APIs, and Data URIs.

    Parameters

    • Optional callback: (url: string) => string

      URL modifier callback. Called with url argument, and must return resolvedURL.

        • (url: string): string

        • Parameters

          • url: string

          Returns string

    Returns LoadingManager

Legend

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

Generated using TypeDoc