@cesium/engine 2.0.0 → 2.2.0

package/Source/Renderer/TextureMinificationFilter.js

@@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js";
 /**
  * Enumerates all possible filters used when minifying WebGL textures.
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @see TextureMagnificationFilter
  */
@@ -11,14 +11,14 @@ const TextureMinificationFilter = {
   /**
    * Samples the texture by returning the closest pixel.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   NEAREST: WebGLConstants.NEAREST,
   /**
    * Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than <code>NEAREST</code> filtering.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LINEAR: WebGLConstants.LINEAR,
@@ -28,7 +28,7 @@ const TextureMinificationFilter = {
    * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
    * </p>
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   NEAREST_MIPMAP_NEAREST: WebGLConstants.NEAREST_MIPMAP_NEAREST,
@@ -38,7 +38,7 @@ const TextureMinificationFilter = {
    * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
    * </p>
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LINEAR_MIPMAP_NEAREST: WebGLConstants.LINEAR_MIPMAP_NEAREST,
@@ -51,7 +51,7 @@ const TextureMinificationFilter = {
    * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
    * </p>
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   NEAREST_MIPMAP_LINEAR: WebGLConstants.NEAREST_MIPMAP_LINEAR,
@@ -63,7 +63,7 @@ const TextureMinificationFilter = {
    * <p>
    * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
    * </p>
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LINEAR_MIPMAP_LINEAR: WebGLConstants.LINEAR_MIPMAP_LINEAR,
@@ -75,7 +75,7 @@ const TextureMinificationFilter = {
  * @private
  *
  * @param textureMinificationFilter
- * @returns {Boolean} <code>true</code> if <code>textureMinificationFilter</code> is valid.
+ * @returns {boolean} <code>true</code> if <code>textureMinificationFilter</code> is valid.
  */
 TextureMinificationFilter.validate = function (textureMinificationFilter) {
   return (

package/Source/Renderer/UniformState.js

@@ -27,7 +27,7 @@ function UniformState() {
    */
   this.globeDepthTexture = undefined;
   /**
-   * @type {Number}
+   * @type {number}
    */
   this.gamma = undefined;
 
@@ -640,7 +640,7 @@ Object.defineProperties(UniformState.prototype, {
    * The far plane's distance from the near plane, plus 1.0.
    *
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   farDepthFromNearPlusOne: {
     get: function () {
@@ -652,7 +652,7 @@ Object.defineProperties(UniformState.prototype, {
    * The log2 of {@link UniformState#farDepthFromNearPlusOne}.
    *
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   log2FarDepthFromNearPlusOne: {
     get: function () {
@@ -664,7 +664,7 @@ Object.defineProperties(UniformState.prototype, {
    * 1.0 divided by {@link UniformState#log2FarDepthFromNearPlusOne}.
    *
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   oneOverLog2FarDepthFromNearPlusOne: {
     get: function () {
@@ -675,7 +675,7 @@ Object.defineProperties(UniformState.prototype, {
   /**
    * The height in meters of the eye (camera) above or below the ellipsoid.
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   eyeHeight: {
     get: function () {
@@ -846,7 +846,7 @@ Object.defineProperties(UniformState.prototype, {
    * Gets the scaling factor for transforming from the canvas
    * pixel space to canvas coordinate space.
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   pixelRatio: {
     get: function () {
@@ -857,7 +857,7 @@ Object.defineProperties(UniformState.prototype, {
   /**
    * A scalar used to mix a color with the fog color based on the distance to the camera.
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   fogDensity: {
     get: function () {
@@ -868,7 +868,7 @@ Object.defineProperties(UniformState.prototype, {
   /**
    * A scalar that represents the geometric tolerance per meter
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   geometricToleranceOverMeter: {
     get: function () {
@@ -955,7 +955,7 @@ Object.defineProperties(UniformState.prototype, {
   /**
    * The maximum level-of-detail of the specular environment map atlas of the scene.
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   specularEnvironmentMapsMaximumLOD: {
     get: function () {
@@ -966,7 +966,7 @@ Object.defineProperties(UniformState.prototype, {
   /**
    * The splitter position to use when rendering with a splitter. This will be in pixel coordinates relative to the canvas.
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   splitPosition: {
     get: function () {
@@ -980,7 +980,7 @@ Object.defineProperties(UniformState.prototype, {
    * be applied. When less than zero, the depth test should never be applied.
    *
    * @memberof UniformState.prototype
-   * @type {Number}
+   * @type {number}
    */
   minimumDisableDepthTestDistance: {
     get: function () {
@@ -1004,7 +1004,7 @@ Object.defineProperties(UniformState.prototype, {
    * Whether or not the current projection is orthographic in 3D.
    *
    * @memberOf UniformState.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   orthographicIn3D: {
     get: function () {
@@ -1135,7 +1135,7 @@ function setSunAndMoonDirections(uniformState, frameState) {
  * by the {@link Scene} when rendering to ensure that automatic GLSL uniforms
  * are set to the right value.
  *
- * @param {Object} camera The camera to synchronize with.
+ * @param {object} camera The camera to synchronize with.
  */
 UniformState.prototype.updateCamera = function (camera) {
   setView(this, camera.viewMatrix);
@@ -1156,7 +1156,7 @@ UniformState.prototype.updateCamera = function (camera) {
  * by the {@link Scene} when rendering to ensure that automatic GLSL uniforms
  * are set to the right value.
  *
- * @param {Object} frustum The frustum to synchronize with.
+ * @param {object} frustum The frustum to synchronize with.
  */
 UniformState.prototype.updateFrustum = function (frustum) {
   setProjection(this, frustum.projectionMatrix);

package/Source/Renderer/VertexArray.js

@@ -178,7 +178,7 @@ function bind(gl, attributes, indexBuffer) {
  * Creates a vertex array, which defines the attributes making up a vertex, and contains an optional index buffer
  * to select vertices for rendering.  Attributes are defined using object literals as shown in Example 1 below.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Context} options.context The context in which the VertexArray gets created.
  * @param {Object[]} options.attributes An array of attributes.
  * @param {IndexBuffer} [options.indexBuffer] An optional index buffer.
@@ -531,7 +531,7 @@ function interleaveAttributes(attributes) {
  * <br />
  * If <code>options</code> is not specified or the <code>geometry</code> contains no data, the returned vertex array is empty.
  *
- * @param {Object} options An object defining the geometry, attribute indices, buffer usage, and vertex layout used to create the vertex array.
+ * @param {object} options An object defining the geometry, attribute indices, buffer usage, and vertex layout used to create the vertex array.
  *
  * @exception {RuntimeError} Each attribute list must have the same number of vertices.
  * @exception {DeveloperError} The geometry must have zero or one index lists.

package/Source/Renderer/createUniform.js

@@ -57,7 +57,7 @@ function createUniform(gl, activeUniform, uniformName, location) {
  */
 function UniformFloat(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -84,7 +84,7 @@ UniformFloat.prototype.set = function () {
  */
 function UniformFloatVec2(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -112,7 +112,7 @@ UniformFloatVec2.prototype.set = function () {
  */
 function UniformFloatVec3(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -152,7 +152,7 @@ UniformFloatVec3.prototype.set = function () {
  */
 function UniformFloatVec4(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -192,7 +192,7 @@ UniformFloatVec4.prototype.set = function () {
  */
 function UniformSampler(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -227,7 +227,7 @@ UniformSampler.prototype._setSampler = function (textureUnitIndex) {
  */
 function UniformInt(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -253,7 +253,7 @@ UniformInt.prototype.set = function () {
  */
 function UniformIntVec2(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -280,7 +280,7 @@ UniformIntVec2.prototype.set = function () {
  */
 function UniformIntVec3(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -307,7 +307,7 @@ UniformIntVec3.prototype.set = function () {
  */
 function UniformIntVec4(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -336,7 +336,7 @@ const scratchUniformArray = new Float32Array(4);
  */
 function UniformMat2(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -366,7 +366,7 @@ const scratchMat3Array = new Float32Array(9);
  */
 function UniformMat3(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -396,7 +396,7 @@ const scratchMat4Array = new Float32Array(16);
  */
 function UniformMat4(gl, activeUniform, uniformName, location) {
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;

package/Source/Renderer/createUniformArray.js

@@ -74,7 +74,7 @@ function UniformArrayFloat(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -116,7 +116,7 @@ function UniformArrayFloatVec2(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -160,7 +160,7 @@ function UniformArrayFloatVec3(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -222,7 +222,7 @@ function UniformArrayFloatVec4(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -289,7 +289,7 @@ function UniformArraySampler(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -339,7 +339,7 @@ function UniformArrayInt(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -381,7 +381,7 @@ function UniformArrayIntVec2(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -425,7 +425,7 @@ function UniformArrayIntVec3(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -469,7 +469,7 @@ function UniformArrayIntVec4(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -513,7 +513,7 @@ function UniformArrayMat2(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -557,7 +557,7 @@ function UniformArrayMat3(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;
@@ -601,7 +601,7 @@ function UniformArrayMat4(gl, activeUniform, uniformName, locations) {
   const length = locations.length;
 
   /**
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   this.name = uniformName;

package/Source/Renderer/freezeRenderState.js

@@ -4,8 +4,8 @@
  *
  * @private
  *
- * @param {Object} renderState
- * @returns {Object} Returns frozen renderState.
+ * @param {object} renderState
+ * @returns {object} Returns frozen renderState.
  *
  */
 function freezeRenderState(renderState) {

package/Source/Renderer/loadCubeMap.js

@@ -11,9 +11,9 @@ import CubeMap from "./CubeMap.js";
  * @function loadCubeMap
  *
  * @param {Context} context The context to use to create the cube map.
- * @param {Object} urls The source URL of each image.  See the example below.
- * @param {Boolean} [skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the images will be ignored.
- * @returns {Promise.<CubeMap>} a promise that will resolve to the requested {@link CubeMap} when loaded.
+ * @param {object} urls The source URL of each image.  See the example below.
+ * @param {boolean} [skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the images will be ignored.
+ * @returns {Promise<CubeMap>} a promise that will resolve to the requested {@link CubeMap} when loaded.
  *
  * @exception {DeveloperError} context is required.
  * @exception {DeveloperError} urls is required and must have positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties.

package/Source/Scene/AlphaMode.js

@@ -1,14 +1,14 @@
 /**
  * The alpha rendering mode of the material.
  *
- * @enum {String}
+ * @enum {string}
  * @private
  */
 const AlphaMode = {
   /**
    * The alpha value is ignored and the rendered output is fully opaque.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   OPAQUE: "OPAQUE",
@@ -16,7 +16,7 @@ const AlphaMode = {
   /**
    * The rendered output is either fully opaque or fully transparent depending on the alpha value and the specified alpha cutoff value.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MASK: "MASK",
@@ -24,7 +24,7 @@ const AlphaMode = {
   /**
    * The rendered output is composited onto the destination with alpha blending.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   BLEND: "BLEND",

package/Source/Scene/Appearance.js

@@ -13,13 +13,13 @@ import CullFace from "./CullFace.js";
  * @alias Appearance
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link Appearance#renderState} has alpha blending enabled.
- * @param {Boolean} [options.closed=false] When <code>true</code>, the geometry is expected to be closed so {@link Appearance#renderState} has backface culling enabled.
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link Appearance#renderState} has alpha blending enabled.
+ * @param {boolean} [options.closed=false] When <code>true</code>, the geometry is expected to be closed so {@link Appearance#renderState} has backface culling enabled.
  * @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 MaterialAppearance
  * @see EllipsoidSurfaceAppearance
@@ -46,7 +46,7 @@ function Appearance(options) {
   /**
    * When <code>true</code>, the geometry is expected to appear translucent.
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default true
    */
@@ -64,7 +64,7 @@ Object.defineProperties(Appearance.prototype, {
    *
    * @memberof Appearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   vertexShaderSource: {
@@ -80,7 +80,7 @@ Object.defineProperties(Appearance.prototype, {
    *
    * @memberof Appearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   fragmentShaderSource: {
@@ -94,7 +94,7 @@ Object.defineProperties(Appearance.prototype, {
    *
    * @memberof Appearance.prototype
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   renderState: {
@@ -108,7 +108,7 @@ Object.defineProperties(Appearance.prototype, {
    *
    * @memberof Appearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -124,7 +124,7 @@ Object.defineProperties(Appearance.prototype, {
  * Procedurally creates the full GLSL fragment shader source for this appearance
  * taking into account {@link Appearance#fragmentShaderSource} and {@link Appearance#material}.
  *
- * @returns {String} The full GLSL fragment shader source.
+ * @returns {string} The full GLSL fragment shader source.
  */
 Appearance.prototype.getFragmentShaderSource = function () {
   const parts = [];
@@ -145,7 +145,7 @@ Appearance.prototype.getFragmentShaderSource = function () {
 /**
  * Determines if the geometry is translucent based on {@link Appearance#translucent} and {@link Material#isTranslucent}.
  *
- * @returns {Boolean} <code>true</code> if the appearance is translucent.
+ * @returns {boolean} <code>true</code> if the appearance is translucent.
  */
 Appearance.prototype.isTranslucent = function () {
   return (
@@ -159,7 +159,7 @@ Appearance.prototype.isTranslucent = function () {
  * it can contain a subset of render state properties identical to the render state
  * created in the context.
  *
- * @returns {Object} The render state.
+ * @returns {object} The render state.
  */
 Appearance.prototype.getRenderState = function () {
   const translucent = this.isTranslucent();