@threepipe/plugin-3d-tiles-renderer 0.2.0 → 0.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@threepipe/plugin-3d-tiles-renderer",
   "description": "Interface for 3d-tiles-renderer",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "dependencies": {},
   "overrides": {
     "threepipe": "$threepipe",

package/src/TilesRendererPlugin.ts

@@ -2,26 +2,35 @@ import {
     AViewerPluginEventMap,
     AViewerPluginSync,
     Box3B,
+    DropzonePlugin,
     EventListener2,
     generateUUID,
     IAssetImporter,
     ILoader,
+    ImportAddOptions,
     Importer,
     IObject3D,
     iObjectCommons,
     IRenderManager,
     IRenderManagerEventMap,
-    IScene,
-    ISceneEventMap,
     Loader,
-    ImportAddOptions,
     LoadingManager,
-    ThreeViewer, Sphere, uiButton,
+    Object3D,
+    Sphere,
+    ThreeViewer,
+    uiButton,
+    uiFolderContainer,
+    IObjectExtension,
 } from 'threepipe'
 import {TilesGroup, TilesRenderer} from '3d-tiles-renderer'
 import {gltfCesiumRTCExtension, gltfMeshFeaturesExtension, gltfStructuralMetadataExtension} from './gltf'
+import {
+    CesiumIonAuthPlugin,
+    ImplicitTilingPlugin,
+    TilesFadePlugin,
+    UpdateOnChangePlugin,
 // @ts-expect-error moduleResolution issue
-import {ImplicitTilingPlugin, TilesFadePlugin, UpdateOnChangePlugin, CesiumIonAuthPlugin} from '3d-tiles-renderer/plugins'
+} from '3d-tiles-renderer/plugins'
 
 export type TilesRendererGroup = TilesGroup & IObject3D
 
@@ -35,6 +44,7 @@ export interface TilesRendererPluginEventMap extends AViewerPluginEventMap {
  *
  * Specification - https://www.ogc.org/standards/3dtiles/
  */
+@uiFolderContainer('3D Tiles')
 export class TilesRendererPlugin extends AViewerPluginSync<TilesRendererPluginEventMap> {
     public static readonly PluginType: string = 'TilesRendererPlugin'
     enabled = true
@@ -65,6 +75,8 @@ export class TilesRendererPlugin extends AViewerPluginSync<TilesRendererPluginEv
             ...options,
             fileExtension: TilesRendererPlugin.DUMMY_EXT,
             fileHandler: importer,
+        }).finally(() => {
+            this._viewer?.assetManager.importer.unregisterFile(temp)
         })
     }
 
@@ -89,7 +101,8 @@ export class TilesRendererPlugin extends AViewerPluginSync<TilesRendererPluginEv
         viewer.assetManager.registerGltfExtension(gltfStructuralMetadataExtension)
         viewer.assetManager.registerGltfExtension(gltfMeshFeaturesExtension)
         viewer.assetManager.importer.addImporter(this._importer)
-        viewer.scene.addEventListener('addSceneObject', this._addSceneObject)
+        viewer.object3dManager.registerObjectExtension(this._objectExt)
+        // viewer.scene.addEventListener('addSceneObject', this._addSceneObject)
         // viewer.scene.addEventListener('mainCameraChange', this._mainCameraChange)
         // viewer.scene.addEventListener('mainCameraUpdate', this._mainCameraUpdate)
         viewer.renderManager.addEventListener('preRender', this._preRender) // note - adding to renderManager preRender, not viewer. So its fired for each camera render
@@ -101,7 +114,8 @@ export class TilesRendererPlugin extends AViewerPluginSync<TilesRendererPluginEv
         viewer.assetManager.unregisterGltfExtension(gltfCesiumRTCExtension.name)
         viewer.assetManager.unregisterGltfExtension(gltfStructuralMetadataExtension.name)
         viewer.assetManager.unregisterGltfExtension(gltfMeshFeaturesExtension.name)
-        viewer.scene.removeEventListener('addSceneObject', this._addSceneObject)
+        viewer.object3dManager.unregisterObjectExtension(this._objectExt)
+        // viewer.scene.removeEventListener('addSceneObject', this._addSceneObject)
         // viewer.scene.removeEventListener('mainCameraChange', this._mainCameraChange)
         // viewer.scene.removeEventListener('mainCameraUpdate', this._mainCameraUpdate)
         viewer.renderManager.removeEventListener('preRender', this._preRender)
@@ -155,53 +169,55 @@ export class TilesRendererPlugin extends AViewerPluginSync<TilesRendererPluginEv
 
     private _cachedRefs?: Pick<TilesRenderer, 'lruCache' | 'downloadQueue' | 'parseQueue'/* | 'processNodeQueue'*/>
 
-    private _addSceneObject: EventListener2<'addSceneObject', ISceneEventMap, IScene> = (e)=>{
-        const object = e.object
-        const group = object as TilesRendererGroup
-        // console.log(e)
-        if (!group || !group.tilesRenderer || !this._viewer) return
-
-        // set the second renderer to share the cache and queues from the first
-        if (!this._cachedRefs) {
-            this._cachedRefs = {
-                lruCache: group.tilesRenderer.lruCache,
-                downloadQueue: group.tilesRenderer.downloadQueue,
-                parseQueue: group.tilesRenderer.parseQueue,
+    private _objectExt: IObjectExtension = {
+        uuid: 'TilesRendererPluginObjectExt',
+        isCompatible: (o)=>!!(o as TilesRendererGroup).tilesRenderer,
+        onRegister: (group: TilesRendererGroup)=>{
+            if (!group || !group.tilesRenderer || !this._viewer) return
+
+            // set the second renderer to share the cache and queues from the first
+            if (!this._cachedRefs) {
+                this._cachedRefs = {
+                    lruCache: group.tilesRenderer.lruCache,
+                    downloadQueue: group.tilesRenderer.downloadQueue,
+                    parseQueue: group.tilesRenderer.parseQueue,
+                    // @ts-expect-error not in ts
+                    processNodeQueue: group.tilesRenderer.processNodeQueue,
+                }
+            } else {
+                group.tilesRenderer.lruCache = this._cachedRefs.lruCache
+                group.tilesRenderer.downloadQueue = this._cachedRefs.downloadQueue
+                group.tilesRenderer.parseQueue = this._cachedRefs.parseQueue
                 // @ts-expect-error not in ts
-                processNodeQueue: group.tilesRenderer.processNodeQueue,
+                group.tilesRenderer.processNodeQueue = this._cachedRefs.processNodeQueue
             }
-        } else {
-            group.tilesRenderer.lruCache = this._cachedRefs.lruCache
-            group.tilesRenderer.downloadQueue = this._cachedRefs.downloadQueue
-            group.tilesRenderer.parseQueue = this._cachedRefs.parseQueue
-            // @ts-expect-error not in ts
-            group.tilesRenderer.processNodeQueue = this._cachedRefs.processNodeQueue
-        }
 
-        this.objects.push(group)
+            this.objects.push(group)
 
-        group.tilesRenderer.registerPlugin({
-            dispose: () => {
-                const index = this.objects.indexOf(group)
-                if (index !== -1) this.objects.splice(index, 1)
-                this.dispatchEvent({type: 'removeTile', group})
-            },
-        })
-        group.tilesRenderer.setCamera(this._viewer.scene.mainCamera)
-        group.tilesRenderer.setResolutionFromRenderer(this._viewer.scene.mainCamera, this._viewer.renderManager.webglRenderer)
-        group.tilesRenderer.update()
-        group.addEventListener('dispose', ()=>{
-            group.tilesRenderer.dispose()
-        })
+            group.tilesRenderer.registerPlugin({
+                dispose: () => {
+                    const index = this.objects.indexOf(group)
+                    if (index !== -1) this.objects.splice(index, 1)
+                    this.dispatchEvent({type: 'removeTile', group})
+                },
+            })
+            group.tilesRenderer.setCamera(this._viewer.scene.mainCamera)
+            group.tilesRenderer.setResolutionFromRenderer(this._viewer.scene.mainCamera, this._viewer.renderManager.webglRenderer)
+            group.tilesRenderer.update()
+            group.addEventListener('dispose', ()=>{
+                group.tilesRenderer.dispose()
+            })
 
-        this.dispatchEvent({type: 'addTile', group})
+            this.dispatchEvent({type: 'addTile', group})
+        },
     }
 
     @uiButton()
     async promptForURL() {
         const url = await this._viewer?.dialog.prompt('TilesRendererPlugin: Enter URL for the root tileset', '', true)
         if (!url) return
-        return this.load(url)
+        const loader = this._viewer?.getPlugin(DropzonePlugin) ?? this._viewer ?? this
+        return await loader.load(url, {fileExtension: TilesRendererPlugin.DUMMY_EXT})
     }
 }
 
@@ -283,7 +299,20 @@ export class TilesRendererLoader extends Loader implements ILoader<TilesRenderer
         })
         tiles.addEventListener('load-tile-set', (e) => {
             const isRoot = e.tileSet === tiles.rootTileSet
-            if (isRoot && resolve) resolve()
+            if (isRoot && resolve) {
+                resolve()
+            }
+        })
+
+        group.userData.rootPathRefresh = true // when next loaded from gltf, the object will be refreshed based on rootPath
+        group._rootPathRefreshed = true // so that it doesn't do it this time
+        group._sChildren = [] // so that it's children are not saved in the gltf exporter.
+        tiles.registerPlugin({
+            processTileModel: (model: Object3D, tile: any) => {
+                if (tile === (tiles.rootTileSet as any)?.root) {
+                    group._sChildren = [model] // the root tileset will be saved inside the gltf on export
+                }
+            },
         })
 
         const ai = this.ai