@cesium/engine 1.0.0 → 2.0.0

package/Source/Scene/MetadataSchema.js

@@ -1,4 +1,6 @@
 import Check from "../Core/Check.js";
+import clone from "../Core/clone.js";
+import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import MetadataClass from "./MetadataClass.js";
 import MetadataEnum from "./MetadataEnum.js";
@@ -6,17 +8,50 @@ import MetadataEnum from "./MetadataEnum.js";
 /**
  * A schema containing classes and enums.
  * <p>
- * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles
+ * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles
  * </p>
  *
- * @param {Object} schema The schema JSON object.
+ * @param {Object} options Object with the following properties:
+ * @param {String} [options.id] The ID of the schema
+ * @param {String} [options.name] The name of the schema.
+ * @param {String} [options.description] The description of the schema.
+ * @param {String} [options.version] The application-specific version of the schema.
+ * @param {Object.<String, MetadataClass>} [options.classes] Classes defined in the schema, where each key is the class ID.
+ * @param {Object.<String, MetadataEnum>} [options.enums] Enums defined in the schema, where each key is the enum ID.
+ * @param {*} [options.extras] Extra user-defined properties.
+ * @param {Object} [options.extensions] An object containing extensions.
  *
  * @alias MetadataSchema
  * @constructor
+ * @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.
+ */
+function MetadataSchema(options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+  const classes = defaultValue(options.classes, {});
+  const enums = defaultValue(options.enums, {});
+
+  this._classes = classes;
+  this._enums = enums;
+  this._id = options.id;
+  this._name = options.name;
+  this._description = options.description;
+  this._version = options.version;
+  this._extras = clone(options.extras, true);
+  this._extensions = clone(options.extensions, true);
+}
+
+/**
+ * Creates a {@link MetadataSchema} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata.
+ *
+ * @param {Object} schema The schema JSON object.
+ *
+ * @returns {MetadataSchema} The newly created metadata schema
+ *
  * @private
  * @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.
  */
-function MetadataSchema(schema) {
+MetadataSchema.fromJson = function (schema) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("schema", schema);
   //>>includeEnd('debug');
@@ -25,7 +60,7 @@ function MetadataSchema(schema) {
   if (defined(schema.enums)) {
     for (const enumId in schema.enums) {
       if (schema.enums.hasOwnProperty(enumId)) {
-        enums[enumId] = new MetadataEnum({
+        enums[enumId] = MetadataEnum.fromJson({
           id: enumId,
           enum: schema.enums[enumId],
         });
@@ -37,7 +72,7 @@ function MetadataSchema(schema) {
   if (defined(schema.classes)) {
     for (const classId in schema.classes) {
       if (schema.classes.hasOwnProperty(classId)) {
-        classes[classId] = new MetadataClass({
+        classes[classId] = MetadataClass.fromJson({
           id: classId,
           class: schema.classes[classId],
           enums: enums,
@@ -46,15 +81,17 @@ function MetadataSchema(schema) {
     }
   }
 
-  this._classes = classes;
-  this._enums = enums;
-  this._id = schema.id;
-  this._name = schema.name;
-  this._description = schema.description;
-  this._version = schema.version;
-  this._extras = schema.extras;
-  this._extensions = schema.extensions;
-}
+  return new MetadataSchema({
+    id: schema.id,
+    name: schema.name,
+    description: schema.description,
+    version: schema.version,
+    classes: classes,
+    enums: enums,
+    extras: schema.extras,
+    extensions: schema.extensions,
+  });
+};
 
 Object.defineProperties(MetadataSchema.prototype, {
   /**
@@ -63,7 +100,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {Object.<String, MetadataClass>}
    * @readonly
-   * @private
    */
   classes: {
     get: function () {
@@ -77,7 +113,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {Object.<String, MetadataEnum>}
    * @readonly
-   * @private
    */
   enums: {
     get: function () {
@@ -91,7 +126,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   id: {
     get: function () {
@@ -105,7 +139,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   name: {
     get: function () {
@@ -119,7 +152,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   description: {
     get: function () {
@@ -133,7 +165,6 @@ Object.defineProperties(MetadataSchema.prototype, {
    * @memberof MetadataSchema.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   version: {
     get: function () {
@@ -142,12 +173,11 @@ Object.defineProperties(MetadataSchema.prototype, {
   },
 
   /**
-   * Extras in the JSON object.
+   * Extra user-defined properties.
    *
    * @memberof MetadataSchema.prototype
    * @type {*}
    * @readonly
-   * @private
    */
   extras: {
     get: function () {
@@ -156,12 +186,11 @@ Object.defineProperties(MetadataSchema.prototype, {
   },
 
   /**
-   * Extensions in the JSON object.
+   * An object containing extensions.
    *
    * @memberof MetadataSchema.prototype
    * @type {Object}
    * @readonly
-   * @private
    */
   extensions: {
     get: function () {

package/Source/Scene/MetadataSchemaLoader.js

@@ -39,7 +39,7 @@ function MetadataSchemaLoader(options) {
   }
   //>>includeEnd('debug');
 
-  this._schema = defined(schema) ? new MetadataSchema(schema) : undefined;
+  this._schema = defined(schema) ? MetadataSchema.fromJson(schema) : undefined;
   this._resource = resource;
   this._cacheKey = cacheKey;
   this._state = ResourceLoaderState.UNLOADED;
@@ -120,7 +120,7 @@ function loadExternalSchema(schemaLoader) {
       if (schemaLoader.isDestroyed()) {
         return;
       }
-      schemaLoader._schema = new MetadataSchema(json);
+      schemaLoader._schema = MetadataSchema.fromJson(json);
       schemaLoader._state = ResourceLoaderState.READY;
       return schemaLoader;
     })

package/Source/Scene/MetadataSemantic.js

@@ -32,6 +32,14 @@ const MetadataSemantic = {
    * @private
    */
   DESCRIPTION: "DESCRIPTION",
+  /**
+   * The number of tiles in a tileset, stored as a <code>UINT64</code>.
+   *
+   * @type {String}
+   * @constant
+   * @private
+   */
+  TILESET_TILE_COUNT: "TILESET_TILE_COUNT",
   /**
    * A bounding box for a tile, stored as an array of 12 <code>FLOAT32</code> or <code>FLOAT64</code> components. The components are the same format as for <code>boundingVolume.box</code> in 3D Tiles 1.0. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling.
    *

package/Source/Scene/MetadataTableProperty.js

@@ -265,7 +265,7 @@ Object.defineProperties(MetadataTableProperty.prototype, {
   },
 
   /**
-   * Extras in the JSON object.
+   * Extra user-defined properties.
    *
    * @memberof MetadataTableProperty.prototype
    * @type {*}
@@ -279,7 +279,7 @@ Object.defineProperties(MetadataTableProperty.prototype, {
   },
 
   /**
-   * Extensions in the JSON object.
+   * An object containing extensions.
    *
    * @memberof MetadataTableProperty.prototype
    * @type {*}

package/Source/Scene/MetadataType.js

@@ -11,8 +11,7 @@ import Matrix4 from "../Core/Matrix4.js";
  * An enum of metadata types. These metadata types are containers containing
  * one or more components of type {@link MetadataComponentType}
  *
- * @enum MetadataType
- * @private
+ * @enum {String}
  * @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.
  */
 const MetadataType = {
@@ -21,7 +20,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   SCALAR: "SCALAR",
   /**
@@ -29,7 +27,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   VEC2: "VEC2",
   /**
@@ -37,7 +34,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   VEC3: "VEC3",
   /**
@@ -45,7 +41,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   VEC4: "VEC4",
   /**
@@ -53,23 +48,20 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   MAT2: "MAT2",
   /**
-   * A 2x2 matrix, stored in column-major format.
+   * A 3x3 matrix, stored in column-major format.
    *
    * @type {String}
    * @constant
-   * @private
    */
   MAT3: "MAT3",
   /**
-   * A 2x2 matrix, stored in column-major format.
+   * A 4x4 matrix, stored in column-major format.
    *
    * @type {String}
    * @constant
-   * @private
    */
   MAT4: "MAT4",
   /**
@@ -77,7 +69,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   BOOLEAN: "BOOLEAN",
   /**
@@ -85,7 +76,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   STRING: "STRING",
   /**
@@ -95,7 +85,6 @@ const MetadataType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   ENUM: "ENUM",
 };
@@ -105,6 +94,7 @@ const MetadataType = {
  *
  * @param {MetadataType} type The type
  * @return {Boolean} <code>true</code> if the type is a vector, <code>false</code> otherwise
+ * @private
  */
 MetadataType.isVectorType = function (type) {
   //>>includeStart('debug', pragmas.debug);
@@ -126,6 +116,7 @@ MetadataType.isVectorType = function (type) {
  *
  * @param {MetadataType} type The type
  * @return {Boolean} <code>true</code> if the type is a matrix, <code>false</code> otherwise
+ * @private
  */
 MetadataType.isMatrixType = function (type) {
   //>>includeStart('debug', pragmas.debug);
@@ -148,6 +139,7 @@ MetadataType.isMatrixType = function (type) {
  *
  * @param {MetadataType} type The type to get the component count for
  * @return {Number} The number of components
+ * @private
  */
 MetadataType.getComponentCount = function (type) {
   //>>includeStart('debug', pragmas.debug);

package/Source/Scene/Model/CustomShader.js

@@ -113,7 +113,7 @@ import CustomShaderTranslucencyMode from "./CustomShaderTranslucencyMode.js";
  *   `,
  *   fragmentShaderText: `
  *   void fragmentMain(FragmentInput fsInput, inout czm_modelMaterial material) {
- *     material.normal = texture2D(u_normalMap, fsInput.attributes.texCoord_0);
+ *     material.normal = texture(u_normalMap, fsInput.attributes.texCoord_0);
  *     material.diffuse = v_selectedColor;
  *   }
  *   `

package/Source/Scene/Model/FeatureIdPipelineStage.js

@@ -295,13 +295,13 @@ function processImplicitRange(
   );
 
   // Declare the vertex attribute in the shader
-  // Example: attribute float a_implicit_feature_id_n;
+  // Example: in float a_implicit_feature_id_n;
   const shaderBuilder = renderResources.shaderBuilder;
   const implicitAttributeName = `a_implicit_${variableName}`;
   shaderBuilder.addAttribute("float", implicitAttributeName);
 
   // Also declare the corresponding varyings
-  // Example: varying float v_implicit_feature_id_n;
+  // Example: in float v_implicit_feature_id_n;
   const implicitVaryingName = `v_implicit_${variableName}`;
   shaderBuilder.addVarying("float", implicitVaryingName);
 
@@ -388,9 +388,9 @@ function processTexture(
   );
 
   // Read one or more channels from the texture
-  // example: texture2D(u_featureIdTexture_0, v_texCoord_1).rg
+  // example: texture(u_featureIdTexture_0, v_texCoord_1).rg
   const texCoord = `v_texCoord_${textureReader.texCoord}`;
-  const textureRead = `texture2D(${uniformName}, ${texCoord}).${channels}`;
+  const textureRead = `texture(${uniformName}, ${texCoord}).${channels}`;
 
   // Finally, assign to the struct field. Example:
   // featureIds.featureId_0 = unpacked;

package/Source/Scene/Model/GeoJsonLoader.js

@@ -606,7 +606,7 @@ function parse(geoJson, frameState) {
   });
   const propertyTables = [propertyTable];
 
-  const schema = new MetadataSchema({});
+  const schema = MetadataSchema.fromJson({});
 
   const structuralMetadata = new StructuralMetadata({
     schema: schema,

package/Source/Scene/Model/LightingModel.js

@@ -9,7 +9,7 @@ const LightingModel = {
   /**
    * Use unlit shading, i.e. skip lighting calculations. The model's
    * diffuse color (assumed to be linear RGB, not sRGB) is used directly
-   * when computing <code>gl_FragColor</code>. The alpha mode is still
+   * when computing <code>out_FragColor</code>. The alpha mode is still
    * applied.
    *
    * @type {Number}

package/Source/Scene/Model/MetadataPipelineStage.js

@@ -452,7 +452,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
 
   // Get a GLSL expression for the value of the property
   const texCoordVariable = `attributes.texCoord_${texCoord}`;
-  const valueExpression = `texture2D(${textureUniformName}, ${texCoordVariable}).${channels}`;
+  const valueExpression = `texture(${textureUniformName}, ${texCoordVariable}).${channels}`;
 
   // Some types need an unpacking step or two. For example, since texture reads
   // are always normalized, UINT8 (not normalized) properties need to be

package/Source/Scene/Model/Model.js

@@ -2099,9 +2099,8 @@ function updateComputedScale(model, modelMatrix, frameState) {
       context.drawingBufferWidth,
       context.drawingBufferHeight
     );
-    scratchPosition.x = modelMatrix[12];
-    scratchPosition.y = modelMatrix[13];
-    scratchPosition.z = modelMatrix[14];
+
+    Matrix4.getTranslation(modelMatrix, scratchPosition);
 
     if (model._sceneMode !== SceneMode.SCENE3D) {
       SceneTransforms.computeActualWgs84Position(

package/Source/Scene/Model/PickingPipelineStage.js

@@ -157,7 +157,7 @@ function processPickTexture(renderResources, primitive, instances) {
 
   // The feature ID is ignored if it is greater than the number of features.
   renderResources.pickId =
-    "((selectedFeature.id < int(model_featuresLength)) ? texture2D(model_pickTexture, selectedFeature.st) : vec4(0.0))";
+    "((selectedFeature.id < int(model_featuresLength)) ? texture(model_pickTexture, selectedFeature.st) : vec4(0.0))";
 }
 
 function processInstancedPickIds(renderResources, context) {

package/Source/Scene/Model/buildDrawCommand.js

@@ -48,21 +48,29 @@ function buildDrawCommand(primitiveRenderResources, frameState) {
   const pass = primitiveRenderResources.alphaOptions.pass;
   const sceneGraph = model.sceneGraph;
 
-  const modelMatrix = Matrix4.multiplyTransformation(
-    sceneGraph.computedModelMatrix,
-    primitiveRenderResources.runtimeNode.computedTransform,
-    new Matrix4()
-  );
+  const is3D = frameState.mode === SceneMode.SCENE3D;
+  let modelMatrix, boundingSphere;
+
+  if (!is3D && !frameState.scene3DOnly && model._projectTo2D) {
+    modelMatrix = Matrix4.multiplyTransformation(
+      sceneGraph._computedModelMatrix,
+      primitiveRenderResources.runtimeNode.computedTransform,
+      new Matrix4()
+    );
 
-  let boundingSphere;
-  if (
-    frameState.mode !== SceneMode.SCENE3D &&
-    !frameState.scene3DOnly &&
-    model._projectTo2D
-  ) {
     const runtimePrimitive = primitiveRenderResources.runtimePrimitive;
     boundingSphere = runtimePrimitive.boundingSphere2D;
   } else {
+    const computedModelMatrix = is3D
+      ? sceneGraph._computedModelMatrix
+      : sceneGraph._computedModelMatrix2D;
+
+    modelMatrix = Matrix4.multiplyTransformation(
+      computedModelMatrix,
+      primitiveRenderResources.runtimeNode.computedTransform,
+      new Matrix4()
+    );
+
     boundingSphere = BoundingSphere.transform(
       primitiveRenderResources.boundingSphere,
       modelMatrix,