Class AcCmLoaderAbstract

Abstract base class for implementing resource loaders.

This class provides the common functionality and interface that all loaders must implement, including loading manager integration, path handling, and configuration options for cross-origin requests.

Example

class MyCustomLoader extends AcCmLoader {
  load(url: string, onLoad: (data: MyDataType) => void, onProgress?: AcCmLoaderProgressCallback, onError?: AcCmOnErrorCallback): void {
    // Implementation specific loading logic
    const fullUrl = this.resolveURL(url)
    // ... fetch and process data
    onLoad(processedData)
  }
}

Constructors

constructor

Properties

crossOrigin manager path requestHeader resourcePath withCredentials

Methods

load loadAsync parse setCrossOrigin setPath setRequestHeader setResourcePath setWithCredentials

Constructors

constructor

Properties

crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

manager

manager: AcCmLoadingManager

path

path: string

The base path from which the asset will be loaded. Default is the empty string.

requestHeader

requestHeader: HeadersInit

The request header used in HTTP request.

resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. Default is false.

Methods

Abstractload

  • load(
        url: string,
        onLoad?: (data: unknown) => void,
        onProgress?: AcCmLoaderProgressCallback,
        onError?: AcCmOnErrorCallback,
    ): void

  • This method needs to be implement by all concrete loaders. It holds the logic for loading the asset from the backend.

    Parameters

    • url: string

      The path or URL to the file. This can also be a Data URI.

    • OptionalonLoad: (data: unknown) => void

      (optional) — Will be called when loading completes.

    • OptionalonProgress: AcCmLoaderProgressCallback

      (optional) — Will be called while load progresses.

    • OptionalonError: AcCmOnErrorCallback

      (optional) — Will be called if an error occurs.

    Returns void

loadAsync

  • loadAsync(url: string, onProgress: AcCmLoaderProgressCallback): Promise<unknown>

  • This method is equivalent to 'load', but returns a Promise.

    Parameters

    • url: string

      A string containing the path/URL of the file to be loaded.

    • onProgress: AcCmLoaderProgressCallback

      (optional) — A function to be called while the loading is in progress. The argument will be the ProgressEvent instance, which contains .lengthComputable, .total and .loaded. If the server does not set the Content-Length header; .total will be 0.

    Returns Promise<unknown>

    Return a promise.

parse

setCrossOrigin

setPath

setRequestHeader

  • setRequestHeader(requestHeader: HeadersInit): AcCmLoader

  • Set the request header used in HTTP request.

    Parameters

    • requestHeader: HeadersInit

      key: The name of the header whose value is to be set. value: The value to set as the body of the header.

    Returns AcCmLoader

    Return this object

setResourcePath

setWithCredentials

  • setWithCredentials(value: boolean): AcCmLoader

  • Set whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. Note that this has no effect if you are loading files locally or from the same domain.

    Parameters

    • value: boolean

      The flag whether the XMLHttpRequest uses credentials.

    Returns AcCmLoader

    Return this object

Settings

Member Visibility

On This Page

Constructors
Properties
Methods