@onerjs/loaders 8.36.5 → 8.36.6

package/glTF/2.0/openpbrMaterialLoadingAdapter.d.ts

@@ -2,13 +2,15 @@ import type { OpenPBRMaterial } from "@onerjs/core/Materials/PBR/openpbrMaterial
 import type { Material } from "@onerjs/core/Materials/material.js";
 import type { BaseTexture } from "@onerjs/core/Materials/Textures/baseTexture.js";
 import type { Nullable } from "@onerjs/core/types.js";
-import type { Color3 } from "@onerjs/core/Maths/math.color.js";
+import { Color3 } from "@onerjs/core/Maths/math.color.js";
 import type { IMaterialLoadingAdapter } from "./materialLoadingAdapter.js";
+import { Vector3 } from "@onerjs/core/Maths/math.vector.js";
 /**
  * Material Loading Adapter for OpenPBR materials that provides a unified OpenPBR-like interface.
  */
 export declare class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
     private _material;
+    private _extinctionCoefficient;
     /**
      * Creates a new instance of the OpenPBRMaterialLoadingAdapter.
      * @param material - The OpenPBR material to adapt.
@@ -371,55 +373,87 @@ export declare class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAd
      * @returns Currently returns null as coat anisotropy is not yet available
      */
     get geometryCoatTangentTexture(): Nullable<BaseTexture>;
+    /**
+     * Configures transmission for OpenPBR material.
+     */
+    configureTransmission(): void;
     /**
      * Sets the transmission weight.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @param value The transmission weight value (0-1)
      */
     set transmissionWeight(value: number);
     /**
      * Sets the transmission weight texture.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @param value The transmission weight texture or null
      */
     set transmissionWeightTexture(value: Nullable<BaseTexture>);
     /**
      * Gets the transmission weight.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @returns Currently returns 0 as transmission is not yet available
      */
     get transmissionWeight(): number;
     /**
-     * Gets the transmission dispersion Abbe number.
+     * Sets the transmission scatter coefficient.
+     * @param value The scatter coefficient as a Vector3
+     */
+    set transmissionScatter(value: Color3);
+    /**
+     * Gets the transmission scatter coefficient.
+     * @returns The scatter coefficient as a Vector3
+     */
+    get transmissionScatter(): Color3;
+    set transmissionScatterTexture(value: Nullable<BaseTexture>);
+    get transmissionScatterTexture(): Nullable<BaseTexture>;
+    /**
+     * Sets the transmission scattering anisotropy.
+     * @param value The anisotropy intensity value (-1 to 1)
+     */
+    set transmissionScatterAnisotropy(value: number);
+    /**
+     * Sets the transmission dispersion Abbe number.
      * @param value The Abbe number value
      */
     set transmissionDispersionAbbeNumber(value: number);
     /**
-     * Configures transmission for OpenPBR material.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
+     * Sets the transmission dispersion scale.
+     * @param value The dispersion scale value
      */
-    configureTransmission(): void;
+    set transmissionDispersionScale(value: number);
     /**
-     * Sets the attenuation distance for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the attenuation distance.
      * @param value The attenuation distance value
      */
     set transmissionDepth(value: number);
     /**
-     * Sets the attenuation color for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Gets the attenuation distance.
+     */
+    get transmissionDepth(): number;
+    /**
+     * Sets the attenuation color.
      * @param value The attenuation color as a Color3
      */
     set transmissionColor(value: Color3);
     /**
-     * Sets the thickness texture for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Gets the attenuation color.
+     */
+    get transmissionColor(): Color3;
+    /**
+     * Gets the refraction background texture
+     * @returns The refraction background texture or null
+     */
+    get refractionBackgroundTexture(): Nullable<BaseTexture>;
+    /**
+     * Sets the refraction background texture
+     * @param value The refraction background texture or null
+     */
+    set refractionBackgroundTexture(value: Nullable<BaseTexture>);
+    /**
+     * Sets the thickness texture.
      * @param value The thickness texture or null
      */
     set volumeThicknessTexture(value: Nullable<BaseTexture>);
     /**
-     * Sets the thickness factor for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the thickness factor.
      * @param value The thickness value
      */
     set volumeThickness(value: number);
@@ -427,6 +461,15 @@ export declare class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAd
      * 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
      */
@@ -446,6 +489,45 @@ export declare class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAd
      * @param value The subsurface tint texture or null
      */
     set subsurfaceColorTexture(value: Nullable<BaseTexture>);
+    /**
+     * Sets the surface tint of the material (when using subsurface scattering)
+     */
+    set subsurfaceConstantTint(value: Color3);
+    /**
+     * Gets the surface tint of the material (when using subsurface scattering)
+     */
+    get subsurfaceConstantTint(): Color3;
+    /**
+     * Sets the surface tint texture of the material (when using subsurface scattering)
+     */
+    set subsurfaceConstantTintTexture(value: Nullable<BaseTexture>);
+    /**
+     * Gets the subsurface radius for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     */
+    get subsurfaceRadius(): number;
+    /**
+     * Sets the subsurface radius for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     * @param value The subsurface radius value
+     */
+    set subsurfaceRadius(value: number);
+    /**
+     * Gets the subsurface radius scale for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     */
+    get subsurfaceRadiusScale(): Color3;
+    /**
+     * Sets the subsurface radius scale for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     * @param value The subsurface radius scale as a Color3
+     */
+    set subsurfaceRadiusScale(value: Color3);
+    /**
+     * Sets the subsurface scattering anisotropy.
+     * @param value The anisotropy intensity value
+     */
+    set subsurfaceScatterAnisotropy(value: number);
     /**
      * Configures fuzz for OpenPBR.
      * Enables fuzz and sets up proper configuration.

package/glTF/2.0/openpbrMaterialLoadingAdapter.js

@@ -1,3 +1,5 @@
+import { Color3 } from "@onerjs/core/Maths/math.color.js";
+import { Vector3 } from "@onerjs/core/Maths/math.vector.js";
 /**
  * Material Loading Adapter for OpenPBR materials that provides a unified OpenPBR-like interface.
  */
@@ -7,6 +9,7 @@ export class OpenPBRMaterialLoadingAdapter {
      * @param material - The OpenPBR material to adapt.
      */
     constructor(material) {
+        this._extinctionCoefficient = Vector3.Zero();
         this._material = material;
     }
     /**
@@ -555,86 +558,148 @@ export class OpenPBRMaterialLoadingAdapter {
     // ========================================
     // TRANSMISSION LAYER
     // ========================================
+    /**
+     * Configures transmission for OpenPBR material.
+     */
+    configureTransmission() {
+        // OpenPBR transmission will be configured differently when available
+    }
     /**
      * Sets the transmission weight.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @param value The transmission weight value (0-1)
      */
     set transmissionWeight(value) {
-        // TODO: Implement when OpenPBR transmission is available
-        // this._material.transmissionWeight = value;
+        this._material.transmissionWeight = value;
+        // If the transmission weight is greater than 0, let's check if the base color
+        // is set and use that for a surface tint in OpenPBR. This may later be
+        // overridden by the volume properties but, without volume, this will give us
+        // glTF compatibility in OpenPBR.
+        this._material.transmissionColor = this._material.baseColor;
+        this._material.transmissionColorTexture = this._material.baseColorTexture;
+        this._material.transmissionDepth = 0.0;
     }
     /**
      * Sets the transmission weight texture.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @param value The transmission weight texture or null
      */
     set transmissionWeightTexture(value) {
-        // TODO: Implement when OpenPBR transmission is available
-        // this._material.transmissionWeightTexture = value;
+        this._material.transmissionWeightTexture = value;
     }
     /**
      * Gets the transmission weight.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
      * @returns Currently returns 0 as transmission is not yet available
      */
     get transmissionWeight() {
-        // TODO: Implement when OpenPBR transmission is available
-        // return this._material.transmissionWeight;
-        return 0;
+        return this._material.transmissionWeight;
+    }
+    /**
+     * Sets the transmission scatter coefficient.
+     * @param value The scatter coefficient as a Vector3
+     */
+    set transmissionScatter(value) {
+        this._material.transmissionScatter = value;
     }
     /**
-     * Gets the transmission dispersion Abbe number.
+     * Gets the transmission scatter coefficient.
+     * @returns The scatter coefficient as a Vector3
+     */
+    get transmissionScatter() {
+        return this._material.transmissionScatter;
+    }
+    set transmissionScatterTexture(value) {
+        this._material.transmissionScatterTexture = value;
+    }
+    get transmissionScatterTexture() {
+        return this._material.transmissionScatterTexture;
+    }
+    /**
+     * Sets the transmission scattering anisotropy.
+     * @param value The anisotropy intensity value (-1 to 1)
+     */
+    set transmissionScatterAnisotropy(value) {
+        this._material.transmissionScatterAnisotropy = value;
+    }
+    /**
+     * Sets the transmission dispersion Abbe number.
      * @param value The Abbe number value
      */
     set transmissionDispersionAbbeNumber(value) {
-        // TODO: Implement when OpenPBR transmission dispersion is available
+        this._material.transmissionDispersionAbbeNumber = value;
     }
     /**
-     * Configures transmission for OpenPBR material.
-     * TODO: Implementation pending OpenPBR transmission feature availability.
+     * Sets the transmission dispersion scale.
+     * @param value The dispersion scale value
      */
-    configureTransmission() {
-        // OpenPBR transmission will be configured differently when available
+    set transmissionDispersionScale(value) {
+        this._material.transmissionDispersionScale = value;
     }
-    // ========================================
-    // VOLUME PROPERTIES (Subsurface Scattering)
-    // ========================================
     /**
-     * Sets the attenuation distance for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the attenuation distance.
      * @param value The attenuation distance value
      */
     set transmissionDepth(value) {
-        // TODO: Implement when OpenPBR volume properties are available
-        // this._material.attenuationDistance = value;
+        // If the value is being set to the default max value, and the current transmission depth is 0,
+        // we assume that attenuation color isn't used and keep it at 0 to allow
+        // us to use constant transmission color to handle glTF's surface tint from base color.
+        if (value !== Number.MAX_VALUE || this._material.transmissionDepth !== 0) {
+            this._material.transmissionDepth = value;
+        }
+        else {
+            this._material.transmissionDepth = 0;
+        }
+    }
+    /**
+     * Gets the attenuation distance.
+     */
+    get transmissionDepth() {
+        return this._material.transmissionDepth;
     }
     /**
-     * Sets the attenuation color for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the attenuation color.
      * @param value The attenuation color as a Color3
      */
     set transmissionColor(value) {
-        // TODO: Implement when OpenPBR volume properties are available
-        // this._material.attenuationColor = value;
+        // Only set the transmission color if it's not white (default)
+        // This allows us to retain the base color as the transmission color,
+        // if that was previously set.
+        if (!value.equals(Color3.White())) {
+            this._material.transmissionColor = value;
+        }
+    }
+    /**
+     * Gets the attenuation color.
+     */
+    get transmissionColor() {
+        return this._material.transmissionColor;
+    }
+    /**
+     * Gets the refraction background texture
+     * @returns The refraction background texture or null
+     */
+    get refractionBackgroundTexture() {
+        return this._material.backgroundRefractionTexture;
+    }
+    /**
+     * Sets the refraction background texture
+     * @param value The refraction background texture or null
+     */
+    set refractionBackgroundTexture(value) {
+        this._material.backgroundRefractionTexture = value;
     }
     /**
-     * Sets the thickness texture for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the thickness texture.
      * @param value The thickness texture or null
      */
     set volumeThicknessTexture(value) {
-        // TODO: Implement when OpenPBR volume properties are available
-        // this._material.thicknessTexture = value;
+        this._material.geometryThicknessTexture = value;
+        this._material._useGeometryThicknessFromGreenChannel = true;
     }
     /**
-     * Sets the thickness factor for volume scattering.
-     * TODO: Implementation pending OpenPBR volume feature availability.
+     * Sets the thickness factor.
      * @param value The thickness value
      */
     set volumeThickness(value) {
-        // TODO: Implement when OpenPBR volume properties are available
-        // this._material.thickness = value;
+        this._material.geometryThickness = value;
     }
     // ========================================
     // SUBSURFACE PROPERTIES (Subsurface Scattering)
@@ -645,6 +710,19 @@ export class OpenPBRMaterialLoadingAdapter {
     configureSubsurface() {
         // TODO
     }
+    /**
+     * Sets the extinction coefficient of the volume.
+     * @param value The extinction coefficient as a Vector3
+     */
+    set extinctionCoefficient(value) {
+        this._extinctionCoefficient = value;
+    }
+    /**
+     * Gets the extinction coefficient of the volume.
+     */
+    get extinctionCoefficient() {
+        return this._extinctionCoefficient;
+    }
     /**
      * Sets the subsurface weight
      */
@@ -675,6 +753,65 @@ export class OpenPBRMaterialLoadingAdapter {
     set subsurfaceColorTexture(value) {
         // TODO
     }
+    /**
+     * Sets the surface tint of the material (when using subsurface scattering)
+     */
+    set subsurfaceConstantTint(value) {
+        // There is no equivalent in OpenPBR
+        // Maybe multiply this by subsurfaceColor?
+    }
+    /**
+     * Gets the surface tint of the material (when using subsurface scattering)
+     */
+    get subsurfaceConstantTint() {
+        return Color3.White();
+    }
+    /**
+     * Sets the surface tint texture of the material (when using subsurface scattering)
+     */
+    set subsurfaceConstantTintTexture(value) {
+        // There is no equivalent in OpenPBR
+        // Maybe multiply this by subsurfaceColorTexture?
+    }
+    /**
+     * Gets the subsurface radius for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     */
+    get subsurfaceRadius() {
+        // TODO
+        return 0;
+    }
+    /**
+     * Sets the subsurface radius for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     * @param value The subsurface radius value
+     */
+    set subsurfaceRadius(value) {
+        // TODO
+    }
+    /**
+     * Gets the subsurface radius scale for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     */
+    get subsurfaceRadiusScale() {
+        // TODO
+        return Color3.White();
+    }
+    /**
+     * Sets the subsurface radius scale for subsurface scattering.
+     * subsurfaceRadiusScale * subsurfaceRadius gives the mean free path per color channel.
+     * @param value The subsurface radius scale as a Color3
+     */
+    set subsurfaceRadiusScale(value) {
+        // TODO
+    }
+    /**
+     * Sets the subsurface scattering anisotropy.
+     * @param value The anisotropy intensity value
+     */
+    set subsurfaceScatterAnisotropy(value) {
+        // TODO
+    }
     // ========================================
     // FUZZ LAYER (Sheen)
     // ========================================