@cesium/engine 11.0.0 → 12.0.0

package/Source/Scene/Model/{buildDrawCommand.js → ModelDrawCommands.js}

@@ -1,18 +1,28 @@
 import BoundingSphere from "../../Core/BoundingSphere.js";
 import clone from "../../Core/clone.js";
 import defined from "../../Core/defined.js";
-import DeveloperError from "../../Core/DeveloperError.js";
 import Matrix4 from "../../Core/Matrix4.js";
 import DrawCommand from "../../Renderer/DrawCommand.js";
 import RenderState from "../../Renderer/RenderState.js";
-import VertexArray from "../../Renderer/VertexArray.js";
-import ModelFS from "../../Shaders/Model/ModelFS.js";
-import ModelVS from "../../Shaders/Model/ModelVS.js";
 import SceneMode from "../SceneMode.js";
 import ShadowMode from "../ShadowMode.js";
 import ClassificationModelDrawCommand from "./ClassificationModelDrawCommand.js";
-import ModelUtility from "./ModelUtility.js";
 import ModelDrawCommand from "./ModelDrawCommand.js";
+import VertexArray from "../../Renderer/VertexArray.js";
+import ModelVS from "../../Shaders/Model/ModelVS.js";
+import ModelFS from "../../Shaders/Model/ModelFS.js";
+import ModelUtility from "./ModelUtility.js";
+import DeveloperError from "../../Core/DeveloperError.js";
+
+/**
+ * Internal functions to build draw commands for models.
+ *
+ * (The core of these functions was taken from `buildDrawCommand.js´,
+ * as of commit hash 7b93161da1cc03bdc796b204e7aa51fb7acebf04)
+ *
+ * @private
+ */
+function ModelDrawCommands() {}
 
 /**
  * Builds the {@link ModelDrawCommand} for a {@link ModelRuntimePrimitive}
@@ -21,16 +31,77 @@ import ModelDrawCommand from "./ModelDrawCommand.js";
  *
  * @param {PrimitiveRenderResources} primitiveRenderResources The render resources for a primitive.
  * @param {FrameState} frameState The frame state for creating GPU resources.
- *
  * @returns {ModelDrawCommand|ClassificationModelDrawCommand} The generated ModelDrawCommand or ClassificationModelDrawCommand.
  *
  * @private
  */
-function buildDrawCommand(primitiveRenderResources, frameState) {
+ModelDrawCommands.buildModelDrawCommand = function (
+  primitiveRenderResources,
+  frameState,
+) {
   const shaderBuilder = primitiveRenderResources.shaderBuilder;
+  const shaderProgram = createShaderProgram(
+    primitiveRenderResources,
+    shaderBuilder,
+    frameState,
+  );
+
+  const command = buildDrawCommandForModel(
+    primitiveRenderResources,
+    shaderProgram,
+    frameState,
+  );
+
+  const model = primitiveRenderResources.model;
+  const hasClassification = defined(model.classificationType);
+  if (hasClassification) {
+    return new ClassificationModelDrawCommand({
+      primitiveRenderResources: primitiveRenderResources,
+      command: command,
+    });
+  }
+
+  return new ModelDrawCommand({
+    primitiveRenderResources: primitiveRenderResources,
+    command: command,
+  });
+};
+
+/**
+ * @private
+ */
+function createShaderProgram(
+  primitiveRenderResources,
+  shaderBuilder,
+  frameState,
+) {
   shaderBuilder.addVertexLines(ModelVS);
   shaderBuilder.addFragmentLines(ModelFS);
 
+  const model = primitiveRenderResources.model;
+  const shaderProgram = shaderBuilder.buildShaderProgram(frameState.context);
+  model._pipelineResources.push(shaderProgram);
+  return shaderProgram;
+}
+
+/**
+ * Builds the {@link DrawCommand} that serves as the basis for either creating
+ * a {@link ModelDrawCommand} or a {@link ModelRuntimePrimitive}
+ *
+ * @param {PrimitiveRenderResources} primitiveRenderResources The render resources for a primitive.
+ * @param {ShaderProgram} shaderProgram The shader program
+ * @param {FrameState} frameState The frame state for creating GPU resources.
+ *
+ * @returns {DrawCommand} The generated DrawCommand, to be passed to
+ * the ModelDrawCommand or ClassificationModelDrawCommand
+ *
+ * @private
+ */
+function buildDrawCommandForModel(
+  primitiveRenderResources,
+  shaderProgram,
+  frameState,
+) {
   const indexBuffer = getIndexBuffer(primitiveRenderResources);
 
   const vertexArray = new VertexArray({
@@ -42,9 +113,6 @@ function buildDrawCommand(primitiveRenderResources, frameState) {
   const model = primitiveRenderResources.model;
   model._pipelineResources.push(vertexArray);
 
-  const shaderProgram = shaderBuilder.buildShaderProgram(frameState.context);
-  model._pipelineResources.push(shaderProgram);
-
   const pass = primitiveRenderResources.alphaOptions.pass;
   const sceneGraph = model.sceneGraph;
 
@@ -55,7 +123,7 @@ function buildDrawCommand(primitiveRenderResources, frameState) {
     modelMatrix = Matrix4.multiplyTransformation(
       sceneGraph._computedModelMatrix,
       primitiveRenderResources.runtimeNode.computedTransform,
-      new Matrix4()
+      new Matrix4(),
     );
 
     const runtimePrimitive = primitiveRenderResources.runtimePrimitive;
@@ -68,25 +136,24 @@ function buildDrawCommand(primitiveRenderResources, frameState) {
     modelMatrix = Matrix4.multiplyTransformation(
       computedModelMatrix,
       primitiveRenderResources.runtimeNode.computedTransform,
-      new Matrix4()
+      new Matrix4(),
     );
 
     boundingSphere = BoundingSphere.transform(
       primitiveRenderResources.boundingSphere,
       modelMatrix,
-      primitiveRenderResources.boundingSphere
     );
   }
 
   // Initialize render state with default values
   let renderState = clone(
     RenderState.fromCache(primitiveRenderResources.renderStateOptions),
-    true
+    true,
   );
 
   renderState.cull.face = ModelUtility.getCullFace(
     modelMatrix,
-    primitiveRenderResources.primitiveType
+    primitiveRenderResources.primitiveType,
   );
   renderState = RenderState.fromCache(renderState);
 
@@ -115,24 +182,14 @@ function buildDrawCommand(primitiveRenderResources, frameState) {
     count: primitiveRenderResources.count,
     owner: model,
     pickId: pickId,
+    pickMetadataAllowed: true,
     instanceCount: primitiveRenderResources.instanceCount,
     primitiveType: primitiveRenderResources.primitiveType,
     debugShowBoundingVolume: model.debugShowBoundingVolume,
     castShadows: castShadows,
     receiveShadows: receiveShadows,
   });
-
-  if (hasClassification) {
-    return new ClassificationModelDrawCommand({
-      primitiveRenderResources: primitiveRenderResources,
-      command: command,
-    });
-  }
-
-  return new ModelDrawCommand({
-    primitiveRenderResources: primitiveRenderResources,
-    command: command,
-  });
+  return command;
 }
 
 /**
@@ -158,4 +215,4 @@ function getIndexBuffer(primitiveRenderResources) {
   return indices.buffer;
 }
 
-export default buildDrawCommand;
+export default ModelDrawCommands;

package/Source/Scene/Model/ModelFeatureTable.js

@@ -167,7 +167,7 @@ ModelFeatureTable.prototype.update = function (frameState) {
 
   const currentStyleCommandsNeeded = StyleCommandsNeeded.getStyleCommandsNeeded(
     this._featuresLength,
-    this._batchTexture.translucentFeaturesLength
+    this._batchTexture.translucentFeaturesLength,
   );
 
   if (this._styleCommandsNeeded !== currentStyleCommandsNeeded) {
@@ -214,7 +214,7 @@ ModelFeatureTable.prototype.hasProperty = function (featureId, propertyName) {
 
 ModelFeatureTable.prototype.hasPropertyBySemantic = function (
   featureId,
-  propertyName
+  propertyName,
 ) {
   return this._propertyTable.hasPropertyBySemantic(featureId, propertyName);
 };
@@ -225,7 +225,7 @@ ModelFeatureTable.prototype.getProperty = function (featureId, name) {
 
 ModelFeatureTable.prototype.getPropertyBySemantic = function (
   featureId,
-  semantic
+  semantic,
 ) {
   return this._propertyTable.getPropertyBySemantic(featureId, semantic);
 };
@@ -266,13 +266,13 @@ ModelFeatureTable.prototype.applyStyle = function (style) {
     const color = defined(style.color)
       ? defaultValue(
           style.color.evaluateColor(feature, scratchColor),
-          BatchTexture.DEFAULT_COLOR_VALUE
+          BatchTexture.DEFAULT_COLOR_VALUE,
         )
       : BatchTexture.DEFAULT_COLOR_VALUE;
     const show = defined(style.show)
       ? defaultValue(
           style.show.evaluate(feature),
-          BatchTexture.DEFAULT_SHOW_VALUE
+          BatchTexture.DEFAULT_SHOW_VALUE,
         )
       : BatchTexture.DEFAULT_SHOW_VALUE;
 

package/Source/Scene/Model/ModelMatrixUpdateStage.js

@@ -42,12 +42,29 @@ ModelMatrixUpdateStage.update = function (runtimeNode, sceneGraph, frameState) {
       runtimeNode,
       sceneGraph,
       modelMatrix,
-      runtimeNode.transformToRoot
+      runtimeNode.transformToRoot,
     );
     runtimeNode._transformDirty = false;
   }
 };
 
+/**
+ * Update the modelMatrix and cullFrace of the given draw command.
+ *
+ * @private
+ */
+function updateDrawCommand(drawCommand, modelMatrix, transformToRoot) {
+  drawCommand.modelMatrix = Matrix4.multiplyTransformation(
+    modelMatrix,
+    transformToRoot,
+    drawCommand.modelMatrix,
+  );
+  drawCommand.cullFace = ModelUtility.getCullFace(
+    drawCommand.modelMatrix,
+    drawCommand.primitiveType,
+  );
+}
+
 /**
  * Recursively update all child runtime nodes and their runtime primitives.
  *
@@ -57,7 +74,7 @@ function updateRuntimeNode(
   runtimeNode,
   sceneGraph,
   modelMatrix,
-  transformToRoot
+  transformToRoot,
 ) {
   let i;
 
@@ -65,7 +82,7 @@ function updateRuntimeNode(
   transformToRoot = Matrix4.multiplyTransformation(
     transformToRoot,
     runtimeNode.transform,
-    new Matrix4()
+    new Matrix4(),
   );
 
   runtimeNode.updateComputedTransform();
@@ -73,15 +90,10 @@ function updateRuntimeNode(
   const primitivesLength = runtimeNode.runtimePrimitives.length;
   for (i = 0; i < primitivesLength; i++) {
     const runtimePrimitive = runtimeNode.runtimePrimitives[i];
-    const drawCommand = runtimePrimitive.drawCommand;
-    drawCommand.modelMatrix = Matrix4.multiplyTransformation(
+    updateDrawCommand(
+      runtimePrimitive.drawCommand,
       modelMatrix,
       transformToRoot,
-      drawCommand.modelMatrix
-    );
-    drawCommand.cullFace = ModelUtility.getCullFace(
-      drawCommand.modelMatrix,
-      drawCommand.primitiveType
     );
   }
 
@@ -92,14 +104,14 @@ function updateRuntimeNode(
     // Update transformToRoot to accommodate changes in the transforms of this node and its ancestors
     childRuntimeNode._transformToRoot = Matrix4.clone(
       transformToRoot,
-      childRuntimeNode._transformToRoot
+      childRuntimeNode._transformToRoot,
     );
 
     updateRuntimeNode(
       childRuntimeNode,
       sceneGraph,
       modelMatrix,
-      transformToRoot
+      transformToRoot,
     );
     childRuntimeNode._transformDirty = false;
   }

package/Source/Scene/Model/ModelRenderResources.js

@@ -76,7 +76,7 @@ function ModelRenderResources(model) {
         enabled: true,
         func: DepthFunction.LESS_OR_EQUAL,
       },
-    })
+    }),
   );
 
   /**

package/Source/Scene/Model/ModelRuntimeNode.js

@@ -328,7 +328,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
       //>>includeStart('debug', pragmas.debug);
       if (!defined(transformParameters)) {
         throw new DeveloperError(
-          "The translation of a node cannot be set if it was defined using a matrix in the model."
+          "The translation of a node cannot be set if it was defined using a matrix in the model.",
         );
       }
       //>>includeEnd('debug');
@@ -340,7 +340,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
 
       transformParameters.translation = Cartesian3.clone(
         value,
-        transformParameters.translation
+        transformParameters.translation,
       );
 
       updateTransformFromParameters(this, transformParameters);
@@ -372,7 +372,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
       //>>includeStart('debug', pragmas.debug);
       if (!defined(transformParameters)) {
         throw new DeveloperError(
-          "The rotation of a node cannot be set if it was defined using a matrix in the model."
+          "The rotation of a node cannot be set if it was defined using a matrix in the model.",
         );
       }
       //>>includeEnd('debug');
@@ -384,7 +384,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
 
       transformParameters.rotation = Quaternion.clone(
         value,
-        transformParameters.rotation
+        transformParameters.rotation,
       );
 
       updateTransformFromParameters(this, transformParameters);
@@ -415,7 +415,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
       //>>includeStart('debug', pragmas.debug);
       if (!defined(transformParameters)) {
         throw new DeveloperError(
-          "The scale of a node cannot be set if it was defined using a matrix in the model."
+          "The scale of a node cannot be set if it was defined using a matrix in the model.",
         );
       }
       //>>includeEnd('debug');
@@ -426,7 +426,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
 
       transformParameters.scale = Cartesian3.clone(
         value,
-        transformParameters.scale
+        transformParameters.scale,
       );
 
       updateTransformFromParameters(this, transformParameters);
@@ -451,7 +451,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, {
       //>>includeStart('debug', pragmas.debug);
       if (this._morphWeights.length !== valueLength) {
         throw new DeveloperError(
-          "value must have the same length as the original weights array."
+          "value must have the same length as the original weights array.",
         );
       }
       //>>includeEnd('debug');
@@ -499,7 +499,7 @@ function initialize(runtimeNode) {
   runtimeNode._computedTransform = Matrix4.multiply(
     transformToRoot,
     transform,
-    computedTransform
+    computedTransform,
   );
 
   const node = runtimeNode.node;
@@ -507,7 +507,7 @@ function initialize(runtimeNode) {
     runtimeNode._transformParameters = new TranslationRotationScale(
       node.translation,
       node.rotation,
-      node.scale
+      node.scale,
     );
   }
 
@@ -534,7 +534,7 @@ function updateTransformFromParameters(runtimeNode, transformParameters) {
 
   runtimeNode._transform = Matrix4.fromTranslationRotationScale(
     transformParameters,
-    runtimeNode._transform
+    runtimeNode._transform,
   );
 }
 
@@ -559,7 +559,7 @@ ModelRuntimeNode.prototype.getChild = function (index) {
   Check.typeOf.number("index", index);
   if (index < 0 || index >= this.children.length) {
     throw new DeveloperError(
-      "index must be greater than or equal to 0 and less than the number of children."
+      "index must be greater than or equal to 0 and less than the number of children.",
     );
   }
   //>>includeEnd('debug');
@@ -599,7 +599,7 @@ ModelRuntimeNode.prototype.updateComputedTransform = function () {
   this._computedTransform = Matrix4.multiply(
     this._transformToRoot,
     this._transform,
-    this._computedTransform
+    this._computedTransform,
   );
 };
 
@@ -629,18 +629,18 @@ ModelRuntimeNode.prototype.updateJointMatrices = function () {
     const nodeWorldTransform = Matrix4.multiplyTransformation(
       this.transformToRoot,
       this.transform,
-      computedJointMatrices[i]
+      computedJointMatrices[i],
     );
 
     const inverseNodeWorldTransform = Matrix4.inverseTransformation(
       nodeWorldTransform,
-      computedJointMatrices[i]
+      computedJointMatrices[i],
     );
 
     computedJointMatrices[i] = Matrix4.multiplyTransformation(
       inverseNodeWorldTransform,
       skinJointMatrices[i],
-      computedJointMatrices[i]
+      computedJointMatrices[i],
     );
   }
 };

package/Source/Scene/Model/ModelRuntimePrimitive.js

@@ -14,6 +14,7 @@ import FeatureIdPipelineStage from "./FeatureIdPipelineStage.js";
 import GeometryPipelineStage from "./GeometryPipelineStage.js";
 import LightingPipelineStage from "./LightingPipelineStage.js";
 import MaterialPipelineStage from "./MaterialPipelineStage.js";
+import MetadataPickingPipelineStage from "./MetadataPickingPipelineStage.js";
 import MetadataPipelineStage from "./MetadataPipelineStage.js";
 import ModelUtility from "./ModelUtility.js";
 import MorphTargetsPipelineStage from "./MorphTargetsPipelineStage.js";
@@ -199,7 +200,8 @@ ModelRuntimePrimitive.prototype.configurePipeline = function (frameState) {
   const mode = frameState.mode;
   const use2D =
     mode !== SceneMode.SCENE3D && !frameState.scene3DOnly && model._projectTo2D;
-  const exaggerateTerrain = frameState.verticalExaggeration !== 1.0;
+  const hasVerticalExaggeration =
+    frameState.verticalExaggeration !== 1.0 && model.hasVerticalExaggeration;
 
   const hasMorphTargets =
     defined(primitive.morphTargets) && primitive.morphTargets.length > 0;
@@ -211,7 +213,7 @@ ModelRuntimePrimitive.prototype.configurePipeline = function (frameState) {
     !hasCustomFragmentShader ||
     customShader.mode !== CustomShaderMode.REPLACE_MATERIAL;
   const hasQuantization = ModelUtility.hasQuantizedAttributes(
-    primitive.attributes
+    primitive.attributes,
   );
   const generateWireframeIndices =
     model.debugWireframe &&
@@ -276,6 +278,7 @@ ModelRuntimePrimitive.prototype.configurePipeline = function (frameState) {
   // are declared to avoid compilation errors.
   pipelineStages.push(FeatureIdPipelineStage);
   pipelineStages.push(MetadataPipelineStage);
+  pipelineStages.push(MetadataPickingPipelineStage);
 
   if (featureIdFlags.hasPropertyTable) {
     pipelineStages.push(SelectedFeatureIdPipelineStage);
@@ -283,7 +286,7 @@ ModelRuntimePrimitive.prototype.configurePipeline = function (frameState) {
     pipelineStages.push(CPUStylingPipelineStage);
   }
 
-  if (exaggerateTerrain) {
+  if (hasVerticalExaggeration) {
     pipelineStages.push(VerticalExaggerationPipelineStage);
   }
 
@@ -315,7 +318,7 @@ function inspectFeatureIds(model, node, primitive) {
   if (defined(node.instances)) {
     featureIds = ModelUtility.getFeatureIdsByLabel(
       node.instances.featureIds,
-      model.instanceFeatureIdLabel
+      model.instanceFeatureIdLabel,
     );
 
     if (defined(featureIds)) {
@@ -328,7 +331,7 @@ function inspectFeatureIds(model, node, primitive) {
 
   featureIds = ModelUtility.getFeatureIdsByLabel(
     primitive.featureIds,
-    model.featureIdLabel
+    model.featureIdLabel,
   );
   if (defined(featureIds)) {
     return {