Class AssetImporter

Asset Importer

Utility class to import assets from local files, blobs, urls, etc. Used in AssetManager to import assets. Acts as a wrapper over three.js LoadingManager and adds support for dynamically loading loaders, caching assets, better event dispatching and file tracking.

Hierarchy

EventDispatcher<IAssetImporterEventMap>
- AssetImporter

Implements

IAssetImporter

Constructors

constructor

new AssetImporter(
logging?: boolean,
__namedParameters?: AssetManagerOptions,
): AssetImporter
Parameters
- logging: boolean = false
- __namedParameters: AssetManagerOptions = {}
Returns AssetImporter
Overrides EventDispatcher<IAssetImporterEventMap>.constructor
- Defined in src/assetmanager/AssetImporter.ts:117

Properties

`Protected` `Optional`_rootContext

_rootContext?: { path: string; rootUrl: string }

`Protected`_urlModifiers

_urlModifiers: ((url: string) => string)[] = []

cacheImportedAssets

cacheImportedAssets: boolean = true

If true, imported assets are cached in memory(as js/three.js objects) and can be reused later. They will be cleared when dispose event is fired on the object or clearCache is called.

`Readonly`importers

importers: IImporter[] = ...

`Static`DummyGeometry

DummyGeometry: IGeometry = ...

Accessors

cachedAssets

get cachedAssets(): IAsset[]
Returns IAsset[]
Implementation of IAssetImporter.cachedAssets
- Defined in src/assetmanager/AssetImporter.ts:159

loadingManager

get loadingManager(): LoadingManager
Returns LoadingManager
Implementation of IAssetImporter.loadingManager
- Defined in src/assetmanager/AssetImporter.ts:156

storage

get storage(): undefined | Storage | Cache
Returns undefined | Storage | Cache
- Defined in src/assetmanager/AssetImporter.ts:75

Methods

`Protected`_onError

_onError(url: string): void
Parameters
- url: string
Returns void
- Defined in src/assetmanager/AssetImporter.ts:752

`Protected`_onLoad

_onLoad(): void
Returns void
- Defined in src/assetmanager/AssetImporter.ts:744

`Protected`_onProgress

_onProgress(url: string, loaded: number, total: number): void
Parameters
- url: string
- loaded: number
- total: number
Returns void
- Defined in src/assetmanager/AssetImporter.ts:748

`Protected`_onStart

_onStart(url: string, loaded: number, total: number): void
Parameters
- url: string
- loaded: number
- total: number
Returns void
- Defined in src/assetmanager/AssetImporter.ts:756

`Protected`_urlModifier

_urlModifier(url: string): string
Parameters
- url: string
Returns string
- Defined in src/assetmanager/AssetImporter.ts:640

addEventListener

addEventListener<T extends keyof IAssetImporterEventMap>(
type: T,
listener: EventListener<IAssetImporterEventMap[T], T, AssetImporter>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof IAssetImporterEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<IAssetImporterEventMap[T], T, AssetImporter>
  The function that gets called when the event is fired.
Returns void
Implementation of IAssetImporter.addEventListener
Overrides EventDispatcher.addEventListener
- Defined in src/assetmanager/AssetImporter.ts:732

addImporter

addImporter(...importers: IImporter[]): void
Parameters
- ...importers: IImporter[]
Returns void
- Defined in src/assetmanager/AssetImporter.ts:163

addURLModifier

addURLModifier(modifier: (url: string) => string): void
Parameters
- modifier: (url: string) => string
Returns void
Implementation of IAssetImporter.addURLModifier
- Defined in src/assetmanager/AssetImporter.ts:632

clearCache

clearCache(): void
Clear memory asset and loader cache. Browser cache and custom cache storage is not cleared with this.

Returns void
- Defined in src/assetmanager/AssetImporter.ts:603

clearLoaderCache

clearLoaderCache(): void
Returns void
- Defined in src/assetmanager/AssetImporter.ts:616

dispose

dispose(): void
Returns void
Implementation of IAssetImporter.dispose
- Defined in src/assetmanager/AssetImporter.ts:594

import

import<T extends undefined | ImportResult = ImportResult>(
    assetOrPath?: string | IAsset | File | IAsset[] | File[],
    options?: ImportAssetOptions,
    onDownloadProgress?: (e: ProgressEvent) => void,
    isInternal?: boolean,
): Promise<(undefined | T)[]>
Import single or multiple assets(like in case of zip files) from a path(url) or an IAsset.
Type Parameters
- T extends undefined | ImportResult = ImportResult
Parameters
- OptionalassetOrPath: string | IAsset | File | IAsset[] | File[]
  The path or asset to import
- Optionaloptions: ImportAssetOptions
  Options for the import
- OptionalonDownloadProgress: (e: ProgressEvent) => void
- OptionalisInternal: boolean
Returns Promise<(undefined | T)[]>
Implementation of IAssetImporter.import
- Defined in src/assetmanager/AssetImporter.ts:181

importAsset

importAsset<T extends undefined | ImportResult = undefined | ImportResult>(
    asset?: IAsset,
    options?: ImportAssetOptions,
    onDownloadProgress?: (e: ProgressEvent) => void,
    isInternal?: boolean,
): Promise<T[]>
Type Parameters
- T extends undefined | ImportResult = undefined | ImportResult
Parameters
- Optionalasset: IAsset
- options: ImportAssetOptions = {}
- OptionalonDownloadProgress: (e: ProgressEvent) => void
- OptionalisInternal: boolean
Returns Promise<T[]>
- Defined in src/assetmanager/AssetImporter.ts:227

importFile

importFile<T extends undefined | ImportResult = undefined | ImportResult>(
    file?: File,
    options?: ImportAssetOptions,
    onDownloadProgress?: (e: ProgressEvent) => void,
): Promise<T[]>
Type Parameters
- T extends undefined | ImportResult = undefined | ImportResult
Parameters
- Optionalfile: File
- options: ImportAssetOptions = {}
- OptionalonDownloadProgress: (e: ProgressEvent) => void
Returns Promise<T[]>
- Defined in src/assetmanager/AssetImporter.ts:292

importFiles

importFiles<T extends undefined | ImportResult = undefined | ImportResult>(
files: Map<string, IFile>,
options?: ImportFilesOptions,
): Promise<Map<string, T[]>>
Import multiple local files/blobs from a map of files, like when a local folder is loaded, or when multiple files are dropped.
Type Parameters
- T extends undefined | ImportResult = undefined | ImportResult
Parameters
- files: Map<string, IFile>
- options: ImportFilesOptions = {}
Returns Promise<Map<string, T[]>>
Implementation of IAssetImporter.importFiles
- Defined in src/assetmanager/AssetImporter.ts:313

importPath

importPath<T extends undefined | ImportResult = undefined | ImportResult>(
    path: string,
    options?: ImportAssetOptions,
    onDownloadProgress?: (e: ProgressEvent) => void,
): Promise<T[]>
Type Parameters
- T extends undefined | ImportResult = undefined | ImportResult
Parameters
- path: string
- options: ImportAssetOptions = {}
- OptionalonDownloadProgress: (e: ProgressEvent) => void
Returns Promise<T[]>
- Defined in src/assetmanager/AssetImporter.ts:204

importSingle

importSingle<T extends undefined | ImportResult = ImportResult>(
    asset?: string | IAsset | File,
    options?: ImportAssetOptions,
    onDownloadProgress?: (e: ProgressEvent) => void,
    isInternal?: boolean,
): Promise<undefined | T>
Import a single asset from a path(url) or an IAsset.
Type Parameters
- T extends undefined | ImportResult = ImportResult
Parameters
- Optionalasset: string | IAsset | File
- Optionaloptions: ImportAssetOptions
- OptionalonDownloadProgress: (e: ProgressEvent) => void
- OptionalisInternal: boolean
Returns Promise<undefined | T>
Implementation of IAssetImporter.importSingle
- Defined in src/assetmanager/AssetImporter.ts:195

processImported

processImported(
    res: any,
    options: ProcessRawOptions,
    path?: string,
): Promise<any[]>
Parameters
- res: any
- options: ProcessRawOptions
- Optionalpath: string
Returns Promise<any[]>
Deprecated
use processRaw instead
- Defined in src/assetmanager/AssetImporter.ts:768

processRaw

processRaw<T extends undefined | ImportResult = ImportResult>(
    res: T | T[],
    options: ProcessRawOptions,
    path?: string,
): Promise<T[]>
Process the raw output from the loaders and return the updated/patched-objects.
Type Parameters
- T extends undefined | ImportResult = ImportResult
Parameters
- res: T | T[]
- options: ProcessRawOptions
- Optionalpath: string
Returns Promise<T[]>
Implementation of IAssetImporter.processRaw
- Defined in src/assetmanager/AssetImporter.ts:512

processRawSingle

processRawSingle<T extends undefined | ImportResult = ImportResult>(
    res: T,
    options: ProcessRawOptions,
    path?: string,
): Promise<T>
Type Parameters
- T extends undefined | ImportResult = ImportResult
Parameters
- res: T
- options: ProcessRawOptions
- Optionalpath: string
Returns Promise<T>
- Defined in src/assetmanager/AssetImporter.ts:586

registerFile

registerFile(
    path: string,
    file?: IFile,
    extension?: string,
    loader?: ILoader<any, any>,
): undefined | ILoader<any, any>
Register a file in the database and return a loader for it. If the loader does not exist, it will be created.
Parameters
- path: string
- Optionalfile: IFile
- Optionalextension: string
- Optionalloader: ILoader<any, any>
Returns undefined | ILoader<any, any>
Implementation of IAssetImporter.registerFile
- Defined in src/assetmanager/AssetImporter.ts:473

removeImporter

removeImporter(...importers: IImporter[]): void
Parameters
- ...importers: IImporter[]
Returns void
- Defined in src/assetmanager/AssetImporter.ts:172

removeURLModifier

removeURLModifier(modifier: (url: string) => string): void
Parameters
- modifier: (url: string) => string
Returns void
Implementation of IAssetImporter.removeURLModifier
- Defined in src/assetmanager/AssetImporter.ts:635

resolveURL

resolveURL(url: string): string
Parameters
- url: string
Returns string
- Defined in src/assetmanager/AssetImporter.ts:627

unregisterAllFiles

unregisterAllFiles(): void
Returns void
- Defined in src/assetmanager/AssetImporter.ts:609

unregisterFile

unregisterFile(path: string): void
Remove a file from the database and revoke the object url if it exists.
Parameters
- path: string
Returns void
Implementation of IAssetImporter.unregisterFile
- Defined in src/assetmanager/AssetImporter.ts:498

Class AssetImporter

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AssetImporter

Properties

Protected Optional_rootContext

Protected_urlModifiers

cacheImportedAssets

Readonlyimporters

StaticDummyGeometry

StaticDummyLineBasicMaterial

StaticDummyLineMaterial

StaticDummyMaterial

Accessors

cachedAssets

Returns IAsset[]

loadingManager

Returns LoadingManager

storage

Returns undefined | Storage | Cache

Methods

Protected_onError

Parameters

Returns void

Protected_onLoad

Returns void

Protected_onProgress

Parameters

Returns void

Protected_onStart

Parameters

Returns void

Protected_urlModifier

Parameters

Returns string

addEventListener

Type Parameters

Parameters

Returns void

addImporter

Parameters

Returns void

addURLModifier

Parameters

Returns void

clearCache

Returns void

clearLoaderCache

Returns void

dispose

Returns void

import

Type Parameters

Parameters

Returns Promise<(undefined | T)[]>

importAsset

Type Parameters

Parameters

Returns Promise<T[]>

importFile

Type Parameters

Parameters

Returns Promise<T[]>

importFiles

Type Parameters

Parameters

Returns Promise<Map<string, T[]>>

importPath

Type Parameters

Parameters

Returns Promise<T[]>

importSingle

`Protected` `Optional`_rootContext

`Protected`_urlModifiers

`Readonly`importers

`Static`DummyGeometry

`Static`DummyLineBasicMaterial

`Static`DummyLineMaterial

`Static`DummyMaterial

`Protected`_onError

`Protected`_onLoad

`Protected`_onProgress

`Protected`_onStart

`Protected`_urlModifier