Class AssetManager

constructor

• new AssetManager(
      viewer: ThreeViewer,
      cacheOptions?: AssetManagerOptions,
  ): AssetManager

  Parameters

  • viewer: ThreeViewer
  • OptionalcacheOptions: AssetManagerOptions

  Returns AssetManager

Readonlyexporter

gltfExtensions

Readonlyimporter

Readonlymaterials

processState

Readonlyviewer

Static ReadonlyPluginType

storage

• get storage(): undefined | Storage | Cache

  Returns undefined | Storage | Cache

addAsset

• addAsset<T extends ImportResult = ImportResult>(
      assetOrPath?: string | IAsset | File | IAsset[] | File[],
      options?: ImportAddOptions,
  ): Promise<(undefined | T)[]>

  Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • OptionalassetOrPath: string | IAsset | File | IAsset[] | File[]
  • Optionaloptions: ImportAddOptions

  Returns Promise<(undefined | T)[]>

addAssetSingle

• addAssetSingle<T extends ImportResult = ImportResult>(
      asset?: string | IAsset | File,
      options?: ImportAssetOptions,
  ): Promise<undefined | T>

  Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • Optionalasset: string | IAsset | File
  • Optionaloptions: ImportAssetOptions

  Returns Promise<undefined | T>

addFromPath

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

  Parameters

  • path: string
  • options: ImportAddOptions = {}

  Returns Promise<any[]>

  Deprecated

  use addAsset instead

addImported

• addImported<T extends undefined | ImportResult = ImportResult>(
      res: T | T[],
      options?: AddRawOptions,
  ): 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 extends undefined | ImportResult = ImportResult>(
      imported: (undefined | T)[],
      options?: AddAssetOptions,
  ): Promise<(undefined | T)[]>

  same as loadImported

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • imported: (undefined | T)[]
  • Optionaloptions: AddAssetOptions

  Returns Promise<(undefined | T)[]>

addRaw

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

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • res: T | T[]
  • options: AddRawOptions = {}

  Returns Promise<(undefined | T)[]>

addRawSingle

• addRawSingle<T extends undefined | ImportResult = undefined | ImportResult>(
      res: T,
      options?: AddRawOptions,
  ): Promise<undefined | T>

  Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • res: T
  • options: AddRawOptions = {}

  Returns Promise<undefined | T>

applyViewerConfig

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

  Parameters

  • viewerConfig: any
  • Optionalresources: any

  Returns null | ThreeViewer

  Deprecated

  use ThreeViewer.fromJSON instead

dispose

• dispose(): void

  Returns void

exportPluginPreset

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

  Parameters

  • plugin: IViewerPlugin

  Returns ISerializedConfig | Record<string, never>

  Deprecated

  use ThreeViewer.exportPluginConfig instead

exportPluginPresets

• exportPluginPresets(filter?: string[]): ISerializedViewerConfig

  Parameters

  • Optionalfilter: string[]

  Returns ISerializedViewerConfig

  Deprecated

  use ThreeViewer.exportPluginsConfig instead

exportViewerConfig

• exportViewerConfig(binary?: boolean): 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: any, extraResources?: any): Promise<any>

  Parameters

  • json: any
  • OptionalextraResources: any

    preloaded resources in the format of viewer config resources.

  Returns Promise<any>

  Deprecated

  moved to ThreeViewer.loadConfigResources

importPluginPreset

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

  Parameters

  • json: any
  • Optionalplugin: IViewerPlugin<ThreeViewer, boolean>

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

  Deprecated

  use ThreeViewer.importPluginConfig instead

importViewerConfig

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

  Parameters

  • viewerConfig: any

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

  Deprecated

  use ThreeViewer.importConfig instead

loadImported

• loadImported<T extends ValOrArr<undefined | ImportResult> = ImportResult>(
      imported: T,
      __namedParameters?: AddAssetOptions,
  ): Promise<T>

  Type Parameters

  • T extends ValOrArr<undefined | ImportResult> = ImportResult

  Parameters

  • imported: T
  • __namedParameters: AddAssetOptions = {}

  Returns Promise<T>

registerGltfExtension

• registerGltfExtension(
      ext: {
          export: (parser: GLTFWriter2) => GLTFExporterPlugin;
          import: (parser: GLTFParser, viewer?: ThreeViewer) => GLTFLoaderPlugin;
          name: string;
          textures?: Record<string, string | number>;
      },
  ): void

  Parameters

  • ext: {
        export: (parser: GLTFWriter2) => GLTFExporterPlugin;
        import: (parser: GLTFParser, viewer?: ThreeViewer) => GLTFLoaderPlugin;
        name: string;
        textures?: Record<string, string | number>;
    }

  Returns void

setProcessState

• setProcessState(
      path: string,
      value: undefined | { progress?: number; state: string },
  ): 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

unregisterGltfExtension

• unregisterGltfExtension(name: string): void

  Parameters

  • name: string

  Returns void