@babylonjs/core 5.24.0 → 5.26.0

package/Meshes/mesh.js

@@ -23,12 +23,12 @@ import { _WarnImport } from "../Misc/devTools.js";
 import { SceneComponentConstants } from "../sceneComponent.js";
 import { MeshLODLevel } from "./meshLODLevel.js";
 /**
- * @hidden
+ * @internal
  **/
 export class _CreationDataStorage {
 }
 /**
- * @hidden
+ * @internal
  **/
 class _InstanceDataStorage {
     constructor() {
@@ -39,7 +39,7 @@ class _InstanceDataStorage {
     }
 }
 /**
- * @hidden
+ * @internal
  **/
 export class _InstancesBatch {
     constructor() {
@@ -50,7 +50,7 @@ export class _InstancesBatch {
     }
 }
 /**
- * @hidden
+ * @internal
  **/
 class _ThinInstanceDataStorage {
     constructor() {
@@ -64,7 +64,7 @@ class _ThinInstanceDataStorage {
     }
 }
 /**
- * @hidden
+ * @internal
  **/
 class _InternalMeshDataInfo {
     constructor() {
@@ -115,18 +115,18 @@ export class Mesh extends AbstractMesh {
          */
         this.instances = new Array();
         // Private
-        /** @hidden */
+        /** @internal */
         this._creationDataStorage = null;
-        /** @hidden */
+        /** @internal */
         this._geometry = null;
-        /** @hidden */
+        /** @internal */
         this._instanceDataStorage = new _InstanceDataStorage();
-        /** @hidden */
+        /** @internal */
         this._thinInstanceDataStorage = new _ThinInstanceDataStorage();
-        /** @hidden */
+        /** @internal */
         this._shouldGenerateFlatShading = false;
         // Use by builder only to know what orientation were the mesh build in.
-        /** @hidden */
+        /** @internal */
         this._originalBuilderSideOrientation = Mesh.DEFAULTSIDE;
         /**
          * Use this property to change the original side orientation defined at construction time
@@ -307,7 +307,7 @@ export class Mesh extends AbstractMesh {
      * Gets the default side orientation.
      * @param orientation the orientation to value to attempt to get
      * @returns the default orientation
-     * @hidden
+     * @internal
      */
     static _GetDefaultSideOrientation(orientation) {
         return orientation || Mesh.FRONTSIDE; // works as Mesh.FRONTSIDE is 0
@@ -496,7 +496,7 @@ export class Mesh extends AbstractMesh {
     getClassName() {
         return "Mesh";
     }
-    /** @hidden */
+    /** @internal */
     get _isMesh() {
         return true;
     }
@@ -528,7 +528,7 @@ export class Mesh extends AbstractMesh {
         }
         return ret;
     }
-    /** @hidden */
+    /** @internal */
     _unBindEffect() {
         super._unBindEffect();
         for (const instance of this.instances) {
@@ -949,7 +949,7 @@ export class Mesh extends AbstractMesh {
         this._instanceDataStorage.overridenInstanceCount = count;
     }
     // Methods
-    /** @hidden */
+    /** @internal */
     _preActivate() {
         const internalDataInfo = this._internalMeshDataInfo;
         const sceneRenderId = this.getScene().getRenderId();
@@ -961,8 +961,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param renderId
-     * @hidden
+     * @internal
      */
     _preActivateForIntermediateRendering(renderId) {
         if (this._instanceDataStorage.visibleInstances) {
@@ -971,9 +970,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param instance
-     * @param renderId
-     * @hidden
+     * @internal
      */
     _registerInstanceForRenderId(instance, renderId) {
         if (!this._instanceDataStorage.visibleInstances) {
@@ -1001,7 +998,7 @@ export class Mesh extends AbstractMesh {
             this.thinInstanceRefreshBoundingInfo(false);
         }
     }
-    /** @hidden */
+    /** @internal */
     _postActivate() {
         if (this.edgesShareWithInstances && this.edgesRenderer && this.edgesRenderer.isEnabled && this._renderingGroup) {
             this._renderingGroup._edgesRenderers.pushNoDuplicate(this.edgesRenderer);
@@ -1024,8 +1021,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param force
-     * @hidden
+     * @internal
      */
     _createGlobalSubMesh(force) {
         const totalVertices = this.getTotalVertices();
@@ -1298,10 +1294,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param subMesh
-     * @param effect
-     * @param fillMode
-     * @hidden
+     * @internal
      */
     _bind(subMesh, effect, fillMode) {
         if (!this._geometry) {
@@ -1341,10 +1334,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param subMesh
-     * @param fillMode
-     * @param instancesCount
-     * @hidden
+     * @internal
      */
     _draw(subMesh, fillMode, instancesCount) {
         if (!this._geometry || !this._geometry.getVertexBuffers() || (!this._unIndexed && !this._geometry.getIndexBuffer())) {
@@ -1405,9 +1395,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param subMeshId
-     * @param isReplacementMode
-     * @hidden
+     * @internal
      */
     _getInstancesRenderList(subMeshId, isReplacementMode = false) {
         if (this._instanceDataStorage.isFrozen) {
@@ -1447,23 +1435,16 @@ export class Mesh extends AbstractMesh {
         return batchCache;
     }
     /**
-     * @param subMesh
-     * @param fillMode
-     * @param batch
-     * @param effect
-     * @param engine
-     * @hidden
+     * @internal
      */
     _renderWithInstances(subMesh, fillMode, batch, effect, engine) {
         const visibleInstances = batch.visibleInstances[subMesh._id];
-        if (!visibleInstances) {
-            return this;
-        }
+        const visibleInstanceCount = visibleInstances ? visibleInstances.length : 0;
         const instanceStorage = this._instanceDataStorage;
         const currentInstancesBufferSize = instanceStorage.instancesBufferSize;
         let instancesBuffer = instanceStorage.instancesBuffer;
         let instancesPreviousBuffer = instanceStorage.instancesPreviousBuffer;
-        const matricesCount = visibleInstances.length + 1;
+        const matricesCount = visibleInstanceCount + 1;
         const bufferSize = matricesCount * 16 * 4;
         while (instanceStorage.instancesBufferSize < bufferSize) {
             instanceStorage.instancesBufferSize *= 2;
@@ -1528,7 +1509,7 @@ export class Mesh extends AbstractMesh {
             }
         }
         else {
-            instancesCount = (renderSelf ? 1 : 0) + visibleInstances.length;
+            instancesCount = (renderSelf ? 1 : 0) + visibleInstanceCount;
         }
         if (needUpdateBuffer) {
             if (instancesBuffer) {
@@ -1593,11 +1574,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param subMesh
-     * @param fillMode
-     * @param effect
-     * @param engine
-     * @hidden
+     * @internal
      */
     _renderWithThinInstances(subMesh, fillMode, effect, engine) {
         // Stats
@@ -1623,24 +1600,14 @@ export class Mesh extends AbstractMesh {
         engine.unbindInstanceAttributes();
     }
     /**
-     * @param visibleInstances
-     * @param renderSelf
-     * @hidden
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _processInstancedBuffers(visibleInstances, renderSelf) {
         // Do nothing
     }
     /**
-     * @param renderingMesh
-     * @param subMesh
-     * @param effect
-     * @param fillMode
-     * @param batch
-     * @param hardwareInstancedRendering
-     * @param onBeforeDraw
-     * @param effectiveMaterial
-     * @hidden
+     * @internal
      */
     _processRendering(renderingMesh, subMesh, effect, fillMode, batch, hardwareInstancedRendering, onBeforeDraw, effectiveMaterial) {
         const scene = this.getScene();
@@ -1687,8 +1654,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     /**
-     * @param dispose
-     * @hidden
+     * @internal
      */
     _rebuild(dispose = false) {
         if (this._instanceDataStorage.instancesBuffer) {
@@ -1716,7 +1682,7 @@ export class Mesh extends AbstractMesh {
         this._internalMeshDataInfo._effectiveMaterial = null;
         super._rebuild(dispose);
     }
-    /** @hidden */
+    /** @internal */
     _freeze() {
         if (!this.subMeshes) {
             return;
@@ -1728,7 +1694,7 @@ export class Mesh extends AbstractMesh {
         this._internalMeshDataInfo._effectiveMaterial = null;
         this._instanceDataStorage.isFrozen = true;
     }
-    /** @hidden */
+    /** @internal */
     _unFreeze() {
         this._instanceDataStorage.isFrozen = false;
         this._instanceDataStorage.previousBatch = null;
@@ -1772,7 +1738,7 @@ export class Mesh extends AbstractMesh {
         if (this._internalMeshDataInfo._onBeforeRenderObservable) {
             this._internalMeshDataInfo._onBeforeRenderObservable.notifyObservers(this);
         }
-        const hardwareInstancedRendering = batch.hardwareInstancedRendering[subMesh._id] || subMesh.getRenderingMesh().hasThinInstances;
+        const hardwareInstancedRendering = batch.hardwareInstancedRendering[subMesh._id] || subMesh.getRenderingMesh().hasThinInstances || !!this._userInstancedBuffersStorage;
         const instanceDataStorage = this._instanceDataStorage;
         const material = subMesh.getMaterial();
         if (!material) {
@@ -2067,7 +2033,7 @@ export class Mesh extends AbstractMesh {
             numBadBoneIndices;
         return { skinned: true, valid: missingWeights === 0 && numberNotNormalized === 0 && numBadBoneIndices === 0, report: output };
     }
-    /** @hidden */
+    /** @internal */
     _checkDelayState() {
         const scene = this.getScene();
         if (this._geometry) {
@@ -2208,7 +2174,7 @@ export class Mesh extends AbstractMesh {
         return this;
     }
     // Cache
-    /** @hidden */
+    /** @internal */
     get _positions() {
         if (this._internalAbstractMeshDataInfo._positions) {
             return this._internalAbstractMeshDataInfo._positions;
@@ -2218,14 +2184,14 @@ export class Mesh extends AbstractMesh {
         }
         return null;
     }
-    /** @hidden */
+    /** @internal */
     _resetPointsArrayCache() {
         if (this._geometry) {
             this._geometry._resetPointsArrayCache();
         }
         return this;
     }
-    /** @hidden */
+    /** @internal */
     _generatePointsArray() {
         if (this._geometry) {
             return this._geometry._generatePointsArray();
@@ -2304,15 +2270,15 @@ export class Mesh extends AbstractMesh {
         }
         super.dispose(doNotRecurse, disposeMaterialAndTextures);
     }
-    /** @hidden */
+    /** @internal */
     _disposeInstanceSpecificData() {
         // Do nothing
     }
-    /** @hidden */
+    /** @internal */
     _disposeThinInstanceSpecificData() {
         // Do nothing
     }
-    /** @hidden */
+    /** @internal */
     _invalidateInstanceVertexArrayObject() {
         // Do nothing
     }
@@ -2833,19 +2799,14 @@ export class Mesh extends AbstractMesh {
     }
     // Instances
     /**
-     * @param name
-     * @param mesh
-     * @hidden
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/naming-convention
     static _instancedMeshFactory(name, mesh) {
         throw _WarnImport("InstancedMesh");
     }
     /**
-     * @param scene
-     * @param physicObject
-     * @param jsonObject
-     * @hidden
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     static _PhysicsImpostorParser(scene, physicObject, jsonObject) {
@@ -3096,7 +3057,7 @@ export class Mesh extends AbstractMesh {
             serializationObject.actions = this.actionManager.serialize(this.name);
         }
     }
-    /** @hidden */
+    /** @internal */
     _syncGeometryWithMorphTargetManager() {
         if (!this.geometry) {
             return;
@@ -3789,16 +3750,14 @@ export class Mesh extends AbstractMesh {
         return meshSubclass;
     }
     /**
-     * @param instance
-     * @hidden
+     * @internal
      */
     addInstance(instance) {
         instance._indexInSourceMeshInstanceArray = this.instances.length;
         this.instances.push(instance);
     }
     /**
-     * @param instance
-     * @hidden
+     * @internal
      */
     removeInstance(instance) {
         // Remove from mesh
@@ -3813,7 +3772,7 @@ export class Mesh extends AbstractMesh {
             this.instances.pop();
         }
     }
-    /** @hidden */
+    /** @internal */
     _shouldConvertRHS() {
         return this.overrideMaterialSideOrientation === Material.CounterClockWiseSideOrientation;
     }
@@ -3905,27 +3864,21 @@ Mesh.BOTTOM = 4;
 Mesh.INSTANCEDMESH_SORT_TRANSPARENT = false;
 // Statics
 /**
- * @param parsedMesh
- * @param scene
- * @hidden
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 Mesh._GroundMeshParser = (parsedMesh, scene) => {
     throw _WarnImport("GroundMesh");
 };
 /**
- * @param parsedMesh
- * @param scene
- * @hidden
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 Mesh._GoldbergMeshParser = (parsedMesh, scene) => {
     throw _WarnImport("GoldbergMesh");
 };
 /**
- * @param parsedMesh
- * @param scene
- * @hidden
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 Mesh._LinesMeshParser = (parsedMesh, scene) => {
@@ -3933,8 +3886,7 @@ Mesh._LinesMeshParser = (parsedMesh, scene) => {
 };
 RegisterClass("BABYLON.Mesh", Mesh);
 /**
- * @param id
- * @hidden
+ * @internal
  */
 Mesh.prototype.setMaterialByID = function (id) {
     return this.setMaterialById(id);