@babylonjs/core 5.24.0 → 5.26.0

package/scene.js

@@ -51,13 +51,13 @@ export class Scene extends AbstractScene {
     constructor(engine, options) {
         super();
         // Members
-        /** @hidden */
+        /** @internal */
         this._inputManager = new InputManager(this);
         /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
         this.cameraToUseForPointers = null;
-        /** @hidden */
+        /** @internal */
         this._isScene = true;
-        /** @hidden */
+        /** @internal */
         this._blockEntityCollection = false;
         /**
          * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
@@ -328,7 +328,7 @@ export class Scene extends AbstractScene {
          */
         this.onAnimationFileImportedObservable = new Observable();
         // Animations
-        /** @hidden */
+        /** @internal */
         this._registeredForLateAnimationBindings = new SmartArrayNoDuplicate(256);
         /**
          * Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer move event occurs.
@@ -473,13 +473,13 @@ export class Scene extends AbstractScene {
         this.proceduralTexturesEnabled = true;
         // Performance counters
         this._totalVertices = new PerfCounter();
-        /** @hidden */
+        /** @internal */
         this._activeIndices = new PerfCounter();
-        /** @hidden */
+        /** @internal */
         this._activeParticles = new PerfCounter();
-        /** @hidden */
+        /** @internal */
         this._activeBones = new PerfCounter();
-        /** @hidden */
+        /** @internal */
         this._animationTime = 0;
         /**
          * Gets or sets a general scale for animation speed
@@ -493,10 +493,10 @@ export class Scene extends AbstractScene {
         this._defaultFrameBufferCleared = false;
         this._viewUpdateFlag = -1;
         this._projectionUpdateFlag = -1;
-        /** @hidden */
+        /** @internal */
         this._toBeDisposed = new Array(256);
         this._activeRequests = new Array();
-        /** @hidden */
+        /** @internal */
         this._pendingData = new Array();
         this._isDisposed = false;
         /**
@@ -508,11 +508,11 @@ export class Scene extends AbstractScene {
         this._processedMaterials = new SmartArray(256);
         this._renderTargets = new SmartArrayNoDuplicate(256);
         this._materialsRenderTargets = new SmartArrayNoDuplicate(256);
-        /** @hidden */
+        /** @internal */
         this._activeParticleSystems = new SmartArray(256);
         this._activeSkeletons = new SmartArrayNoDuplicate(32);
         this._softwareSkinnedMeshes = new SmartArrayNoDuplicate(32);
-        /** @hidden */
+        /** @internal */
         this._activeAnimatables = new Array();
         this._transformMatrix = Matrix.Zero();
         /**
@@ -521,12 +521,12 @@ export class Scene extends AbstractScene {
          */
         this.requireLightSorting = false;
         /**
-         * @hidden
+         * @internal
          * Backing store of defined scene components.
          */
         this._components = [];
         /**
-         * @hidden
+         * @internal
          * Backing store of defined scene components.
          */
         this._serializableComponents = [];
@@ -535,112 +535,121 @@ export class Scene extends AbstractScene {
          */
         this._transientComponents = [];
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening before camera updates.
          */
         this._beforeCameraUpdateStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening before clear the canvas.
          */
         this._beforeClearStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening before clear the canvas.
          */
         this._beforeRenderTargetClearStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions when collecting render targets for the frame.
          */
         this._gatherRenderTargetsStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening for one camera in the frame.
          */
         this._gatherActiveCameraRenderTargetsStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening during the per mesh ready checks.
          */
         this._isReadyForMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening before evaluate active mesh checks.
          */
         this._beforeEvaluateActiveMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening during the evaluate sub mesh checks.
          */
         this._evaluateSubMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening during the active mesh stage.
          */
         this._preActiveMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening during the per camera render target step.
          */
         this._cameraDrawRenderTargetStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just before the active camera is drawing.
          */
         this._beforeCameraDrawStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just before a render target is drawing.
          */
         this._beforeRenderTargetDrawStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just before a rendering group is drawing.
          */
         this._beforeRenderingGroupDrawStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just before a mesh is drawing.
          */
         this._beforeRenderingMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just after a mesh has been drawn.
          */
         this._afterRenderingMeshStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just after a rendering group has been drawn.
          */
         this._afterRenderingGroupDrawStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening just after the active camera has been drawn.
          */
         this._afterCameraDrawStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
+         * Defines the actions happening just after the post processing
+         */
+        this._afterCameraPostProcessStage = Stage.Create();
+        /**
+         * @internal
          * Defines the actions happening just after a render target has been drawn.
          */
         this._afterRenderTargetDrawStage = Stage.Create();
         /**
-         * @hidden
+         * Defines the actions happening just after the post processing on a render target
+         */
+        this._afterRenderTargetPostProcessStage = Stage.Create();
+        /**
+         * @internal
          * Defines the actions happening just after rendering all cameras and computing intersections.
          */
         this._afterRenderStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening when a pointer move event happens.
          */
         this._pointerMoveStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening when a pointer down event happens.
          */
         this._pointerDownStage = Stage.Create();
         /**
-         * @hidden
+         * @internal
          * Defines the actions happening when a pointer up event happens.
          */
         this._pointerUpStage = Stage.Create();
@@ -657,11 +666,11 @@ export class Scene extends AbstractScene {
             length: 0
         };
         this._preventFreeActiveMeshesAndRenderingGroups = false;
-        /** @hidden */
+        /** @internal */
         this._activeMeshesFrozen = false;
         this._activeMeshesFrozenButKeepClipping = false;
         this._skipEvaluateActiveMeshesCompletely = false;
-        /** @hidden */
+        /** @internal */
         this._allowPostProcessClearColor = true;
         /**
          * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
@@ -788,10 +797,21 @@ export class Scene extends AbstractScene {
         }
         this._performancePriority = value;
         switch (value) {
+            case ScenePerformancePriority.BackwardCompatible:
+                this.skipFrustumClipping = false;
+                this._renderingManager.maintainStateBetweenFrames = false;
+                this.skipPointerMovePicking = false;
+                this.autoClear = true;
+                break;
+            case ScenePerformancePriority.Intermediate:
+                this.skipFrustumClipping = false;
+                this._renderingManager.maintainStateBetweenFrames = false;
+                this.skipPointerMovePicking = true;
+                this.autoClear = false;
+                break;
             case ScenePerformancePriority.Aggressive:
                 this.skipFrustumClipping = true;
-            // eslint-disable-next-line no-fallthrough
-            case ScenePerformancePriority.Intermediate:
+                this._renderingManager.maintainStateBetweenFrames = true;
                 this.skipPointerMovePicking = true;
                 this.autoClear = false;
                 break;
@@ -1127,7 +1147,7 @@ export class Scene extends AbstractScene {
     get skeletonsEnabled() {
         return this._skeletonsEnabled;
     }
-    /** @hidden */
+    /** @internal */
     get collisionCoordinator() {
         if (!this._collisionCoordinator) {
             this._collisionCoordinator = Scene.CollisionCoordinatorFactory();
@@ -1135,6 +1155,12 @@ export class Scene extends AbstractScene {
         }
         return this._collisionCoordinator;
     }
+    /**
+     * Gets the scene's rendering manager
+     */
+    get renderingManager() {
+        return this._renderingManager;
+    }
     /**
      * Gets the list of frustum planes (built from the active camera)
      */
@@ -1154,7 +1180,7 @@ export class Scene extends AbstractScene {
         }
     }
     /**
-     * @hidden
+     * @internal
      * Add a component to the scene.
      * Note that the ccomponent could be registered on th next frame if this is called after
      * the register component stage.
@@ -1169,7 +1195,7 @@ export class Scene extends AbstractScene {
         }
     }
     /**
-     * @hidden
+     * @internal
      * Gets a component from the scene.
      * @param name defines the name of the component to retrieve
      * @returns the component or null if not present
@@ -1190,7 +1216,7 @@ export class Scene extends AbstractScene {
         return "Scene";
     }
     /**
-     * @hidden
+     * @internal
      */
     _getDefaultMeshCandidates() {
         this._defaultMeshCandidates.data = this.meshes;
@@ -1198,8 +1224,7 @@ export class Scene extends AbstractScene {
         return this._defaultMeshCandidates;
     }
     /**
-     * @param mesh
-     * @hidden
+     * @internal
      */
     _getDefaultSubMeshCandidates(mesh) {
         this._defaultSubMeshCandidates.data = mesh.subMeshes;
@@ -1657,8 +1682,7 @@ export class Scene extends AbstractScene {
         });
     }
     /**
-     * @param checkRenderTargets
-     * @hidden
+     * @internal
      */
     _checkIsReady(checkRenderTargets = false) {
         this._registerTransientComponents();
@@ -2940,14 +2964,8 @@ export class Scene extends AbstractScene {
     removeExternalData(key) {
         return this._externalData.remove(key);
     }
-    _evaluateSubMesh(subMesh, mesh, initialMesh) {
-        if (initialMesh.hasInstances ||
-            initialMesh.isAnInstance ||
-            this.dispatchAllSubMeshesOfActiveMeshes ||
-            this._skipFrustumClipping ||
-            mesh.alwaysSelectAsActiveMesh ||
-            mesh.subMeshes.length === 1 ||
-            subMesh.isInFrustum(this._frustumPlanes)) {
+    _evaluateSubMesh(subMesh, mesh, initialMesh, forcePush) {
+        if (forcePush || subMesh.isInFrustum(this._frustumPlanes)) {
             for (const step of this._evaluateSubMeshStage) {
                 step.action(mesh, subMesh);
             }
@@ -3028,7 +3046,7 @@ export class Scene extends AbstractScene {
             }
         }
     }
-    /** @hidden */
+    /** @internal */
     _isInIntermediateRendering() {
         return this._intermediateRendering;
     }
@@ -3190,7 +3208,6 @@ export class Scene extends AbstractScene {
                 mesh._postActivate();
             }
         }
-        this.onAfterActiveMeshesEvaluationObservable.notifyObservers(this);
         // Particle systems
         if (this.particlesEnabled) {
             this.onBeforeParticlesRenderingObservable.notifyObservers(this);
@@ -3219,12 +3236,14 @@ export class Scene extends AbstractScene {
                 this._softwareSkinnedMeshes.pushNoDuplicate(mesh);
             }
         }
+        let forcePush = sourceMesh.hasInstances || sourceMesh.isAnInstance || this.dispatchAllSubMeshesOfActiveMeshes || this._skipFrustumClipping || mesh.alwaysSelectAsActiveMesh;
         if (mesh && mesh.subMeshes && mesh.subMeshes.length > 0) {
             const subMeshes = this.getActiveSubMeshCandidates(mesh);
             const len = subMeshes.length;
+            forcePush = forcePush || len === 1;
             for (let i = 0; i < len; i++) {
                 const subMesh = subMeshes.data[i];
-                this._evaluateSubMesh(subMesh, mesh, sourceMesh);
+                this._evaluateSubMesh(subMesh, mesh, sourceMesh, forcePush);
             }
         }
     }
@@ -3289,10 +3308,7 @@ export class Scene extends AbstractScene {
         }
     }
     /**
-     * @param camera
-     * @param rigParent
-     * @param bindFrameBuffer
-     * @hidden
+     * @internal
      */
     _renderForCamera(camera, rigParent, bindFrameBuffer = true) {
         if (camera && camera._skipRendering) {
@@ -3400,6 +3416,10 @@ export class Scene extends AbstractScene {
             const texture = camera.outputRenderTarget ? camera.outputRenderTarget.renderTarget : undefined;
             this.postProcessManager._finalizeFrame(camera.isIntermediate, texture);
         }
+        // After post process
+        for (const step of this._afterCameraPostProcessStage) {
+            step.action(this.activeCamera);
+        }
         // Reset some special arrays
         this._renderTargets.reset();
         this.onAfterCameraRenderObservable.notifyObservers(this.activeCamera);
@@ -3470,13 +3490,12 @@ export class Scene extends AbstractScene {
         }
     }
     /**
-     * @param step
-     * @hidden
+     * @internal
      */
     _advancePhysicsEngineStep(step) {
         // Do nothing. Code will be replaced if physics engine component is referenced
     }
-    /** @hidden */
+    /** @internal */
     _animate() {
         // Nothing to do as long as Animatable have not been imported.
     }
@@ -4082,7 +4101,7 @@ export class Scene extends AbstractScene {
         return this._inputManager.getPointerOverMesh();
     }
     // Misc.
-    /** @hidden */
+    /** @internal */
     _rebuildGeometries() {
         for (const geometry of this.geometries) {
             geometry._rebuild();
@@ -4105,7 +4124,7 @@ export class Scene extends AbstractScene {
             }
         }
     }
-    /** @hidden */
+    /** @internal */
     _rebuildTextures() {
         for (const texture of this.textures) {
             texture._rebuild();
@@ -4241,14 +4260,7 @@ export class Scene extends AbstractScene {
         }
     }
     /**
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFile(fileOrUrl, onSuccess, onProgress, useOfflineSupport, useArrayBuffer, onError, onOpened) {
         const request = LoadFile(fileOrUrl, onSuccess, onProgress, useOfflineSupport ? this.offlineProvider : undefined, useArrayBuffer, onError, onOpened);
@@ -4259,12 +4271,7 @@ export class Scene extends AbstractScene {
         return request;
     }
     /**
-     * @param fileOrUrl
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFileAsync(fileOrUrl, onProgress, useOfflineSupport, useArrayBuffer, onOpened) {
         return new Promise((resolve, reject) => {
@@ -4276,14 +4283,7 @@ export class Scene extends AbstractScene {
         });
     }
     /**
-     * @param url
-     * @param onSuccess
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _requestFile(url, onSuccess, onProgress, useOfflineSupport, useArrayBuffer, onError, onOpened) {
         const request = RequestFile(url, onSuccess, onProgress, useOfflineSupport ? this.offlineProvider : undefined, useArrayBuffer, onError, onOpened);
@@ -4294,12 +4294,7 @@ export class Scene extends AbstractScene {
         return request;
     }
     /**
-     * @param url
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _requestFileAsync(url, onProgress, useOfflineSupport, useArrayBuffer, onOpened) {
         return new Promise((resolve, reject) => {
@@ -4311,12 +4306,7 @@ export class Scene extends AbstractScene {
         });
     }
     /**
-     * @param file
-     * @param onSuccess
-     * @param onProgress
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     _readFile(file, onSuccess, onProgress, useArrayBuffer, onError) {
         const request = ReadFile(file, onSuccess, onProgress, useArrayBuffer, onError);
@@ -4327,10 +4317,7 @@ export class Scene extends AbstractScene {
         return request;
     }
     /**
-     * @param file
-     * @param onProgress
-     * @param useArrayBuffer
-     * @hidden
+     * @internal
      */
     _readFileAsync(file, onProgress, useArrayBuffer) {
         return new Promise((resolve, reject) => {
@@ -4368,8 +4355,7 @@ Scene.MinDeltaTime = 1.0;
  */
 Scene.MaxDeltaTime = 1000.0;
 /**
- * @param id
- * @hidden
+ * @internal
  */
 Scene.prototype.setActiveCameraByID = function (id) {
     return this.setActiveCameraById(id);