@cesium/engine 14.0.0 → 16.0.0

package/Source/Scene/VoxelPrimitive.js

@@ -2,30 +2,32 @@ import buildVoxelDrawCommands from "./buildVoxelDrawCommands.js";
 import Cartesian2 from "../Core/Cartesian2.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import Cartesian4 from "../Core/Cartesian4.js";
+import Cartographic from "../Core/Cartographic.js";
+import Cesium3DTilesetStatistics from "./Cesium3DTilesetStatistics.js";
 import CesiumMath from "../Core/Math.js";
 import Check from "../Core/Check.js";
-import clone from "../Core/clone.js";
 import Color from "../Core/Color.js";
-import defaultValue from "../Core/defaultValue.js";
+import ClippingPlaneCollection from "./ClippingPlaneCollection.js";
+import clone from "../Core/clone.js";
+import CustomShader from "./Model/CustomShader.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
+import Ellipsoid from "../Core/Ellipsoid.js";
 import Event from "../Core/Event.js";
 import JulianDate from "../Core/JulianDate.js";
+import Material from "./Material.js";
 import Matrix3 from "../Core/Matrix3.js";
 import Matrix4 from "../Core/Matrix4.js";
-import oneTimeWarning from "../Core/oneTimeWarning.js";
-import ClippingPlaneCollection from "./ClippingPlaneCollection.js";
-import Material from "./Material.js";
 import MetadataComponentType from "./MetadataComponentType.js";
 import MetadataType from "./MetadataType.js";
+import oneTimeWarning from "../Core/oneTimeWarning.js";
 import PolylineCollection from "./PolylineCollection.js";
+import VerticalExaggeration from "../Core/VerticalExaggeration.js";
+import VoxelContent from "./VoxelContent.js";
 import VoxelShapeType from "./VoxelShapeType.js";
 import VoxelTraversal from "./VoxelTraversal.js";
-import CustomShader from "./Model/CustomShader.js";
-import Cartographic from "../Core/Cartographic.js";
-import Ellipsoid from "../Core/Ellipsoid.js";
-import VerticalExaggeration from "../Core/VerticalExaggeration.js";
-import Cesium3DTilesetStatistics from "./Cesium3DTilesetStatistics.js";
+import VoxelMetadataOrder from "./VoxelMetadataOrder.js";
 
 /**
  * A primitive that renders voxel data from a {@link VoxelProvider}.
@@ -38,6 +40,7 @@ import Cesium3DTilesetStatistics from "./Cesium3DTilesetStatistics.js";
  * @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.
  * @param {Clock} [options.clock] The clock used to control time dynamic behavior.
+ * @param {Boolean} [options.calculateStatistics] Generate statistics for performance profile.
  *
  * @see VoxelProvider
  * @see Cesium3DTilesVoxelProvider
@@ -46,7 +49,7 @@ import Cesium3DTilesetStatistics from "./Cesium3DTilesetStatistics.js";
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function VoxelPrimitive(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   /**
    * @type {boolean}
@@ -58,10 +61,7 @@ function VoxelPrimitive(options) {
    * @type {VoxelProvider}
    * @private
    */
-  this._provider = defaultValue(
-    options.provider,
-    VoxelPrimitive.DefaultProvider,
-  );
+  this._provider = options.provider ?? VoxelPrimitive.DefaultProvider;
 
   /**
    * This member is not created until the provider and shape are ready.
@@ -77,6 +77,12 @@ function VoxelPrimitive(options) {
    */
   this._statistics = new Cesium3DTilesetStatistics();
 
+  /**
+   * @type {boolean}
+   * @private
+   */
+  this._calculateStatistics = options.calculateStatistics ?? false;
+
   /**
    * This member is not created until the provider is ready.
    *
@@ -91,6 +97,22 @@ function VoxelPrimitive(options) {
    */
   this._shapeVisible = false;
 
+  /**
+   * This member is not created until the provider is ready.
+   *
+   * @type {Cartesian3}
+   * @private
+   */
+  this._dimensions = new Cartesian3();
+
+  /**
+   * This member is not created until the provider is ready.
+   *
+   * @type {Cartesian3}
+   * @private
+   */
+  this._inputDimensions = new Cartesian3();
+
   /**
    * This member is not created until the provider is ready.
    *
@@ -237,9 +259,7 @@ function VoxelPrimitive(options) {
    * @type {Matrix4}
    * @private
    */
-  this._modelMatrix = Matrix4.clone(
-    defaultValue(options.modelMatrix, Matrix4.IDENTITY),
-  );
+  this._modelMatrix = Matrix4.clone(options.modelMatrix ?? Matrix4.IDENTITY);
 
   /**
    * Model matrix with vertical exaggeration applied. Only used for BOX shape type.
@@ -271,10 +291,8 @@ function VoxelPrimitive(options) {
    * @type {CustomShader}
    * @private
    */
-  this._customShader = defaultValue(
-    options.customShader,
-    VoxelPrimitive.DefaultCustomShader,
-  );
+  this._customShader =
+    options.customShader ?? VoxelPrimitive.DefaultCustomShader;
 
   /**
    * @type {Event}
@@ -418,6 +436,7 @@ function VoxelPrimitive(options) {
     megatextureSliceSizeUv: new Cartesian2(),
     megatextureTileSizeUv: new Cartesian2(),
     dimensions: new Cartesian3(),
+    inputDimensions: new Cartesian3(),
     paddingBefore: new Cartesian3(),
     paddingAfter: new Cartesian3(),
     transformPositionViewToUv: new Matrix4(),
@@ -705,7 +724,8 @@ Object.defineProperties(VoxelPrimitive.prototype, {
   },
 
   /**
-   * Gets the voxel dimensions.
+   * Gets the dimensions of each voxel tile, in z-up orientation.
+   * Does not include padding.
    *
    * @memberof VoxelPrimitive.prototype
    * @type {Cartesian3}
@@ -713,7 +733,46 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    */
   dimensions: {
     get: function () {
-      return this._provider.dimensions;
+      return this._dimensions;
+    },
+  },
+
+  /**
+   * Gets the dimensions of one tile of the input voxel data, in the input orientation.
+   * Includes padding.
+   * @memberof VoxelPrimitive.prototype
+   * @type {Cartesian3}
+   * @readonly
+   */
+  inputDimensions: {
+    get: function () {
+      return this._inputDimensions;
+    },
+  },
+
+  /**
+   * Gets the padding before the voxel data.
+   *
+   * @memberof VoxelPrimitive.prototype
+   * @type {Cartesian3}
+   * @readonly
+   */
+  paddingBefore: {
+    get: function () {
+      return this._paddingBefore;
+    },
+  },
+
+  /**
+   * Gets the padding after the voxel data.
+   *
+   * @memberof VoxelPrimitive.prototype
+   * @type {Cartesian3}
+   * @readonly
+   */
+  paddingAfter: {
+    get: function () {
+      return this._paddingAfter;
     },
   },
 
@@ -1059,9 +1118,21 @@ Object.defineProperties(VoxelPrimitive.prototype, {
       return this._customShaderCompilationEvent;
     },
   },
+
+  /**
+   *  Loading and rendering information for requested content
+   * To use `visited` and `numberOfTilesWithContentReady` statistics, set options._calculateStatistics` to `true` in the constructor.
+   * @type {Cesium3DTilesetStatistics}
+   * @readonly
+   * @private
+   */
+  statistics: {
+    get: function () {
+      return this._statistics;
+    },
+  },
 });
 
-const scratchDimensions = new Cartesian3();
 const scratchIntersect = new Cartesian4();
 const scratchNdcAabb = new Cartesian4();
 const scratchScale = new Cartesian3();
@@ -1287,7 +1358,7 @@ function updateVerticalExaggeration(primitive, frameState) {
       (primitive._minBounds.z - relativeHeight) * exaggeration + relativeHeight;
     primitive._exaggeratedMaxBounds.z =
       (primitive._maxBounds.z - relativeHeight) * exaggeration + relativeHeight;
-  } else if (primitive.shape === VoxelShapeType.BOX) {
+  } else {
     // Apply the exaggeration via the model matrix
     const exaggerationScale = Cartesian3.fromElements(
       1.0,
@@ -1397,12 +1468,16 @@ function initFromProvider(primitive, provider, context) {
 
   // Set uniforms that come from the provider.
   // Note that minBounds and maxBounds can be set dynamically, so their uniforms aren't set here.
-  uniforms.dimensions = Cartesian3.clone(
+  primitive._dimensions = Cartesian3.clone(
     provider.dimensions,
+    primitive._dimensions,
+  );
+  uniforms.dimensions = Cartesian3.clone(
+    primitive._dimensions,
     uniforms.dimensions,
   );
   primitive._paddingBefore = Cartesian3.clone(
-    defaultValue(provider.paddingBefore, Cartesian3.ZERO),
+    provider.paddingBefore ?? Cartesian3.ZERO,
     primitive._paddingBefore,
   );
   uniforms.paddingBefore = Cartesian3.clone(
@@ -1410,16 +1485,38 @@ function initFromProvider(primitive, provider, context) {
     uniforms.paddingBefore,
   );
   primitive._paddingAfter = Cartesian3.clone(
-    defaultValue(provider.paddingAfter, Cartesian3.ZERO),
-    primitive._paddingBefore,
+    provider.paddingAfter ?? Cartesian3.ZERO,
+    primitive._paddingAfter,
   );
   uniforms.paddingAfter = Cartesian3.clone(
     primitive._paddingAfter,
     uniforms.paddingAfter,
   );
+  primitive._inputDimensions = Cartesian3.add(
+    primitive._dimensions,
+    primitive._paddingBefore,
+    primitive._inputDimensions,
+  );
+  primitive._inputDimensions = Cartesian3.add(
+    primitive._inputDimensions,
+    primitive._paddingAfter,
+    primitive._inputDimensions,
+  );
+  if (provider.metadataOrder === VoxelMetadataOrder.Y_UP) {
+    const inputDimensionsY = primitive._inputDimensions.y;
+    primitive._inputDimensions.y = primitive._inputDimensions.z;
+    primitive._inputDimensions.z = inputDimensionsY;
+  }
+  uniforms.inputDimensions = Cartesian3.clone(
+    primitive._inputDimensions,
+    uniforms.inputDimensions,
+  );
 
   // Create the VoxelTraversal, and set related uniforms
-  primitive._traversal = setupTraversal(primitive, provider, context);
+  const keyframeCount = provider.keyframeCount ?? 1;
+  primitive._traversal = new VoxelTraversal(primitive, context, keyframeCount);
+  primitive.statistics.texturesByteLength =
+    primitive._traversal.textureMemoryByteLength;
   setTraversalUniforms(primitive._traversal, uniforms);
 }
 
@@ -1431,14 +1528,8 @@ function initFromProvider(primitive, provider, context) {
  * @private
  */
 function checkTransformAndBounds(primitive, provider) {
-  const shapeTransform = defaultValue(
-    provider.shapeTransform,
-    Matrix4.IDENTITY,
-  );
-  const globalTransform = defaultValue(
-    provider.globalTransform,
-    Matrix4.IDENTITY,
-  );
+  const shapeTransform = provider.shapeTransform ?? Matrix4.IDENTITY;
+  const globalTransform = provider.globalTransform ?? Matrix4.IDENTITY;
 
   // Compound model matrix = global transform * model matrix * shape transform
   Matrix4.multiplyTransformation(
@@ -1556,44 +1647,6 @@ function updateShapeAndTransforms(primitive, shape, provider) {
   return true;
 }
 
-/**
- * Set up a VoxelTraversal based on dimensions and types from the primitive and provider
- * @param {VoxelPrimitive} primitive
- * @param {VoxelProvider} provider
- * @param {Context} context
- * @returns {VoxelTraversal}
- * @private
- */
-function setupTraversal(primitive, provider, context) {
-  const dimensions = Cartesian3.clone(provider.dimensions, scratchDimensions);
-  Cartesian3.add(dimensions, primitive._paddingBefore, dimensions);
-  Cartesian3.add(dimensions, primitive._paddingAfter, dimensions);
-
-  // It's ok for memory byte length to be undefined.
-  // The system will choose a default memory size.
-  const maximumTileCount = provider.maximumTileCount;
-  const maximumTextureMemoryByteLength = defined(maximumTileCount)
-    ? VoxelTraversal.getApproximateTextureMemoryByteLength(
-        maximumTileCount,
-        dimensions,
-        provider.types,
-        provider.componentTypes,
-      )
-    : undefined;
-
-  const keyframeCount = defaultValue(provider.keyframeCount, 1);
-
-  return new VoxelTraversal(
-    primitive,
-    context,
-    dimensions,
-    provider.types,
-    provider.componentTypes,
-    keyframeCount,
-    maximumTextureMemoryByteLength,
-  );
-}
-
 /**
  * Set uniforms that come from the traversal.
  * @param {VoxelTraversal} traversal
@@ -1798,6 +1851,7 @@ VoxelPrimitive.prototype.destroy = function () {
 
   this._pickId = this._pickId && this._pickId.destroy();
   this._traversal = this._traversal && this._traversal.destroy();
+  this.statistics.texturesByteLength = 0;
   this._clippingPlanes = this._clippingPlanes && this._clippingPlanes.destroy();
 
   return destroyObject(this);
@@ -2074,12 +2128,13 @@ function DefaultVoxelProvider() {
 }
 
 DefaultVoxelProvider.prototype.requestData = function (options) {
-  const tileLevel = defined(options) ? defaultValue(options.tileLevel, 0) : 0;
+  const tileLevel = defined(options) ? (options.tileLevel ?? 0) : 0;
   if (tileLevel >= 1) {
     return undefined;
   }
 
-  return Promise.resolve([new Float32Array(1)]);
+  const content = new VoxelContent({ metadata: [new Float32Array(1)] });
+  return Promise.resolve(content);
 };
 
 VoxelPrimitive.DefaultProvider = new DefaultVoxelProvider();

package/Source/Scene/VoxelProvider.js

@@ -19,10 +19,11 @@ function VoxelProvider() {
 
 Object.defineProperties(VoxelProvider.prototype, {
   /**
-   * A transform from local space to global space. If undefined, the identity matrix will be used instead.
+   * A transform from local space to global space.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Matrix4|undefined}
+   * @type {Matrix4}
+   * @default Matrix4.IDENTITY
    * @readonly
    */
   globalTransform: {
@@ -30,10 +31,11 @@ Object.defineProperties(VoxelProvider.prototype, {
   },
 
   /**
-   * A transform from shape space to local space. If undefined, the identity matrix will be used instead.
+   * A transform from shape space to local space.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Matrix4|undefined}
+   * @type {Matrix4}
+   * @default Matrix4.IDENTITY
    * @readonly
    */
   shapeTransform: {
@@ -42,7 +44,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the {@link VoxelShapeType}
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {VoxelShapeType}
@@ -55,7 +56,6 @@ Object.defineProperties(VoxelProvider.prototype, {
   /**
    * Gets the minimum bounds.
    * If undefined, the shape's default minimum bounds will be used instead.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {Cartesian3|undefined}
@@ -68,7 +68,6 @@ Object.defineProperties(VoxelProvider.prototype, {
   /**
    * Gets the maximum bounds.
    * If undefined, the shape's default maximum bounds will be used instead.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {Cartesian3|undefined}
@@ -80,7 +79,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the number of voxels per dimension of a tile. This is the same for all tiles in the dataset.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {Cartesian3}
@@ -92,10 +90,10 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the number of padding voxels before the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Cartesian3|undefined}
+   * @type {Cartesian3}
+   * @default Cartesian3.ZERO
    * @readonly
    */
   paddingBefore: {
@@ -104,10 +102,10 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the number of padding voxels after the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {Cartesian3|undefined}
+   * @type {Cartesian3}
+   * @default Cartesian3.ZERO
    * @readonly
    */
   paddingAfter: {
@@ -116,7 +114,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the metadata names.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {string[]}
@@ -128,7 +125,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the metadata types.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {MetadataType[]}
@@ -140,7 +136,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the metadata component types.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {MetadataComponentType[]}
@@ -152,7 +147,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the metadata minimum values.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {number[][]|undefined}
@@ -164,7 +158,6 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the metadata maximum values.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
    * @type {number[][]|undefined}
@@ -175,8 +168,9 @@ Object.defineProperties(VoxelProvider.prototype, {
   },
 
   /**
-   * The maximum number of tiles that exist for this provider. This value is used as a hint to the voxel renderer to allocate an appropriate amount of GPU memory. If this value is not known it can be undefined.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
+   * The maximum number of tiles that exist for this provider.
+   * This value is used as a hint to the voxel renderer to allocate an appropriate amount of GPU memory.
+   * If this value is not known it can be undefined.
    *
    * @memberof VoxelProvider.prototype
    * @type {number|undefined}
@@ -198,10 +192,9 @@ Object.defineProperties(VoxelProvider.prototype, {
 
   /**
    * Gets the number of keyframes in the dataset.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
    *
    * @memberof VoxelProvider.prototype
-   * @type {number}
+   * @type {number|undefined}
    * @readonly
    * @private
    */
@@ -210,11 +203,11 @@ Object.defineProperties(VoxelProvider.prototype, {
   },
 
   /**
-   * Gets the {@link TimeIntervalCollection} for the dataset, or undefined if it doesn't have timestamps.
-   * This should not be called before {@link VoxelProvider#ready} returns true.
+   * Gets the {@link TimeIntervalCollection} for the dataset,
+   * or undefined if it doesn't have timestamps.
    *
    * @memberof VoxelProvider.prototype
-   * @type {TimeIntervalCollection}
+   * @type {TimeIntervalCollection|undefined}
    * @readonly
    * @private
    */
@@ -224,9 +217,7 @@ Object.defineProperties(VoxelProvider.prototype, {
 });
 
 /**
- * Requests the data for a given tile. The data is a flattened 3D array ordered by X, then Y, then Z.
- * This function should not be called before {@link VoxelProvider#ready} returns true.
- * @function
+ * Requests the data for a given tile.
  *
  * @param {object} [options] Object with the following properties:
  * @param {number} [options.tileLevel=0] The tile's level.
@@ -234,8 +225,10 @@ Object.defineProperties(VoxelProvider.prototype, {
  * @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.
+ * @returns {Promise<VoxelContent>|undefined} A promise resolving to a VoxelContent containing the data for the tile, or undefined if the request could not be scheduled this frame.
  */
-VoxelProvider.prototype.requestData = DeveloperError.throwInstantiationError;
+VoxelProvider.prototype.requestData = function (options) {
+  DeveloperError.throwInstantiationError();
+};
 
 export default VoxelProvider;

package/Source/Scene/VoxelRenderResources.js

@@ -19,6 +19,7 @@ import convertUvToCylinder from "../Shaders/Voxels/convertUvToCylinder.js";
 import convertUvToEllipsoid from "../Shaders/Voxels/convertUvToEllipsoid.js";
 import Octree from "../Shaders/Voxels/Octree.js";
 import Megatexture from "../Shaders/Voxels/Megatexture.js";
+import VoxelMetadataOrder from "./VoxelMetadataOrder.js";
 
 /**
  * Set up render resources, including basic shader code, for rendering
@@ -69,7 +70,7 @@ function VoxelRenderResources(primitive) {
   /**
    * A dictionary mapping uniform name to functions that return the uniform
    * values.
-   *
+   * @private
    * @type {Object<string, Function>}
    */
   this.uniformMap = uniformMap;
@@ -86,6 +87,30 @@ function VoxelRenderResources(primitive) {
   // Build shader
   shaderBuilder.addVertexLines([VoxelVS]);
 
+  if (primitive.provider.metadataOrder === VoxelMetadataOrder.Y_UP) {
+    shaderBuilder.addDefine(
+      "Y_UP_METADATA_ORDER",
+      undefined,
+      ShaderDestination.FRAGMENT,
+    );
+  }
+  const shapeType = primitive._provider.shape;
+  if (shapeType === "BOX") {
+    shaderBuilder.addDefine("SHAPE_BOX", undefined, ShaderDestination.FRAGMENT);
+  } else if (shapeType === "CYLINDER") {
+    shaderBuilder.addDefine(
+      "SHAPE_CYLINDER",
+      undefined,
+      ShaderDestination.FRAGMENT,
+    );
+  } else if (shapeType === "ELLIPSOID") {
+    shaderBuilder.addDefine(
+      "SHAPE_ELLIPSOID",
+      undefined,
+      ShaderDestination.FRAGMENT,
+    );
+  }
+
   shaderBuilder.addFragmentLines([
     customShader.fragmentShaderText,
     "#line 0",
@@ -124,7 +149,6 @@ function VoxelRenderResources(primitive) {
     shaderBuilder.addFragmentLines([IntersectDepth]);
   }
 
-  const shapeType = primitive._provider.shape;
   if (shapeType === "BOX") {
     shaderBuilder.addFragmentLines([
       convertUvToBox,
@@ -139,11 +163,6 @@ function VoxelRenderResources(primitive) {
       Intersection,
     ]);
   } else if (shapeType === "ELLIPSOID") {
-    shaderBuilder.addDefine(
-      "SHAPE_ELLIPSOID",
-      undefined,
-      ShaderDestination.FRAGMENT,
-    );
     shaderBuilder.addFragmentLines([
       convertUvToEllipsoid,
       IntersectLongitude,

package/Source/Scene/VoxelShape.js

@@ -26,6 +26,7 @@ Object.defineProperties(VoxelShape.prototype, {
    * @memberof VoxelShape.prototype
    * @type {OrientedBoundingBox}
    * @readonly
+   * @private
    */
   orientedBoundingBox: {
     get: DeveloperError.throwInstantiationError,
@@ -38,6 +39,7 @@ Object.defineProperties(VoxelShape.prototype, {
    * @memberof VoxelShape.prototype
    * @type {BoundingSphere}
    * @readonly
+   * @private
    */
   boundingSphere: {
     get: DeveloperError.throwInstantiationError,
@@ -50,6 +52,7 @@ Object.defineProperties(VoxelShape.prototype, {
    * @memberof VoxelShape.prototype
    * @type {Matrix4}
    * @readonly
+   * @private
    */
   boundTransform: {
     get: DeveloperError.throwInstantiationError,
@@ -62,6 +65,7 @@ Object.defineProperties(VoxelShape.prototype, {
    * @memberof VoxelShape.prototype
    * @type {Matrix4}
    * @readonly
+   * @private
    */
   shapeTransform: {
     get: DeveloperError.throwInstantiationError,
@@ -70,6 +74,7 @@ Object.defineProperties(VoxelShape.prototype, {
   /**
    * @type {Object<string, any>}
    * @readonly
+   * @private
    */
   shaderUniforms: {
     get: DeveloperError.throwInstantiationError,
@@ -78,6 +83,7 @@ Object.defineProperties(VoxelShape.prototype, {
   /**
    * @type {Object<string, any>}
    * @readonly
+   * @private
    */
   shaderDefines: {
     get: DeveloperError.throwInstantiationError,
@@ -87,6 +93,7 @@ Object.defineProperties(VoxelShape.prototype, {
    * The maximum number of intersections against the shape for any ray direction.
    * @type {number}
    * @readonly
+   * @private
    */
   shaderMaximumIntersectionsLength: {
     get: DeveloperError.throwInstantiationError,
@@ -95,7 +102,7 @@ Object.defineProperties(VoxelShape.prototype, {
 
 /**
  * Update the shape's state.
- *
+ * @private
  * @param {Matrix4} modelMatrix The model matrix.
  * @param {Cartesian3} minBounds The minimum bounds.
  * @param {Cartesian3} maxBounds The maximum bounds.
@@ -106,7 +113,7 @@ VoxelShape.prototype.update = DeveloperError.throwInstantiationError;
 /**
  * Computes an oriented bounding box for a specified tile.
  * The update function must be called before calling this function.
- *
+ * @private
  * @param {number} tileLevel The tile's level.
  * @param {number} tileX The tile's x coordinate.
  * @param {number} tileY The tile's y coordinate.
@@ -120,7 +127,7 @@ VoxelShape.prototype.computeOrientedBoundingBoxForTile =
 /**
  * Computes an oriented bounding box for a specified sample within a specified tile.
  * The update function must be called before calling this function.
- *
+ * @private
  * @param {SpatialNode} spatialNode The spatial node containing the sample
  * @param {Cartesian3} tileDimensions The size of the tile in number of samples, before padding
  * @param {Cartesian3} tileUv The sample coordinate within the tile