Class ObjectLoader

Base class for implementing loaders.

Hierarchy

Loader
- ObjectLoader

Constructors

constructor

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

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

requestHeader

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

Default

Type declaration

[header: string]: string

resourcePath

resourcePath: string

Default

withCredentials

withCredentials: boolean

@default: false

Methods

load

load(url: string, onLoad?: (<ObjectType>(object: ObjectType) => void), onProgress?: ((event: ProgressEvent<EventTarget>) => void), onError?: ((event: Error | ErrorEvent) => void)): void
Parameters
- url: string
- Optional onLoad: (<ObjectType>(object: ObjectType) => void)
  - - <ObjectType>(object: ObjectType): void
    - Type Parameters
      
      ObjectType extends Object3D<Event, ObjectType>
      
      Parameters
      
      object: ObjectType
      
      Returns void
- Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
- Optional onError: ((event: Error | ErrorEvent) => void)
  - - (event: Error | ErrorEvent): void
    - Parameters
      
      event: Error | ErrorEvent
      
      Returns void
Returns void
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:13

loadAsync

loadAsync<ObjectType>(url: string, onProgress?: ((event: ProgressEvent<EventTarget>) => void)): Promise<ObjectType>
Type Parameters
- ObjectType extends Object3D<Event, ObjectType>
Parameters
- url: string
- Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<ObjectType>
Overrides Loader.loadAsync
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:20

parse

parse<T>(json: any, onLoad?: ((object: Object3D<Event>) => void)): T
Type Parameters
- T extends Object3D<Event, T>
Parameters
- json: any
- Optional onLoad: ((object: Object3D<Event>) => void)
  - - (object: Object3D<Event>): void
    - Parameters
      
      object: Object3D<Event>
      
      Returns void
Returns T
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:26

parseAnimations

parseAnimations(json: any): AnimationClip[]
Parameters
- json: any
Returns AnimationClip[]
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:31

parseAsync

parseAsync<T>(json: any): Promise<T>
Type Parameters
- T extends Object3D<Event, T>
Parameters
- json: any
Returns Promise<T>
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:28

parseGeometries

parseGeometries(json: any): {
[key: string]: InstancedBufferGeometry | BufferGeometry;
}
Parameters
- json: any
Returns {
[key: string]: InstancedBufferGeometry | BufferGeometry;
}
- [key: string]: InstancedBufferGeometry | BufferGeometry
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:29

parseImages

parseImages(json: any, onLoad: (() => void)): {
[key: string]: HTMLImageElement;
}
Parameters
- json: any
- onLoad: (() => void)
  - - (): void
    - Returns void
Returns {
[key: string]: HTMLImageElement;
}
- [key: string]: HTMLImageElement
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:32

parseImagesAsync

parseImagesAsync(json: any): Promise<{
[key: string]: HTMLImageElement;
}>
Parameters
- json: any
Returns Promise<{
[key: string]: HTMLImageElement;
}>
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:33

parseMaterials

parseMaterials(json: any, textures: Texture[]): THREE.Material[]
Parameters
- json: any
- textures: Texture[]
Returns THREE.Material[]
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:30

parseObject

parseObject<T>(data: any, geometries: any[], materials: THREE.Material[], animations: AnimationClip[]): T
Type Parameters
- T extends Object3D<Event, T>
Parameters
- data: any
- geometries: any[]
- materials: THREE.Material[]
- animations: AnimationClip[]
Returns T
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:35

parseTextures

parseTextures(json: any, images: any): Texture[]
Parameters
- json: any
- images: any
Returns Texture[]
- Defined in node_modules/@types/three/src/loaders/ObjectLoader.d.ts:34

setCrossOrigin

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

setPath

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

setRequestHeader

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

setResourcePath

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

setWithCredentials

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

Class ObjectLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: LoadingManager

Returns ObjectLoader

Properties

crossOrigin

Default

manager

path

Default

requestHeader

Default

Type declaration

[header: string]: string

resourcePath

Default

withCredentials

Methods

load

Parameters

url: string

Optional onLoad: (<ObjectType>(object: ObjectType) => void)

Type Parameters

ObjectType extends Object3D<Event, ObjectType>

Parameters

object: ObjectType

Returns void

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

Parameters

event: ProgressEvent<EventTarget>

Returns void

Optional onError: ((event: Error | ErrorEvent) => void)

Parameters

event: Error | ErrorEvent

Returns void

Returns void

loadAsync

Type Parameters

ObjectType extends Object3D<Event, ObjectType>

Parameters

url: string

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

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<ObjectType>

parse

Type Parameters

T extends Object3D<Event, T>

Parameters

json: any

Optional onLoad: ((object: Object3D<Event>) => void)

Parameters

object: Object3D<Event>

Returns void

Returns T

parseAnimations

Parameters

json: any

Returns AnimationClip[]

parseAsync

Type Parameters

T extends Object3D<Event, T>

Parameters

json: any

Returns Promise<T>

parseGeometries

Parameters

json: any

Returns { [key: string]: InstancedBufferGeometry | BufferGeometry; }

[key: string]: InstancedBufferGeometry | BufferGeometry

parseImages

Parameters

`Optional` manager: LoadingManager

`Optional` onLoad: (<ObjectType>(object: ObjectType) => void)

`Optional` onProgress: ((event: ProgressEvent<EventTarget>) => void)

`Optional` onError: ((event: Error | ErrorEvent) => void)

`Optional` onProgress: ((event: ProgressEvent<EventTarget>) => void)

`Optional` onLoad: ((object: Object3D<Event>) => void)

Returns {
[key: string]: InstancedBufferGeometry | BufferGeometry;
}

Returns {
[key: string]: HTMLImageElement;
}

Returns Promise<{
[key: string]: HTMLImageElement;
}>

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