Fix gbuffer flags in tonemap, Add disposeRuntimeMaterials option in MaterialManager.dispose, undo autoReset in RenderManager, Minor fixes and types, docs.

src/assetmanager/MaterialManager.ts

@@ -207,11 +207,16 @@ export class MaterialManager<T = ''> extends EventDispatcher<BaseEvent, T> {
         if (i >= 0) this.templates.splice(i, 1)
     }
 
-    dispose() {
-        for (const material of this._materials) {
+    dispose(disposeRuntimeMaterials = true) {
+        const mats = this._materials
+        this._materials = []
+        for (const material of mats) {
+            if (!disposeRuntimeMaterials && material.userData.runtimeMaterial) {
+                this._materials.push(material)
+                continue
+            }
             material.dispose()
         }
-        this._materials = []
         return
     }
 

src/core/IMaterial.ts

@@ -58,6 +58,11 @@ export interface IMaterialUserData extends IImportResultUserData{
 
     inverseAlphaMap?: boolean // only for physical material right now
 
+    /**
+     * See {@link MaterialManager.dispose} as {@link BaseGroundPlugin._refreshMaterial}
+     */
+    runtimeMaterial?: boolean
+
     /**
      * See {@link GBufferPlugin}
      */
@@ -67,9 +72,30 @@ export interface IMaterialUserData extends IImportResultUserData{
          * @default true
          */
         tonemapEnabled?: boolean
+
+        [key: string]: any
     }
 
 
+    // todo: move these to respective plugins
+
+    /**
+     * For SSAOPlugin
+     */
+    ssaoDisabled?: boolean
+    /**
+     * For SSCSPlugin
+     */
+    sscsDisabled?: boolean
+    /**
+     * For SSRPlugin
+     */
+    ssreflDisabled?: boolean
+    /**
+     * For SSRPlugin
+     */
+    ssreflNonPhysical?: boolean
+
     [key: string]: any
 
 
@@ -79,7 +105,7 @@ export interface IMaterialUserData extends IImportResultUserData{
      */
     setDirty?: (options?: IMaterialSetDirtyOptions) => void
     /**
-     * @deprecated
+     * @deprecated Use {@link postTonemap.tonemapEnabled} instead. This is kept because used in old files.
      */
     postTonemap?: boolean
 }

src/core/IObject.ts

@@ -98,6 +98,11 @@ export interface IObject3DUserData extends IImportResultUserData {
      */
     userSelectable?: boolean
 
+    /**
+     * For Physics plugins
+     */
+    physicsMass?: number
+
     /**
      * see {@link GLTFAnimationPlugin}
      */
@@ -147,6 +152,8 @@ export interface IObject3DUserData extends IImportResultUserData {
      * todo: remove support for this
      */
     __autoBubbleToParentEvents?: string[]
+
+    [key: string]: any
 }
 
 export interface IObject3D<E extends Event = IObject3DEvent, ET = IObject3DEventTypes> extends Object3D<E, ET>, IUiConfigContainer, IDisposable {

src/core/geometry/iGeometryCommons.ts

@@ -177,4 +177,6 @@ function upgradeGeometry(this: IGeometry) {
     // todo: dispose uiconfig on geometry dispose
 
     // todo: add serialization?
+
+    return this
 }

src/core/object/Mesh2.ts

@@ -1,5 +1,5 @@
 import {Mesh} from 'three'
-import {IObject3D} from '../IObject'
+import {IObject3D, IObject3DUserData} from '../IObject'
 import {iObjectCommons} from './iObjectCommons'
 import {IMaterial} from '../IMaterial'
 import {IGeometry} from '../IGeometry'
@@ -29,6 +29,8 @@ export class Mesh2<
         iObjectCommons.upgradeObject3D.call(this)
     }
 
+    userData: IObject3DUserData
+
     // region inherited type fixes
     // re-declaring from IObject3D because: https://github.com/microsoft/TypeScript/issues/16936
 

src/plugins/animation/GLTFAnimationPlugin.ts

@@ -184,16 +184,16 @@ export class GLTFAnimationPlugin extends AViewerPluginSync<'checkpointEnd'|'chec
     }
 
 
-    async onAdded(viewer: ThreeViewer): Promise<void> {
+    onAdded(viewer: ThreeViewer): void {
+        super.onAdded(viewer)
         viewer.scene.addEventListener('addSceneObject', this._objectAdded)
         viewer.addEventListener('postFrame', this._postFrame)
         window.addEventListener('wheel', this._wheel)
         window.addEventListener('scroll', this._scroll)
         this._pointerDragHelper.element = viewer.canvas
-        return super.onAdded(viewer)
     }
 
-    async onRemove(viewer: ThreeViewer): Promise<void> {
+    onRemove(viewer: ThreeViewer): void {
         while (this.animations.length) this.animations.pop()
         viewer.scene.removeEventListener('addSceneObject', this._objectAdded)
         viewer.removeEventListener('postFrame', this._postFrame)

src/plugins/pipeline/GBufferPlugin.ts

@@ -392,7 +392,7 @@ export class GBufferMaterial extends ShaderMaterial2 {
         this.uniformsNeedUpdate = true
 
         updateMaterialDefines({
-            ['USE_ALPHAMAP']: this.uniforms.alphaMap.value ? 1 : undefined,
+            // ['USE_ALPHAMAP']: this.uniforms.alphaMap.value ? 1 : undefined,
             ['ALPHAMAP_UV']: this.uniforms.alphaMap.value ? 'uv' : undefined, // todo use getChannel, see WebGLPrograms.js
             ['USE_DISPLACEMENTMAP']: this.uniforms.displacementMap.value ? 1 : undefined,
             ['DISPLACEMENTMAP_UV']: this.uniforms.displacementMap.value ? 'uv' : undefined, // todo use getChannel, see WebGLPrograms.js

src/plugins/pipeline/ProgressivePlugin.ts

@@ -111,7 +111,7 @@ export class ProgressivePlugin
      * @param postRender - if called after rendering frame.
      */
     public isConverged(postRender = false): boolean {
-        return (this._viewer?.renderer.frameCount || 0) >= this.maxFrameCount - 1 + (postRender ? 1 : 0)
+        return (this._viewer?.renderManager.frameCount || 0) >= this.maxFrameCount - 1 + (postRender ? 1 : 0)
     }
 
     updateShaderProperties(material: {defines: Record<string, string | number | undefined>; uniforms: {[p: string]: IUniform}}): this {

src/plugins/postprocessing/AScreenPassExtensionPlugin.ts

@@ -1,5 +1,5 @@
 import {type AViewerPlugin, AViewerPluginSync} from '../../viewer/AViewerPlugin'
-import type {ThreeViewer} from '../../viewer'
+import type {IViewerEvent, ThreeViewer} from '../../viewer'
 import {MaterialExtension} from '../../materials'
 import {Shader, Vector4, WebGLRenderer} from 'three'
 import {IMaterial} from '../../core'
@@ -80,11 +80,21 @@ export abstract class AScreenPassExtensionPlugin<T extends string> extends AView
 
     onAdded(viewer: ThreeViewer) {
         super.onAdded(viewer)
-        viewer.getPlugin(GBufferPlugin)?.registerGBufferUpdater(this.constructor.PluginType, this.updateGBufferFlags)
+        const gbuffer = viewer.getPlugin(GBufferPlugin)
+        if (gbuffer) gbuffer.registerGBufferUpdater(this.constructor.PluginType, this.updateGBufferFlags.bind(this))
+        else viewer.addEventListener('addPlugin', this._onPluginAdd)
         viewer.renderManager.screenPass.material.registerMaterialExtensions([this])
     }
 
+    private _onPluginAdd = (e: IViewerEvent)=>{
+        if (e.plugin?.constructor?.PluginType !== 'GBuffer') return
+        const gbuffer = e.plugin as GBufferPlugin
+        gbuffer.registerGBufferUpdater(this.constructor.PluginType, this.updateGBufferFlags.bind(this))
+        this._viewer?.removeEventListener('addPlugin', this._onPluginAdd)
+    }
+
     onRemove(viewer: ThreeViewer) {
+        viewer.removeEventListener('addPlugin', this._onPluginAdd)
         viewer.getPlugin(GBufferPlugin)?.unregisterGBufferUpdater(this.constructor.PluginType)
         viewer.renderManager.screenPass.material.unregisterMaterialExtensions([this])
         super.onRemove(viewer)

src/plugins/postprocessing/shaders/TonemapPlugin.patch.glsl

@@ -1,6 +1,6 @@
 bool doTonemap = true;
 #ifdef HAS_GBUFFER
-// doTonemap = getToneMapBit(getGBufferFlags(vUv).a) > 0; // todo
+doTonemap = getToneMapBit(getGBufferFlags(vUv).a) > 0;
 #if TONEMAP_BACKGROUND < 1
 if(isBackground) doTonemap = false;
 #endif

src/postprocessing/ExtendedRenderPass.ts

@@ -163,7 +163,9 @@ export class ExtendedRenderPass extends RenderPass implements IPipelinePass<'ren
             }
             this.renderToScreen = false // for super RenderPass.render
 
-            if (renderer.info && !renderer.info.autoReset) throw 'renderer.info.autoReset must be true'
+            if (renderer.info && !renderer.info.autoReset)
+                throw 'renderer.info.autoReset must be true' // it is required to check if any object is rendered in the scene, also frame count is maintained separately in the render manager, use that.
+
 
             // Opaque
             {

src/rendering/RenderManager.ts

@@ -146,7 +146,7 @@ export class RenderManager extends RenderTargetManager<IRenderManagerEvent, IRen
             preserveDrawingBuffer: true,
             powerPreference: RenderManager.POWER_PREFERENCE,
         })
-        renderer.info.autoReset = false
+        // renderer.info.autoReset = false // Not supported by ExtendedRenderPass
 
         renderer.useLegacyLights = false
         renderer.setAnimationLoop(this._animationLoop)
@@ -225,7 +225,6 @@ export class RenderManager extends RenderTargetManager<IRenderManagerEvent, IRen
         if (renderToScreen) {
             this._frameCount += 1
             this._totalFrameCount += 1
-            this._renderer.info.reset()
         }
         this._dirty = false
     }