@cesium/engine 1.0.0 → 1.1.0

package/Source/Scene/MetadataComponentType.js

@@ -1,13 +1,13 @@
 import CesiumMath from "../Core/Math.js";
 import Check from "../Core/Check.js";
+import ComponentDatatype from "../Core/ComponentDatatype.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import FeatureDetection from "../Core/FeatureDetection.js";
 
 /**
  * An enum of metadata component types.
  *
- * @enum MetadataComponentType
- * @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 MetadataComponentType = {
@@ -16,7 +16,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   INT8: "INT8",
   /**
@@ -24,7 +23,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   UINT8: "UINT8",
   /**
@@ -32,7 +30,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   INT16: "INT16",
   /**
@@ -40,7 +37,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   UINT16: "UINT16",
   /**
@@ -48,7 +44,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   INT32: "INT32",
   /**
@@ -56,7 +51,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   UINT32: "UINT32",
   /**
@@ -66,7 +60,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   INT64: "INT64",
   /**
@@ -76,7 +69,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   UINT64: "UINT64",
   /**
@@ -84,7 +76,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   FLOAT32: "FLOAT32",
   /**
@@ -92,7 +83,6 @@ const MetadataComponentType = {
    *
    * @type {String}
    * @constant
-   * @private
    */
   FLOAT64: "FLOAT64",
 };
@@ -107,15 +97,11 @@ const MetadataComponentType = {
  * @param {MetadataComponentType} type The type.
  * @returns {Number|BigInt} The minimum value.
  *
- * @exception {DeveloperError} type must be a numeric type
- *
  * @private
  */
 MetadataComponentType.getMinimum = function (type) {
   //>>includeStart('debug', pragmas.debug);
-  if (!MetadataComponentType.isNumericType(type)) {
-    throw new DeveloperError("type must be a numeric type");
-  }
+  Check.typeOf.string("type", type);
   //>>includeEnd('debug');
 
   switch (type) {
@@ -159,15 +145,11 @@ MetadataComponentType.getMinimum = function (type) {
  * @param {MetadataComponentType} type The type.
  * @returns {Number|BigInt} The maximum value.
  *
- * @exception {DeveloperError} type must be a numeric type
- *
  * @private
  */
 MetadataComponentType.getMaximum = function (type) {
   //>>includeStart('debug', pragmas.debug);
-  if (!MetadataComponentType.isNumericType(type)) {
-    throw new DeveloperError("type must be a numeric type");
-  }
+  Check.typeOf.string("type", type);
   //>>includeEnd('debug');
 
   switch (type) {
@@ -203,36 +185,6 @@ MetadataComponentType.getMaximum = function (type) {
   }
 };
 
-/**
- * Returns whether the type is a numeric type.
- *
- * @param {MetadataComponentType} type The type.
- * @returns {Boolean} Whether the type is a numeric type.
- *
- * @private
- */
-MetadataComponentType.isNumericType = function (type) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.string("type", type);
-  //>>includeEnd('debug');
-
-  switch (type) {
-    case MetadataComponentType.INT8:
-    case MetadataComponentType.UINT8:
-    case MetadataComponentType.INT16:
-    case MetadataComponentType.UINT16:
-    case MetadataComponentType.INT32:
-    case MetadataComponentType.UINT32:
-    case MetadataComponentType.INT64:
-    case MetadataComponentType.UINT64:
-    case MetadataComponentType.FLOAT32:
-    case MetadataComponentType.FLOAT64:
-      return true;
-    default:
-      return false;
-  }
-};
-
 /**
  * Returns whether the type is an integer type.
  *
@@ -395,10 +347,16 @@ MetadataComponentType.unnormalize = function (value, type) {
   return value;
 };
 
+/**
+ * @private
+ */
 MetadataComponentType.applyValueTransform = function (value, offset, scale) {
   return scale * value + offset;
 };
 
+/**
+ * @private
+ */
 MetadataComponentType.unapplyValueTransform = function (value, offset, scale) {
   // if the scale is 0, avoid a divide by zero error. The result can be any
   // finite number, so 0.0 will do nicely.
@@ -415,16 +373,13 @@ MetadataComponentType.unapplyValueTransform = function (value, offset, scale) {
  * @param {MetadataComponentType} type The type.
  * @returns {Number} The size in bytes.
  *
- * @exception {DeveloperError} type must be a numeric type
- *
  * @private
  */
 MetadataComponentType.getSizeInBytes = function (type) {
   //>>includeStart('debug', pragmas.debug);
-  if (!MetadataComponentType.isNumericType(type)) {
-    throw new DeveloperError("type must be a numeric type");
-  }
+  Check.typeOf.string("type", type);
   //>>includeEnd('debug');
+
   switch (type) {
     case MetadataComponentType.INT8:
     case MetadataComponentType.UINT8:
@@ -445,4 +400,70 @@ MetadataComponentType.getSizeInBytes = function (type) {
   }
 };
 
+/**
+ * Gets the {@link MetadataComponentType} from a {@link ComponentDatatype}.
+ *
+ * @param {ComponentDatatype} componentDatatype The component datatype.
+ * @returns {MetadataComponentType} The type.
+ *
+ * @private
+ */
+MetadataComponentType.fromComponentDatatype = function (componentDatatype) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.number("componentDatatype", componentDatatype);
+  //>>includeEnd('debug');
+
+  switch (componentDatatype) {
+    case ComponentDatatype.BYTE:
+      return MetadataComponentType.INT8;
+    case ComponentDatatype.UNSIGNED_BYTE:
+      return MetadataComponentType.UINT8;
+    case ComponentDatatype.SHORT:
+      return MetadataComponentType.INT16;
+    case ComponentDatatype.UNSIGNED_SHORT:
+      return MetadataComponentType.UINT16;
+    case ComponentDatatype.INT:
+      return MetadataComponentType.INT32;
+    case ComponentDatatype.UNSIGNED_INT:
+      return MetadataComponentType.UINT32;
+    case ComponentDatatype.FLOAT:
+      return MetadataComponentType.FLOAT32;
+    case ComponentDatatype.DOUBLE:
+      return MetadataComponentType.FLOAT64;
+  }
+};
+
+/**
+ * Gets the {@link ComponentDatatype} from a {@link MetadataComponentType}.
+ *
+ * @param {MetadataComponentType} type The type.
+ * @returns {ComponentDatatype} The component datatype.
+ *
+ * @private
+ */
+MetadataComponentType.toComponentDatatype = function (type) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("type", type);
+  //>>includeEnd('debug');
+
+  switch (type) {
+    case MetadataComponentType.INT8:
+      return ComponentDatatype.BYTE;
+    case MetadataComponentType.UINT8:
+      return ComponentDatatype.UNSIGNED_BYTE;
+    case MetadataComponentType.INT16:
+      return ComponentDatatype.SHORT;
+    case MetadataComponentType.UINT16:
+      return ComponentDatatype.UNSIGNED_SHORT;
+    case MetadataComponentType.INT32:
+      return ComponentDatatype.INT;
+    case MetadataComponentType.UINT32:
+      return ComponentDatatype.UNSIGNED_INT;
+    case MetadataComponentType.FLOAT32:
+      return ComponentDatatype.FLOAT;
+    case MetadataComponentType.FLOAT64:
+      return ComponentDatatype.DOUBLE;
+  }
+};
+
 export default Object.freeze(MetadataComponentType);

package/Source/Scene/MetadataEnum.js

@@ -1,4 +1,5 @@
 import Check from "../Core/Check.js";
+import clone from "../Core/clone.js";
 import defaultValue from "../Core/defaultValue.js";
 import MetadataEnumValue from "./MetadataEnumValue.js";
 import MetadataComponentType from "./MetadataComponentType.js";
@@ -6,38 +7,44 @@ import MetadataComponentType from "./MetadataComponentType.js";
 /**
  * A metadata enum.
  * <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} options Object with the following properties:
  * @param {String} options.id The ID of the enum.
- * @param {Object} options.enum The enum JSON object.
+ * @param {MetadataEnumValue[]} options.values The enum values.
+ * @param {MetadataComponentType} [options.valueType=MetadataComponentType.UINT16] The enum value type.
+ * @param {String} [options.name] The name of the enum.
+ * @param {String} [options.description] The description of the enum.
+ * @param {*} [options.extras] Extra user-defined properties.
+ * @param {Object} [options.extensions] An object containing extensions.
  *
  * @alias MetadataEnum
  * @constructor
- * @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 MetadataEnum(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
   const id = options.id;
-  const enumDefinition = options.enum;
+  const values = options.values;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("options.id", id);
-  Check.typeOf.object("options.enum", enumDefinition);
+  Check.defined("options.values", values);
   //>>includeEnd('debug');
 
   const namesByValue = {};
   const valuesByName = {};
-  const values = enumDefinition.values.map(function (value) {
+
+  const valuesLength = values.length;
+  for (let i = 0; i < valuesLength; ++i) {
+    const value = values[i];
     namesByValue[value.value] = value.name;
     valuesByName[value.name] = value.value;
-    return new MetadataEnumValue(value);
-  });
+  }
 
   const valueType = defaultValue(
-    MetadataComponentType[enumDefinition.valueType],
+    options.valueType,
     MetadataComponentType.UINT16
   );
 
@@ -46,12 +53,49 @@ function MetadataEnum(options) {
   this._valuesByName = valuesByName;
   this._valueType = valueType;
   this._id = id;
-  this._name = enumDefinition.name;
-  this._description = enumDefinition.description;
-  this._extras = enumDefinition.extras;
-  this._extensions = enumDefinition.extensions;
+  this._name = options.name;
+  this._description = options.description;
+  this._extras = clone(options.extras, true);
+  this._extensions = clone(options.extensions, true);
 }
 
+/**
+ * Creates a {@link MetadataEnum} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata.
+ *
+ * @param {Object} options Object with the following properties:
+ * @param {String} options.id The ID of the enum.
+ * @param {Object} options.enum The enum JSON object.
+ *
+ * @returns {MetadataEnum} The newly created metadata enum.
+ *
+ * @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.
+ */
+MetadataEnum.fromJson = function (options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  const id = options.id;
+  const enumDefinition = options.enum;
+
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("options.id", id);
+  Check.typeOf.object("options.enum", enumDefinition);
+  //>>includeEnd('debug');
+
+  const values = enumDefinition.values.map(function (value) {
+    return MetadataEnumValue.fromJson(value);
+  });
+
+  return new MetadataEnum({
+    id: id,
+    values: values,
+    valueType: MetadataComponentType[enumDefinition.valueType],
+    name: enumDefinition.name,
+    description: enumDefinition.description,
+    extras: enumDefinition.extras,
+    extensions: enumDefinition.extensions,
+  });
+};
+
 Object.defineProperties(MetadataEnum.prototype, {
   /**
    * The enum values.
@@ -59,7 +103,6 @@ Object.defineProperties(MetadataEnum.prototype, {
    * @memberof MetadataEnum.prototype
    * @type {MetadataEnumValue[]}
    * @readonly
-   * @private
    */
   values: {
     get: function () {
@@ -103,8 +146,6 @@ Object.defineProperties(MetadataEnum.prototype, {
    * @memberof MetadataEnum.prototype
    * @type {MetadataComponentType}
    * @readonly
-   *
-   * @private
    */
   valueType: {
     get: function () {
@@ -118,7 +159,6 @@ Object.defineProperties(MetadataEnum.prototype, {
    * @memberof MetadataEnum.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   id: {
     get: function () {
@@ -132,7 +172,6 @@ Object.defineProperties(MetadataEnum.prototype, {
    * @memberof MetadataEnum.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   name: {
     get: function () {
@@ -146,7 +185,6 @@ Object.defineProperties(MetadataEnum.prototype, {
    * @memberof MetadataEnum.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   description: {
     get: function () {
@@ -155,12 +193,11 @@ Object.defineProperties(MetadataEnum.prototype, {
   },
 
   /**
-   * Extras in the JSON object.
+   * Extra user-defined properties.
    *
    * @memberof MetadataEnum.prototype
    * @type {*}
    * @readonly
-   * @private
    */
   extras: {
     get: function () {
@@ -169,12 +206,11 @@ Object.defineProperties(MetadataEnum.prototype, {
   },
 
   /**
-   * Extensions in the JSON object.
+   * An object containing extensions.
    *
    * @memberof MetadataEnum.prototype
    * @type {Object}
    * @readonly
-   * @private
    */
   extensions: {
     get: function () {

package/Source/Scene/MetadataEnumValue.js

@@ -1,26 +1,65 @@
 import Check from "../Core/Check.js";
+import clone from "../Core/clone.js";
+import defaultValue from "../Core/defaultValue.js";
 
 /**
  * A metadata enum value.
+ * <p>
+ * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles
+ * </p>
  *
- * @param {Object} value The enum value JSON object.
+ * @param {Object} options Object with the following properties:
+ * @param {Number} options.value The integer value.
+ * @param {String} options.name The name of the enum value.
+ * @param {String} [options.description] The description of the enum value.
+ * @param {*} [options.extras] Extra user-defined properties.
+ * @param {Object} [options.extensions] An object containing extensions.
  *
  * @alias MetadataEnumValue
  * @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 MetadataEnumValue(options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  const value = options.value;
+  const name = options.name;
+
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.number("options.value", value);
+  Check.typeOf.string("options.name", name);
+
+  //>>includeEnd('debug');
+
+  this._value = value;
+  this._name = name;
+  this._description = options.description;
+  this._extras = clone(options.extras, true);
+  this._extensions = clone(options.extensions, true);
+}
+
+/**
+ * Creates a {@link MetadataEnumValue} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata.
+ *
+ * @param {Object} value The enum value JSON object.
+ *
+ * @returns {MetadataEnumValue} The newly created metadata enum value.
+ *
  * @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 MetadataEnumValue(value) {
+MetadataEnumValue.fromJson = function (value) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("value", value);
   //>>includeEnd('debug');
 
-  this._value = value.value;
-  this._name = value.name;
-  this._description = value.description;
-  this._extras = value.extras;
-  this._extensions = value.extensions;
-}
+  return new MetadataEnumValue({
+    value: value.value,
+    name: value.name,
+    description: value.description,
+    extras: value.extras,
+    extensions: value.extensions,
+  });
+};
 
 Object.defineProperties(MetadataEnumValue.prototype, {
   /**
@@ -29,7 +68,6 @@ Object.defineProperties(MetadataEnumValue.prototype, {
    * @memberof MetadataEnumValue.prototype
    * @type {Number}
    * @readonly
-   * @private
    */
   value: {
     get: function () {
@@ -43,7 +81,6 @@ Object.defineProperties(MetadataEnumValue.prototype, {
    * @memberof MetadataEnumValue.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   name: {
     get: function () {
@@ -57,7 +94,6 @@ Object.defineProperties(MetadataEnumValue.prototype, {
    * @memberof MetadataEnumValue.prototype
    * @type {String}
    * @readonly
-   * @private
    */
   description: {
     get: function () {
@@ -66,12 +102,11 @@ Object.defineProperties(MetadataEnumValue.prototype, {
   },
 
   /**
-   * Extras in the JSON object.
+   * Extra user-defined properties.
    *
    * @memberof MetadataEnumValue.prototype
    * @type {*}
    * @readonly
-   * @private
    */
   extras: {
     get: function () {
@@ -80,12 +115,11 @@ Object.defineProperties(MetadataEnumValue.prototype, {
   },
 
   /**
-   * Extensions in the JSON object.
+   * An object containing extensions.
    *
    * @memberof MetadataEnumValue.prototype
    * @type {Object}
    * @readonly
-   * @private
    */
   extensions: {
     get: function () {