babylonjs-loaders 9.1.0 → 9.2.2

package/babylonjs.loaders.d.ts

@@ -627,7 +627,6 @@ declare namespace BABYLON.GLTF2 {
      */
     export class PBRMaterialLoadingAdapter implements BABYLON.GLTF2.IMaterialLoadingAdapter {
         private _material;
-        private _extinctionCoefficient;
         /**
          * Creates a new instance of the PBRMaterialLoadingAdapter.
          * @param material - The PBR material to adapt.
@@ -1044,6 +1043,7 @@ declare namespace BABYLON.GLTF2 {
          * @returns The scatter coefficient as a Color3
          */
         get transmissionScatter(): Color3;
+        set transmissionScatterTexture(value: Nullable<BaseTexture>);
         /**
          * Sets the transmission scattering anisotropy.
          * @param value The anisotropy intensity value (-1 to 1)
@@ -1074,6 +1074,15 @@ declare namespace BABYLON.GLTF2 {
          * Sets up the material for proper thin-surface transmission behavior.
          */
         configureTransmission(): void;
+        configureVolume(): void;
+        /**
+         * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
+         */
+        set geometryThinWalled(value: boolean);
+        /**
+         * Gets whether the material is thin-walled (i.e. non-volumetric) or not.
+         */
+        get geometryThinWalled(): boolean;
         /**
          * Sets the thickness texture (mapped to PBR subSurface.thicknessTexture).
          * Automatically enables refraction.
@@ -1090,15 +1099,6 @@ declare namespace BABYLON.GLTF2 {
          * Configures subsurface properties for PBR material
          */
         configureSubsurface(): void;
-        /**
-         * Sets the extinction coefficient of the volume.
-         * @param value The extinction coefficient as a Vector3
-         */
-        set extinctionCoefficient(value: Vector3);
-        /**
-         * Gets the extinction coefficient of the volume.
-         */
-        get extinctionCoefficient(): Vector3;
         /**
          * Sets the subsurface weight
          */
@@ -1125,17 +1125,17 @@ declare namespace BABYLON.GLTF2 {
         /**
          * Sets the surface tint of the material (when using subsurface scattering)
          */
-        set subsurfaceConstantTint(value: Color3);
+        set diffuseTransmissionTint(value: Color3);
         /**
          * Gets the subsurface constant tint (when using subsurface scattering)
          * @returns The subsurface constant tint as a Color3
          */
-        get subsurfaceConstantTint(): Color3;
+        get diffuseTransmissionTint(): Color3;
         /**
          * Sets the subsurface constant tint texture (when using subsurface scattering)
          * @param value The subsurface constant tint texture or null
          */
-        set subsurfaceConstantTintTexture(value: Nullable<BaseTexture>);
+        set diffuseTransmissionTintTexture(value: Nullable<BaseTexture>);
         /**
          * Gets the subsurface radius (used for subsurface scattering)
          * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
@@ -1166,6 +1166,11 @@ declare namespace BABYLON.GLTF2 {
          * @param value The anisotropy intensity value (ignored for PBR)
          */
         set subsurfaceScatterAnisotropy(value: number);
+        /**
+         * Does this material have a translucent surface (i.e. either transmission or subsurface)?
+         * @returns True if the material is translucent, false otherwise
+         */
+        isTranslucent(): boolean;
         /**
          * Configures sheen for PBR material.
          * Enables sheen and sets up proper configuration.
@@ -1334,7 +1339,6 @@ declare namespace BABYLON.GLTF2 {
      */
     export class OpenPBRMaterialLoadingAdapter implements BABYLON.GLTF2.IMaterialLoadingAdapter {
         private _material;
-        private _extinctionCoefficient;
         /**
          * Creates a new instance of the OpenPBRMaterialLoadingAdapter.
          * @param material - The OpenPBR material to adapt.
@@ -1726,7 +1730,15 @@ declare namespace BABYLON.GLTF2 {
          * @returns The scatter coefficient as a Vector3
          */
         get transmissionScatter(): Color3;
+        /**
+         * Sets the transmission scatter texture.
+         * @param value The transmission scatter texture or null
+         */
         set transmissionScatterTexture(value: Nullable<BaseTexture>);
+        /**
+         * Gets the transmission scatter texture.
+         * @returns The transmission scatter texture or null
+         */
         get transmissionScatterTexture(): Nullable<BaseTexture>;
         /**
          * Sets the transmission scattering anisotropy.
@@ -1771,6 +1783,15 @@ declare namespace BABYLON.GLTF2 {
          * @param value The refraction background texture or null
          */
         set refractionBackgroundTexture(value: Nullable<BaseTexture>);
+        configureVolume(): void;
+        /**
+         * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
+         */
+        set geometryThinWalled(value: boolean);
+        /**
+         * Gets whether the material is thin-walled (i.e. non-volumetric) or not.
+         */
+        get geometryThinWalled(): boolean;
         /**
          * Sets the thickness texture.
          * @param value The thickness texture or null
@@ -1785,15 +1806,6 @@ declare namespace BABYLON.GLTF2 {
          * Configures subsurface properties for PBR material
          */
         configureSubsurface(): void;
-        /**
-         * Sets the extinction coefficient of the volume.
-         * @param value The extinction coefficient as a Vector3
-         */
-        set extinctionCoefficient(value: Vector3);
-        /**
-         * Gets the extinction coefficient of the volume.
-         */
-        get extinctionCoefficient(): Vector3;
         /**
          * Sets the subsurface weight
          */
@@ -1813,18 +1825,20 @@ declare namespace BABYLON.GLTF2 {
          * @param value The subsurface tint texture or null
          */
         set subsurfaceColorTexture(value: Nullable<BaseTexture>);
+        private _diffuseTransmissionTint;
+        private _diffuseTransmissionTintTexture;
         /**
-         * Sets the surface tint of the material (when using subsurface scattering)
+         * Sets the diffuse transmission tint of the material
          */
-        set subsurfaceConstantTint(value: Color3);
+        set diffuseTransmissionTint(value: Color3);
         /**
-         * Gets the surface tint of the material (when using subsurface scattering)
+         * Gets the diffuse transmission tint of the material
          */
-        get subsurfaceConstantTint(): Color3;
+        get diffuseTransmissionTint(): Color3;
         /**
-         * Sets the surface tint texture of the material (when using subsurface scattering)
+         * Sets the diffuse transmission tint texture of the material
          */
-        set subsurfaceConstantTintTexture(value: Nullable<BaseTexture>);
+        set diffuseTransmissionTintTexture(value: Nullable<BaseTexture>);
         /**
          * Gets the subsurface radius for subsurface scattering.
          * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
@@ -1852,6 +1866,11 @@ declare namespace BABYLON.GLTF2 {
          * @param value The anisotropy intensity value
          */
         set subsurfaceScatterAnisotropy(value: number);
+        /**
+         * Does this material have a translucent surface (i.e. either transmission or subsurface)?
+         * @returns True if the material is translucent, false otherwise
+         */
+        isTranslucent(): boolean;
         /**
          * Configures fuzz for OpenPBR.
          * Enables fuzz and sets up proper configuration.
@@ -1995,6 +2014,7 @@ declare namespace BABYLON.GLTF2 {
          * @param value The scale value for the coat normal texture
          */
         set geometryCoatNormalTextureScale(value: number);
+        finalize(): void;
     }
 
 
@@ -2014,6 +2034,10 @@ declare namespace BABYLON.GLTF2 {
          * Gets the underlying material
          */
         readonly material: Material;
+        /**
+         * Finalizes material properties after loading is complete.
+         */
+        finalize?(): void;
         /**
          * Whether the material should be treated as unlit
          */
@@ -2195,6 +2219,10 @@ declare namespace BABYLON.GLTF2 {
          * Sets the scattering coefficient
          */
         transmissionScatter: Color3;
+        /**
+         * Sets the transmission scatter texture
+         */
+        transmissionScatterTexture: Nullable<BaseTexture>;
         /**
          * Sets the scattering anisotropy (-1 to 1)
          */
@@ -2215,6 +2243,11 @@ declare namespace BABYLON.GLTF2 {
          * Configures transmission for thin-surface transmission (KHR_materials_transmission)
          */
         configureTransmission(): void;
+        configureVolume(): void;
+        /**
+         * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
+         */
+        geometryThinWalled: boolean;
         /**
          * Sets the thickness texture
          */
@@ -2227,11 +2260,6 @@ declare namespace BABYLON.GLTF2 {
          * Configures subsurface properties
          */
         configureSubsurface(): void;
-        /**
-         * @internal
-         * Sets/gets the extinction coefficient
-         */
-        extinctionCoefficient: Vector3;
         /**
          * Sets/gets the subsurface weight
          */
@@ -2249,13 +2277,13 @@ declare namespace BABYLON.GLTF2 {
          */
         subsurfaceColorTexture: Nullable<BaseTexture>;
         /**
-         * Sets/gets the surface tint of the material (when using subsurface scattering)
+         * Sets/gets the diffuse transmission tint of the material
          */
-        subsurfaceConstantTint: Color3;
+        diffuseTransmissionTint: Color3;
         /**
-         * Sets/gets the surface tint texture of the material (when using subsurface scattering)
+         * Sets/gets the diffuse transmission tint texture of the material
          */
-        subsurfaceConstantTintTexture: Nullable<BaseTexture>;
+        diffuseTransmissionTintTexture: Nullable<BaseTexture>;
         /**
          * Sets/gets the subsurface radius (used for subsurface scattering)
          */
@@ -2268,6 +2296,10 @@ declare namespace BABYLON.GLTF2 {
          * Sets/gets the subsurface scattering anisotropy
          */
         subsurfaceScatterAnisotropy: number;
+        /**
+         * Does this material have a translucent surface (i.e. either transmission or subsurface)?
+         */
+        isTranslucent(): boolean;
         /**
          * Configures initial settings for fuzz for material.
          */
@@ -2951,6 +2983,7 @@ declare namespace BABYLON.GLTF2 {
         private _defaultBabylonMaterialData;
         private readonly _postSceneLoadActions;
         private readonly _materialAdapterCache;
+        private readonly _materialAdapters;
         /** @internal */
         _pbrMaterialImpl: Nullable<Readonly<PBRMaterialImplementation>> | false;
         /**
@@ -6757,13 +6790,45 @@ declare namespace BABYLON {
 
 
     /**
-     * Parses SPZ data and returns a promise resolving to an IParsedPLY object.
+     * Parses SPZ data and returns a promise resolving to an IParsedSplat object.
      * @param data The ArrayBuffer containing SPZ data.
      * @param scene The Babylon.js scene.
-     * @param loadingOptions Options for loading Gaussian Splatting files.
+     * @param _loadingOptions Options for loading Gaussian Splatting files.
      * @returns A promise resolving to the parsed SPZ data.
      */
-    export function ParseSpz(data: ArrayBuffer, scene: Scene, loadingOptions: SPLATLoadingOptions): Promise<IParsedSplat>;
+    export function ParseSpz(data: ArrayBuffer, scene: Scene, _loadingOptions: SPLATLoadingOptions): Promise<IParsedSplat>;
+    /**
+     * Returns the initialized spz WASM module loaded from the given URL, loading it on first call.
+     * @param url URL to the spz WASM ES module (its default export should be a factory function)
+     * @returns A promise resolving to the initialized spz WASM module
+     */
+    export function GetSpzModule(url: string): Promise<SpzModule>;
+    /**
+     * Converts a GaussianCloud object (from the spz WASM module) into the packed 32-byte-per-splat
+     * ArrayBuffer and SH texture arrays expected by GaussianSplattingMeshBase.updateData.
+     *
+     * Packed layout per splat (32 bytes):
+     *   [0-11]  position xyz   (float32 x3)
+     *   [12-23] scale xyz      (float32 x3)
+     *   [24-27] color RGBA     (uint8 x4, colors in [0,255], alpha in [0,255])
+     *   [28-31] quaternion wxyz (uint8 x4, encoded as q * 127.5 + 127.5)
+     *
+     * SH coefficients from the cloud (Float32, range ~[-1,1]) are encoded to bytes
+     * using the SPZ convention (load-spz.cc unquantizeSH): byte = coeff * 128 + 128.
+     *
+     * @param cloud The GaussianCloud returned by spz.loadSpzFromBuffer
+     * @param scene The Babylon.js scene (used to query maxTextureSize for SH textures)
+     * @param useCoroutine If true, yields periodically to avoid blocking the main thread
+     * @returns A coroutine returning an IParsedSplat ready to be passed to updateData
+     */
+    export function ConvertSpzToSplat(cloud: GaussianCloud, scene: Scene, useCoroutine?: boolean): Coroutine<IParsedSplat>;
+    /**
+     * Async version of ConvertSpzToSplat that yields periodically to avoid blocking the main thread.
+     * @param cloud The GaussianCloud returned by spz.loadSpzFromBuffer
+     * @param scene The Babylon.js scene
+     * @returns A promise resolving to an IParsedSplat
+     */
+    export function ConvertSpzToSplatAsync(cloud: any, scene: Scene): Promise<IParsedSplat>;
 
 
     /**
@@ -6797,6 +6862,17 @@ declare namespace BABYLON {
          * Mesh that will be used to load data instead of creating a new one
          */
         gaussianSplattingMesh?: GaussianSplattingMesh;
+        /**
+         * URL to load the spz WASM ES module from (e.g. the \@adobe/spz package).
+         * When provided, the WASM-based SPZ loader is used, which supports extra features
+         * such as antialiasing metadata, and vendor-specific extensions such as safe-orbit
+         * camera limits.
+         * Defaults to the \@adobe/spz unpkg URL when WebAssembly is supported, and undefined otherwise.
+         * Set to undefined to force the built-in manual SPZ parser regardless of WebAssembly support.
+         * @example Setting the URL directly on the loader options
+         * spzLibraryUrl: "https://unpkg.com/\@adobe/spz\@0.2.0/dist/spz.js"
+         */
+        spzLibraryUrl?: string;
     };
 
 
@@ -6935,6 +7011,7 @@ declare namespace BABYLON {
         faces?: number[];
         hasVertexColors?: boolean;
         sh?: Uint8Array[];
+        shDegree?: number;
         trainedWithAntialiasing?: boolean;
         compressed?: boolean;
         rawSplat?: boolean;