@cesium/engine 11.0.0 → 12.0.0

package/Source/Scene/Model/MetadataPickingPipelineStage.js

@@ -0,0 +1,96 @@
+import ShaderDestination from "../../Renderer/ShaderDestination.js";
+
+/**
+ * The MetadataPickingPipelineStage is inserting the
+ * metadataPickingStage function into the shader code,
+ * including the 'defines' that will be filled with
+ * the proper values for metadata picking in the
+ * 'DerivedCommands'
+ *
+ * @namespace MetadataPickingPipelineStage
+ * @private
+ */
+const MetadataPickingPipelineStage = {
+  name: "MetadataPickingPipelineStage", // Helps with debugging
+
+  // The identifiers for 'define' directives that are inserted into the
+  // shader code. The values of these defines will be be assigned
+  // in the `DerivedCommands` class when a derived command for metadata
+  // picking is created.
+  METADATA_PICKING_ENABLED: "METADATA_PICKING_ENABLED",
+  METADATA_PICKING_VALUE_TYPE: "METADATA_PICKING_VALUE_TYPE",
+  METADATA_PICKING_VALUE_STRING: "METADATA_PICKING_VALUE_STRING",
+  METADATA_PICKING_VALUE_COMPONENT_X: "METADATA_PICKING_VALUE_COMPONENT_X",
+  METADATA_PICKING_VALUE_COMPONENT_Y: "METADATA_PICKING_VALUE_COMPONENT_Y",
+  METADATA_PICKING_VALUE_COMPONENT_Z: "METADATA_PICKING_VALUE_COMPONENT_Z",
+  METADATA_PICKING_VALUE_COMPONENT_W: "METADATA_PICKING_VALUE_COMPONENT_W",
+};
+
+/**
+ * Process a primitive. This modifies the following parts of the render resources:
+ * <ul>
+ *  <li>adds the required defines and "metadataPickingStage" to function in the shader</li>
+ * </ul>
+ *
+ * @param {PrimitiveRenderResources} renderResources The render resources for this primitive.
+ * @param {ModelComponents.Primitive} primitive The primitive.
+ * @param {FrameState} frameState The frame state.
+ */
+MetadataPickingPipelineStage.process = function (
+  renderResources,
+  primitive,
+  frameState,
+) {
+  const shaderBuilder = renderResources.shaderBuilder;
+
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_TYPE,
+    "float",
+    ShaderDestination.FRAGMENT,
+  );
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_STRING,
+    "0.0",
+    ShaderDestination.FRAGMENT,
+  );
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_X,
+    "0.0",
+    ShaderDestination.FRAGMENT,
+  );
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_Y,
+    "0.0",
+    ShaderDestination.FRAGMENT,
+  );
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_Z,
+    "0.0",
+    ShaderDestination.FRAGMENT,
+  );
+  shaderBuilder.addDefine(
+    MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_W,
+    "0.0",
+    ShaderDestination.FRAGMENT,
+  );
+
+  shaderBuilder.addFunction(
+    "metadataPickingStage",
+    "void metadataPickingStage(Metadata metadata, MetadataClass metadataClass, inout vec4 metadataValues)",
+    ShaderDestination.FRAGMENT,
+  );
+
+  shaderBuilder.addFunctionLines(
+    "metadataPickingStage",
+    [
+      `${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_TYPE} value = ${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_TYPE}(${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_STRING});`,
+      `metadataValues.x = ${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_X};`,
+      `metadataValues.y = ${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_Y};`,
+      `metadataValues.z = ${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_Z};`,
+      `metadataValues.w = ${MetadataPickingPipelineStage.METADATA_PICKING_VALUE_COMPONENT_W};`,
+    ],
+    ShaderDestination.FRAGMENT,
+  );
+};
+
+export default MetadataPickingPipelineStage;

package/Source/Scene/Model/MetadataPipelineStage.js

@@ -80,7 +80,7 @@ const MetadataPipelineStage = {
 MetadataPipelineStage.process = function (
   renderResources,
   primitive,
-  frameState
+  frameState,
 ) {
   const { shaderBuilder, model } = renderResources;
   const { structuralMetadata = {}, content } = model;
@@ -89,11 +89,11 @@ MetadataPipelineStage.process = function (
   const propertyAttributesInfo = getPropertyAttributesInfo(
     structuralMetadata.propertyAttributes,
     primitive,
-    statistics
+    statistics,
   );
   const propertyTexturesInfo = getPropertyTexturesInfo(
     structuralMetadata.propertyTextures,
-    statistics
+    statistics,
   );
 
   // Declare <type>MetadataClass and <type>MetadataStatistics structs as needed
@@ -130,7 +130,7 @@ function getPropertyAttributesInfo(propertyAttributes, primitive, statistics) {
     return [];
   }
   return propertyAttributes.flatMap((propertyAttribute) =>
-    getPropertyAttributeInfo(propertyAttribute, primitive, statistics)
+    getPropertyAttributeInfo(propertyAttribute, primitive, statistics),
   );
 }
 
@@ -143,11 +143,8 @@ function getPropertyAttributesInfo(propertyAttributes, primitive, statistics) {
  * @private
  */
 function getPropertyAttributeInfo(propertyAttribute, primitive, statistics) {
-  const {
-    getAttributeByName,
-    getAttributeInfo,
-    sanitizeGlslIdentifier,
-  } = ModelUtility;
+  const { getAttributeByName, getAttributeInfo, sanitizeGlslIdentifier } =
+    ModelUtility;
 
   const classId = propertyAttribute.class.id;
   const classStatistics = statistics?.classes[classId];
@@ -187,7 +184,7 @@ function getPropertyTexturesInfo(propertyTextures, statistics) {
     return [];
   }
   return propertyTextures.flatMap((propertyTexture) =>
-    getPropertyTextureInfo(propertyTexture, statistics)
+    getPropertyTextureInfo(propertyTexture, statistics),
   );
 }
 
@@ -204,9 +201,9 @@ function getPropertyTextureInfo(propertyTexture, statistics) {
   const classId = propertyTexture.class.id;
   const classStatistics = statistics?.classes[classId];
 
-  const propertiesArray = Object.entries(
-    propertyTexture.properties
-  ).filter(([id, property]) => property.isGpuCompatible());
+  const propertiesArray = Object.entries(propertyTexture.properties).filter(
+    ([id, property]) => property.isGpuCompatible(),
+  );
   const infoArray = new Array(propertiesArray.length);
 
   for (let i = 0; i < propertiesArray.length; i++) {
@@ -299,36 +296,36 @@ function declareStructsAndFunctions(shaderBuilder) {
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_VS,
     MetadataPipelineStage.STRUCT_NAME_METADATA,
-    ShaderDestination.VERTEX
+    ShaderDestination.VERTEX,
   );
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_FS,
     MetadataPipelineStage.STRUCT_NAME_METADATA,
-    ShaderDestination.FRAGMENT
+    ShaderDestination.FRAGMENT,
   );
 
   // Declare the MetadataClass struct
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_CLASS_VS,
     MetadataPipelineStage.STRUCT_NAME_METADATA_CLASS,
-    ShaderDestination.VERTEX
+    ShaderDestination.VERTEX,
   );
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_CLASS_FS,
     MetadataPipelineStage.STRUCT_NAME_METADATA_CLASS,
-    ShaderDestination.FRAGMENT
+    ShaderDestination.FRAGMENT,
   );
 
   // Declare the MetadataStatistics struct
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_STATISTICS_VS,
     MetadataPipelineStage.STRUCT_NAME_METADATA_STATISTICS,
-    ShaderDestination.VERTEX
+    ShaderDestination.VERTEX,
   );
   shaderBuilder.addStruct(
     MetadataPipelineStage.STRUCT_ID_METADATA_STATISTICS_FS,
     MetadataPipelineStage.STRUCT_NAME_METADATA_STATISTICS,
-    ShaderDestination.FRAGMENT
+    ShaderDestination.FRAGMENT,
   );
 
   // declare the initializeMetadata() function. The details may differ
@@ -336,19 +333,19 @@ function declareStructsAndFunctions(shaderBuilder) {
   shaderBuilder.addFunction(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_VS,
     MetadataPipelineStage.FUNCTION_SIGNATURE_INITIALIZE_METADATA,
-    ShaderDestination.VERTEX
+    ShaderDestination.VERTEX,
   );
   shaderBuilder.addFunction(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_FS,
     MetadataPipelineStage.FUNCTION_SIGNATURE_INITIALIZE_METADATA,
-    ShaderDestination.FRAGMENT
+    ShaderDestination.FRAGMENT,
   );
 
   // declare the setMetadataVaryings() function in the vertex shader only.
   shaderBuilder.addFunction(
     MetadataPipelineStage.FUNCTION_ID_SET_METADATA_VARYINGS,
     MetadataPipelineStage.FUNCTION_SIGNATURE_SET_METADATA_VARYINGS,
-    ShaderDestination.VERTEX
+    ShaderDestination.VERTEX,
   );
 }
 
@@ -388,23 +385,23 @@ function addPropertyAttributePropertyMetadata(renderResources, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_VS,
     glslType,
-    metadataVariable
+    metadataVariable,
   );
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_FS,
     glslType,
-    metadataVariable
+    metadataVariable,
   );
 
   // assign the result to the metadata struct property.
   const initializationLine = `metadata.${metadataVariable} = ${valueExpression};`;
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_VS,
-    [initializationLine]
+    [initializationLine],
   );
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_FS,
-    [initializationLine]
+    [initializationLine],
   );
 }
 
@@ -431,13 +428,8 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
   const { shaderBuilder, uniformMap } = renderResources;
   const { metadataVariable, glslType, property } = propertyInfo;
 
-  const {
-    texCoord,
-    channels,
-    index,
-    texture,
-    transform,
-  } = property.textureReader;
+  const { texCoord, channels, index, texture, transform } =
+    property.textureReader;
   const textureUniformName = `u_propertyTexture_${index}`;
 
   // Property texture properties may share the same physical texture, so only
@@ -446,7 +438,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
     shaderBuilder.addUniform(
       "sampler2D",
       textureUniformName,
-      ShaderDestination.FRAGMENT
+      ShaderDestination.FRAGMENT,
     );
     uniformMap[textureUniformName] = () => texture;
   }
@@ -454,7 +446,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_FS,
     glslType,
-    metadataVariable
+    metadataVariable,
   );
 
   // Get a GLSL expression for the texture coordinates of the property.
@@ -469,7 +461,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
     shaderBuilder.addUniform(
       "mat3",
       transformUniformName,
-      ShaderDestination.FRAGMENT
+      ShaderDestination.FRAGMENT,
     );
     uniformMap[transformUniformName] = function () {
       return transform;
@@ -499,7 +491,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
   const initializationLine = `metadata.${metadataVariable} = ${transformedValue};`;
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_FS,
-    [initializationLine]
+    [initializationLine],
   );
 }
 
@@ -520,7 +512,7 @@ function addPropertyMetadataClass(shaderBuilder, propertyInfo) {
     MetadataPipelineStage.METADATA_CLASS_FIELDS,
     classProperty,
     `metadataClass.${metadataVariable}`,
-    glslType
+    glslType,
   );
 
   // Struct field: Prefix to get the appropriate <type>MetadataClass struct
@@ -528,11 +520,11 @@ function addPropertyMetadataClass(shaderBuilder, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_CLASS_FS,
     metadataType,
-    metadataVariable
+    metadataVariable,
   );
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_FS,
-    assignments
+    assignments,
   );
   if (!ShaderDestination.includesVertexShader(shaderDestination)) {
     return;
@@ -540,11 +532,11 @@ function addPropertyMetadataClass(shaderBuilder, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_CLASS_VS,
     metadataType,
-    metadataVariable
+    metadataVariable,
   );
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_VS,
-    assignments
+    assignments,
   );
 }
 
@@ -574,7 +566,7 @@ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) {
     fields,
     propertyStatistics,
     struct,
-    glslType
+    glslType,
   );
 
   // Struct field: Prefix to get the appropriate <type>MetadataStatistics struct
@@ -582,11 +574,11 @@ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_STATISTICS_FS,
     statisticsType,
-    metadataVariable
+    metadataVariable,
   );
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_FS,
-    assignments
+    assignments,
   );
   if (!ShaderDestination.includesVertexShader(propertyInfo.shaderDestination)) {
     return;
@@ -594,11 +586,11 @@ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) {
   shaderBuilder.addStructField(
     MetadataPipelineStage.STRUCT_ID_METADATA_STATISTICS_VS,
     statisticsType,
-    metadataVariable
+    metadataVariable,
   );
   shaderBuilder.addFunctionLines(
     MetadataPipelineStage.FUNCTION_ID_INITIALIZE_METADATA_VS,
-    assignments
+    assignments,
   );
 }