Handle multiple feature ID sets in ModelExperimental

Apps/Sandcastle/gallery/3D Tiles Next Photogrammetry Classification.html

@@ -107,8 +107,7 @@
             "const float TOTAL_FEATURES = 12.0;",
             "",
             "void fragmentMain(FragmentInput fsInput, inout czm_modelMaterial material) {",
-            "  // NOTE: This is exposing internal details of the shader. It would be better if this was added to fsInput somewhere...",
-            "  float featureId = floor(texture2D(FEATURE_ID_TEXTURE, FEATURE_ID_TEXCOORD).FEATURE_ID_CHANNEL * 255.0 + 0.5);",
+            "  float featureId = fsInput.featureIds.featureId_0;",
             "",
             "  if (featureId == WINDOW || featureId == SKYLIGHT) {",
             "    material.alpha = 0.4;",
@@ -136,8 +135,7 @@
             "const float TRAFFIC_LIGHT = 11.0;",
             "",
             "void fragmentMain(FragmentInput fsInput, inout czm_modelMaterial material) {",
-            "  // NOTE: This is exposing internal details of the shader. It would be better if this was added to fsInput somewhere...",
-            "  float featureId = floor(texture2D(FEATURE_ID_TEXTURE, FEATURE_ID_TEXCOORD).FEATURE_ID_CHANNEL * 255.0 + 0.5);",
+            "  float featureId = fsInput.featureIds.featureId_0;",
             "",
             "  if (featureId == CLOCK) {",
             "    // Shiny brass",
@@ -183,8 +181,7 @@
           fragmentShaderText: [
             "const float NOTHING_SELECTED = 12.0;",
             "void fragmentMain(FragmentInput fsInput, inout czm_modelMaterial material) {",
-            "  // NOTE: This is exposing internal details of the shader. It would be better if this was added to fsInput somewhere...",
-            "  float featureId = floor(texture2D(FEATURE_ID_TEXTURE, FEATURE_ID_TEXCOORD).FEATURE_ID_CHANNEL * 255.0 + 0.5);",
+            "  float featureId = fsInput.featureIds.featureId_0;",
             "",
             "  if (u_selectedFeature < NOTHING_SELECTED && featureId == u_selectedFeature) {",
             "    material.specular = vec3(1.00, 0.85, 0.57);",

Apps/Sandcastle/gallery/3D Tiles Next S2 Globe.html

@@ -105,8 +105,7 @@
           fragmentShaderText: [
             "void fragmentMain(FragmentInput fsInput, inout czm_modelMaterial material)",
             "{",
-            "  // NOTE: this is exposing internal details of the shader.",
-            "  float featureId = floor(texture2D(FEATURE_ID_TEXTURE, FEATURE_ID_TEXCOORD).FEATURE_ID_CHANNEL * 255.0 + 0.5);",
+            "  float featureId = fsInput.featureIds.featureId_0;",
             "  // Use cartesian coordinates but scale to be roughly [-1, 1]",
             "  vec3 positionWC = fsInput.attributes.positionWC / 6.3e6;",
             "  if (featureId == 60.0)",

CHANGES.md

@@ -4,6 +4,8 @@
 
 ##### Additions :tada:
 
+- Feature IDs for styling and picking in `ModelExperimental` can now be selected via `(tileset|model).featureIdIndex` and `(tileset|model).instanceFeatureIdIndex`. [#10018](https://github.com/CesiumGS/cesium/pull/10018)
+- Added support for all types of feature IDs in `CustomShader`. [#10018](https://github.com/CesiumGS/cesium/pull/10018)
 - Added getters `Cesium3DTileFeature.featureId` and `ModelFeature.featureId` so the feature ID or batch ID can be accessed from a picked feature. [#10022](https://github.com/CesiumGS/cesium/pull/10022)
 - Added `I3dmLoader` to transcode .i3dm to `ModelExperimental`. [#9968](https://github.com/CesiumGS/cesium/pull/9968)
 - Added `PntsLoader` to transcode .pnts to `ModelExperimental`. [#9978](https://github.com/CesiumGS/cesium/pull/9978)

Source/Scene/Cesium3DTileset.js

@@ -963,6 +963,28 @@ function Cesium3DTileset(options) {
     ExperimentalFeatures.enableModelExperimental
   );
 
+  /**
+   * The index into the list of primitive feature IDs used for picking and
+   * styling. For EXT_feature_metadata, feature ID attributes are listed before
+   * feature ID textures. If both per-primitive and per-instance feature IDs are
+   * present, the instance feature IDs take priority.
+   *
+   * @type {Number}
+   * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
+   */
+  this.featureIdIndex = defaultValue(options.featureIdIndex, 0);
+
+  /**
+   * The index into the list of instance feature IDs used for picking and
+   * styling. If both per-primitive and per-instance feature IDs are present,
+   * the instance feature IDs take priority.
+   *
+   * @type {Number}
+   * @readonly
+   * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
+   */
+  this.instanceFeatureIdIndex = defaultValue(options.instanceFeatureIdIndex, 0);
+
   this._schemaLoader = undefined;
 
   var that = this;

Source/Scene/GltfLoader.js

@@ -28,6 +28,7 @@ var Attribute = ModelComponents.Attribute;
 var Indices = ModelComponents.Indices;
 var FeatureIdAttribute = ModelComponents.FeatureIdAttribute;
 var FeatureIdTexture = ModelComponents.FeatureIdTexture;
+var FeatureIdImplicitRange = ModelComponents.FeatureIdImplicitRange;
 var MorphTarget = ModelComponents.MorphTarget;
 var Primitive = ModelComponents.Primitive;
 var Instances = ModelComponents.Instances;
@@ -814,8 +815,6 @@ function loadFeatureIdAttribute(featureIds, propertyTableId) {
   var featureIdAttribute = new FeatureIdAttribute();
   featureIdAttribute.propertyTableId = propertyTableId;
   featureIdAttribute.setIndex = featureIds.attribute;
-  featureIdAttribute.offset = defaultValue(featureIds.offset, 0);
-  featureIdAttribute.repeat = featureIds.repeat;
   return featureIdAttribute;
 }
 
@@ -825,6 +824,26 @@ function loadFeatureIdAttributeLegacy(gltfFeatureIdAttribute, featureTableId) {
   var featureIds = gltfFeatureIdAttribute.featureIds;
   featureIdAttribute.propertyTableId = featureTableId;
   featureIdAttribute.setIndex = getSetIndex(featureIds.attribute);
+  return featureIdAttribute;
+}
+
+// for EXT_mesh_features
+function loadFeatureIdImplicitRange(featureIds, propertyTableId) {
+  var featureIdAttribute = new FeatureIdImplicitRange();
+  featureIdAttribute.propertyTableId = propertyTableId;
+  featureIdAttribute.offset = defaultValue(featureIds.offset, 0);
+  featureIdAttribute.repeat = featureIds.repeat;
+  return featureIdAttribute;
+}
+
+// for backwards compatibility with EXT_feature_metadata
+function loadFeatureIdImplicitRangeLegacy(
+  gltfFeatureIdAttribute,
+  featureTableId
+) {
+  var featureIdAttribute = new FeatureIdImplicitRange();
+  var featureIds = gltfFeatureIdAttribute.featureIds;
+  featureIdAttribute.propertyTableId = featureTableId;
   // constant/divisor was renamed to offset/repeat
   featureIdAttribute.offset = defaultValue(featureIds.constant, 0);
   // The default is now undefined
@@ -833,6 +852,7 @@ function loadFeatureIdAttributeLegacy(gltfFeatureIdAttribute, featureTableId) {
   return featureIdAttribute;
 }
 
+// for EXT_mesh_features
 function loadFeatureIdTexture(
   loader,
   gltf,
@@ -864,6 +884,7 @@ function loadFeatureIdTexture(
   return featureIdTexture;
 }
 
+// for backwards compatibility with EXT_feature_metadata
 function loadFeatureIdTextureLegacy(
   loader,
   gltf,
@@ -991,49 +1012,43 @@ function loadPrimitiveMetadata(
   metadataExtension,
   supportedImageFormats
 ) {
-  // Partition feature ID attributes and textures
-  var i;
-  var featureIdAttributes = [];
-  var featureIdTextures = [];
-  var featureIdsArray = metadataExtension.featureIds;
-  var propertyTablesArray = metadataExtension.propertyTables;
-
-  if (defined(featureIdsArray)) {
-    for (i = 0; i < featureIdsArray.length; i++) {
-      var featureIds = featureIdsArray[i];
-      if (defined(featureIds.channel)) {
-        featureIdTextures.push(featureIds);
-      } else {
-        featureIdAttributes.push(featureIds);
-      }
-    }
-  }
+  var featureIdsArray = defined(metadataExtension.featureIds)
+    ? metadataExtension.featureIds
+    : [];
+  var propertyTables = defined(metadataExtension.propertyTables)
+    ? metadataExtension.propertyTables
+    : [];
 
-  // Feature ID Attributes
-  var featureIdAttributesLength = featureIdAttributes.length;
-  for (i = 0; i < featureIdAttributesLength; ++i) {
-    primitive.featureIdAttributes.push(
-      loadFeatureIdAttribute(featureIdAttributes[i], propertyTablesArray[i])
-    );
-  }
+  for (var i = 0; i < featureIdsArray.length; i++) {
+    var featureIds = featureIdsArray[i];
+    // This may be undefined, as feature IDs are not required to have
+    // associated metadata.
+    var propertyTableId = propertyTables[i];
 
-  // Feature ID Textures
-  var featureIdTexturesLength = featureIdTextures.length;
-  for (i = 0; i < featureIdTexturesLength; ++i) {
-    primitive.featureIdTextures.push(
-      loadFeatureIdTexture(
+    var featureIdComponent;
+    if (defined(featureIds.channel)) {
+      featureIdComponent = loadFeatureIdTexture(
         loader,
         gltf,
-        featureIdTextures[i],
-        propertyTablesArray[i],
+        featureIds,
+        propertyTableId,
         supportedImageFormats
-      )
-    );
+      );
+    } else if (defined(featureIds.attribute)) {
+      featureIdComponent = loadFeatureIdAttribute(featureIds, propertyTableId);
+    } else {
+      featureIdComponent = loadFeatureIdImplicitRange(
+        featureIds,
+        propertyTableId
+      );
+    }
+
+    primitive.featureIds.push(featureIdComponent);
   }
 
-  // Feature Textures
+  // Property Textures
   if (defined(metadataExtension.propertyTextures)) {
-    primitive.featureTextureIds = metadataExtension.propertyTextures;
+    primitive.propertyTextureIds = metadataExtension.propertyTextures;
   }
 }
 
@@ -1045,21 +1060,31 @@ function loadPrimitiveMetadataLegacy(
   supportedImageFormats
 ) {
   var i;
+  var featureIdComponent;
+  var featureTableId;
+  var propertyTableId;
 
   // Feature ID Attributes
   var featureIdAttributes = metadataExtension.featureIdAttributes;
   if (defined(featureIdAttributes)) {
     var featureIdAttributesLength = featureIdAttributes.length;
     for (i = 0; i < featureIdAttributesLength; ++i) {
       var featureIdAttribute = featureIdAttributes[i];
-      primitive.featureIdAttributes.push(
-        loadFeatureIdAttributeLegacy(
+      featureTableId = featureIdAttribute.featureTable;
+      propertyTableId = loader._sortedPropertyTableIds.indexOf(featureTableId);
+
+      if (defined(featureIdAttribute.featureIds.attribute)) {
+        featureIdComponent = loadFeatureIdAttributeLegacy(
           featureIdAttribute,
-          loader._sortedPropertyTableIds.indexOf(
-            featureIdAttribute.featureTable
-          )
-        )
-      );
+          propertyTableId
+        );
+      } else {
+        featureIdComponent = loadFeatureIdImplicitRangeLegacy(
+          featureIdAttribute,
+          propertyTableId
+        );
+      }
+      primitive.featureIds.push(featureIdComponent);
     }
   }
 
@@ -1069,15 +1094,17 @@ function loadPrimitiveMetadataLegacy(
     var featureIdTexturesLength = featureIdTextures.length;
     for (i = 0; i < featureIdTexturesLength; ++i) {
       var featureIdTexture = featureIdTextures[i];
-      primitive.featureIdTextures.push(
-        loadFeatureIdTextureLegacy(
-          loader,
-          gltf,
-          featureIdTexture,
-          loader._sortedPropertyTableIds.indexOf(featureIdTexture.featureTable),
-          supportedImageFormats
-        )
+      featureTableId = featureIdTexture.featureTable;
+      propertyTableId = loader._sortedPropertyTableIds.indexOf(featureTableId);
+      featureIdComponent = loadFeatureIdTextureLegacy(
+        loader,
+        gltf,
+        featureIdTexture,
+        propertyTableId,
+        supportedImageFormats
       );
+      // Feature ID textures are added after feature ID attributes in the list
+      primitive.featureIds.push(featureIdComponent);
     }
   }
 
@@ -1086,7 +1113,7 @@ function loadPrimitiveMetadataLegacy(
     // feature textures are now identified by an integer index. To convert the
     // string IDs to integers, find their place in the sorted list of feature
     // table names
-    primitive.featureTextureIds = metadataExtension.featureTextures.map(
+    primitive.propertyTextureIds = metadataExtension.featureTextures.map(
       function (id) {
         return loader._sortedFeatureTextureIds.indexOf(id);
       }
@@ -1161,18 +1188,25 @@ function loadInstances(loader, gltf, nodeExtensions, frameState) {
 // For EXT_mesh_features
 function loadInstanceMetadata(instances, metadataExtension) {
   // feature IDs are required in EXT_mesh_features
-  var featureIdAttributes = metadataExtension.featureIds;
+  var featureIdsArray = metadataExtension.featureIds;
   var propertyTables = defined(metadataExtension.propertyTables)
     ? metadataExtension.propertyTables
     : [];
 
-  var featureIdAttributesLength = featureIdAttributes.length;
-  for (var i = 0; i < featureIdAttributesLength; i++) {
-    var featureIds = featureIdAttributes[i];
+  for (var i = 0; i < featureIdsArray.length; i++) {
+    var featureIds = featureIdsArray[i];
     var propertyTableId = propertyTables[i];
-    instances.featureIdAttributes.push(
-      loadFeatureIdAttribute(featureIds, propertyTableId)
-    );
+
+    var featureIdComponent;
+    if (defined(featureIds.attribute)) {
+      featureIdComponent = loadFeatureIdAttribute(featureIds, propertyTableId);
+    } else {
+      featureIdComponent = loadFeatureIdImplicitRange(
+        featureIds,
+        propertyTableId
+      );
+    }
+    instances.featureIds.push(featureIdComponent);
   }
 }
 
@@ -1187,12 +1221,22 @@ function loadInstanceMetadataLegacy(
     var featureIdAttributesLength = featureIdAttributes.length;
     for (var i = 0; i < featureIdAttributesLength; ++i) {
       var featureIdAttribute = featureIdAttributes[i];
-      instances.featureIdAttributes.push(
-        loadFeatureIdAttributeLegacy(
+      var featureTableId = featureIdAttribute.featureTable;
+      var propertyTableId = sortedPropertyTableIds.indexOf(featureTableId);
+
+      var featureIdComponent;
+      if (defined(featureIdAttribute.featureIds.attribute)) {
+        featureIdComponent = loadFeatureIdAttributeLegacy(
           featureIdAttribute,
-          sortedPropertyTableIds.indexOf(featureIdAttribute.featureTable)
-        )
-      );
+          propertyTableId
+        );
+      } else {
+        featureIdComponent = loadFeatureIdImplicitRangeLegacy(
+          featureIdAttribute,
+          propertyTableId
+        );
+      }
+      instances.featureIds.push(featureIdComponent);
     }
   }
 }