@babylonjs/core 9.2.0 → 9.2.2

package/Meshes/GaussianSplatting/gaussianSplattingCompoundMesh.js

@@ -1,4 +1,5 @@
 import { GaussianSplattingMesh } from "./gaussianSplattingMesh.js";
+import { Mesh } from "../mesh.js";
 /**
  * Class used to compose multiple Gaussian Splatting meshes into a single draw call,
  * with per-part world-matrix and visibility control via addPart/addParts/removePart.
@@ -21,7 +22,7 @@ export class GaussianSplattingCompoundMesh extends GaussianSplattingMesh {
     }
     /**
      * Add another mesh to this compound mesh as a new part.
-     * The source mesh's splat data is read directly — no merged CPU buffer is constructed.
+     * The source mesh's splat data is read directly and copied into the compound's retained source buffers.
      * @param other - The other mesh to add. Must be fully loaded before calling this method.
      * @param disposeOther - Whether to dispose the other mesh after adding it.
      * @returns a placeholder mesh that can be used to manipulate the part transform
@@ -31,7 +32,7 @@ export class GaussianSplattingCompoundMesh extends GaussianSplattingMesh {
     }
     /**
      * Add multiple meshes to this compound mesh as new parts in a single operation.
-     * Splat data is written directly into texture arrays without constructing a merged CPU buffer.
+     * Splat data is written into texture arrays while the compound refreshes its retained merged source buffers.
      * @param others - The meshes to add. Each must be fully loaded and must not be a compound.
      * @param disposeOthers - Whether to dispose the other meshes after adding them.
      * @returns an array of placeholder meshes that can be used to manipulate the part transforms
@@ -45,12 +46,36 @@ export class GaussianSplattingCompoundMesh extends GaussianSplattingMesh {
     }
     /**
      * Remove a part from this compound mesh.
-     * The remaining parts are rebuilt directly from their stored source mesh references —
-     * no merged CPU splat buffer is read back.
+     * The remaining parts are rebuilt directly from the compound mesh's retained source buffers.
      * @param index - The index of the part to remove
      */
     removePart(index) {
         super.removePart(index);
     }
+    /**
+     * Serialize current GaussianSplattingMesh
+     * @param serializationObject defines the object which will receive the serialization data
+     * @param encoding the encoding of binary data, defaults to base64 for json serialize,
+     * kept for future internal use like cloning where base64 encoding wastes cycles and memory
+     * @returns the serialized object
+     */
+    serialize(serializationObject = {}, encoding = "base64") {
+        serializationObject = super.serialize(serializationObject, encoding);
+        // Note here, the getClassName() is not overridden,
+        // as a lot of code currently depend on `getClassName() === "GaussianSplattingMesh"` check,
+        // to not break those code, serialization uses `_isCompound` to mark the type
+        serializationObject._isCompound = true;
+        return serializationObject;
+    }
+    /**
+     * Parses a serialized GaussianSplattingCompoundMesh
+     * @param parsedMesh the serialized mesh
+     * @param scene the scene to create the GaussianSplattingCompoundMesh in
+     * @returns the created GaussianSplattingCompoundMesh
+     */
+    static Parse(parsedMesh, scene) {
+        return GaussianSplattingMesh._ParseInternal(parsedMesh, scene, GaussianSplattingCompoundMesh);
+    }
 }
+Mesh._GaussianSplattingCompoundMeshParser = GaussianSplattingCompoundMesh.Parse;
 //# sourceMappingURL=gaussianSplattingCompoundMesh.js.map

package/Meshes/GaussianSplatting/gaussianSplattingCompoundMesh.js.map

@@ -1 +1 @@
-{"version":3,"file":"gaussianSplattingCompoundMesh.js","sourceRoot":"","sources":["../../../../../dev/core/src/Meshes/GaussianSplatting/gaussianSplattingCompoundMesh.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE;;;;;;;;GAQG;AACH,MAAM,OAAO,6BAA8B,SAAQ,qBAAqB;IACpE;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,MAAwB,IAAI,EAAE,QAAyB,IAAI,EAAE,YAAqB,KAAK;QAC7G,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACa,OAAO,CAAC,KAA4B,EAAE,eAAwB,IAAI;QAC9E,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,MAA+B,EAAE,gBAAyB,IAAI;QAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACtE,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACa,UAAU,CAAC,KAAa;QACpC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;CACJ","sourcesContent":["import { type Nullable } from \"core/types\";\r\nimport { type Scene } from \"core/scene\";\r\nimport { GaussianSplattingMesh } from \"./gaussianSplattingMesh\";\r\nimport { type GaussianSplattingPartProxyMesh } from \"./gaussianSplattingPartProxyMesh\";\r\n\r\n/**\r\n * Class used to compose multiple Gaussian Splatting meshes into a single draw call,\r\n * with per-part world-matrix and visibility control via addPart/addParts/removePart.\r\n *\r\n * This is the recommended class for multi-part Gaussian Splatting use cases.\r\n *\r\n * Next major version: the compound mesh API (addPart/addParts/removePart) will\r\n * move exclusively to this class and will be removed from GaussianSplattingMesh.\r\n */\r\nexport class GaussianSplattingCompoundMesh extends GaussianSplattingMesh {\r\n    /**\r\n     * Creates a new GaussianSplattingCompoundMesh\r\n     * @param name the name of the mesh\r\n     * @param url optional URL to load a Gaussian Splatting file from\r\n     * @param scene the hosting scene\r\n     * @param keepInRam whether to keep the raw splat data in RAM after uploading to GPU\r\n     */\r\n    constructor(name: string, url: Nullable<string> = null, scene: Nullable<Scene> = null, keepInRam: boolean = false) {\r\n        super(name, url, scene, keepInRam);\r\n    }\r\n\r\n    /**\r\n     * Add another mesh to this compound mesh as a new part.\r\n     * The source mesh's splat data is read directly — no merged CPU buffer is constructed.\r\n     * @param other - The other mesh to add. Must be fully loaded before calling this method.\r\n     * @param disposeOther - Whether to dispose the other mesh after adding it.\r\n     * @returns a placeholder mesh that can be used to manipulate the part transform\r\n     */\r\n    public override addPart(other: GaussianSplattingMesh, disposeOther: boolean = true): GaussianSplattingPartProxyMesh {\r\n        return super.addPart(other, disposeOther);\r\n    }\r\n\r\n    /**\r\n     * Add multiple meshes to this compound mesh as new parts in a single operation.\r\n     * Splat data is written directly into texture arrays without constructing a merged CPU buffer.\r\n     * @param others - The meshes to add. Each must be fully loaded and must not be a compound.\r\n     * @param disposeOthers - Whether to dispose the other meshes after adding them.\r\n     * @returns an array of placeholder meshes that can be used to manipulate the part transforms\r\n     */\r\n    public addParts(others: GaussianSplattingMesh[], disposeOthers: boolean = true): GaussianSplattingPartProxyMesh[] {\r\n        if (others.length === 0) {\r\n            return [];\r\n        }\r\n        const { proxyMeshes } = this._addPartsInternal(others, disposeOthers);\r\n        return proxyMeshes;\r\n    }\r\n\r\n    /**\r\n     * Remove a part from this compound mesh.\r\n     * The remaining parts are rebuilt directly from their stored source mesh references —\r\n     * no merged CPU splat buffer is read back.\r\n     * @param index - The index of the part to remove\r\n     */\r\n    public override removePart(index: number): void {\r\n        super.removePart(index);\r\n    }\r\n}\r\n"]}
+{"version":3,"file":"gaussianSplattingCompoundMesh.js","sourceRoot":"","sources":["../../../../../dev/core/src/Meshes/GaussianSplatting/gaussianSplattingCompoundMesh.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B;;;;;;;;GAQG;AACH,MAAM,OAAO,6BAA8B,SAAQ,qBAAqB;IACpE;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,MAAwB,IAAI,EAAE,QAAyB,IAAI,EAAE,YAAqB,KAAK;QAC7G,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACa,OAAO,CAAC,KAA4B,EAAE,eAAwB,IAAI;QAC9E,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,MAA+B,EAAE,gBAAyB,IAAI;QAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACtE,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACa,UAAU,CAAC,KAAa;QACpC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACa,SAAS,CAAC,sBAA2B,EAAE,EAAE,WAAmB,QAAQ;QAChF,mBAAmB,GAAG,KAAK,CAAC,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QACrE,mDAAmD;QACnD,2FAA2F;QAC3F,6EAA6E;QAC7E,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;QACvC,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAU,KAAK,CAAC,UAAe,EAAE,KAAY;QACtD,OAAO,qBAAqB,CAAC,cAAc,CAAC,UAAU,EAAE,KAAK,EAAE,6BAA6B,CAAC,CAAC;IAClG,CAAC;CACJ;AAED,IAAI,CAAC,oCAAoC,GAAG,6BAA6B,CAAC,KAAK,CAAC","sourcesContent":["import { type Nullable } from \"core/types\";\r\nimport { type Scene } from \"core/scene\";\r\nimport { GaussianSplattingMesh } from \"./gaussianSplattingMesh\";\r\nimport { type GaussianSplattingPartProxyMesh } from \"./gaussianSplattingPartProxyMesh\";\r\nimport { Mesh } from \"../mesh\";\r\n\r\n/**\r\n * Class used to compose multiple Gaussian Splatting meshes into a single draw call,\r\n * with per-part world-matrix and visibility control via addPart/addParts/removePart.\r\n *\r\n * This is the recommended class for multi-part Gaussian Splatting use cases.\r\n *\r\n * Next major version: the compound mesh API (addPart/addParts/removePart) will\r\n * move exclusively to this class and will be removed from GaussianSplattingMesh.\r\n */\r\nexport class GaussianSplattingCompoundMesh extends GaussianSplattingMesh {\r\n    /**\r\n     * Creates a new GaussianSplattingCompoundMesh\r\n     * @param name the name of the mesh\r\n     * @param url optional URL to load a Gaussian Splatting file from\r\n     * @param scene the hosting scene\r\n     * @param keepInRam whether to keep the raw splat data in RAM after uploading to GPU\r\n     */\r\n    constructor(name: string, url: Nullable<string> = null, scene: Nullable<Scene> = null, keepInRam: boolean = false) {\r\n        super(name, url, scene, keepInRam);\r\n    }\r\n\r\n    /**\r\n     * Add another mesh to this compound mesh as a new part.\r\n     * The source mesh's splat data is read directly and copied into the compound's retained source buffers.\r\n     * @param other - The other mesh to add. Must be fully loaded before calling this method.\r\n     * @param disposeOther - Whether to dispose the other mesh after adding it.\r\n     * @returns a placeholder mesh that can be used to manipulate the part transform\r\n     */\r\n    public override addPart(other: GaussianSplattingMesh, disposeOther: boolean = true): GaussianSplattingPartProxyMesh {\r\n        return super.addPart(other, disposeOther);\r\n    }\r\n\r\n    /**\r\n     * Add multiple meshes to this compound mesh as new parts in a single operation.\r\n     * Splat data is written into texture arrays while the compound refreshes its retained merged source buffers.\r\n     * @param others - The meshes to add. Each must be fully loaded and must not be a compound.\r\n     * @param disposeOthers - Whether to dispose the other meshes after adding them.\r\n     * @returns an array of placeholder meshes that can be used to manipulate the part transforms\r\n     */\r\n    public addParts(others: GaussianSplattingMesh[], disposeOthers: boolean = true): GaussianSplattingPartProxyMesh[] {\r\n        if (others.length === 0) {\r\n            return [];\r\n        }\r\n        const { proxyMeshes } = this._addPartsInternal(others, disposeOthers);\r\n        return proxyMeshes;\r\n    }\r\n\r\n    /**\r\n     * Remove a part from this compound mesh.\r\n     * The remaining parts are rebuilt directly from the compound mesh's retained source buffers.\r\n     * @param index - The index of the part to remove\r\n     */\r\n    public override removePart(index: number): void {\r\n        super.removePart(index);\r\n    }\r\n\r\n    /**\r\n     * Serialize current GaussianSplattingMesh\r\n     * @param serializationObject defines the object which will receive the serialization data\r\n     * @param encoding the encoding of binary data, defaults to base64 for json serialize,\r\n     * kept for future internal use like cloning where base64 encoding wastes cycles and memory\r\n     * @returns the serialized object\r\n     */\r\n    public override serialize(serializationObject: any = {}, encoding: string = \"base64\"): any {\r\n        serializationObject = super.serialize(serializationObject, encoding);\r\n        // Note here, the getClassName() is not overridden,\r\n        // as a lot of code currently depend on `getClassName() === \"GaussianSplattingMesh\"` check,\r\n        // to not break those code, serialization uses `_isCompound` to mark the type\r\n        serializationObject._isCompound = true;\r\n        return serializationObject;\r\n    }\r\n\r\n    /**\r\n     * Parses a serialized GaussianSplattingCompoundMesh\r\n     * @param parsedMesh the serialized mesh\r\n     * @param scene the scene to create the GaussianSplattingCompoundMesh in\r\n     * @returns the created GaussianSplattingCompoundMesh\r\n     */\r\n    public static override Parse(parsedMesh: any, scene: Scene): GaussianSplattingCompoundMesh {\r\n        return GaussianSplattingMesh._ParseInternal(parsedMesh, scene, GaussianSplattingCompoundMesh);\r\n    }\r\n}\r\n\r\nMesh._GaussianSplattingCompoundMeshParser = GaussianSplattingCompoundMesh.Parse;\r\n"]}

package/Meshes/GaussianSplatting/gaussianSplattingMesh.d.ts

@@ -5,6 +5,18 @@ import { type Effect } from "../../Materials/effect.js";
 import { GaussianSplattingMeshBase } from "./gaussianSplattingMeshBase.js";
 import "../thinInstanceMesh.js";
 import { GaussianSplattingPartProxyMesh } from "./gaussianSplattingPartProxyMesh.js";
+import { type BoundingInfo } from "../../Culling/boundingInfo.js";
+interface IGaussianSplattingPartSource {
+    name: string;
+    _vertexCount: number;
+    _splatsData: Nullable<ArrayBuffer>;
+    _shData: Nullable<Uint8Array[]>;
+    _shDegree: number;
+    isCompound: boolean;
+    getWorldMatrix(): Matrix;
+    getBoundingInfo(): BoundingInfo;
+    dispose(): void;
+}
 /**
  * Class used to render a Gaussian Splatting mesh. Supports both single-cloud and compound
  * (multi-part) rendering. In compound mode, multiple Gaussian Splatting source meshes are
@@ -140,22 +152,25 @@ export declare class GaussianSplattingMesh extends GaussianSplattingMeshBase {
      * @param partIndices - Part index data; if undefined the method is a no-op
      */
     protected _ensurePartIndicesTexture(textureSize: Vector2, partIndices: Uint8Array | undefined): void;
+    private _appendPartSourceToArrays;
+    private _createRetainedPartSource;
+    private _retainMergedPartData;
     /**
-     * Core implementation for adding one or more external GaussianSplattingMesh objects as new
-     * parts. Writes directly into texture-sized CPU arrays and uploads in one pass — no merged
-     * CPU splat buffer is ever constructed.
+     * Core implementation for adding one or more source parts as new
+     * parts. Writes directly into texture-sized CPU arrays, updates the retained merged source
+     * buffers, and uploads in one pass.
      *
      * @param others - Source meshes to append (must each be non-compound and fully loaded)
      * @param disposeOthers - Dispose source meshes after appending
      * @returns Proxy meshes and their assigned part indices
      */
-    protected _addPartsInternal(others: GaussianSplattingMesh[], disposeOthers: boolean): {
+    protected _addPartsInternal(others: IGaussianSplattingPartSource[], disposeOthers: boolean): {
         proxyMeshes: GaussianSplattingPartProxyMesh[];
         assignedPartIndices: number[];
     };
     /**
      * Add another mesh to this mesh, as a new part. This makes the current mesh a compound, if not already.
-     * The source mesh's splat data is read directly — no merged CPU buffer is constructed.
+     * The source mesh's splat data is read directly and copied into the compound's retained source buffers.
      * @param other - The other mesh to add. Must be fully loaded before calling this method.
      * @param disposeOther - Whether to dispose the other mesh after adding it to the current mesh.
      * @returns a placeholder mesh that can be used to manipulate the part transform
@@ -164,11 +179,36 @@ export declare class GaussianSplattingMesh extends GaussianSplattingMeshBase {
     addPart(other: GaussianSplattingMesh, disposeOther?: boolean): GaussianSplattingPartProxyMesh;
     /**
      * Remove a part from this compound mesh.
-     * The remaining parts are rebuilt directly from their stored source mesh references —
-     * no merged CPU splat buffer is read back. The current mesh is reset to a plain (single-part)
-     * state and then each remaining source is re-added via addParts.
+     * The remaining parts are rebuilt directly from the compound mesh's retained source buffers.
+     * The current mesh is reset to a plain (single-part) state and then each remaining source is
+     * re-added via addParts.
      * @param index - The index of the part to remove
      * @deprecated Use {@link GaussianSplattingCompoundMesh.removePart} instead.
      */
     removePart(index: number): void;
+    /**
+     * Serialize current GaussianSplattingMesh
+     * @param serializationObject defines the object which will receive the serialization data
+     * @param encoding the encoding of binary data, defaults to base64 for json serialize,
+     * kept for future internal use like cloning where base64 encoding wastes cycles and memory
+     * @returns the serialized object
+     */
+    serialize(serializationObject?: any, encoding?: string): any;
+    /**
+     * Internal helper to parses a serialized GaussianSplattingMesh or GaussianSplattingCompoundMesh
+     * @param parsedMesh the serialized mesh
+     * @param scene the scene to create the GaussianSplattingMesh or GaussianSplattingCompoundMesh in
+     * @param ctor the constructor of the mesh to create
+     * @returns the created GaussianSplattingMesh
+     * @internal
+     */
+    static _ParseInternal<T extends GaussianSplattingMesh>(parsedMesh: any, scene: Scene, ctor: new (name: string, url: Nullable<string>, scene: Nullable<Scene>, keepInRam: boolean) => T): T;
+    /**
+     * Parses a serialized GaussianSplattingMesh
+     * @param parsedMesh the serialized mesh
+     * @param scene the scene to create the GaussianSplattingMesh in
+     * @returns the created GaussianSplattingMesh
+     */
+    static Parse(parsedMesh: any, scene: Scene): GaussianSplattingMesh;
 }
+export {};