@cesium/engine 2.0.0 → 2.1.0

package/Source/Scene/VoxelEllipsoidShape.js

@@ -62,13 +62,13 @@ function VoxelEllipsoidShape() {
   this._rectangle = new Rectangle();
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._minimumHeight = VoxelEllipsoidShape.DefaultMinBounds.z;
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._maximumHeight = VoxelEllipsoidShape.DefaultMaxBounds.z;
@@ -90,7 +90,7 @@ function VoxelEllipsoidShape() {
   this._rotation = new Matrix3();
 
   /**
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @readonly
    */
   this.shaderUniforms = {
@@ -108,7 +108,7 @@ function VoxelEllipsoidShape() {
   };
 
   /**
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @readonly
    */
   this.shaderDefines = {
@@ -147,7 +147,7 @@ function VoxelEllipsoidShape() {
 
   /**
    * The maximum number of intersections against the shape for any ray direction.
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   this.shaderMaximumIntersectionsLength = 0; // not known until update
@@ -169,7 +169,7 @@ const scratchRenderRectangle = new Rectangle();
  * @param {Cartesian3} maxBounds The maximum bounds.
  * @param {Cartesian3} [clipMinBounds=VoxelEllipsoidShape.DefaultMinBounds] The minimum clip bounds.
  * @param {Cartesian3} [clipMaxBounds=VoxelEllipsoidShape.DefaultMaxBounds] The maximum clip bounds.
- * @returns {Boolean} Whether the shape is visible.
+ * @returns {boolean} Whether the shape is visible.
  */
 VoxelEllipsoidShape.prototype.update = function (
   modelMatrix,
@@ -792,10 +792,10 @@ const scratchRectangle = new Rectangle();
  * Computes an oriented bounding box for a specified tile.
  * The update function must be called before calling this function.
  *
- * @param {Number} tileLevel The tile's level.
- * @param {Number} tileX The tile's x coordinate.
- * @param {Number} tileY The tile's y coordinate.
- * @param {Number} tileZ The tile's z coordinate.
+ * @param {number} tileLevel The tile's level.
+ * @param {number} tileX The tile's x coordinate.
+ * @param {number} tileY The tile's y coordinate.
+ * @param {number} tileZ The tile's z coordinate.
  * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile
  * @returns {OrientedBoundingBox} The oriented bounding box.
  */
@@ -859,7 +859,7 @@ VoxelEllipsoidShape.prototype.computeOrientedBoundingBoxForTile = function (
  * The update function must be called before calling this function.
  *
  * @param {Cartesian3} dimensions The voxel grid dimensions for a tile.
- * @returns {Number} The step size.
+ * @returns {number} The step size.
  */
 VoxelEllipsoidShape.prototype.computeApproximateStepSize = function (
   dimensions
@@ -885,8 +885,8 @@ VoxelEllipsoidShape.prototype.computeApproximateStepSize = function (
  * @function
  *
  * @param {Rectangle} rectangle The rectangle.
- * @param {Number} minHeight The minimumZ.
- * @param {Number} maxHeight The maximumZ.
+ * @param {number} minHeight The minimumZ.
+ * @param {number} maxHeight The maximumZ.
  * @param {Ellipsoid} ellipsoid The ellipsoid.
  * @param {Cartesian3} translation The translation applied to the shape
  * @param {Matrix3} rotation The rotation applied to the shape

package/Source/Scene/VoxelPrimitive.js

@@ -30,7 +30,7 @@ import CustomShader from "./Model/CustomShader.js";
  * @alias VoxelPrimitive
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {VoxelProvider} [options.provider] The voxel provider that supplies the primitive with tile data.
  * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix used to transform the primitive.
  * @param {CustomShader} [options.customShader] The custom shader used to style the primitive.
@@ -46,7 +46,7 @@ function VoxelPrimitive(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._ready = false;
@@ -77,7 +77,7 @@ function VoxelPrimitive(options) {
   this._shape = undefined;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._shapeVisible = false;
@@ -177,7 +177,7 @@ function VoxelPrimitive(options) {
   /**
    * Keeps track of when the clipping planes change
    *
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._clippingPlanesState = 0;
@@ -185,7 +185,7 @@ function VoxelPrimitive(options) {
   /**
    * Keeps track of when the clipping planes are enabled / disabled
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._clippingPlanesEnabled = false;
@@ -234,7 +234,7 @@ function VoxelPrimitive(options) {
   this._customShaderCompilationEvent = new Event();
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._shaderDirty = true;
@@ -252,7 +252,7 @@ function VoxelPrimitive(options) {
   this._drawCommandPick = undefined;
 
   /**
-   * @type {Object}
+   * @type {object}
    * @private
    */
   this._pickId = undefined;
@@ -290,50 +290,50 @@ function VoxelPrimitive(options) {
   this._transformNormalLocalToWorld = new Matrix3();
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._stepSizeUv = 1.0;
 
   // Rendering
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._jitter = true;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._nearestSampling = false;
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._levelBlendFactor = 0.0;
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._stepSizeMultiplier = 1.0;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._depthTest = true;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._useLogDepth = undefined;
 
   /**
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this._screenSpaceError = 4.0; // in pixels
@@ -346,25 +346,25 @@ function VoxelPrimitive(options) {
   this._debugPolylines = new PolylineCollection();
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._debugDraw = false;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._disableRender = false;
 
   /**
-   * @type {Boolean}
+   * @type {boolean}
    * @private
    */
   this._disableUpdate = false;
 
   /**
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @private
    */
   this._uniforms = {
@@ -397,14 +397,14 @@ function VoxelPrimitive(options) {
 
   /**
    * Shape specific shader defines from the previous shape update. Used to detect if the shader needs to be rebuilt.
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @private
    */
   this._shapeDefinesOld = {};
 
   /**
    * Map uniform names to functions that return the uniform values.
-   * @type {Object.<string, function():any>}
+   * @type {Object<string, function():any>}
    * @private
    */
   this._uniformMap = {};
@@ -449,7 +449,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets a value indicating whether or not the primitive is ready for use.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -462,7 +462,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets the promise that will be resolved when the primitive is ready for use.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Promise.<VoxelPrimitive>}
+   * @type {Promise<VoxelPrimitive>}
    * @readonly
    */
   readyPromise: {
@@ -600,7 +600,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets the minimum value per channel of the voxel data.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Number[][]}
+   * @type {number[][]}
    * @readonly
    *
    * @exception {DeveloperError} If the primitive is not ready.
@@ -623,7 +623,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets the maximum value per channel of the voxel data.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Number[][]}
+   * @type {number[][]}
    * @readonly
    *
    * @exception {DeveloperError} If the primitive is not ready.
@@ -646,7 +646,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets or sets whether or not this primitive should be displayed.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   show: {
     get: function () {
@@ -665,7 +665,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets or sets whether or not the primitive should update when the view changes.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   disableUpdate: {
     get: function () {
@@ -684,7 +684,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets or sets whether or not to render debug visualizations.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   debugDraw: {
     get: function () {
@@ -703,7 +703,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets or sets whether or not to test against depth when rendering.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   depthTest: {
     get: function () {
@@ -726,7 +726,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * This reduces stair-step artifacts but introduces noise.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   jitter: {
     get: function () {
@@ -748,7 +748,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * Gets or sets the nearest sampling.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   nearestSampling: {
     get: function () {
@@ -772,7 +772,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * 1.0 means a full linear blend.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Number}
+   * @type {number}
    * @private
    */
   levelBlendFactor: {
@@ -795,7 +795,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * result in worse performance and higher memory consumption.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Number}
+   * @type {number}
    */
   screenSpaceError: {
     get: function () {
@@ -816,7 +816,7 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * also the worse the performance.
    *
    * @memberof VoxelPrimitive.prototype
-   * @type {Number}
+   * @type {number}
    */
   stepSize: {
     get: function () {
@@ -1266,7 +1266,7 @@ function initFromProvider(primitive, provider, context) {
  * Track changes in provider transform and primitive bounds
  * @param {VoxelPrimitive} primitive
  * @param {VoxelProvider} provider
- * @returns {Boolean} Whether any of the transform or bounds changed
+ * @returns {boolean} Whether any of the transform or bounds changed
  * @private
  */
 function checkTransformAndBounds(primitive, provider) {
@@ -1302,9 +1302,9 @@ function checkTransformAndBounds(primitive, provider) {
 /**
  * Compare old and new values of a bound and update the old if it is different.
  * @param {VoxelPrimitive} primitive The primitive with bounds properties
- * @param {String} newBoundKey A key pointing to a bounds property of type Cartesian3 or Matrix4
- * @param {String} oldBoundKey A key pointing to a bounds property of the same type as the property at newBoundKey
- * @returns {Number} 1 if the bound value changed, 0 otherwise
+ * @param {string} newBoundKey A key pointing to a bounds property of type Cartesian3 or Matrix4
+ * @param {string} oldBoundKey A key pointing to a bounds property of the same type as the property at newBoundKey
+ * @returns {number} 1 if the bound value changed, 0 otherwise
  *
  * @private
  */
@@ -1324,7 +1324,7 @@ function updateBound(primitive, newBoundKey, oldBoundKey) {
  * @param {VoxelPrimitive} primitive
  * @param {VoxelShape} shape
  * @param {VoxelProvider} provider
- * @returns {Boolean} True if the shape is visible
+ * @returns {boolean} True if the shape is visible
  * @private
  */
 function updateShapeAndTransforms(primitive, shape, provider) {
@@ -1428,7 +1428,7 @@ function setupTraversal(primitive, provider, context) {
 /**
  * Set uniforms that come from the traversal.
  * @param {VoxelTraversal} traversal
- * @param {Object} uniforms
+ * @param {object} uniforms
  * @private
  */
 function setTraversalUniforms(traversal, uniforms) {
@@ -1473,7 +1473,7 @@ function setTraversalUniforms(traversal, uniforms) {
  * Track changes in shape-related shader defines
  * @param {VoxelPrimitive} primitive
  * @param {VoxelShape} shape
- * @returns {Boolean} True if any of the shape defines changed, requiring a shader rebuild
+ * @returns {boolean} True if any of the shape defines changed, requiring a shader rebuild
  * @private
  */
 function checkShapeDefines(primitive, shape) {
@@ -1491,7 +1491,7 @@ function checkShapeDefines(primitive, shape) {
  * Find the keyframe location to render at. Doesn't need to be a whole number.
  * @param {TimeIntervalCollection} timeIntervalCollection
  * @param {Clock} clock
- * @returns {Number}
+ * @returns {number}
  *
  * @private
  */
@@ -1537,7 +1537,7 @@ function getKeyframeLocation(timeIntervalCollection, clock) {
  *
  * @param {VoxelPrimitive} primitive
  * @param {FrameState} frameState
- * @returns {Boolean} Whether the clipping planes changed, requiring a shader rebuild
+ * @returns {boolean} Whether the clipping planes changed, requiring a shader rebuild
  * @private
  */
 function updateClippingPlanes(primitive, frameState) {
@@ -1592,7 +1592,7 @@ function updateClippingPlanes(primitive, frameState) {
  * 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 VoxelPrimitive#destroy
  */

package/Source/Scene/VoxelProvider.js

@@ -22,7 +22,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * Gets a value indicating whether or not the provider is ready for use.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -33,7 +33,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * Gets the promise that will be resolved when the provider is ready for use.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Promise.<VoxelProvider>}
+   * @type {Promise<VoxelProvider>}
    * @readonly
    */
   readyPromise: {
@@ -141,7 +141,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {String[]}
+   * @type {string[]}
    * @readonly
    */
   names: {
@@ -177,7 +177,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Number[][]|undefined}
+   * @type {number[][]|undefined}
    * @readonly
    */
   minimumValues: {
@@ -189,7 +189,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Number[][]|undefined}
+   * @type {number[][]|undefined}
    * @readonly
    */
   maximumValues: {
@@ -201,7 +201,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @readonly
    */
   maximumTileCount: {
@@ -213,7 +213,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -240,12 +240,12 @@ Object.defineProperties(VoxelProvider.prototype, {
  * This function should not be called before {@link VoxelProvider#ready} returns true.
  * @function
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Number} [options.tileLevel=0] The tile's level.
- * @param {Number} [options.tileX=0] The tile's X coordinate.
- * @param {Number} [options.tileY=0] The tile's Y coordinate.
- * @param {Number} [options.tileZ=0] The tile's Z coordinate.
- * @privateparam {Number} [options.keyframe=0] The requested keyframe.
+ * @param {object} [options] Object with the following properties:
+ * @param {number} [options.tileLevel=0] The tile's level.
+ * @param {number} [options.tileX=0] The tile's X coordinate.
+ * @param {number} [options.tileY=0] The tile's Y coordinate.
+ * @param {number} [options.tileZ=0] The tile's Z coordinate.
+ * @privateparam {number} [options.keyframe=0] The requested keyframe.
  * @returns {Promise<Array[]>|undefined} A promise to an array of typed arrays containing the requested voxel data or undefined if there was a problem loading the data.
  *
  * @exception {DeveloperError} The provider must be ready.

package/Source/Scene/VoxelRenderResources.js

@@ -68,7 +68,7 @@ function VoxelRenderResources(primitive) {
    * A dictionary mapping uniform name to functions that return the uniform
    * values.
    *
-   * @type {Object.<String, Function>}
+   * @type {Object<string, Function>}
    */
   this.uniformMap = uniformMap;
 
@@ -87,7 +87,9 @@ function VoxelRenderResources(primitive) {
   shaderBuilder.addFragmentLines([
     customShader.fragmentShaderText,
     "#line 0",
+    Octree,
     IntersectionUtils,
+    Megatexture,
   ]);
 
   if (clippingPlanesLength > 0) {
@@ -121,10 +123,11 @@ function VoxelRenderResources(primitive) {
 
   const shapeType = primitive._provider.shape;
   if (shapeType === "BOX") {
+    shaderBuilder.addDefine("SHAPE_BOX", undefined, ShaderDestination.FRAGMENT);
     shaderBuilder.addFragmentLines([
+      convertUvToBox,
       IntersectBox,
       Intersection,
-      convertUvToBox,
     ]);
   } else if (shapeType === "CYLINDER") {
     shaderBuilder.addFragmentLines([
@@ -140,7 +143,7 @@ function VoxelRenderResources(primitive) {
     ]);
   }
 
-  shaderBuilder.addFragmentLines([Octree, Megatexture, VoxelFS]);
+  shaderBuilder.addFragmentLines([VoxelFS]);
 
   const shape = primitive._shape;
   const shapeDefines = shape.shaderDefines;

package/Source/Scene/VoxelShape.js

@@ -68,7 +68,7 @@ Object.defineProperties(VoxelShape.prototype, {
   },
 
   /**
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @readonly
    */
   shaderUniforms: {
@@ -76,7 +76,7 @@ Object.defineProperties(VoxelShape.prototype, {
   },
 
   /**
-   * @type {Object.<string, any>}
+   * @type {Object<string, any>}
    * @readonly
    */
   shaderDefines: {
@@ -85,7 +85,7 @@ Object.defineProperties(VoxelShape.prototype, {
 
   /**
    * The maximum number of intersections against the shape for any ray direction.
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   shaderMaximumIntersectionsLength: {
@@ -99,7 +99,7 @@ Object.defineProperties(VoxelShape.prototype, {
  * @param {Matrix4} modelMatrix The model matrix.
  * @param {Cartesian3} minBounds The minimum bounds.
  * @param {Cartesian3} maxBounds The maximum bounds.
- * @returns {Boolean} Whether the shape is visible.
+ * @returns {boolean} Whether the shape is visible.
  */
 VoxelShape.prototype.update = DeveloperError.throwInstantiationError;
 
@@ -107,10 +107,10 @@ VoxelShape.prototype.update = DeveloperError.throwInstantiationError;
  * Computes an oriented bounding box for a specified tile.
  * The update function must be called before calling this function.
  *
- * @param {Number} tileLevel The tile's level.
- * @param {Number} tileX The tile's x coordinate.
- * @param {Number} tileY The tile's y coordinate.
- * @param {Number} tileZ The tile's z coordinate.
+ * @param {number} tileLevel The tile's level.
+ * @param {number} tileX The tile's x coordinate.
+ * @param {number} tileY The tile's y coordinate.
+ * @param {number} tileZ The tile's z coordinate.
  * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile.
  * @returns {OrientedBoundingBox} The oriented bounding box.
  */
@@ -122,7 +122,7 @@ VoxelShape.prototype.computeOrientedBoundingBoxForTile =
  * The update function must be called before calling this function.
  *
  * @param {Cartesian3} voxelDimensions The voxel grid dimensions for a tile.
- * @returns {Number} The step size.
+ * @returns {number} The step size.
  */
 VoxelShape.prototype.computeApproximateStepSize =
   DeveloperError.throwInstantiationError;

package/Source/Scene/VoxelShapeType.js

@@ -6,7 +6,7 @@ import VoxelEllipsoidShape from "./VoxelEllipsoidShape.js";
 /**
  * An enum of voxel shapes. The shape controls how the voxel grid is mapped to 3D space.
  *
- * @enum {String}
+ * @enum {string}
  *
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
  */
@@ -14,7 +14,7 @@ const VoxelShapeType = {
   /**
    * A box shape.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -22,7 +22,7 @@ const VoxelShapeType = {
   /**
    * An ellipsoid shape.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -30,7 +30,7 @@ const VoxelShapeType = {
   /**
    * A cylinder shape.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */