@cesium/engine 6.1.0 → 6.2.0

package/Source/Shaders/Model/VerticalExaggerationStageVS.glsl

@@ -0,0 +1,39 @@
+void verticalExaggerationStage(
+  inout ProcessedAttributes attributes
+) {
+  // Compute the distance from the camera to the local center of curvature.
+  vec4 vertexPositionENU = czm_modelToEnu * vec4(attributes.positionMC, 1.0);
+  vec2 vertexAzimuth = normalize(vertexPositionENU.xy);
+  // Curvature = 1 / radius of curvature.
+  float azimuthalCurvature = dot(vertexAzimuth * vertexAzimuth, czm_eyeEllipsoidCurvature);
+  float eyeToCenter = 1.0 / azimuthalCurvature + czm_eyeHeight;
+
+  // Compute the approximate ellipsoid normal at the vertex position.
+  // Uses a circular approximation for the Earth curvature along the geodesic.
+  vec3 vertexPositionEC = (czm_modelView * vec4(attributes.positionMC, 1.0)).xyz;
+  vec3 centerToVertex = eyeToCenter * czm_eyeEllipsoidNormalEC + vertexPositionEC;
+  vec3 vertexNormal = normalize(centerToVertex);
+
+  // Estimate the (sine of the) angle between the camera direction and the vertex normal
+  float verticalDistance = dot(vertexPositionEC, czm_eyeEllipsoidNormalEC);
+  float horizontalDistance = length(vertexPositionEC - verticalDistance * czm_eyeEllipsoidNormalEC);
+  float sinTheta = horizontalDistance / (eyeToCenter + verticalDistance);
+  bool isSmallAngle = clamp(sinTheta, 0.0, 0.05) == sinTheta;
+
+  // Approximate the change in height above the ellipsoid, from camera to vertex position.
+  float exactVersine = 1.0 - dot(czm_eyeEllipsoidNormalEC, vertexNormal);
+  float smallAngleVersine = 0.5 * sinTheta * sinTheta;
+  float versine = isSmallAngle ? smallAngleVersine : exactVersine;
+  float dHeight = dot(vertexPositionEC, vertexNormal) - eyeToCenter * versine;
+  float vertexHeight = czm_eyeHeight + dHeight;
+
+  // Transform the approximate vertex normal to model coordinates.
+  vec3 vertexNormalMC = (czm_inverseModelView * vec4(vertexNormal, 0.0)).xyz;
+  vertexNormalMC = normalize(vertexNormalMC);
+
+  // Compute the exaggeration and apply it along the approximate vertex normal.
+  float stretch = u_verticalExaggerationAndRelativeHeight.x;
+  float shift = u_verticalExaggerationAndRelativeHeight.y;
+  float exaggeration = (vertexHeight - shift) * (stretch - 1.0);
+  attributes.positionMC += exaggeration * vertexNormalMC;
+}

package/Source/Shaders/Model/VerticalExaggerationStageVS.js

@@ -0,0 +1,41 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "void verticalExaggerationStage(\n\
+  inout ProcessedAttributes attributes\n\
+) {\n\
+  // Compute the distance from the camera to the local center of curvature.\n\
+  vec4 vertexPositionENU = czm_modelToEnu * vec4(attributes.positionMC, 1.0);\n\
+  vec2 vertexAzimuth = normalize(vertexPositionENU.xy);\n\
+  // Curvature = 1 / radius of curvature.\n\
+  float azimuthalCurvature = dot(vertexAzimuth * vertexAzimuth, czm_eyeEllipsoidCurvature);\n\
+  float eyeToCenter = 1.0 / azimuthalCurvature + czm_eyeHeight;\n\
+\n\
+  // Compute the approximate ellipsoid normal at the vertex position.\n\
+  // Uses a circular approximation for the Earth curvature along the geodesic.\n\
+  vec3 vertexPositionEC = (czm_modelView * vec4(attributes.positionMC, 1.0)).xyz;\n\
+  vec3 centerToVertex = eyeToCenter * czm_eyeEllipsoidNormalEC + vertexPositionEC;\n\
+  vec3 vertexNormal = normalize(centerToVertex);\n\
+\n\
+  // Estimate the (sine of the) angle between the camera direction and the vertex normal\n\
+  float verticalDistance = dot(vertexPositionEC, czm_eyeEllipsoidNormalEC);\n\
+  float horizontalDistance = length(vertexPositionEC - verticalDistance * czm_eyeEllipsoidNormalEC);\n\
+  float sinTheta = horizontalDistance / (eyeToCenter + verticalDistance);\n\
+  bool isSmallAngle = clamp(sinTheta, 0.0, 0.05) == sinTheta;\n\
+\n\
+  // Approximate the change in height above the ellipsoid, from camera to vertex position.\n\
+  float exactVersine = 1.0 - dot(czm_eyeEllipsoidNormalEC, vertexNormal);\n\
+  float smallAngleVersine = 0.5 * sinTheta * sinTheta;\n\
+  float versine = isSmallAngle ? smallAngleVersine : exactVersine;\n\
+  float dHeight = dot(vertexPositionEC, vertexNormal) - eyeToCenter * versine;\n\
+  float vertexHeight = czm_eyeHeight + dHeight;\n\
+\n\
+  // Transform the approximate vertex normal to model coordinates.\n\
+  vec3 vertexNormalMC = (czm_inverseModelView * vec4(vertexNormal, 0.0)).xyz;\n\
+  vertexNormalMC = normalize(vertexNormalMC);\n\
+\n\
+  // Compute the exaggeration and apply it along the approximate vertex normal.\n\
+  float stretch = u_verticalExaggerationAndRelativeHeight.x;\n\
+  float shift = u_verticalExaggerationAndRelativeHeight.y;\n\
+  float exaggeration = (vertexHeight - shift) * (stretch - 1.0);\n\
+  attributes.positionMC += exaggeration * vertexNormalMC;\n\
+}\n\
+";

package/index.d.ts

@@ -5818,6 +5818,13 @@ export class Ellipsoid {
      * @returns the intersection point if it's inside the ellipsoid, undefined otherwise
      */
     getSurfaceNormalIntersectionWithZAxis(position: Cartesian3, buffer?: number, result?: Cartesian3): Cartesian3 | undefined;
+    /**
+     * Computes the ellipsoid curvatures at a given position on the surface.
+     * @param surfacePosition - The position on the ellipsoid surface where curvatures will be calculated.
+     * @param [result] - The cartesian to which to copy the result, or undefined to create and return a new instance.
+     * @returns The local curvature of the ellipsoid surface at the provided position, in east and north directions.
+     */
+    getLocalCurvature(surfacePosition: Cartesian3, result?: Cartesian2): Cartesian2;
     /**
      * Computes an approximation of the surface area of a rectangle on the surface of an ellipsoid using
      * Gauss-Legendre 10th order quadrature.
@@ -29473,9 +29480,9 @@ export class Cesium3DTileset {
      *   console.error(`Error creating tileset: ${error}`);
      * }
      * @param assetId - The Cesium ion asset id.
-     * @param options - An object describing initialization options
+     * @param [options] - An object describing initialization options
      */
-    static fromIonAssetId(assetId: number, options: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
+    static fromIonAssetId(assetId: number, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
     /**
      * Creates a {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification|3D Tiles tileset},
      * used for streaming massive heterogeneous 3D geospatial datasets.
@@ -31301,20 +31308,6 @@ export class Globe {
      * A brightness shift of -1.0 is complete darkness, which will let space show through.
      */
     atmosphereBrightnessShift: number;
-    /**
-     * A scalar used to exaggerate the terrain. Defaults to <code>1.0</code> (no exaggeration).
-     * A value of <code>2.0</code> scales the terrain by 2x.
-     * A value of <code>0.0</code> makes the terrain completely flat.
-     * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
-     */
-    terrainExaggeration: number;
-    /**
-     * The height from which terrain is exaggerated. Defaults to <code>0.0</code> (scaled relative to ellipsoid surface).
-     * Terrain that is above this height will scale upwards and terrain that is below this height will scale downwards.
-     * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
-     * If {@link Globe#terrainExaggeration} is <code>1.0</code> this value will have no effect.
-     */
-    terrainExaggerationRelativeHeight: number;
     /**
      * Whether to show terrain skirts. Terrain skirts are geometry extending downwards from a tile's edges used to hide seams between neighboring tiles.
      * Skirts are always hidden when the camera is underground or translucency is enabled.
@@ -31372,6 +31365,20 @@ export class Globe {
      * Gets an event that's raised when the terrain provider is changed
      */
     readonly terrainProviderChanged: Event;
+    /**
+     * A scalar used to exaggerate the terrain. Defaults to <code>1.0</code> (no exaggeration).
+     * A value of <code>2.0</code> scales the terrain by 2x.
+     * A value of <code>0.0</code> makes the terrain completely flat.
+     * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
+     */
+    terrainExaggeration: number;
+    /**
+     * The height from which terrain is exaggerated. Defaults to <code>0.0</code> (scaled relative to ellipsoid surface).
+     * Terrain that is above this height will scale upwards and terrain that is below this height will scale downwards.
+     * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
+     * If {@link Globe#terrainExaggeration} is <code>1.0</code> this value will have no effect.
+     */
+    terrainExaggerationRelativeHeight: number;
     /**
      * Gets an event that's raised when the length of the tile load queue has changed since the last render frame.  When the load queue is empty,
      * all terrain and imagery for the current view have been loaded.  The event passes the new length of the tile load queue.
@@ -32937,7 +32944,7 @@ export namespace ImageryLayer {
  * // Add an OpenStreetMaps layer
  * const imageryLayer = new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
  *   url: "https://tile.openstreetmap.org/"
- * })),
+ * }));
  * scene.imageryLayers.add(imageryLayer);
  * @example
  * // Add Cesium ion's default world imagery layer
@@ -32948,11 +32955,11 @@ export namespace ImageryLayer {
  * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
  * imageryLayer.alpha = 0.5;
  * scene.imageryLayers.add(imageryLayer);
- * @param imageryProvider - The imagery provider to use.
- * @param options - An object describing initialization options
+ * @param [imageryProvider] - The imagery provider to use.
+ * @param [options] - An object describing initialization options
  */
 export class ImageryLayer {
-    constructor(imageryProvider: ImageryProvider, options: ImageryLayer.ConstructorOptions);
+    constructor(imageryProvider?: ImageryProvider, options?: ImageryLayer.ConstructorOptions);
     /**
      * The alpha blending value of this layer, with 0.0 representing fully transparent and
      * 1.0 representing fully opaque.
@@ -33613,10 +33620,10 @@ export class IonImageryProvider {
      * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
      * viewer.imageryLayers.add(imageryLayer);
      * @param assetId - An ion imagery asset ID.
-     * @param options - Object describing initialization options.
+     * @param [options] - Object describing initialization options.
      * @returns A promise which resolves to the created IonImageryProvider.
      */
-    static fromAssetId(assetId: number, options: IonImageryProvider.ConstructorOptions): Promise<IonImageryProvider>;
+    static fromAssetId(assetId: number, options?: IonImageryProvider.ConstructorOptions): Promise<IonImageryProvider>;
     /**
      * Gets the credits to be displayed when a given tile is displayed.
      * @param x - The tile X coordinate.
@@ -39255,6 +39262,16 @@ export class Scene {
      * other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface.
      */
     nearToFarDistance2D: number;
+    /**
+     * The vertical exaggeration of the scene.
+     * When set to 1.0, no exaggeration is applied.
+     */
+    verticalExaggeration: number;
+    /**
+     * The reference height for vertical exaggeration of the scene.
+     * When set to 0.0, the exaggeration is applied relative to the ellipsoid surface.
+     */
+    verticalExaggerationRelativeHeight: number;
     /**
      * This property is for debugging only; it is not for production use.
      * <p>