@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/Material.js

@@ -224,16 +224,16 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  * </div>
  *
  * @alias Material
+ * @constructor
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.strict=false] Throws errors for issues that would normally be ignored, including unused uniforms or materials.
- * @param {Boolean|Function} [options.translucent=true] When <code>true</code> or a function that returns <code>true</code>, the geometry
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.strict=false] Throws errors for issues that would normally be ignored, including unused uniforms or materials.
+ * @param {boolean|Function} [options.translucent=true] When <code>true</code> or a function that returns <code>true</code>, the geometry
  *                           with this material is expected to appear translucent.
  * @param {TextureMinificationFilter} [options.minificationFilter=TextureMinificationFilter.LINEAR] The {@link TextureMinificationFilter} to apply to this material's textures.
  * @param {TextureMagnificationFilter} [options.magnificationFilter=TextureMagnificationFilter.LINEAR] The {@link TextureMagnificationFilter} to apply to this material's textures.
- * @param {Object} options.fabric The fabric JSON used to generate the material.
- *
- * @constructor
+ * @param {object} options.fabric The fabric JSON used to generate the material.
+ *ructor
  *
  * @exception {DeveloperError} fabric: uniform has invalid type.
  * @exception {DeveloperError} fabric: uniforms and materials cannot share the same property.
@@ -258,39 +258,39 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  *
  * // Create a color material with full Fabric notation:
  * polygon.material = new Cesium.Material({
- *     fabric : {
- *         type : 'Color',
- *         uniforms : {
- *             color : new Cesium.Color(1.0, 1.0, 0.0, 1.0)
- *         }
+ *   fabric: {
+ *     type: 'Color',
+ *     uniforms: {
+ *       color: new Cesium.Color(1.0, 1.0, 0.0, 1.0)
  *     }
+ *   }
  * });
  */
 function Material(options) {
   /**
    * The material type. Can be an existing type or a new type. If no type is specified in fabric, type is a GUID.
-   * @type {String}
+   * @type {string}
    * @default undefined
    */
   this.type = undefined;
 
   /**
    * The glsl shader source for this material.
-   * @type {String}
+   * @type {string}
    * @default undefined
    */
   this.shaderSource = undefined;
 
   /**
    * Maps sub-material names to Material objects.
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   this.materials = undefined;
 
   /**
    * Maps uniform names to their values.
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   this.uniforms = undefined;
@@ -299,7 +299,7 @@ function Material(options) {
   /**
    * When <code>true</code> or a function that returns <code>true</code>,
    * the geometry is expected to appear translucent.
-   * @type {Boolean|Function}
+   * @type {boolean|Function}
    * @default undefined
    */
   this.translucent = undefined;
@@ -349,15 +349,15 @@ Material._uniformList = {};
  * <br /><br />
  * Shorthand for: new Material({fabric : {type : type}});
  *
- * @param {String} type The base material type.
- * @param {Object} [uniforms] Overrides for the default uniforms.
+ * @param {string} type The base material type.
+ * @param {object} [uniforms] Overrides for the default uniforms.
  * @returns {Material} New material object.
  *
  * @exception {DeveloperError} material with that type does not exist.
  *
  * @example
  * const material = Cesium.Material.fromType('Color', {
- *     color : new Cesium.Color(1.0, 0.0, 0.0, 1.0)
+ *   color: new Cesium.Color(1.0, 0.0, 0.0, 1.0)
  * });
  */
 Material.fromType = function (type, uniforms) {
@@ -386,7 +386,7 @@ Material.fromType = function (type, uniforms) {
 
 /**
  * Gets whether or not this material is translucent.
- * @returns {Boolean} <code>true</code> if this material is translucent, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if this material is translucent, <code>false</code> otherwise.
  */
 Material.prototype.isTranslucent = function () {
   if (defined(this.translucent)) {
@@ -537,7 +537,7 @@ Material.prototype.update = function (context) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see Material#destroy
  */
@@ -1216,19 +1216,19 @@ Material._materialCache = {
 
 /**
  * Gets or sets the default texture uniform value.
- * @type {String}
+ * @type {string}
  */
 Material.DefaultImageId = "czm_defaultImage";
 
 /**
  * Gets or sets the default cube map texture uniform value.
- * @type {String}
+ * @type {string}
  */
 Material.DefaultCubeMapId = "czm_defaultCubeMap";
 
 /**
  * Gets the name of the color material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.ColorType = "Color";
@@ -1250,7 +1250,7 @@ Material._materialCache.addMaterial(Material.ColorType, {
 
 /**
  * Gets the name of the image material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.ImageType = "Image";
@@ -1275,7 +1275,7 @@ Material._materialCache.addMaterial(Material.ImageType, {
 
 /**
  * Gets the name of the diffuce map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.DiffuseMapType = "DiffuseMap";
@@ -1296,7 +1296,7 @@ Material._materialCache.addMaterial(Material.DiffuseMapType, {
 
 /**
  * Gets the name of the alpha map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.AlphaMapType = "AlphaMap";
@@ -1317,7 +1317,7 @@ Material._materialCache.addMaterial(Material.AlphaMapType, {
 
 /**
  * Gets the name of the specular map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.SpecularMapType = "SpecularMap";
@@ -1338,7 +1338,7 @@ Material._materialCache.addMaterial(Material.SpecularMapType, {
 
 /**
  * Gets the name of the emmision map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.EmissionMapType = "EmissionMap";
@@ -1359,7 +1359,7 @@ Material._materialCache.addMaterial(Material.EmissionMapType, {
 
 /**
  * Gets the name of the bump map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.BumpMapType = "BumpMap";
@@ -1379,7 +1379,7 @@ Material._materialCache.addMaterial(Material.BumpMapType, {
 
 /**
  * Gets the name of the normal map material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.NormalMapType = "NormalMap";
@@ -1399,7 +1399,7 @@ Material._materialCache.addMaterial(Material.NormalMapType, {
 
 /**
  * Gets the name of the grid material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.GridType = "Grid";
@@ -1423,7 +1423,7 @@ Material._materialCache.addMaterial(Material.GridType, {
 
 /**
  * Gets the name of the stripe material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.StripeType = "Stripe";
@@ -1447,7 +1447,7 @@ Material._materialCache.addMaterial(Material.StripeType, {
 
 /**
  * Gets the name of the checkerboard material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.CheckerboardType = "Checkerboard";
@@ -1469,7 +1469,7 @@ Material._materialCache.addMaterial(Material.CheckerboardType, {
 
 /**
  * Gets the name of the dot material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.DotType = "Dot";
@@ -1491,7 +1491,7 @@ Material._materialCache.addMaterial(Material.DotType, {
 
 /**
  * Gets the name of the water material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.WaterType = "Water";
@@ -1521,7 +1521,7 @@ Material._materialCache.addMaterial(Material.WaterType, {
 
 /**
  * Gets the name of the rim lighting material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.RimLightingType = "RimLighting";
@@ -1543,7 +1543,7 @@ Material._materialCache.addMaterial(Material.RimLightingType, {
 
 /**
  * Gets the name of the fade material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.FadeType = "Fade";
@@ -1573,7 +1573,7 @@ Material._materialCache.addMaterial(Material.FadeType, {
 
 /**
  * Gets the name of the polyline arrow material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.PolylineArrowType = "PolylineArrow";
@@ -1590,7 +1590,7 @@ Material._materialCache.addMaterial(Material.PolylineArrowType, {
 
 /**
  * Gets the name of the polyline glow material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.PolylineDashType = "PolylineDash";
@@ -1610,7 +1610,7 @@ Material._materialCache.addMaterial(Material.PolylineDashType, {
 
 /**
  * Gets the name of the polyline glow material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.PolylineGlowType = "PolylineGlow";
@@ -1629,7 +1629,7 @@ Material._materialCache.addMaterial(Material.PolylineGlowType, {
 
 /**
  * Gets the name of the polyline outline material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.PolylineOutlineType = "PolylineOutline";
@@ -1651,7 +1651,7 @@ Material._materialCache.addMaterial(Material.PolylineOutlineType, {
 
 /**
  * Gets the name of the elevation contour material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.ElevationContourType = "ElevationContour";
@@ -1670,7 +1670,7 @@ Material._materialCache.addMaterial(Material.ElevationContourType, {
 
 /**
  * Gets the name of the elevation contour material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.ElevationRampType = "ElevationRamp";
@@ -1689,7 +1689,7 @@ Material._materialCache.addMaterial(Material.ElevationRampType, {
 
 /**
  * Gets the name of the slope ramp material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.SlopeRampMaterialType = "SlopeRamp";
@@ -1706,7 +1706,7 @@ Material._materialCache.addMaterial(Material.SlopeRampMaterialType, {
 
 /**
  * Gets the name of the aspect ramp material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.AspectRampMaterialType = "AspectRamp";
@@ -1723,7 +1723,7 @@ Material._materialCache.addMaterial(Material.AspectRampMaterialType, {
 
 /**
  * Gets the name of the elevation band material.
- * @type {String}
+ * @type {string}
  * @readonly
  */
 Material.ElevationBandType = "ElevationBand";

package/Source/Scene/MaterialAppearance.js

@@ -17,16 +17,16 @@ import Material from "./Material.js";
      * @alias MaterialAppearance
      * @constructor
      *
-     * @param {Object} [options] Object with the following properties:
-     * @param {Boolean} [options.flat=false] When <code>true</code>, flat shading is used in the fragment shader, which means lighting is not taking into account.
-     * @param {Boolean} [options.faceForward=!options.closed] When <code>true</code>, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots.  This is useful when both sides of a geometry should be shaded like {@link WallGeometry}.
-     * @param {Boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled.
-     * @param {Boolean} [options.closed=false] When <code>true</code>, the geometry is expected to be closed so {@link MaterialAppearance#renderState} has backface culling enabled.
+     * @param {object} [options] Object with the following properties:
+     * @param {boolean} [options.flat=false] When <code>true</code>, flat shading is used in the fragment shader, which means lighting is not taking into account.
+     * @param {boolean} [options.faceForward=!options.closed] When <code>true</code>, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots.  This is useful when both sides of a geometry should be shaded like {@link WallGeometry}.
+     * @param {boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled.
+     * @param {boolean} [options.closed=false] When <code>true</code>, the geometry is expected to be closed so {@link MaterialAppearance#renderState} has backface culling enabled.
      * @param {MaterialAppearance.MaterialSupportType} [options.materialSupport=MaterialAppearance.MaterialSupport.TEXTURED] The type of materials that will be supported.
      * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color.
-     * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader.
-     * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader.
-     * @param {Object} [options.renderState] Optional render state to override the default render state.
+     * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader.
+     * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader.
+     * @param {object} [options.renderState] Optional render state to override the default render state.
      *
      * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric}
      * @demo {@link https://sandcastle.cesium.com/index.html?src=Materials.html|Cesium Sandcastle Material Appearance Demo}
@@ -73,7 +73,7 @@ function MaterialAppearance(options) {
   /**
    * When <code>true</code>, the geometry is expected to appear translucent.
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default true
    */
@@ -108,7 +108,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   vertexShaderSource: {
@@ -125,7 +125,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   fragmentShaderSource: {
@@ -144,7 +144,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   renderState: {
@@ -160,7 +160,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -212,7 +212,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -231,7 +231,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
    *
    * @memberof MaterialAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -250,7 +250,7 @@ Object.defineProperties(MaterialAppearance.prototype, {
  *
  * @function
  *
- * @returns {String} The full GLSL fragment shader source.
+ * @returns {string} The full GLSL fragment shader source.
  */
 MaterialAppearance.prototype.getFragmentShaderSource =
   Appearance.prototype.getFragmentShaderSource;
@@ -260,7 +260,7 @@ MaterialAppearance.prototype.getFragmentShaderSource =
  *
  * @function
  *
- * @returns {Boolean} <code>true</code> if the appearance is translucent.
+ * @returns {boolean} <code>true</code> if the appearance is translucent.
  */
 MaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent;
 
@@ -271,17 +271,17 @@ MaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent;
  *
  * @function
  *
- * @returns {Object} The render state.
+ * @returns {object} The render state.
  */
 MaterialAppearance.prototype.getRenderState =
   Appearance.prototype.getRenderState;
 
 /**
  * @typedef MaterialAppearance.MaterialSupportType
- * @type {Object}
+ * @type {object}
  * @property {VertexFormat} vertexFormat
- * @property {String} vertexShaderSource
- * @property {String} fragmentShaderSource
+ * @property {string} vertexShaderSource
+ * @property {string} fragmentShaderSource
  */
 
 /**

package/Source/Scene/Megatexture.js

@@ -23,9 +23,9 @@ import TextureWrap from "../Renderer/TextureWrap.js";
  *
  * @param {Context} context
  * @param {Cartesian3} dimensions
- * @param {Number} channelCount
+ * @param {number} channelCount
  * @param {MetadataComponentType} componentType
- * @param {Number} [textureMemoryByteLength]
+ * @param {number} [textureMemoryByteLength]
  *
  * @private
  */
@@ -106,7 +106,7 @@ function Megatexture(
   }
 
   /**
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   this.channelCount = channelCount;
@@ -124,7 +124,7 @@ function Megatexture(
   this.voxelCountPerTile = Cartesian3.clone(dimensions, new Cartesian3());
 
   /**
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   this.maximumTileCount =
@@ -245,7 +245,7 @@ function Megatexture(
   this.emptyList = this.nodes[0];
 
   /**
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   this.occupiedCount = 0;
@@ -255,13 +255,13 @@ function Megatexture(
  * @alias MegatextureNode
  * @constructor
  *
- * @param {Number} index
+ * @param {number} index
  *
  * @private
  */
 function MegatextureNode(index) {
   /**
-   * @type {Number}
+   * @type {number}
    */
   this.index = index;
 
@@ -278,7 +278,7 @@ function MegatextureNode(index) {
 
 /**
  * @param {Array} data
- * @returns {Number}
+ * @returns {number}
  */
 Megatexture.prototype.add = function (data) {
   if (this.isFull()) {
@@ -307,7 +307,7 @@ Megatexture.prototype.add = function (data) {
 };
 
 /**
- * @param {Number} index
+ * @param {number} index
  */
 Megatexture.prototype.remove = function (index) {
   if (index < 0 || index >= this.maximumTileCount) {
@@ -334,18 +334,18 @@ Megatexture.prototype.remove = function (index) {
 };
 
 /**
- * @returns {Boolean}
+ * @returns {boolean}
  */
 Megatexture.prototype.isFull = function () {
   return this.emptyList === undefined;
 };
 
 /**
- * @param {Number} tileCount
+ * @param {number} tileCount
  * @param {Cartesian3} dimensions
- * @param {Number} channelCount number of channels in the metadata. Must be 1 to 4.
+ * @param {number} channelCount number of channels in the metadata. Must be 1 to 4.
  * @param {MetadataComponentType} componentType
- * @returns {Number}
+ * @returns {number}
  */
 Megatexture.getApproximateTextureMemoryByteLength = function (
   tileCount,
@@ -393,7 +393,7 @@ Megatexture.getApproximateTextureMemoryByteLength = function (
 };
 
 /**
- * @param {Number} index
+ * @param {number} index
  * @param {Float32Array|Uint16Array|Uint8Array} data
  */
 Megatexture.prototype.writeDataToTexture = function (index, data) {
@@ -459,7 +459,7 @@ Megatexture.prototype.writeDataToTexture = function (index, data) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see Megatexture#destroy
  */

package/Source/Scene/MetadataClass.js

@@ -11,13 +11,13 @@ import MetadataClassProperty from "./MetadataClassProperty.js";
  * 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 class.
- * @param {String} [options.name] The name of the class.
- * @param {String} [options.description] The description of the class.
- * @param {Object.<String, MetadataClassProperty>} [options.properties] The class properties, where each key is the property ID.
+ * @param {object} options Object with the following properties:
+ * @param {string} options.id The ID of the class.
+ * @param {string} [options.name] The name of the class.
+ * @param {string} [options.description] The description of the class.
+ * @param {Object<string, MetadataClassProperty>} [options.properties] The class properties, where each key is the property ID.
  * @param {*} [options.extras] Extra user-defined properties.
- * @param {Object} [options.extensions] An object containing extensions.
+ * @param {object} [options.extensions] An object containing extensions.
  *
  * @alias MetadataClass
  * @constructor
@@ -54,10 +54,10 @@ function MetadataClass(options) {
 /**
  * Creates a {@link MetadataClass} 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 class.
- * @param {Object} options.class The class JSON object.
- * @param {Object.<String, MetadataEnum>} [options.enums] A dictionary of enums.
+ * @param {object} options Object with the following properties:
+ * @param {string} options.id The ID of the class.
+ * @param {object} options.class The class JSON object.
+ * @param {Object<string, MetadataEnum>} [options.enums] A dictionary of enums.
  *
  * @returns {MetadataClass} The newly created metadata class.
  *
@@ -101,7 +101,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * The class properties.
    *
    * @memberof MetadataClass.prototype
-   * @type {Object.<String, MetadataClassProperty>}
+   * @type {Object<string, MetadataClassProperty>}
    * @readonly
    */
   properties: {
@@ -114,7 +114,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * A dictionary mapping semantics to class properties.
    *
    * @memberof MetadataClass.prototype
-   * @type {Object.<String, MetadataClassProperty>}
+   * @type {Object<string, MetadataClassProperty>}
    * @readonly
    *
    * @private
@@ -129,7 +129,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * The ID of the class.
    *
    * @memberof MetadataClass.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   id: {
@@ -142,7 +142,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * The name of the class.
    *
    * @memberof MetadataClass.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   name: {
@@ -155,7 +155,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * The description of the class.
    *
    * @memberof MetadataClass.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   description: {
@@ -181,7 +181,7 @@ Object.defineProperties(MetadataClass.prototype, {
    * An object containing extensions.
    *
    * @memberof MetadataClass.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   extensions: {