@babylonjs/core 8.47.2 → 8.48.1

package/Meshes/GaussianSplatting/gaussianSplattingMesh.d.ts

@@ -4,7 +4,7 @@ import type { BaseTexture } from "../../Materials/Textures/baseTexture.js";
 import { SubMesh } from "../subMesh.js";
 import type { AbstractMesh } from "../abstractMesh.js";
 import { Mesh } from "../mesh.js";
-import { Vector3 } from "../../Maths/math.vector.js";
+import { Matrix, Vector3 } from "../../Maths/math.vector.js";
 import "../thinInstanceMesh.js";
 import type { Material } from "../../Materials/material.js";
 import type { Camera } from "../../Cameras/camera.js";
@@ -186,6 +186,7 @@ export declare class GaussianSplattingMesh extends Mesh {
     private _vertexCount;
     private _worker;
     private _modelViewProjectionMatrix;
+    private _viewProjectionMatrix;
     private _depthMix;
     private _canPostToWorker;
     private _readyToDisplay;
@@ -197,6 +198,11 @@ export declare class GaussianSplattingMesh extends Mesh {
     private _splatIndex;
     private _shTextures;
     private _splatsData;
+    private _shData;
+    private _partIndicesTexture;
+    private _partIndices;
+    private _partMatrices;
+    private _textureSize;
     private readonly _keepInRam;
     private _delayedTextureUpdate;
     private _useRGBACovariants;
@@ -238,6 +244,22 @@ export declare class GaussianSplattingMesh extends Mesh {
      * returns the splats data array buffer that contains in order : postions (3 floats), size (3 floats), color (4 bytes), orientation quaternion (4 bytes)
      */
     get splatsData(): Nullable<ArrayBuffer>;
+    /**
+     * returns the SH data arrays
+     */
+    get shData(): Nullable<Uint8Array<ArrayBufferLike>[]>;
+    /**
+     * True when this mesh is a compound that regroups multiple Gaussian splatting parts.
+     */
+    get isCompound(): boolean;
+    /**
+     * returns the part indices array
+     */
+    get partIndices(): Nullable<Uint8Array<ArrayBufferLike>>;
+    /**
+     * Gets the part indices texture, if the mesh is a compound
+     */
+    get partIndicesTexture(): Nullable<BaseTexture>;
     /**
      * Set the number of batch (a batch is 16384 splats) after which a display update is performed
      * A value of 0 (default) means display update will not happens before splat is ready.
@@ -411,17 +433,19 @@ export declare class GaussianSplattingMesh extends Mesh {
      * Update asynchronously the buffer
      * @param data array buffer containing center, color, orientation and scale of splats
      * @param sh optional array of uint8 array for SH data
+     * @param partIndices optional array of uint8 for rig node indices
      * @returns a promise
      */
-    updateDataAsync(data: ArrayBuffer, sh?: Uint8Array[]): Promise<void>;
+    updateDataAsync(data: ArrayBuffer, sh?: Uint8Array[], partIndices?: Uint8Array): Promise<void>;
     /**
      * @experimental
      * Update data from GS (position, orientation, color, scaling)
      * @param data array that contain all the datas
      * @param sh optional array of uint8 array for SH data
-     * @param options optional informations on how to treat data
+     * @param options optional informations on how to treat data (needs to be 3rd for backward compatibility)
+     * @param partIndices optional array of uint8 for rig node indices
      */
-    updateData(data: ArrayBuffer, sh?: Uint8Array[], options?: IUpdateOptions): void;
+    updateData(data: ArrayBuffer, sh?: Uint8Array[], options?: IUpdateOptions, partIndices?: Uint8Array): void;
     /**
      * Refreshes the bounding info, taking into account all the thin instances defined
      * @returns the current Gaussian Splatting
@@ -431,5 +455,45 @@ export declare class GaussianSplattingMesh extends Mesh {
     private _updateSubTextures;
     private _instanciateWorker;
     private _getTextureSize;
+    /**
+     * Gets the number of parts in the compound
+     * @returns the number of parts in the compound, or 0 if the mesh is not a compound
+     */
+    get partCount(): number;
+    /**
+     * Sets the world matrix for a specific part of the compound (if this mesh is a compound).
+     * This will trigger a re-sort of the mesh.
+     * @param partIndex index of the part, that must be between 0 and partCount - 1
+     * @param worldMatrix the world matrix to set
+     */
+    setWorldMatrixForPart(partIndex: number, worldMatrix: Matrix): void;
+    /**
+     * Gets the world matrix for a specific part of the compound (if this mesh is a compound).
+     * @param partIndex index of the part, that must be between 0 and partCount - 1
+     * @returns the world matrix for the part, or the current world matrix of the mesh if the mesh is not a compound
+     */
+    getWorldMatrixForPart(partIndex: number): Matrix;
+    /**
+     * Ensure that the part world matrix array is at least the given length.
+     * NB: This length is used as reference for the number of parts in the compound.
+     * Newly inserted parts are initialized with the current world matrix of the mesh.
+     * @param length - The minimum length to ensure
+     */
+    private _ensureMinimumPartMatricesLength;
+    /**
+     * This sets the number of parts in the compound.
+     * Warning: This must be consistent with the indices used in the partIndices texture.
+     * Newly inserted parts are initialized with the current world matrix of the mesh.
+     * @param length - The length to resize to
+     */
+    private _resizePartMatrices;
+    /**
+     * Add another mesh to this mesh, as a new part. This makes the current mesh a compound, if not already.
+     * NB: The current mesh needs to be loaded with keepInRam: true.
+     * @param other - The other mesh to add. This must be loaded with keepInRam: true.
+     * @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
+     */
+    addPart(other: GaussianSplattingMesh, disposeOther?: boolean): Mesh;
 }
 export {};