import {ImportAssetOptions, ImportResult, ProcessRawOptions, RootSceneImportResult} from './IAssetImporter' import { BaseEvent, Cache as threeCache, Camera, EventDispatcher, Light, LinearFilter, LinearMipmapLinearFilter, LoadingManager, PerspectiveCamera, TextureLoader, } from 'three' import {ISerializedConfig, IViewerPlugin, ThreeViewer} from '../viewer' import {AssetImporter} from './AssetImporter' import {generateUUID, getTextureDataType, overrideThreeCache} from '../three' import {IAsset} from './IAsset' import { AddObjectOptions, AmbientLight2, DirectionalLight2, HemisphereLight2, ICamera, iCameraCommons, ILight, iLightCommons, IMaterial, iMaterialCommons, IObject3D, iObjectCommons, ISceneEvent, ITexture, PerspectiveCamera2, PointLight2, RectAreaLight2, SpotLight2, upgradeTexture, } from '../core' import {Importer} from './Importer' import {MaterialManager} from './MaterialManager' import {DRACOLoader2, GLTFLoader2, JSONMaterialLoader, MTLLoader2, OBJLoader2, ZipLoader} from './import' import {RGBELoader} from 'three/examples/jsm/loaders/RGBELoader.js' import {FBXLoader} from 'three/examples/jsm/loaders/FBXLoader.js' import {EXRLoader} from 'three/examples/jsm/loaders/EXRLoader.js' import {Class, ValOrArr} from 'ts-browser-helpers' import {ILoader} from './IImporter' import {AssetExporter} from './AssetExporter' import {IExporter} from './IExporter' import {GLTFExporter2} from './export' export interface AssetManagerOptions{ /** * simple memory based cache for downloaded files, default = false */ simpleCache?: boolean /** * Cache Storage for downloaded files, can use with `caches.open` * When true and by default uses `caches.open('threepipe-assetmanager')`, set to false to disable * @default true */ storage?: Cache | Storage | boolean } export interface AddAssetOptions extends AddObjectOptions{ /** * Automatically set any loaded HDR, EXR file as the scene environment map * @default true */ autoSetEnvironment?: boolean /** * Automatically set any loaded image(ITexture) file as the scene background */ autoSetBackground?: boolean } export type ImportAddOptions = ImportAssetOptions & AddAssetOptions export type AddRawOptions = ProcessRawOptions & AddAssetOptions /** * Asset Manager * * Utility class to manage import, export, and material management. * @category Asset Manager */ export class AssetManager extends EventDispatcher { readonly viewer: ThreeViewer readonly importer: AssetImporter readonly exporter: AssetExporter readonly materials: MaterialManager private _storage?: Cache | Storage get storage() {return this._storage} constructor(viewer: ThreeViewer, {simpleCache = false, storage}: AssetManagerOptions = {}) { super() this._sceneUpdated = this._sceneUpdated.bind(this) this.addAsset = this.addAsset.bind(this) this.addRaw = this.addRaw.bind(this) this.addImported = this.addImported.bind(this) this.importer = new AssetImporter(!!viewer.getPlugin('debug')) this.exporter = new AssetExporter() this.materials = new MaterialManager() this.viewer = viewer this.viewer.scene.addEventListener('addSceneObject', this._sceneUpdated) this.viewer.scene.addEventListener('materialChanged', this._sceneUpdated) this.viewer.scene.addEventListener('beforeDeserialize', this._sceneUpdated) this._initCacheStorage(simpleCache, storage ?? true) this.importer.addEventListener('processRaw', (event)=>{ // console.log('preprocess mat', mat) const mat = event.data as IMaterial if (!mat || !mat.isMaterial || !mat.uuid) return if (this.materials?.findMaterial(mat.uuid)) { console.warn('imported material uuid already exists, creating new uuid') mat.uuid = generateUUID() if (mat.userData.uuid) mat.userData.uuid = mat.uuid } // todo: check for name exists also this.materials.registerMaterial(mat) }) this.importer.addEventListener('processRawStart', (event)=>{ // console.log('preprocess mat', mat) const res = event.data! const options = event.options! as ProcessRawOptions // if (!res.assetType) { // if (res.isBufferGeometry) { // for eg stl todo // res = new Mesh(res, new MeshStandardMaterial()) // } // if (res.isObject3D) { // } // } if (res.isObject3D) { const cameras: Camera[] = [] const lights: Light[] = [] res.traverse((obj: any) => { if (obj.material) { const materials = Array.isArray(obj.material) ? obj.material : [obj.material] const newMaterials = [] for (const material of materials) { const mat = this.materials.convertToIMaterial(material, {createFromTemplate: options.replaceMaterials !== false}) || material mat.uuid = material.uuid mat.userData.uuid = material.uuid newMaterials.push(mat) } if (Array.isArray(obj.material)) obj.material = newMaterials else obj.material = newMaterials[0] } if (obj.isCamera) cameras.push(obj) if (obj.isLight) lights.push(obj) }) for (const camera of cameras) { if ((camera as PerspectiveCamera2).assetType === 'camera') continue // todo: OrthographicCamera if (!(camera as PerspectiveCamera).isPerspectiveCamera || !camera.parent || options.replaceCameras === false) { iCameraCommons.upgradeCamera.call(camera) } else { const newCamera: ICamera = (camera as any).iCamera ?? new PerspectiveCamera2('', this.viewer.canvas) if (camera === newCamera) continue camera.parent.children.splice(camera.parent.children.indexOf(camera), 1, newCamera) newCamera.parent = camera.parent as any newCamera.copy(camera as any) camera.parent = null ;(newCamera as any).uuid = camera.uuid newCamera.userData.uuid = camera.uuid ;(camera as any).iCamera = newCamera // console.log('replacing camera', camera, newCamera) } } for (const light of lights) { if ((light as ILight).assetType === 'light') continue if (!light.parent || options.replaceLights === false) { iLightCommons.upgradeLight.call(light) } else { const newLight: ILight|undefined = (light as any).iLight ?? (light as any).isDirectionalLight ? new DirectionalLight2() : (light as any).isPointLight ? new PointLight2() : (light as any).isSpotLight ? new SpotLight2() : (light as any).isAmbientLight ? new AmbientLight2() : (light as any).isHemisphereLight ? new HemisphereLight2() : (light as any).isRectAreaLight ? new RectAreaLight2() : undefined if (light === newLight || !newLight) continue light.parent.children.splice(light.parent.children.indexOf(light), 1, newLight) newLight.parent = light.parent as any newLight.copy(light as any) light.parent = null ;(newLight as any).uuid = light.uuid newLight.userData.uuid = light.uuid ;(light as any).iLight = newLight } } iObjectCommons.upgradeObject3D.call(res) } else if (res.isMaterial) { iMaterialCommons.upgradeMaterial.call(res) // todo update res by generating new material? } else if (res.isTexture) { upgradeTexture.call(res) if (event?.options?.generateMipmaps !== undefined) res.generateMipmaps = event?.options.generateMipmaps if (!res.generateMipmaps && !res.isRenderTargetTexture) { // todo: do we need to check more? res.minFilter = res.minFilter === LinearMipmapLinearFilter ? LinearFilter : res.minFilter res.magFilter = res.magFilter === LinearMipmapLinearFilter ? LinearFilter : res.magFilter } } // todo other asset/object types? }) this._addImporters() this._addExporters() } async addAsset(assetOrPath?: string | IAsset | IAsset[] | File | File[], options?: ImportAddOptions): Promise<(T|undefined)[]> { if (!this.importer || !this.viewer) return [] const imported = await this.importer.import(assetOrPath, options) if (!imported) { console.warn('Unable to import', assetOrPath, imported) return [] } return this.loadImported<(T|undefined)[]>(imported, options) } // materials: IMaterial[] = [] // textures: ITexture[] = [] // todo move this function to viewer async loadImported = ImportResult>(imported: T, {autoSetEnvironment = true, autoSetBackground = false, ...options}: AddAssetOptions = {}): Promise { const arr: (ImportResult|undefined)[] = Array.isArray(imported) ? imported : [imported] let ret: T = Array.isArray(imported) ? [] : undefined as any for (const obj of arr) { if (!obj) { if (Array.isArray(ret)) ret.push(undefined) continue } let r = obj switch (obj.assetType) { case 'material': this.materials.registerMaterial(obj) break case 'texture': if (autoSetEnvironment && ( obj.__rootPath?.endsWith('.hdr') || obj.__rootPath?.endsWith('.exr') )) this.viewer.scene.environment = obj if (autoSetBackground) this.viewer.scene.background = obj break case 'model': case 'light': case 'camera': r = await this.viewer.addSceneObject(obj, options) // todo update references in scene update event break case 'config': if (options?.importConfig !== false) await this.viewer.importConfig(obj) break default: // legacy if (obj.type && typeof obj.type === 'string' && (Array.isArray((obj as any).plugins) || (obj as any).type === 'ThreeViewer' || this.viewer.getPlugin((obj as any).type))) { await this.viewer.importConfig(obj) } break } this.dispatchEvent({type: 'loadAsset', data: obj}) if (Array.isArray(ret)) ret.push(r) else ret = r as T } return ret || [] } /** * same as {@link loadImported} * @param imported * @param options */ async addProcessedAssets(imported: (T|undefined)[], options?: AddAssetOptions): Promise<(T | undefined)[]> { return this.loadImported(imported, options) } async addAssetSingle(asset?: string | IAsset | File, options?: ImportAssetOptions): Promise { return !asset ? undefined : (await this.addAsset(asset, options))?.[0] } // processAndAddObjects async addRaw(res: T|T[], options: AddRawOptions = {}): Promise<(T|undefined)[]> { const r = await this.importer.processRaw(res, options) return this.loadImported(r, options) } async addRawSingle(res: T, options: AddRawOptions = {}): Promise { return (await this.addRaw(res, options))?.[0] } private _sceneUpdated(event: ISceneEvent) { // todo: check if objects are added some other way. if (event.type === 'addSceneObject') { const target = event.object as ImportResult switch (target.assetType) { case 'material': this.materials.registerMaterial(target) break case 'texture': break case 'model': case 'light': case 'camera': break default: break } } else if (event.type === 'materialChanged') { const target = event.material as IMaterial | IMaterial[] | undefined const targets = Array.isArray(target) ? target : target ? [target] : [] for (const t of targets) { this.materials.registerMaterial(t) } } else if (event.type === 'beforeDeserialize') { // object/material/texture to be deserialized const data = event.data const meta = event.meta if (!data.metadata) { console.warn('Invalid data(no metadata)', data) } if (event.material) { if (data.metadata?.type !== 'Material') { console.warn('Invalid material data', data) } JSONMaterialLoader.DeserializeMaterialJSON(data, this.viewer, meta, event.material).then(()=>{ // }) } } else { console.error('Unexpected') } } dispose() { this.importer.dispose() this.materials.dispose() this.viewer.scene.removeEventListener('addSceneObject', this._sceneUpdated) this.viewer.scene.removeEventListener('materialChanged', this._sceneUpdated) this.exporter.dispose() } protected _addImporters() { const viewer = this.viewer if (!viewer) return const importers: Importer[] = [ new Importer(TextureLoader, ['webp', 'png', 'jpeg', 'jpg', 'svg', 'ico', 'data:image', 'avif'], [ 'image/webp', 'image/png', 'image/jpeg', 'image/svg+xml', 'image/gif', 'image/bmp', 'image/tiff', 'image/x-icon', 'image/avif', ], false), // todo: use ImageBitmapLoader if supported (better performance) new Importer(JSONMaterialLoader, ['mat', ...this.materials.templates.map(t=>t.typeSlug!).filter(v=>v)], // todo add others [], false, (loader)=>{ if (loader) loader.viewer = this.viewer return loader }), new Importer(class extends RGBELoader { constructor(manager: LoadingManager) { super(manager) this.setDataType(getTextureDataType(viewer.renderManager.renderer)) } }, ['hdr'], ['image/vnd.radiance'], false), new Importer(class extends EXRLoader { constructor(manager: LoadingManager) { super(manager) this.setDataType(getTextureDataType(viewer.renderManager.renderer)) } }, ['exr'], ['image/x-exr'], false), new Importer(FBXLoader, ['fbx'], ['model/fbx'], true), new Importer(ZipLoader, ['zip', 'glbz', 'gltfz'], ['application/zip', 'data:model/gltf+zip'], true), // gltfz and glbz are invented zip files with gltf/glb inside along with resources new Importer(OBJLoader2 as any as Class, ['obj'], ['model/obj'], true), new Importer(MTLLoader2 as any as Class, ['mtl'], ['model/mtl'], false), new Importer(GLTFLoader2, ['gltf', 'glb', 'data:model/gltf'], ['model/gltf', 'model/gltf+json', 'model/gltf-binary'], true, (l, _, i) => l?.setup(this.viewer, i.extensions)), new Importer(DRACOLoader2, ['drc'], ['model/mesh+draco'], true), ] this.importer.addImporter(...importers) } protected _addExporters() { const exporters: IExporter[] = [ {ext: ['gltf', 'glb'], extensions: [], ctor: (_, exporter)=>{ const ex = new GLTFExporter2() // This should be added at the end. ex.setup(this.viewer, exporter.extensions) return ex }}, ] this.exporter.addExporter(...exporters) } private _initCacheStorage(simpleCache?: boolean, storage?: Cache | Storage | boolean) { if (storage === true && window?.caches) { window.caches.open?.('threepipe-assetmanager').then(c => { this._initCacheStorage(simpleCache, c) this._storage = c }) return } if (simpleCache || storage) { // three.js built-in simple memory cache. used in FileLoader.js todo: use local storage somehow if (simpleCache) threeCache.enabled = true if (storage && window.Cache && typeof window.Cache === 'function' && storage instanceof window.Cache) { overrideThreeCache(storage) // todo: clear cache } } this._storage = typeof storage === 'boolean' ? undefined : storage } // region deprecated /** * @deprecated use addRaw instead * @param res * @param options */ async addImported(res: T|T[], options: AddRawOptions = {}): Promise<(T|undefined)[]> { console.error('addImported is deprecated, use addRaw instead') return this.addRaw(res, options) } /** * @deprecated use addAsset instead * @param path * @param options */ public async addFromPath(path: string, options: ImportAddOptions = {}): Promise { console.error('addFromPath is deprecated, use addAsset instead') return this.addAsset(path, options) } /** * @deprecated use {@link ThreeViewer.exportConfig} instead * @param binary - if set to false, encodes all the array buffers to base64 */ exportViewerConfig(binary = true): Record { if (!this.viewer) return {} console.error('exportViewerConfig is deprecated, use viewer.toJSON instead') return this.viewer.toJSON(binary, undefined) } /** * @deprecated use {@link ThreeViewer.exportPluginsConfig} instead * @param filter */ exportPluginPresets(filter?: string[]) { console.error('exportPluginPresets is deprecated, use viewer.exportPluginsConfig instead') return this.viewer?.exportPluginsConfig(filter) } /** * @deprecated use {@link ThreeViewer.exportPluginConfig} instead * @param plugin */ exportPluginPreset(plugin: IViewerPlugin) { console.error('exportPluginPreset is deprecated, use viewer.exportPluginConfig instead') return this.viewer?.exportPluginConfig(plugin) } /** * @deprecated use {@link ThreeViewer.importPluginConfig} instead * @param json * @param plugin */ async importPluginPreset(json: any, plugin?: IViewerPlugin) { console.error('importPluginPreset is deprecated, use viewer.importPluginConfig instead') return this.viewer?.importPluginConfig(json, plugin) } // todo continue from here by moving functions to the viewer. /** * @deprecated use {@link ThreeViewer.importConfig} instead * @param viewerConfig */ async importViewerConfig(viewerConfig: any) { return this.viewer?.importConfig(viewerConfig) } /** * @deprecated use {@link ThreeViewer.fromJSON} instead * @param viewerConfig */ applyViewerConfig(viewerConfig: any, resources?: any) { console.error('applyViewerConfig is deprecated, use viewer.fromJSON instead') return this.viewer?.fromJSON(viewerConfig, resources) } /** * @deprecated moved to {@link ThreeViewer.loadConfigResources} * @param json * @param extraResources - preloaded resources in the format of viewer config resources. */ async importConfigResources(json: any, extraResources?: any) { if (!this.importer) throw 'Importer not initialized yet.' if (json.__isLoadedResources) return json return this.viewer?.loadConfigResources(json, extraResources) } /** * @deprecated not a plugin anymore */ static readonly PluginType = 'AssetManager' // endregion }