babylonjs-addons 8.34.0 → 8.34.1

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.
@@ -2628,10 +2628,15 @@ export class AtmospherePerCameraVariables {
2628
2628
  get clampedCameraHeight(): number;
2629
2629
  /**
2630
2630
  * The camera position in global space kilometers.
2631
+ *
2632
+ * The behavior of this value depends on whether floating origin mode is enabled:
2633
+ * - If floating origin mode is enabled, this is simply the camera's global position scaled to kilometers. The atmosphere's origin height is used to offset the camera position along its geocentric normal.
2634
+ * - If floating origin mode is disabled, the camera's y position is offset by the planet radius plus any origin height.
2631
2635
  */
2632
2636
  get cameraPositionGlobal(): IVector3Like;
2633
2637
  /**
2634
2638
  * The camera position, clamped to the planet radius offset, in global space kilometers.
2639
+ * See {@link cameraPositionGlobal} for details on how the value is computed.
2635
2640
  */
2636
2641
  get clampedCameraPositionGlobal(): IVector3Like;
2637
2642
  /**
@@ -2644,6 +2649,7 @@ export class AtmospherePerCameraVariables {
2644
2649
  get sinCameraAtmosphereHorizonAngleFromNadir(): number;
2645
2650
  /**
2646
2651
  * The geocentric normal of the camera in global space i.e., the normalization of {@link cameraPositionGlobal}.
2652
+ * Note the behavior of this value depends on whether floating origin mode is enabled. See {@link cameraPositionGlobal} for details.
2647
2653
  */
2648
2654
  get cameraGeocentricNormal(): IVector3Like;
2649
2655
  /**
@@ -3000,11 +3006,11 @@ export class Atmosphere implements IDisposable {
3000
3006
  /**
3001
3007
  * Called before the LUTs are rendered for this camera. This happens after the per-camera UBO update.
3002
3008
  */
3003
- readonly onBeforeRenderLutsForCameraObservable: Observable<void>;
3009
+ readonly onBeforeRenderLutsForCameraObservable: Observable<Camera>;
3004
3010
  /**
3005
3011
  * Called after the LUTs were rendered.
3006
3012
  */
3007
- readonly onAfterRenderLutsForCameraObservable: Observable<void>;
3013
+ readonly onAfterRenderLutsForCameraObservable: Observable<Camera>;
3008
3014
  /**
3009
3015
  * If provided, this is the depth texture used for composition passes.
3010
3016
  * Expects an infinite far plane on the camera (camera.maxZ = 0) and the non-linear depth accessible in red channel.
@@ -3258,6 +3264,7 @@ export class Atmosphere implements IDisposable {
3258
3264
  /**
3259
3265
  * Renders the lookup tables, some of which can vary per-camera.
3260
3266
  * It is expected that updatePerCameraVariables was previously called.
3267
+ * @param camera - The camera to render the LUTs for.
3261
3268
  */
3262
3269
  private _renderLutsForCamera;
3263
3270
  /**
@@ -5873,10 +5880,15 @@ declare module ADDONS {
5873
5880
  get clampedCameraHeight(): number;
5874
5881
  /**
5875
5882
  * The camera position in global space kilometers.
5883
+ *
5884
+ * The behavior of this value depends on whether floating origin mode is enabled:
5885
+ * - If floating origin mode is enabled, this is simply the camera's global position scaled to kilometers. The atmosphere's origin height is used to offset the camera position along its geocentric normal.
5886
+ * - If floating origin mode is disabled, the camera's y position is offset by the planet radius plus any origin height.
5876
5887
  */
5877
5888
  get cameraPositionGlobal(): BABYLON.IVector3Like;
5878
5889
  /**
5879
5890
  * The camera position, clamped to the planet radius offset, in global space kilometers.
5891
+ * See {@link cameraPositionGlobal} for details on how the value is computed.
5880
5892
  */
5881
5893
  get clampedCameraPositionGlobal(): BABYLON.IVector3Like;
5882
5894
  /**
@@ -5889,6 +5901,7 @@ declare module ADDONS {
5889
5901
  get sinCameraAtmosphereHorizonAngleFromNadir(): number;
5890
5902
  /**
5891
5903
  * The geocentric normal of the camera in global space i.e., the normalization of {@link cameraPositionGlobal}.
5904
+ * Note the behavior of this value depends on whether floating origin mode is enabled. See {@link cameraPositionGlobal} for details.
5892
5905
  */
5893
5906
  get cameraGeocentricNormal(): BABYLON.IVector3Like;
5894
5907
  /**
@@ -6203,11 +6216,11 @@ declare module ADDONS {
6203
6216
  /**
6204
6217
  * Called before the LUTs are rendered for this camera. This happens after the per-camera UBO update.
6205
6218
  */
6206
- readonly onBeforeRenderLutsForCameraObservable: BABYLON.Observable<void>;
6219
+ readonly onBeforeRenderLutsForCameraObservable: BABYLON.Observable<BABYLON.Camera>;
6207
6220
  /**
6208
6221
  * Called after the LUTs were rendered.
6209
6222
  */
6210
- readonly onAfterRenderLutsForCameraObservable: BABYLON.Observable<void>;
6223
+ readonly onAfterRenderLutsForCameraObservable: BABYLON.Observable<BABYLON.Camera>;
6211
6224
  /**
6212
6225
  * If provided, this is the depth texture used for composition passes.
6213
6226
  * Expects an infinite far plane on the camera (camera.maxZ = 0) and the non-linear depth accessible in red channel.
@@ -6461,6 +6474,7 @@ declare module ADDONS {
6461
6474
  /**
6462
6475
  * Renders the lookup tables, some of which can vary per-camera.
6463
6476
  * It is expected that updatePerCameraVariables was previously called.
6477
+ * @param camera - The camera to render the LUTs for.
6464
6478
  */
6465
6479
  private _renderLutsForCamera;
6466
6480
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "babylonjs-addons",
3
- "version": "8.34.0",
3
+ "version": "8.34.1",
4
4
  "main": "babylonjs.addons.min.js",
5
5
  "types": "babylonjs.addons.module.d.ts",
6
6
  "files": [
@@ -15,7 +15,7 @@
15
15
  "test:escheck": "es-check es6 ./babylonjs.addons.js"
16
16
  },
17
17
  "dependencies": {
18
- "babylonjs": "^8.34.0"
18
+ "babylonjs": "^8.34.1"
19
19
  },
20
20
  "devDependencies": {
21
21
  "@dev/build-tools": "1.0.0",