@yschindel/ara3d-webgl 1.3.1 → 1.3.3

package/dist/types/viewer/environment.d.ts

@@ -16,13 +16,14 @@ export declare class GroundPlane {
 }
 export declare class Environment {
     skyLight: THREE.HemisphereLight;
+    ambientLight: THREE.AmbientLight;
     sunLights: THREE.DirectionalLight[];
     private _groundPlane;
     get groundPlane(): THREE.Mesh;
     constructor(settings: Settings);
     loadGroundTexture(encoding: TextureEncoding, url: string): void;
     /**
-     * Returns all three objects composing the environment
+     * Returns all objects composing the environment
      */
     getObjects(): THREE.Object3D[];
     applySettings(settings: Settings): void;
@@ -34,6 +35,7 @@ export declare class Environment {
 }
 export interface IEnvironment {
     skyLight: THREE.HemisphereLight;
+    ambientLight: THREE.AmbientLight;
     sunLights: THREE.DirectionalLight[];
     groundPlane: THREE.Mesh;
 }

package/dist/types/viewer/rendering/renderer.d.ts

@@ -10,6 +10,7 @@ export declare class Renderer {
     camera: Camera;
     needsUpdate: boolean;
     constructor(scene: THREE.Scene, viewport: Viewport, camera: Camera, settings: Settings);
+    applyRenderingSettings(settings: Settings): void;
     dispose(): void;
     get background(): THREE.Color | THREE.Texture;
     set background(color: THREE.Color | THREE.Texture);

package/dist/types/viewer/viewerSettings.d.ts

@@ -1,6 +1,32 @@
 import * as THREE from 'three';
 export type TextureEncoding = 'url' | 'base64' | undefined;
 export { GizmoOptions } from './gizmos/gizmoAxes';
+/**
+ * Example: Neutral lighting setup for color calibration or asset review
+ *
+ * ```typescript
+ * const neutralSettings = {
+ *   skylight: {
+ *     intensity: 0  // Disable hemisphere light for neutral lighting
+ *   },
+ *   ambientLight: {
+ *     color: new THREE.Color(0xffffff),
+ *     intensity: 0.5  // Base level of even illumination
+ *   },
+ *   sunLights: [
+ *     {
+ *       position: new THREE.Vector3(5, 10, 7.5),
+ *       color: new THREE.Color(0xffffff),
+ *       intensity: 1  // Primary directional light
+ *     }
+ *   ],
+ *   rendering: {
+ *     toneMapping: THREE.ACESFilmicToneMapping,
+ *     toneMappingExposure: 1.0
+ *   }
+ * }
+ * ```
+ */
 /**
  * Makes all field optional recursively
  * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
@@ -87,12 +113,21 @@ export type Settings = {
     };
     /**
      * Skylight (hemisphere light) options
+     * Used for natural lighting with sky/ground color variation
      */
     skylight: {
         skyColor: THREE.Color;
         groundColor: THREE.Color;
         intensity: number;
     };
+    /**
+     * Ambient light options
+     * Used for neutral lighting setup (even illumination without color casts)
+     */
+    ambientLight: {
+        color: THREE.Color;
+        intensity: number;
+    };
     /**
      * Sunlight (directional light) options
      */
@@ -103,6 +138,15 @@ export type Settings = {
     }[];
     rendering: {
         onDemand: boolean;
+        /**
+         * Tone mapping mode for the renderer
+         * ACESFilmicToneMapping is recommended for realistic results and wider dynamic range
+         */
+        toneMapping: THREE.ToneMapping;
+        /**
+         * Tone mapping exposure value
+         */
+        toneMappingExposure: number;
     };
 };
 export type PartialSettings = RecursivePartial<Settings>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yschindel/ara3d-webgl",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "A 3D viewer designed for large architectural (BIM) models built on top of Three.JS.",
   "files": [
     "dist"