Class FileLoader

Base class for implementing loaders.

Hierarchy

Loader
- FileLoader

Index

Constructors

Properties

crossOrigin manager mimeType path requestHeader resourcePath responseType withCredentials

Methods

load loadAsync setCrossOrigin setMimeType setPath setRequestHeader setResourcePath setResponseType setWithCredentials

Constructors

constructor

new FileLoader(manager?: LoadingManager): FileLoader
Parameters
- Optional manager: LoadingManager
Returns FileLoader
Overrides Loader.constructor
- Defined in node_modules/@types/three/src/loaders/FileLoader.d.ts:5

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

mimeType

mimeType: MimeType

path

path: string

Default

''

requestHeader

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

Default

Type declaration

[header: string]: string

resourcePath

resourcePath: string

Default

''

responseType

responseType: string

withCredentials

withCredentials: boolean

@default: false

Methods

load

load(url: string, onLoad?: ((response: string | ArrayBuffer) => void), onProgress?: ((request: ProgressEvent<EventTarget>) => void), onError?: ((event: ErrorEvent) => void)): any
Parameters
- url: string
- Optional onLoad: ((response: string | ArrayBuffer) => void)
  - - (response: string | ArrayBuffer): void
    - Parameters
      
      response: string | ArrayBuffer
      
      Returns void
- Optional onProgress: ((request: ProgressEvent<EventTarget>) => void)
  - - (request: ProgressEvent<EventTarget>): void
    - Parameters
      
      request: ProgressEvent<EventTarget>
      
      Returns void
- Optional onError: ((event: ErrorEvent) => void)
  - - (event: ErrorEvent): void
    - Parameters
      
      event: ErrorEvent
      
      Returns void
Returns any
- Defined in node_modules/@types/three/src/loaders/FileLoader.d.ts:10

loadAsync

loadAsync(url: string, onProgress?: ((event: ProgressEvent<EventTarget>) => void)): Promise<string | ArrayBuffer>
Parameters
- url: string
- Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<string | ArrayBuffer>
Overrides Loader.loadAsync
- Defined in node_modules/@types/three/src/loaders/FileLoader.d.ts:16

setCrossOrigin

setCrossOrigin(crossOrigin: string): FileLoader
Parameters
- crossOrigin: string
Returns FileLoader
Inherited from Loader.setCrossOrigin
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:42

setMimeType

setMimeType(mimeType: MimeType): FileLoader
Parameters
- mimeType: MimeType
Returns FileLoader
- Defined in node_modules/@types/three/src/loaders/FileLoader.d.ts:17

setPath

setPath(path: string): FileLoader
Parameters
- path: string
Returns FileLoader
Inherited from Loader.setPath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:44

setRequestHeader

setRequestHeader(requestHeader: {
[header: string]: string;
}): FileLoader
Parameters
- requestHeader: {
  [header: string]: string;
  }
  - [header: string]: string
Returns FileLoader
Inherited from Loader.setRequestHeader
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:46

setResourcePath

setResourcePath(resourcePath: string): FileLoader
Parameters
- resourcePath: string
Returns FileLoader
Inherited from Loader.setResourcePath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:45

setResponseType

setResponseType(responseType: string): FileLoader
Parameters
- responseType: string
Returns FileLoader
- Defined in node_modules/@types/three/src/loaders/FileLoader.d.ts:18

setWithCredentials

setWithCredentials(value: boolean): FileLoader
Parameters
- value: boolean
Returns FileLoader
Inherited from Loader.setWithCredentials
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:43

Generated using TypeDoc