@crystaldesign/real-time-viewer-next 26.11.0-beta.18

package/build/types/real-time-viewer-next/src/core/environment/lighting.config.d.ts

@@ -0,0 +1,297 @@
+import { type ConfigInput, type ConfigResolved } from '../../config/descriptor';
+/**
+ * Lens flare along the sun direction: generated additive billboard sprites (haze burst + chromatic
+ * ghost train). Lives at `lighting.sun.lensflare` and is rendered by `EnvironmentSunLensflare`.
+ */
+declare const LENSFLARE_FIELDS: import("../../config/descriptor").GroupDescriptor<{
+    enabled: import("../../config/descriptor").BooleanField;
+    /** Tint for the whole flare; per-ghost chromatic tints multiply with it. */
+    color: import("../../config/descriptor").ColorField;
+    /** World position along the sun ray as a fraction of `distance` (just inside the sky shell). */
+    distanceScale: import("../../config/descriptor").NumberField;
+    /** Multiplier on flare element sizes — burst and ghosts. */
+    sizeScale: import("../../config/descriptor").NumberField;
+    /**
+     * When `true`, each frame raycasts a 9-tap kernel around the sun direction to fade / shift the
+     * flare based on what blocks the sun. Disable to skip all raycasting and per-frame scene
+     * traversal — the flare stays at full intensity, anchored on the sun direction. Big perf win on
+     * scenes with many meshes; trade-off is no occlusion / partial-occlusion shaping.
+     */
+    occlusionEnabled: import("../../config/descriptor").BooleanField;
+}>;
+/** {@link LENSFLARE_FIELDS} as a switchable block — `false` = no flare. */
+declare const LENSFLARE_CONFIG: import("../../config/descriptor").ToggleDescriptor<{
+    enabled: import("../../config/descriptor").BooleanField;
+    /** Tint for the whole flare; per-ghost chromatic tints multiply with it. */
+    color: import("../../config/descriptor").ColorField;
+    /** World position along the sun ray as a fraction of `distance` (just inside the sky shell). */
+    distanceScale: import("../../config/descriptor").NumberField;
+    /** Multiplier on flare element sizes — burst and ghosts. */
+    sizeScale: import("../../config/descriptor").NumberField;
+    /**
+     * When `true`, each frame raycasts a 9-tap kernel around the sun direction to fade / shift the
+     * flare based on what blocks the sun. Disable to skip all raycasting and per-frame scene
+     * traversal — the flare stays at full intensity, anchored on the sun direction. Big perf win on
+     * scenes with many meshes; trade-off is no occlusion / partial-occlusion shaping.
+     */
+    occlusionEnabled: import("../../config/descriptor").BooleanField;
+}>;
+/**
+ * One studio light of the Key / Fill / Rim / Back rig. `label` prefixes the analyzer's leva keys;
+ * `position` and `intensity` are the only per-light defaults that differ.
+ *
+ * Light model:
+ * - `'spot'`: a `SpotLight` with a world position + cone aimed at the scene center. Draggable
+ *   studio light; keeps illumination focused on the product but throws a visible pool on the ground.
+ * - `'directional'`: a `DirectionalLight` — parallel rays from `position` toward the scene center.
+ *   Lights the whole scene evenly (no ground pool), matching the old Babylon viewer's 4-directional
+ *   rig. `angle`/`penumbra`/`distance`/`decay` are ignored.
+ */
+declare function lightGroup(label: string, position: [number, number, number], intensity: number): import("../../config/descriptor").GroupDescriptor<{
+    type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+    position: import("../../config/descriptor").TupleField<[number, number, number]>;
+    intensity: import("../../config/descriptor").NumberField;
+    color: import("../../config/descriptor").ColorField;
+    /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+    angle: import("../../config/descriptor").NumberField;
+    /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+    penumbra: import("../../config/descriptor").NumberField;
+    /**
+     * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+     * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+     */
+    distance: import("../../config/descriptor").NumberField;
+    /**
+     * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+     * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+     * usually want `0` or `1` so the light still reads on the product.
+     */
+    decay: import("../../config/descriptor").NumberField;
+}>;
+/**
+ * The scene sun: a directional light steered by sky angles rather than a vector. `azimuth` /
+ * `elevation` are canonical; `direction` is derived from them by
+ * `syncLightingSunDirectionWithAngles` after every resolve (a config that supplies only
+ * `direction` gets the angles back-computed once, so old bundles keep working).
+ */
+declare const SUN_FIELDS: import("../../config/descriptor").GroupDescriptor<{
+    enabled: import("../../config/descriptor").BooleanField;
+    /** Azimuth angle in degrees (0 = North, 90 = East, 180 = South, 270 = West). */
+    azimuth: import("../../config/descriptor").NumberField;
+    /** Elevation angle in degrees above horizon (0 = horizon, 90 = zenith). */
+    elevation: import("../../config/descriptor").NumberField;
+    /** Matches {@link azimuth} + {@link elevation} after resolve / sync — prefer angles as source of truth. */
+    direction: import("../../config/descriptor").TupleField<[number, number, number]>;
+    color: import("../../config/descriptor").ColorField;
+    intensity: import("../../config/descriptor").NumberField;
+    /** Lens flare along the sun direction (additive billboards). Shown when the sun is enabled. */
+    lensflare: import("../../config/descriptor").ToggleDescriptor<{
+        enabled: import("../../config/descriptor").BooleanField;
+        /** Tint for the whole flare; per-ghost chromatic tints multiply with it. */
+        color: import("../../config/descriptor").ColorField;
+        /** World position along the sun ray as a fraction of `distance` (just inside the sky shell). */
+        distanceScale: import("../../config/descriptor").NumberField;
+        /** Multiplier on flare element sizes — burst and ghosts. */
+        sizeScale: import("../../config/descriptor").NumberField;
+        /**
+         * When `true`, each frame raycasts a 9-tap kernel around the sun direction to fade / shift the
+         * flare based on what blocks the sun. Disable to skip all raycasting and per-frame scene
+         * traversal — the flare stays at full intensity, anchored on the sun direction. Big perf win on
+         * scenes with many meshes; trade-off is no occlusion / partial-occlusion shaping.
+         */
+        occlusionEnabled: import("../../config/descriptor").BooleanField;
+    }>;
+}>;
+/** {@link SUN_FIELDS} as a switchable block — `false` = no sun light at all. On by default. */
+declare const SUN_CONFIG: import("../../config/descriptor").ToggleDescriptor<{
+    enabled: import("../../config/descriptor").BooleanField;
+    /** Azimuth angle in degrees (0 = North, 90 = East, 180 = South, 270 = West). */
+    azimuth: import("../../config/descriptor").NumberField;
+    /** Elevation angle in degrees above horizon (0 = horizon, 90 = zenith). */
+    elevation: import("../../config/descriptor").NumberField;
+    /** Matches {@link azimuth} + {@link elevation} after resolve / sync — prefer angles as source of truth. */
+    direction: import("../../config/descriptor").TupleField<[number, number, number]>;
+    color: import("../../config/descriptor").ColorField;
+    intensity: import("../../config/descriptor").NumberField;
+    /** Lens flare along the sun direction (additive billboards). Shown when the sun is enabled. */
+    lensflare: import("../../config/descriptor").ToggleDescriptor<{
+        enabled: import("../../config/descriptor").BooleanField;
+        /** Tint for the whole flare; per-ghost chromatic tints multiply with it. */
+        color: import("../../config/descriptor").ColorField;
+        /** World position along the sun ray as a fraction of `distance` (just inside the sky shell). */
+        distanceScale: import("../../config/descriptor").NumberField;
+        /** Multiplier on flare element sizes — burst and ghosts. */
+        sizeScale: import("../../config/descriptor").NumberField;
+        /**
+         * When `true`, each frame raycasts a 9-tap kernel around the sun direction to fade / shift the
+         * flare based on what blocks the sun. Disable to skip all raycasting and per-frame scene
+         * traversal — the flare stays at full intensity, anchored on the sun direction. Big perf win on
+         * scenes with many meshes; trade-off is no occlusion / partial-occlusion shaping.
+         */
+        occlusionEnabled: import("../../config/descriptor").BooleanField;
+    }>;
+}>;
+/** The Back light's fields; `LIGHTING_CONFIG.backLight` wraps them in an off-by-default toggle. */
+declare const BACK_LIGHT_FIELDS: import("../../config/descriptor").GroupDescriptor<{
+    type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+    position: import("../../config/descriptor").TupleField<[number, number, number]>;
+    intensity: import("../../config/descriptor").NumberField;
+    color: import("../../config/descriptor").ColorField;
+    /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+    angle: import("../../config/descriptor").NumberField;
+    /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+    penumbra: import("../../config/descriptor").NumberField;
+    /**
+     * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+     * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+     */
+    distance: import("../../config/descriptor").NumberField;
+    /**
+     * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+     * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+     * usually want `0` or `1` so the light still reads on the product.
+     */
+    decay: import("../../config/descriptor").NumberField;
+}>;
+/**
+ * Lighting rig config — the single source for its types, defaults, clamps, round-trip and analyzer
+ * inputs (see `config/descriptor.ts`). Drives `LightingRig` + `EnvironmentSunLensflare`.
+ *
+ * Defaults match EZ-Tree's `ambient + sun` model: ambient slightly raised, key/fill/rim softened so
+ * the directional sun reads as the primary light source. Key/Fill/Rim/Back are SpotLights aimed at
+ * the scene center (auto-targeted in `LightingRig`); `position` is world-space (not a direction
+ * vector), and `angle` + `penumbra` keep the illumination focused on the product so the ground
+ * beyond the cone stays unaffected. `decay = 0` preserves the pre-conversion "no falloff" look.
+ */
+export declare const LIGHTING_CONFIG: import("../../config/descriptor").GroupDescriptor<{
+    /** `LightingRig` renders either the hemisphere light or flat ambient, never both. */
+    useHemisphere: import("../../config/descriptor").BooleanField;
+    hemisphereConfig: import("../../config/descriptor").GroupDescriptor<{
+        skyColor: import("../../config/descriptor").ColorField;
+        groundColor: import("../../config/descriptor").ColorField;
+        intensity: import("../../config/descriptor").NumberField;
+    }>;
+    ambientIntensity: import("../../config/descriptor").NumberField;
+    keyLight: import("../../config/descriptor").GroupDescriptor<{
+        type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+        position: import("../../config/descriptor").TupleField<[number, number, number]>;
+        intensity: import("../../config/descriptor").NumberField;
+        color: import("../../config/descriptor").ColorField;
+        /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+        angle: import("../../config/descriptor").NumberField;
+        /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+        penumbra: import("../../config/descriptor").NumberField;
+        /**
+         * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+         * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+         */
+        distance: import("../../config/descriptor").NumberField;
+        /**
+         * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+         * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+         * usually want `0` or `1` so the light still reads on the product.
+         */
+        decay: import("../../config/descriptor").NumberField;
+    }>;
+    fillLight: import("../../config/descriptor").GroupDescriptor<{
+        type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+        position: import("../../config/descriptor").TupleField<[number, number, number]>;
+        intensity: import("../../config/descriptor").NumberField;
+        color: import("../../config/descriptor").ColorField;
+        /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+        angle: import("../../config/descriptor").NumberField;
+        /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+        penumbra: import("../../config/descriptor").NumberField;
+        /**
+         * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+         * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+         */
+        distance: import("../../config/descriptor").NumberField;
+        /**
+         * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+         * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+         * usually want `0` or `1` so the light still reads on the product.
+         */
+        decay: import("../../config/descriptor").NumberField;
+    }>;
+    rimLight: import("../../config/descriptor").GroupDescriptor<{
+        type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+        position: import("../../config/descriptor").TupleField<[number, number, number]>;
+        intensity: import("../../config/descriptor").NumberField;
+        color: import("../../config/descriptor").ColorField;
+        /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+        angle: import("../../config/descriptor").NumberField;
+        /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+        penumbra: import("../../config/descriptor").NumberField;
+        /**
+         * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+         * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+         */
+        distance: import("../../config/descriptor").NumberField;
+        /**
+         * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+         * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+         * usually want `0` or `1` so the light still reads on the product.
+         */
+        decay: import("../../config/descriptor").NumberField;
+    }>;
+    backLight: import("../../config/descriptor").ToggleDescriptor<{
+        type: import("../../config/descriptor").EnumField<"spot" | "directional">;
+        position: import("../../config/descriptor").TupleField<[number, number, number]>;
+        intensity: import("../../config/descriptor").NumberField;
+        color: import("../../config/descriptor").ColorField;
+        /** SpotLight cone half-angle in radians (max `Math.PI / 2`). Smaller = tighter pencil beam. */
+        angle: import("../../config/descriptor").NumberField;
+        /** SpotLight penumbra. `0` = sharp cone edge, `1` = fully soft; `0.4–0.6` blends nicely. */
+        penumbra: import("../../config/descriptor").NumberField;
+        /**
+         * Maximum world-space distance the light reaches. `0` = infinite (no range-based cutoff).
+         * Combined with `decay > 0` this controls how a light fades to black inside its cone.
+         */
+        distance: import("../../config/descriptor").NumberField;
+        /**
+         * Falloff exponent. `0` = no falloff (looks like a cone-clipped directional), `1` = soft /
+         * cinematic, `2` = physically correct inverse-square. With low intensity values (~0.1–1) you
+         * usually want `0` or `1` so the light still reads on the product.
+         */
+        decay: import("../../config/descriptor").NumberField;
+    }>;
+    sun: import("../../config/descriptor").ToggleDescriptor<{
+        enabled: import("../../config/descriptor").BooleanField;
+        /** Azimuth angle in degrees (0 = North, 90 = East, 180 = South, 270 = West). */
+        azimuth: import("../../config/descriptor").NumberField;
+        /** Elevation angle in degrees above horizon (0 = horizon, 90 = zenith). */
+        elevation: import("../../config/descriptor").NumberField;
+        /** Matches {@link azimuth} + {@link elevation} after resolve / sync — prefer angles as source of truth. */
+        direction: import("../../config/descriptor").TupleField<[number, number, number]>;
+        color: import("../../config/descriptor").ColorField;
+        intensity: import("../../config/descriptor").NumberField;
+        /** Lens flare along the sun direction (additive billboards). Shown when the sun is enabled. */
+        lensflare: import("../../config/descriptor").ToggleDescriptor<{
+            enabled: import("../../config/descriptor").BooleanField;
+            /** Tint for the whole flare; per-ghost chromatic tints multiply with it. */
+            color: import("../../config/descriptor").ColorField;
+            /** World position along the sun ray as a fraction of `distance` (just inside the sky shell). */
+            distanceScale: import("../../config/descriptor").NumberField;
+            /** Multiplier on flare element sizes — burst and ghosts. */
+            sizeScale: import("../../config/descriptor").NumberField;
+            /**
+             * When `true`, each frame raycasts a 9-tap kernel around the sun direction to fade / shift the
+             * flare based on what blocks the sun. Disable to skip all raycasting and per-frame scene
+             * traversal — the flare stays at full intensity, anchored on the sun direction. Big perf win on
+             * scenes with many meshes; trade-off is no occlusion / partial-occlusion shaping.
+             */
+            occlusionEnabled: import("../../config/descriptor").BooleanField;
+        }>;
+    }>;
+}>;
+export type LightingConfig = ConfigInput<typeof LIGHTING_CONFIG>;
+export type ResolvedLightingConfig = ConfigResolved<typeof LIGHTING_CONFIG>;
+export type LightConfig = ConfigInput<ReturnType<typeof lightGroup>>;
+export type ResolvedLightConfig = ConfigResolved<ReturnType<typeof lightGroup>>;
+export type SunConfig = ConfigInput<typeof SUN_CONFIG>;
+export type ResolvedSunConfig = ConfigResolved<typeof SUN_CONFIG>;
+export type SunLensflareConfig = ConfigInput<typeof LENSFLARE_CONFIG>;
+export type ResolvedSunLensflareConfig = ConfigResolved<typeof LENSFLARE_FIELDS>;
+export { SUN_FIELDS, BACK_LIGHT_FIELDS, LENSFLARE_FIELDS };
+//# sourceMappingURL=lighting.config.d.ts.map

package/build/types/real-time-viewer-next/src/core/environment/lighting.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lighting.config.d.ts","sourceRoot":"","sources":["../../../../../../src/core/environment/lighting.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEvF;;;GAGG;AACH,QAAA,MAAM,gBAAgB;;IAEpB,4EAA4E;;IAE5E,gGAAgG;;IAQhG,4DAA4D;;IAQ5D;;;;;OAKG;;EAOH,CAAC;AAEH,2EAA2E;AAC3E,QAAA,MAAM,gBAAgB;;IAjCpB,4EAA4E;;IAE5E,gGAAgG;;IAQhG,4DAA4D;;IAQ5D;;;;;OAKG;;EAUgE,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,iBAAS,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM;;;;;IAgBpF,+FAA+F;;IAQ/F,4FAA4F;;IAE5F;;;OAGG;;IAEH;;;;OAIG;;GAGN;AAED;;;;;GAKG;AACH,QAAA,MAAM,UAAU;;IAEd,gFAAgF;;IAEhF,2EAA2E;;IAE3E,2GAA2G;;;;IAI3G,+FAA+F;;;QAtG/F,4EAA4E;;QAE5E,gGAAgG;;QAQhG,4DAA4D;;QAQ5D;;;;;WAKG;;;EAiFH,CAAC;AAEH,+FAA+F;AAC/F,QAAA,MAAM,UAAU;;IAbd,gFAAgF;;IAEhF,2EAA2E;;IAE3E,2GAA2G;;;;IAI3G,+FAA+F;;;QAtG/F,4EAA4E;;QAE5E,gGAAgG;;QAQhG,4DAA4D;;QAQ5D;;;;;WAKG;;;EAoFmD,CAAC;AAEzD,mGAAmG;AACnG,QAAA,MAAM,iBAAiB;;;;;IAhDnB,+FAA+F;;IAQ/F,4FAA4F;;IAE5F;;;OAGG;;IAEH;;;;OAIG;;EA6BuD,CAAC;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;IAC1B,qFAAqF;;;;;;;;;;;;;QA7DnF,+FAA+F;;QAQ/F,4FAA4F;;QAE5F;;;WAGG;;QAEH;;;;WAIG;;;;;;;;QAnBH,+FAA+F;;QAQ/F,4FAA4F;;QAE5F;;;WAGG;;QAEH;;;;WAIG;;;;;;;;QAnBH,+FAA+F;;QAQ/F,4FAA4F;;QAE5F;;;WAGG;;QAEH;;;;WAIG;;;;;;;;QAnBH,+FAA+F;;QAQ/F,4FAA4F;;QAE5F;;;WAGG;;QAEH;;;;WAIG;;;;;QAaL,gFAAgF;;QAEhF,2EAA2E;;QAE3E,2GAA2G;;;;QAI3G,+FAA+F;;;YAtG/F,4EAA4E;;YAE5E,gGAAgG;;YAQhG,4DAA4D;;YAQ5D;;;;;eAKG;;;;EAiHH,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AACjE,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,OAAO,eAAe,CAAC,CAAC;AAC5E,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC;AACrE,MAAM,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC;AAChF,MAAM,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,UAAU,CAAC,CAAC;AACvD,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC,OAAO,UAAU,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AACtE,MAAM,MAAM,0BAA0B,GAAG,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjF,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,CAAC"}

package/build/types/real-time-viewer-next/src/core/environment/lighting.config.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lighting.config.test.d.ts.map

package/build/types/real-time-viewer-next/src/core/environment/lighting.config.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lighting.config.test.d.ts","sourceRoot":"","sources":["../../../../../../src/core/environment/lighting.config.test.ts"],"names":[],"mappings":""}