Class ObjectLoader

Base class for implementing loaders.

Hierarchy (view full)

Loader<Object3D>
- ObjectLoader

Constructors

constructor

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

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

''

requestHeader

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

Type declaration

[header: string]: string

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

`Static` DEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

load

load(url, onLoad?, onProgress?, onError?): void
Parameters
- url: string
- Optional onLoad: ((data) => void)
  - - (data): void
    - Parameters
      data: Object3D<Object3DEventMap>
      Returns void
- Optional onProgress: ((event) => void)
  - - (event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: ((err) => void)
  - - (err): void
    - Parameters
      err: unknown
      Returns void
Returns void
Overrides Loader.load
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:14

loadAsync

loadAsync(url, onProgress?): Promise<Object3D<Object3DEventMap>>
Parameters
- url: string
- Optional onProgress: ((event) => void)
  - - (event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
Returns Promise<Object3D<Object3DEventMap>>
Inherited from Loader.loadAsync
- Defined in ../node_modules/@types/three/src/loaders/Loader.d.ts:41

parse

parse(json, onLoad?): Object3D<Object3DEventMap>
Parameters
- json: unknown
- Optional onLoad: ((object) => void)
  - - (object): void
    - Parameters
      object: Object3D<Object3DEventMap>
      Returns void
Returns Object3D<Object3DEventMap>
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:21

parseAnimations

parseAnimations(json): {
[key: string]: AnimationClip;
}
Parameters
- json: unknown
Returns {
[key: string]: AnimationClip;
}
- [key: string]: AnimationClip
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:25

parseAsync

parseAsync(json): Promise<Object3D<Object3DEventMap>>
Parameters
- json: unknown
Returns Promise<Object3D<Object3DEventMap>>
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:22

parseGeometries

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

parseImages

parseImages(json, onLoad?): {
[key: string]: external.three.Source;
}
Parameters
- json: unknown
- Optional onLoad: (() => void)
  - - (): void
    - Returns void
Returns {
[key: string]: external.three.Source;
}
- [key: string]: external.three.Source
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:26

parseImagesAsync

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

parseMaterials

parseMaterials(json, textures): {
[key: string]: Material;
}
Parameters
- json: unknown
- textures: {
  [key: string]: Texture;
  }
  - [key: string]: Texture
Returns {
[key: string]: Material;
}
- [key: string]: Material
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:24

parseObject

parseObject(data, geometries, materials, animations): Object3D<Object3DEventMap>
Parameters
- data: unknown
- geometries: {
  [key: string]: InstancedBufferGeometry | BufferGeometry;
  }
  - [key: string]: InstancedBufferGeometry | BufferGeometry
- materials: {
  [key: string]: Material;
  }
  - [key: string]: Material
- animations: {
  [key: string]: AnimationClip;
  }
  - [key: string]: AnimationClip
Returns Object3D<Object3DEventMap>
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:29

parseTextures

parseTextures(json, images): {
[key: string]: Texture;
}
Parameters
- json: unknown
- images: {
  [key: string]: external.three.Source;
  }
  - [key: string]: external.three.Source
Returns {
[key: string]: Texture;
}
- [key: string]: Texture
- Defined in ../node_modules/@types/three/src/loaders/ObjectLoader.d.ts:28

setCrossOrigin

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

setPath

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

setRequestHeader

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

setResourcePath

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

setWithCredentials

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

Class ObjectLoader

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ObjectLoader

Properties

crossOrigin

Default

manager

path

Default

requestHeader

Type declaration

[header: string]: string

Default

resourcePath

Default

withCredentials

Default

Static DEFAULT_MATERIAL_NAME

Methods

load

Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Returns void

loadAsync

Parameters

Parameters

Returns void

Returns Promise<Object3D<Object3DEventMap>>

parse

Parameters

Parameters

Returns void

Returns Object3D<Object3DEventMap>

parseAnimations

Parameters

Returns { [key: string]: AnimationClip; }

[key: string]: AnimationClip

parseAsync

Parameters

Returns Promise<Object3D<Object3DEventMap>>

parseGeometries

Parameters

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

[key: string]: InstancedBufferGeometry | BufferGeometry

parseImages

Parameters

Returns void

Returns { [key: string]: external.three.Source; }

[key: string]: external.three.Source

parseImagesAsync

Parameters

Returns Promise<{ [key: string]: external.three.Source; }>

parseMaterials

Parameters

[key: string]: Texture

Returns { [key: string]: Material; }

[key: string]: Material

parseObject

Parameters

[key: string]: InstancedBufferGeometry | BufferGeometry

[key: string]: Material

[key: string]: AnimationClip

Returns Object3D<Object3DEventMap>

parseTextures

Parameters

[key: string]: external.three.Source

Returns { [key: string]: Texture; }

[key: string]: Texture

`Static` DEFAULT_MATERIAL_NAME

Returns {
[key: string]: AnimationClip;
}

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

Returns {
[key: string]: external.three.Source;
}

Returns Promise<{
[key: string]: external.three.Source;
}>

Returns {
[key: string]: Material;
}

Returns {
[key: string]: Texture;
}