Class AssetManager

constructor

• new AssetManager(viewer, __namedParameters?): AssetManager

• Parameters

  • viewer: ThreeViewer

  • __namedParameters: AssetManagerOptions = {}

  Returns AssetManager

Readonly exporter

Readonly importer

Readonly materials

processState

Readonly viewer

Static Readonly PluginType

storage

• get storage(): undefined | Storage | Cache

• Returns undefined | Storage | Cache

addAsset

• addAsset<T>(assetOrPath?, options?): Promise<(undefined | T)[]>

• Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • Optional assetOrPath: string | File | File[] | IAsset | IAsset[]

  • Optional options: ImportAddOptions

  Returns Promise<(undefined | T)[]>

addAssetSingle

• addAssetSingle<T>(asset?, options?): Promise<undefined | T>

• Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • Optional asset: string | File | IAsset

  • Optional options: ImportAssetOptions

  Returns Promise<undefined | T>

addFromPath

• addFromPath(path, options?): Promise<any[]>

• Parameters

  • path: string

  • options: ImportAddOptions = {}

  Returns Promise<any[]>

  Deprecated

  use addAsset instead

addImported

• addImported<T>(res, options?): Promise<(undefined | T)[]>

• Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • res: T | T[]

  • options: AddRawOptions = {}

  Returns Promise<(undefined | T)[]>

  Deprecated

  use addRaw instead

addProcessedAssets

• addProcessedAssets<T>(imported, options?): Promise<(undefined | T)[]>

• same as loadImported

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • imported: (undefined | T)[]

  • Optional options: AddAssetOptions

  Returns Promise<(undefined | T)[]>

addRaw

• addRaw<T>(res, options?): Promise<(undefined | T)[]>

• Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • res: T | T[]

  • options: AddRawOptions = {}

  Returns Promise<(undefined | T)[]>

addRawSingle

• addRawSingle<T>(res, options?): Promise<undefined | T>

• Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • res: T

  • options: AddRawOptions = {}

  Returns Promise<undefined | T>

applyViewerConfig

• applyViewerConfig(viewerConfig, resources?): null | ThreeViewer

• Parameters

  • viewerConfig: any

  • Optional resources: any

  Returns null | ThreeViewer

  Deprecated

  use ThreeViewer.fromJSON instead

dispose

• dispose(): void

• Returns void

exportPluginPreset

• exportPluginPreset(plugin): ISerializedConfig | Record<string, never>

• Parameters

  • plugin: IViewerPlugin<ThreeViewer, boolean>

  Returns ISerializedConfig | Record<string, never>

  Deprecated

  use ThreeViewer.exportPluginConfig instead

exportPluginPresets

• exportPluginPresets(filter?): ISerializedViewerConfig

• Parameters

  • Optional filter: string[]

  Returns ISerializedViewerConfig

  Deprecated

  use ThreeViewer.exportPluginsConfig instead

exportViewerConfig

• exportViewerConfig(binary?): Record<string, any>

• Parameters

  • binary: boolean = true

    if set to false, encodes all the array buffers to base64

  Returns Record<string, any>

  Deprecated

  use ThreeViewer.exportConfig instead

importConfigResources

• importConfigResources(json, extraResources?): Promise<any>

• Parameters

  • json: any

  • Optional extraResources: any

    preloaded resources in the format of viewer config resources.

  Returns Promise<any>

  Deprecated

  moved to ThreeViewer.loadConfigResources

importPluginPreset

• importPluginPreset(json, plugin?): Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

• Parameters

  • json: any

  • Optional plugin: IViewerPlugin<ThreeViewer, boolean>

  Returns Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

  Deprecated

  use ThreeViewer.importPluginConfig instead

importViewerConfig

• importViewerConfig(viewerConfig): Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

• Parameters

  • viewerConfig: any

  Returns Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

  Deprecated

  use ThreeViewer.importConfig instead

loadImported

• loadImported<T>(imported, __namedParameters?): Promise<never[] | T>

• Type Parameters

  • T extends ValOrArr<undefined | ImportResult> = ImportResult

  Parameters

  • imported: T

  • __namedParameters: AddAssetOptions = {}

  Returns Promise<never[] | T>

setProcessState

• setProcessState(path, value): void

• Set process state for a path Progress should be a number between 0 and 100 Pass undefined in value to remove the state

  Parameters

  • path: string

  • value: undefined | {
        progress?: number;
        state: string;
    }

  Returns void