@cesium/engine 11.0.0 → 12.0.0

package/Source/Renderer/UniformState.js

@@ -160,6 +160,7 @@ function UniformState() {
   this._specularEnvironmentMapsMaximumLOD = undefined;
 
   this._fogDensity = undefined;
+  this._fogVisualDensityScalar = undefined;
   this._fogMinimumBrightness = undefined;
 
   this._atmosphereHsbShift = undefined;
@@ -924,6 +925,17 @@ Object.defineProperties(UniformState.prototype, {
     },
   },
 
+  /**
+   * A scalar used to mix a color with the fog color based on the distance to the camera.
+   * @memberof UniformState.prototype
+   * @type {number}
+   */
+  fogVisualDensityScalar: {
+    get: function () {
+      return this._fogVisualDensityScalar;
+    },
+  },
+
   /**
    * A scalar used as a minimum value when brightening fog
    * @memberof UniformState.prototype
@@ -1227,25 +1239,26 @@ function setCamera(uniformState, camera) {
     if (Cartesian3.magnitude(camera.positionWC) > 0.0) {
       uniformState._eyeEllipsoidNormalEC = Cartesian3.normalize(
         camera.positionWC,
-        uniformState._eyeEllipsoidNormalEC
+        uniformState._eyeEllipsoidNormalEC,
       );
     }
     surfacePosition = ellipsoid.scaleToGeodeticSurface(
       camera.positionWC,
-      surfacePositionScratch
+      surfacePositionScratch,
     );
   } else {
     uniformState._eyeHeight = positionCartographic.height;
-    uniformState._eyeEllipsoidNormalEC = ellipsoid.geodeticSurfaceNormalCartographic(
-      positionCartographic,
-      uniformState._eyeEllipsoidNormalEC
-    );
+    uniformState._eyeEllipsoidNormalEC =
+      ellipsoid.geodeticSurfaceNormalCartographic(
+        positionCartographic,
+        uniformState._eyeEllipsoidNormalEC,
+      );
     surfacePosition = Cartesian3.fromRadians(
       positionCartographic.longitude,
       positionCartographic.latitude,
       0.0,
       ellipsoid,
-      surfacePositionScratch
+      surfacePositionScratch,
     );
   }
 
@@ -1258,29 +1271,29 @@ function setCamera(uniformState, camera) {
   uniformState._eyeEllipsoidNormalEC = Matrix3.multiplyByVector(
     uniformState._viewRotation,
     uniformState._eyeEllipsoidNormalEC,
-    uniformState._eyeEllipsoidNormalEC
+    uniformState._eyeEllipsoidNormalEC,
   );
 
   const enuToWorld = Transforms.eastNorthUpToFixedFrame(
     surfacePosition,
     ellipsoid,
-    enuTransformScratch
+    enuTransformScratch,
   );
   uniformState._enuToModel = Matrix4.multiplyTransformation(
     uniformState.inverseModel,
     enuToWorld,
-    uniformState._enuToModel
+    uniformState._enuToModel,
   );
   uniformState._modelToEnu = Matrix4.inverseTransformation(
     uniformState._enuToModel,
-    uniformState._modelToEnu
+    uniformState._modelToEnu,
   );
 
   if (
     !CesiumMath.equalsEpsilon(
       ellipsoid._radii.x,
       ellipsoid._radii.y,
-      CesiumMath.EPSILON15
+      CesiumMath.EPSILON15,
     )
   ) {
     // Ellipsoid curvature calculations assume radii.x === radii.y as is true for WGS84
@@ -1289,7 +1302,7 @@ function setCamera(uniformState, camera) {
 
   uniformState._eyeEllipsoidCurvature = ellipsoid.getLocalCurvature(
     surfacePosition,
-    uniformState._eyeEllipsoidCurvature
+    uniformState._eyeEllipsoidCurvature,
   );
 }
 
@@ -1298,13 +1311,14 @@ const sunCartographicScratch = new Cartographic();
 function setSunAndMoonDirections(uniformState, frameState) {
   Transforms.computeIcrfToCentralBodyFixedMatrix(
     frameState.time,
-    transformMatrix
+    transformMatrix,
   );
 
-  let position = Simon1994PlanetaryPositions.computeSunPositionInEarthInertialFrame(
-    frameState.time,
-    uniformState._sunPositionWC
-  );
+  let position =
+    Simon1994PlanetaryPositions.computeSunPositionInEarthInertialFrame(
+      frameState.time,
+      uniformState._sunPositionWC,
+    );
   Matrix3.multiplyByVector(transformMatrix, position, position);
 
   Cartesian3.normalize(position, uniformState._sunDirectionWC);
@@ -1312,14 +1326,15 @@ function setSunAndMoonDirections(uniformState, frameState) {
   position = Matrix3.multiplyByVector(
     uniformState.viewRotation3D,
     position,
-    uniformState._sunDirectionEC
+    uniformState._sunDirectionEC,
   );
   Cartesian3.normalize(position, position);
 
-  position = Simon1994PlanetaryPositions.computeMoonPositionInEarthInertialFrame(
-    frameState.time,
-    uniformState._moonDirectionEC
-  );
+  position =
+    Simon1994PlanetaryPositions.computeMoonPositionInEarthInertialFrame(
+      frameState.time,
+      uniformState._moonDirectionEC,
+    );
   Matrix3.multiplyByVector(transformMatrix, position, position);
   Matrix3.multiplyByVector(uniformState.viewRotation3D, position, position);
   Cartesian3.normalize(position, position);
@@ -1328,7 +1343,7 @@ function setSunAndMoonDirections(uniformState, frameState) {
   const ellipsoid = projection.ellipsoid;
   const sunCartographic = ellipsoid.cartesianToCartographic(
     uniformState._sunPositionWC,
-    sunCartographicScratch
+    sunCartographicScratch,
   );
   projection.project(sunCartographic, uniformState._sunPositionColumbusView);
 }
@@ -1362,7 +1377,10 @@ UniformState.prototype.updateCamera = function (camera) {
  * @param {object} frustum The frustum to synchronize with.
  */
 UniformState.prototype.updateFrustum = function (frustum) {
+  // If any frustum parameters have changed, calling the frustum.projectionMatrix
+  // getter will recompute the projection before it is copied.
   setProjection(this, frustum.projectionMatrix);
+
   if (defined(frustum.infiniteProjectionMatrix)) {
     setInfiniteProjection(this, frustum.infiniteProjectionMatrix);
   }
@@ -1371,7 +1389,7 @@ UniformState.prototype.updateFrustum = function (frustum) {
 
   this._farDepthFromNearPlusOne = frustum.far - frustum.near + 1.0;
   this._log2FarDepthFromNearPlusOne = CesiumMath.log2(
-    this._farDepthFromNearPlusOne
+    this._farDepthFromNearPlusOne,
   );
   this._oneOverLog2FarDepthFromNearPlusOne =
     1.0 / this._log2FarDepthFromNearPlusOne;
@@ -1426,21 +1444,21 @@ UniformState.prototype.update = function (frameState) {
   if (light instanceof SunLight) {
     this._lightDirectionWC = Cartesian3.clone(
       this._sunDirectionWC,
-      this._lightDirectionWC
+      this._lightDirectionWC,
     );
     this._lightDirectionEC = Cartesian3.clone(
       this._sunDirectionEC,
-      this._lightDirectionEC
+      this._lightDirectionEC,
     );
   } else {
     this._lightDirectionWC = Cartesian3.normalize(
       Cartesian3.negate(light.direction, this._lightDirectionWC),
-      this._lightDirectionWC
+      this._lightDirectionWC,
     );
     this._lightDirectionEC = Matrix3.multiplyByVector(
       this.viewRotation3D,
       this._lightDirectionWC,
-      this._lightDirectionEC
+      this._lightDirectionEC,
     );
   }
 
@@ -1449,19 +1467,19 @@ UniformState.prototype.update = function (frameState) {
     lightColor.red,
     lightColor.green,
     lightColor.blue,
-    this._lightColorHdr
+    this._lightColorHdr,
   );
   lightColorHdr = Cartesian3.multiplyByScalar(
     lightColorHdr,
     light.intensity,
-    lightColorHdr
+    lightColorHdr,
   );
   const maximumComponent = Cartesian3.maximumComponent(lightColorHdr);
   if (maximumComponent > 1.0) {
     Cartesian3.divideByScalar(
       lightColorHdr,
       maximumComponent,
-      this._lightColor
+      this._lightColor,
     );
   } else {
     Cartesian3.clone(lightColorHdr, this._lightColor);
@@ -1475,20 +1493,21 @@ UniformState.prototype.update = function (frameState) {
 
   this._environmentMap = defaultValue(
     frameState.environmentMap,
-    frameState.context.defaultCubeMap
+    frameState.context.defaultCubeMap,
   );
 
   // IE 11 doesn't optimize out uniforms that are #ifdef'd out. So undefined values for the spherical harmonic
   // coefficients cause a crash.
   this._sphericalHarmonicCoefficients = defaultValue(
     frameState.sphericalHarmonicCoefficients,
-    EMPTY_ARRAY
+    EMPTY_ARRAY,
   );
   this._specularEnvironmentMaps = frameState.specularEnvironmentMaps;
   this._specularEnvironmentMapsMaximumLOD =
     frameState.specularEnvironmentMapsMaximumLOD;
 
   this._fogDensity = frameState.fog.density;
+  this._fogVisualDensityScalar = frameState.fog.visualDensityScalar;
   this._fogMinimumBrightness = frameState.fog.minimumBrightness;
 
   const atmosphere = frameState.atmosphere;
@@ -1497,17 +1516,17 @@ UniformState.prototype.update = function (frameState) {
       atmosphere.hueShift,
       atmosphere.saturationShift,
       atmosphere.brightnessShift,
-      this._atmosphereHsbShift
+      this._atmosphereHsbShift,
     );
     this._atmosphereLightIntensity = atmosphere.lightIntensity;
     this._atmosphereRayleighCoefficient = Cartesian3.clone(
       atmosphere.rayleighCoefficient,
-      this._atmosphereRayleighCoefficient
+      this._atmosphereRayleighCoefficient,
     );
     this._atmosphereRayleighScaleHeight = atmosphere.rayleighScaleHeight;
     this._atmosphereMieCoefficient = Cartesian3.clone(
       atmosphere.mieCoefficient,
-      this._atmosphereMieCoefficient
+      this._atmosphereMieCoefficient,
     );
     this._atmosphereMieScaleHeight = atmosphere.mieScaleHeight;
     this._atmosphereMieAnisotropy = atmosphere.mieAnisotropy;
@@ -1519,7 +1538,7 @@ UniformState.prototype.update = function (frameState) {
   this._frameState = frameState;
   this._temeToPseudoFixed = Transforms.computeTemeToPseudoFixedMatrix(
     frameState.time,
-    this._temeToPseudoFixed
+    this._temeToPseudoFixed,
   );
 
   // Convert the relative splitPosition to absolute pixel coordinates
@@ -1544,7 +1563,8 @@ UniformState.prototype.update = function (frameState) {
 
   this._minimumDisableDepthTestDistance =
     frameState.minimumDisableDepthTestDistance;
-  this._minimumDisableDepthTestDistance *= this._minimumDisableDepthTestDistance;
+  this._minimumDisableDepthTestDistance *=
+    this._minimumDisableDepthTestDistance;
   if (this._minimumDisableDepthTestDistance === Number.POSITIVE_INFINITY) {
     this._minimumDisableDepthTestDistance = -1.0;
   }
@@ -1560,13 +1580,13 @@ function cleanViewport(uniformState) {
       v.y + v.height,
       0.0,
       1.0,
-      uniformState._viewportOrthographicMatrix
+      uniformState._viewportOrthographicMatrix,
     );
     Matrix4.computeViewportTransformation(
       v,
       0.0,
       1.0,
-      uniformState._viewportTransformation
+      uniformState._viewportTransformation,
     );
     uniformState._viewportDirty = false;
   }
@@ -1583,7 +1603,7 @@ function cleanInverseProjection(uniformState) {
     ) {
       Matrix4.inverse(
         uniformState._projection,
-        uniformState._inverseProjection
+        uniformState._inverseProjection,
       );
     } else {
       Matrix4.clone(Matrix4.ZERO, uniformState._inverseProjection);
@@ -1599,7 +1619,7 @@ function cleanModelView(uniformState) {
     Matrix4.multiplyTransformation(
       uniformState._view,
       uniformState._model,
-      uniformState._modelView
+      uniformState._modelView,
     );
   }
 }
@@ -1611,7 +1631,7 @@ function cleanModelView3D(uniformState) {
     Matrix4.multiplyTransformation(
       uniformState.view3D,
       uniformState._model,
-      uniformState._modelView3D
+      uniformState._modelView3D,
     );
   }
 }
@@ -1639,7 +1659,7 @@ function cleanViewProjection(uniformState) {
     Matrix4.multiply(
       uniformState._projection,
       uniformState._view,
-      uniformState._viewProjection
+      uniformState._viewProjection,
     );
   }
 }
@@ -1650,7 +1670,7 @@ function cleanInverseViewProjection(uniformState) {
 
     Matrix4.inverse(
       uniformState.viewProjection,
-      uniformState._inverseViewProjection
+      uniformState._inverseViewProjection,
     );
   }
 }
@@ -1662,7 +1682,7 @@ function cleanModelViewProjection(uniformState) {
     Matrix4.multiply(
       uniformState._projection,
       uniformState.modelView,
-      uniformState._modelViewProjection
+      uniformState._modelViewProjection,
     );
   }
 }
@@ -1698,7 +1718,7 @@ function cleanInverseModelViewProjection(uniformState) {
 
     Matrix4.inverse(
       uniformState.modelViewProjection,
-      uniformState._inverseModelViewProjection
+      uniformState._inverseModelViewProjection,
     );
   }
 }
@@ -1710,7 +1730,7 @@ function cleanModelViewProjectionRelativeToEye(uniformState) {
     Matrix4.multiply(
       uniformState._projection,
       uniformState.modelViewRelativeToEye,
-      uniformState._modelViewProjectionRelativeToEye
+      uniformState._modelViewProjectionRelativeToEye,
     );
   }
 }
@@ -1722,7 +1742,7 @@ function cleanModelViewInfiniteProjection(uniformState) {
     Matrix4.multiply(
       uniformState._infiniteProjection,
       uniformState.modelView,
-      uniformState._modelViewInfiniteProjection
+      uniformState._modelViewInfiniteProjection,
     );
   }
 }
@@ -1776,11 +1796,11 @@ function cleanEncodedCameraPositionMC(uniformState) {
     Matrix4.multiplyByPoint(
       uniformState.inverseModel,
       uniformState._cameraPosition,
-      cameraPositionMC
+      cameraPositionMC,
     );
     EncodedCartesian3.fromCartesian(
       cameraPositionMC,
-      uniformState._encodedCameraPositionMC
+      uniformState._encodedCameraPositionMC,
     );
   }
 }
@@ -1801,7 +1821,7 @@ function view2Dto3D(
   frustum2DWidth,
   mode,
   projection,
-  result
+  result,
 ) {
   // The camera position and directions are expressed in the 2D coordinate system where the Y axis is to the East,
   // the Z axis is to the North, and the X axis is out of the map.  Express them instead in the ENU axes where
@@ -1840,24 +1860,24 @@ function view2Dto3D(
   cartographic.longitude = CesiumMath.clamp(
     cartographic.longitude,
     -Math.PI,
-    Math.PI
+    Math.PI,
   );
   cartographic.latitude = CesiumMath.clamp(
     cartographic.latitude,
     -CesiumMath.PI_OVER_TWO,
-    CesiumMath.PI_OVER_TWO
+    CesiumMath.PI_OVER_TWO,
   );
   const ellipsoid = projection.ellipsoid;
   const position3D = ellipsoid.cartographicToCartesian(
     cartographic,
-    view2Dto3DCartesian3Scratch
+    view2Dto3DCartesian3Scratch,
   );
 
   // Compute the rotation from the local ENU at the real world camera position to the fixed axes.
   const enuToFixed = Transforms.eastNorthUpToFixedFrame(
     position3D,
     ellipsoid,
-    view2Dto3DMatrix4Scratch
+    view2Dto3DMatrix4Scratch,
   );
 
   // Transform each camera direction to the fixed axes.
@@ -1903,7 +1923,7 @@ function updateView3D(that) {
         that._frustum2DWidth,
         that._mode,
         that._mapProjection,
-        that._view3D
+        that._view3D,
       );
     }
     Matrix4.getMatrix3(that._view3D, that._viewRotation3D);

package/Source/Renderer/VertexArray.js

@@ -25,7 +25,7 @@ function addAttribute(attributes, attribute, index, context) {
   }
   if (hasVertexBuffer && hasValue) {
     throw new DeveloperError(
-      "attribute cannot have both a vertexBuffer and a value.  It must have either a vertexBuffer property defining per-vertex data or a value property defining data for all vertices."
+      "attribute cannot have both a vertexBuffer and a value.  It must have either a vertexBuffer property defining per-vertex data or a value property defining data for all vertices.",
     );
   }
   if (
@@ -36,12 +36,12 @@ function addAttribute(attributes, attribute, index, context) {
   ) {
     if (hasValue) {
       throw new DeveloperError(
-        "attribute.value.length must be in the range [1, 4]."
+        "attribute.value.length must be in the range [1, 4].",
       );
     }
 
     throw new DeveloperError(
-      "attribute.componentsPerAttribute must be in the range [1, 4]."
+      "attribute.componentsPerAttribute must be in the range [1, 4].",
     );
   }
   if (
@@ -49,13 +49,13 @@ function addAttribute(attributes, attribute, index, context) {
     !ComponentDatatype.validate(attribute.componentDatatype)
   ) {
     throw new DeveloperError(
-      "attribute must have a valid componentDatatype or not specify it."
+      "attribute must have a valid componentDatatype or not specify it.",
     );
   }
   if (defined(attribute.strideInBytes) && attribute.strideInBytes > 255) {
     // WebGL limit.  Not in GL ES.
     throw new DeveloperError(
-      "attribute must have a strideInBytes less than or equal to 255 or not specify it."
+      "attribute must have a strideInBytes less than or equal to 255 or not specify it.",
     );
   }
   if (
@@ -67,12 +67,12 @@ function addAttribute(attributes, attribute, index, context) {
   }
   if (defined(attribute.instanceDivisor) && attribute.instanceDivisor < 0) {
     throw new DeveloperError(
-      "attribute must have an instanceDivisor greater than or equal to zero"
+      "attribute must have an instanceDivisor greater than or equal to zero",
     );
   }
   if (defined(attribute.instanceDivisor) && hasValue) {
     throw new DeveloperError(
-      "attribute cannot have have an instanceDivisor if it is not backed by a buffer"
+      "attribute cannot have have an instanceDivisor if it is not backed by a buffer",
     );
   }
   if (
@@ -81,7 +81,7 @@ function addAttribute(attributes, attribute, index, context) {
     attribute.index === 0
   ) {
     throw new DeveloperError(
-      "attribute zero cannot have an instanceDivisor greater than 0"
+      "attribute zero cannot have an instanceDivisor greater than 0",
     );
   }
   //>>includeEnd('debug');
@@ -95,7 +95,7 @@ function addAttribute(attributes, attribute, index, context) {
     componentsPerAttribute: componentsPerAttribute,
     componentDatatype: defaultValue(
       attribute.componentDatatype,
-      ComponentDatatype.FLOAT
+      ComponentDatatype.FLOAT,
     ),
     normalize: defaultValue(attribute.normalize, false),
     offsetInBytes: defaultValue(attribute.offsetInBytes, 0),
@@ -114,7 +114,7 @@ function addAttribute(attributes, attribute, index, context) {
         this.componentDatatype,
         this.normalize,
         this.strideInBytes,
-        this.offsetInBytes
+        this.offsetInBytes,
       );
       gl.enableVertexAttribArray(index);
       if (this.instanceDivisor > 0) {
@@ -341,7 +341,7 @@ function VertexArray(options) {
     const index = vaAttributes[i].index;
     if (uniqueIndices[index]) {
       throw new DeveloperError(
-        `Index ${index} is used by more than one attribute.`
+        `Index ${index} is used by more than one attribute.`,
       );
     }
     uniqueIndices[index] = true;
@@ -399,7 +399,7 @@ function interleaveAttributes(attributes) {
         attributes[name].componentDatatype = ComponentDatatype.FLOAT;
         attributes[name].values = ComponentDatatype.createTypedArray(
           ComponentDatatype.FLOAT,
-          attributes[name].values
+          attributes[name].values,
         );
       }
     }
@@ -414,7 +414,7 @@ function interleaveAttributes(attributes) {
 
     for (j = 1; j < namesLength; ++j) {
       const currentNumberOfVertices = computeNumberOfVertices(
-        attributes[names[j]]
+        attributes[names[j]],
       );
 
       if (currentNumberOfVertices !== numberOfVertices) {
@@ -424,7 +424,7 @@ function interleaveAttributes(attributes) {
             "Attribute "
           }${names[j]} has a different number of vertices ` +
             `(${currentNumberOfVertices.toString()})` +
-            ` than attribute ${names[0]} (${numberOfVertices.toString()}).`
+            ` than attribute ${names[0]} (${numberOfVertices.toString()}).`,
         );
       }
     }
@@ -454,7 +454,7 @@ function interleaveAttributes(attributes) {
     // Pad each vertex to be a multiple of the largest component datatype so each
     // attribute can be addressed using typed arrays.
     const maxComponentSizeInBytes = ComponentDatatype.getSizeInBytes(
-      attributes[names[0]].componentDatatype
+      attributes[names[0]].componentDatatype,
     ); // Sorted large to small
     const remainder = vertexSizeInBytes % maxComponentSizeInBytes;
     if (remainder !== 0) {
@@ -471,13 +471,13 @@ function interleaveAttributes(attributes) {
     for (j = 0; j < namesLength; ++j) {
       name = names[j];
       const sizeInBytes = ComponentDatatype.getSizeInBytes(
-        attributes[name].componentDatatype
+        attributes[name].componentDatatype,
       );
 
       views[name] = {
         pointer: ComponentDatatype.createTypedArray(
           attributes[name].componentDatatype,
-          buffer
+          buffer,
         ),
         index: offsetsInBytes[name] / sizeInBytes, // Offset in ComponentType
         strideInComponentType: vertexSizeInBytes / sizeInBytes,
@@ -582,12 +582,12 @@ VertexArray.fromGeometry = function (options) {
 
   const bufferUsage = defaultValue(
     options.bufferUsage,
-    BufferUsage.DYNAMIC_DRAW
+    BufferUsage.DYNAMIC_DRAW,
   );
 
   const attributeLocations = defaultValue(
     options.attributeLocations,
-    defaultValue.EMPTY_OBJECT
+    defaultValue.EMPTY_OBJECT,
   );
   const interleave = defaultValue(options.interleave, false);
   const createdVAAttributes = options.vertexArrayAttributes;
@@ -654,7 +654,7 @@ VertexArray.fromGeometry = function (options) {
             context: context,
             typedArray: ComponentDatatype.createTypedArray(
               componentDatatype,
-              attribute.values
+              attribute.values,
             ),
             usage: bufferUsage,
           });