beckhoff-xts-viewer-3d 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -12,7 +12,7 @@ import { GLTF } from 'three-stdlib';
12
12
  * Run `npm run sync-version` (or any script that depends on it) to refresh
13
13
  * after bumping the package version.
14
14
  */
15
- declare const VERSION: "4.1.0";
15
+ declare const VERSION: "4.2.0";
16
16
 
17
17
  /**
18
18
  * Default CDN URL for the GLB asset bundle (`beckhoff-xts-viewer-3d-assets`).
@@ -508,6 +508,48 @@ interface DisplayOptions {
508
508
  * Default: `1.0`.
509
509
  */
510
510
  toneMappingExposure?: number;
511
+ /**
512
+ * Screen-space ambient occlusion (GTAO). Adds contact shadows in
513
+ * crevices and between adjacent surfaces for significantly more visual
514
+ * depth. Cost: one half-res pass per frame.
515
+ *
516
+ * Default: `false`.
517
+ */
518
+ ssao?: boolean;
519
+ /**
520
+ * SSAO blend intensity. Higher values darken crevices more.
521
+ * Range: 0.0–4.0. Default: `1.0`.
522
+ */
523
+ ssaoIntensity?: number;
524
+ /**
525
+ * SSAO sampling radius in world units (mm). Larger values spread the
526
+ * occlusion over a wider area. Default: `20`.
527
+ */
528
+ ssaoRadius?: number;
529
+ /**
530
+ * Bloom (glow) for bright metallic surfaces. Adds a soft halo around
531
+ * polished rails and highlights, giving metals a more realistic
532
+ * reflective appearance. Cost: one half-res pass per frame.
533
+ *
534
+ * Default: `false`.
535
+ */
536
+ bloom?: boolean;
537
+ /**
538
+ * Bloom intensity (strength). Higher values produce brighter glow.
539
+ * Range: 0.0–3.0. Default: `0.4`.
540
+ */
541
+ bloomIntensity?: number;
542
+ /**
543
+ * Bloom luminance threshold. Only pixels brighter than this value
544
+ * contribute to the bloom. Lower values bloom more of the scene.
545
+ * Range: 0.0–1.0. Default: `0.85`.
546
+ */
547
+ bloomThreshold?: number;
548
+ /**
549
+ * Bloom blur radius. Controls how far the glow spreads.
550
+ * Range: 0.0–1.0. Default: `0.4`.
551
+ */
552
+ bloomRadius?: number;
511
553
  }
512
554
  /**
513
555
  * Style + placement overrides for the per-mover-id 3D text labels
@@ -1632,6 +1674,28 @@ interface XtsViewer3DProps {
1632
1674
  maxFps?: number;
1633
1675
  instancing?: boolean;
1634
1676
  autoPauseOnHidden?: boolean;
1677
+ /**
1678
+ * Enable demand rendering: frames only render when something changes
1679
+ * (camera move, mover position update, selection). Saves >90% GPU
1680
+ * time when the scene is idle. Default: true.
1681
+ */
1682
+ demandRendering?: boolean;
1683
+ /**
1684
+ * Cap the device pixel ratio. Values above 2 rarely improve
1685
+ * perceptible quality but double fill-rate cost on Retina/4K
1686
+ * displays. Default: 2.
1687
+ */
1688
+ maxDpr?: number;
1689
+ /**
1690
+ * Disable automatic per-frame shadow map updates. Shadows only
1691
+ * re-render on camera change. Default: true (when shadows enabled).
1692
+ */
1693
+ shadowOnDemand?: boolean;
1694
+ /**
1695
+ * Opt into the WebGPU renderer when the browser supports it.
1696
+ * Falls back to WebGL automatically. Default: false (experimental).
1697
+ */
1698
+ webgpu?: boolean;
1635
1699
  };
1636
1700
  /**
1637
1701
  * Live override of the per-asset origin-correction sidecars. Useful for
package/dist/index.d.ts CHANGED
@@ -12,7 +12,7 @@ import { GLTF } from 'three-stdlib';
12
12
  * Run `npm run sync-version` (or any script that depends on it) to refresh
13
13
  * after bumping the package version.
14
14
  */
15
- declare const VERSION: "4.1.0";
15
+ declare const VERSION: "4.2.0";
16
16
 
17
17
  /**
18
18
  * Default CDN URL for the GLB asset bundle (`beckhoff-xts-viewer-3d-assets`).
@@ -508,6 +508,48 @@ interface DisplayOptions {
508
508
  * Default: `1.0`.
509
509
  */
510
510
  toneMappingExposure?: number;
511
+ /**
512
+ * Screen-space ambient occlusion (GTAO). Adds contact shadows in
513
+ * crevices and between adjacent surfaces for significantly more visual
514
+ * depth. Cost: one half-res pass per frame.
515
+ *
516
+ * Default: `false`.
517
+ */
518
+ ssao?: boolean;
519
+ /**
520
+ * SSAO blend intensity. Higher values darken crevices more.
521
+ * Range: 0.0–4.0. Default: `1.0`.
522
+ */
523
+ ssaoIntensity?: number;
524
+ /**
525
+ * SSAO sampling radius in world units (mm). Larger values spread the
526
+ * occlusion over a wider area. Default: `20`.
527
+ */
528
+ ssaoRadius?: number;
529
+ /**
530
+ * Bloom (glow) for bright metallic surfaces. Adds a soft halo around
531
+ * polished rails and highlights, giving metals a more realistic
532
+ * reflective appearance. Cost: one half-res pass per frame.
533
+ *
534
+ * Default: `false`.
535
+ */
536
+ bloom?: boolean;
537
+ /**
538
+ * Bloom intensity (strength). Higher values produce brighter glow.
539
+ * Range: 0.0–3.0. Default: `0.4`.
540
+ */
541
+ bloomIntensity?: number;
542
+ /**
543
+ * Bloom luminance threshold. Only pixels brighter than this value
544
+ * contribute to the bloom. Lower values bloom more of the scene.
545
+ * Range: 0.0–1.0. Default: `0.85`.
546
+ */
547
+ bloomThreshold?: number;
548
+ /**
549
+ * Bloom blur radius. Controls how far the glow spreads.
550
+ * Range: 0.0–1.0. Default: `0.4`.
551
+ */
552
+ bloomRadius?: number;
511
553
  }
512
554
  /**
513
555
  * Style + placement overrides for the per-mover-id 3D text labels
@@ -1632,6 +1674,28 @@ interface XtsViewer3DProps {
1632
1674
  maxFps?: number;
1633
1675
  instancing?: boolean;
1634
1676
  autoPauseOnHidden?: boolean;
1677
+ /**
1678
+ * Enable demand rendering: frames only render when something changes
1679
+ * (camera move, mover position update, selection). Saves >90% GPU
1680
+ * time when the scene is idle. Default: true.
1681
+ */
1682
+ demandRendering?: boolean;
1683
+ /**
1684
+ * Cap the device pixel ratio. Values above 2 rarely improve
1685
+ * perceptible quality but double fill-rate cost on Retina/4K
1686
+ * displays. Default: 2.
1687
+ */
1688
+ maxDpr?: number;
1689
+ /**
1690
+ * Disable automatic per-frame shadow map updates. Shadows only
1691
+ * re-render on camera change. Default: true (when shadows enabled).
1692
+ */
1693
+ shadowOnDemand?: boolean;
1694
+ /**
1695
+ * Opt into the WebGPU renderer when the browser supports it.
1696
+ * Falls back to WebGL automatically. Default: false (experimental).
1697
+ */
1698
+ webgpu?: boolean;
1635
1699
  };
1636
1700
  /**
1637
1701
  * Live override of the per-asset origin-correction sidecars. Useful for