Class: Loaders
Loaders methods providing loaders for various asset types
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Loaders(params?)
Parameters
| Name | Type |
|---|---|
params? | LoadersParams |
Defined in
packages/three/src/loaders/loaders.ts:48
Properties
_fbxLoader
• Private _fbxLoader: FBXLoader
Defined in
packages/three/src/loaders/loaders.ts:42
_fileLoader
• Private _fileLoader: FileLoader
Defined in
packages/three/src/loaders/loaders.ts:34
_gltfLoader
• Private _gltfLoader: GLTFLoader
Defined in
packages/three/src/loaders/loaders.ts:44
_imgLoader
• Private _imgLoader: ImageLoader
Defined in
packages/three/src/loaders/loaders.ts:36
_svgLoader
• Private _svgLoader: SVGLoader
Defined in
packages/three/src/loaders/loaders.ts:38
_textureLoader
• Private _textureLoader: TextureLoader
Defined in
packages/three/src/loaders/loaders.ts:40
dracoDecoderPath
• Private dracoDecoderPath: string
Defined in
packages/three/src/loaders/loaders.ts:46
preloadAliases
• Private preloadAliases: Map<string, string>
A map of friendly alias names to urls for preloaded resources
Defined in
packages/three/src/loaders/loaders.ts:100
Accessors
fbxLoader
• Private get fbxLoader(): FBXLoader
Returns
FBXLoader
Defined in
packages/three/src/loaders/loaders.ts:90
fileLoader
• Private get fileLoader(): FileLoader
Returns
FileLoader
Defined in
packages/three/src/loaders/loaders.ts:54
gltfLoader
• Private get gltfLoader(): GLTFLoader
Returns
GLTFLoader
Defined in
packages/three/src/loaders/loaders.ts:80
imageLoader
• Private get imageLoader(): ImageLoader
Returns
ImageLoader
Defined in
packages/three/src/loaders/loaders.ts:59
svgLoader
• Private get svgLoader(): SVGLoader
Returns
SVGLoader
Defined in
packages/three/src/loaders/loaders.ts:66
textureLoader
• Private get textureLoader(): TextureLoader
Returns
TextureLoader
Defined in
packages/three/src/loaders/loaders.ts:73
Methods
fbx
▸ fbx(url, params?): Promise<Group>
Loads an FBX model
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url of key for the FBX |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<Group>
a promise for the FBX
Defined in
packages/three/src/loaders/loaders.ts:288
file
▸ file(url, params?): Promise<string | ArrayBuffer>
Loads a file
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url or key for the file |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<string | ArrayBuffer>
a promise for a string or arraybuffer for the file
Defined in
packages/three/src/loaders/loaders.ts:173
gltf
▸ gltf(url, params?): Promise<GLTF>
Loads a GLTF model
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url or key for the GLTF |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<GLTF>
a promise for the GLTF
Defined in
packages/three/src/loaders/loaders.ts:262
image
▸ image(url, params?): Promise<HTMLImageElement>
Loads an image
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url or key for the image |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<HTMLImageElement>
a promise for a HTMLImageElement
Defined in
packages/three/src/loaders/loaders.ts:147
preload
▸ preload(friendlyName, url, params?): Promise<void>
Pre-loads a resource
Parameters
| Name | Type | Description |
|---|---|---|
friendlyName | string | the friendly name that will be a key for the resource |
url | string | the url for the resource |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<void>
a void promise for finishing preloading the resource
Defined in
packages/three/src/loaders/loaders.ts:108
svg
▸ svg(url, params?): Promise<SVGResult>
Loads an SVG
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url or key for the svg |
params? | Object | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<SVGResult>
a promise for the SVGResult
Defined in
packages/three/src/loaders/loaders.ts:199
texture
▸ texture(url, params?): Promise<Texture>
Loads a three texture
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url or key for the texture |
params? | Object | - |
params.textureAnisotropy | number | - |
params.onProgress? | (event: ProgressEvent<EventTarget>) => void | - |
Returns
Promise<Texture>
a promise for the texture