@cesium/engine 24.0.0 → 26.0.0

package/Source/Scene/renderBufferPointCollection.js

@@ -19,40 +19,51 @@ import BufferPointMaterialVS from "../Shaders/BufferPointMaterialVS.js";
 import BufferPointMaterialFS from "../Shaders/BufferPointMaterialFS.js";
 import EncodedCartesian3 from "../Core/EncodedCartesian3.js";
 import AttributeCompression from "../Core/AttributeCompression.js";
-import Matrix4 from "../Core/Matrix4.js";
-import BoundingSphere from "../Core/BoundingSphere.js";
 import BufferPointMaterial from "./BufferPointMaterial.js";
+import BlendOption from "./BlendOption.js";
 
 /** @import FrameState from "./FrameState.js"; */
 /** @import BufferPointCollection from "./BufferPointCollection.js"; */
-/** @import {Destroyable, TypedArray} from "../Core/globalTypes.js"; */
+/** @import {TypedArray} from "../Core/globalTypes.js"; */
 
 /**
  * TODO(PR#13211): Need 'keyof' syntax to avoid duplicating attribute names.
- * @typedef {'positionHigh' | 'positionLow' | 'pickColor' | 'showSizeAndColor' | 'outlineWidthAndOutlineColor'} BufferPointAttribute
+ * @typedef {'positionHigh' | 'positionLow' | 'pickColor' | 'showSizeColorAlpha' | 'outlineWidthColorAlpha'} BufferPointAttribute
  * @ignore
  */
 
 /**
+ * Attribute locations when using 64-bit position precision.
  * @type {Record<BufferPointAttribute, number>}
  * @ignore
  */
-const BufferPointAttributeLocations = {
+const BufferPointAttributeLocationsFloat64 = {
   positionHigh: 0,
   positionLow: 1,
   pickColor: 2,
-  showSizeAndColor: 3,
-  outlineWidthAndOutlineColor: 4,
+  showSizeColorAlpha: 3,
+  outlineWidthColorAlpha: 4,
+};
+
+/**
+ * Attribute locations when using <= 32-bit position precision.
+ * @type {Record<string, number>}
+ * @ignore
+ */
+const BufferPointAttributeLocations = {
+  position: 0,
+  pickColor: 1,
+  showSizeColorAlpha: 2,
+  outlineWidthColorAlpha: 3,
 };
 
 /**
  * @typedef {object} BufferPointRenderContext
  * @property {VertexArray} [vertexArray]
- * @property {Record<BufferPointAttribute, TypedArray>} [attributeArrays]
+ * @property {Record<string, TypedArray>} [attributeArrays]
  * @property {RenderState} [renderState]
  * @property {ShaderProgram} [shaderProgram]
  * @property {DrawCommand} [command]
- * @property {Destroyable[]} [pickIds] Unordered list of collection PickIds.
  * @property {Function} destroy
  * @ignore
  */
@@ -74,32 +85,33 @@ const encodedCartesian = new EncodedCartesian3();
 function renderBufferPointCollection(collection, frameState, renderContext) {
   const context = frameState.context;
   renderContext = renderContext || { destroy: destroyRenderContext };
+  const useFloat64 = collection._positionDatatype === ComponentDatatype.DOUBLE;
+  const attributeLocations = useFloat64
+    ? BufferPointAttributeLocationsFloat64
+    : BufferPointAttributeLocations;
 
   if (!defined(renderContext.attributeArrays)) {
     const featureCountMax = collection.primitiveCountMax;
 
     renderContext.attributeArrays = {
-      positionHigh: new Float32Array(featureCountMax * 3),
-      positionLow: new Float32Array(featureCountMax * 3),
+      ...(useFloat64
+        ? {
+            positionHigh: new Float32Array(featureCountMax * 3),
+            positionLow: new Float32Array(featureCountMax * 3),
+          }
+        : { position: collection._positionView }),
       pickColor: new Uint8Array(featureCountMax * 4),
-      showSizeAndColor: new Float32Array(featureCountMax * 3),
-      outlineWidthAndOutlineColor: new Float32Array(featureCountMax * 2),
+      showSizeColorAlpha: new Float32Array(featureCountMax * 4),
+      outlineWidthColorAlpha: new Float32Array(featureCountMax * 3),
     };
   }
 
-  if (!defined(renderContext.pickIds)) {
-    renderContext.pickIds = [];
-  }
-
   if (collection._dirtyCount > 0) {
-    const { attributeArrays, pickIds } = renderContext;
+    const { attributeArrays } = renderContext;
 
-    const positionHighArray = attributeArrays.positionHigh;
-    const positionLowArray = attributeArrays.positionLow;
     const pickColorArray = attributeArrays.pickColor;
-    const showSizeAndColorArray = attributeArrays.showSizeAndColor;
-    const outlineWidthAndOutlineColorArray =
-      attributeArrays.outlineWidthAndOutlineColor;
+    const showSizeColorAlphaArray = attributeArrays.showSizeColorAlpha;
+    const outlineWidthColorAlphaArray = attributeArrays.outlineWidthColorAlpha;
 
     const { _dirtyOffset, _dirtyCount } = collection;
 
@@ -110,46 +122,37 @@ function renderBufferPointCollection(collection, frameState, renderContext) {
         continue;
       }
 
-      if (collection._allowPicking && point._pickId === 0) {
-        const pickId = context.createPickId({
-          collection,
-          index: i,
-          get primitive() {
-            // Cannot reuse primitives; scene.drillPick() appends to a list.
-            return collection.get(this.index, new BufferPoint());
-          },
-        });
-        point._pickId = pickId.key;
-        pickIds.push(pickId);
+      if (useFloat64) {
+        point.getPosition(cartesian);
+        EncodedCartesian3.fromCartesian(cartesian, encodedCartesian);
+        attributeArrays.positionHigh[i * 3] = encodedCartesian.high.x;
+        attributeArrays.positionHigh[i * 3 + 1] = encodedCartesian.high.y;
+        attributeArrays.positionHigh[i * 3 + 2] = encodedCartesian.high.z;
+        attributeArrays.positionLow[i * 3] = encodedCartesian.low.x;
+        attributeArrays.positionLow[i * 3 + 1] = encodedCartesian.low.y;
+        attributeArrays.positionLow[i * 3 + 2] = encodedCartesian.low.z;
       }
 
-      point.getPosition(cartesian);
-      EncodedCartesian3.fromCartesian(cartesian, encodedCartesian);
       point.getMaterial(material);
       Color.fromRgba(point._pickId, pickColor);
 
-      positionHighArray[i * 3] = encodedCartesian.high.x;
-      positionHighArray[i * 3 + 1] = encodedCartesian.high.y;
-      positionHighArray[i * 3 + 2] = encodedCartesian.high.z;
-
-      positionLowArray[i * 3] = encodedCartesian.low.x;
-      positionLowArray[i * 3 + 1] = encodedCartesian.low.y;
-      positionLowArray[i * 3 + 2] = encodedCartesian.low.z;
-
       pickColorArray[i * 4] = Color.floatToByte(pickColor.red);
       pickColorArray[i * 4 + 1] = Color.floatToByte(pickColor.green);
       pickColorArray[i * 4 + 2] = Color.floatToByte(pickColor.blue);
       pickColorArray[i * 4 + 3] = Color.floatToByte(pickColor.alpha);
 
-      showSizeAndColorArray[i * 3] = point.show ? 1 : 0;
-      showSizeAndColorArray[i * 3 + 1] = material.size;
-      showSizeAndColorArray[i * 3 + 2] = AttributeCompression.encodeRGB8(
+      showSizeColorAlphaArray[i * 4] = point.show ? 1 : 0;
+      showSizeColorAlphaArray[i * 4 + 1] = material.size;
+      showSizeColorAlphaArray[i * 4 + 2] = AttributeCompression.encodeRGB8(
         material.color,
       );
+      showSizeColorAlphaArray[i * 4 + 3] = material.color.alpha;
 
-      outlineWidthAndOutlineColorArray[i * 2] = material.outlineWidth;
-      outlineWidthAndOutlineColorArray[i * 2 + 1] =
-        AttributeCompression.encodeRGB8(material.outlineColor);
+      outlineWidthColorAlphaArray[i * 3] = material.outlineWidth;
+      outlineWidthColorAlphaArray[i * 3 + 1] = AttributeCompression.encodeRGB8(
+        material.outlineColor,
+      );
+      outlineWidthColorAlphaArray[i * 3 + 2] = material.outlineColor.alpha;
 
       point._dirty = false;
     }
@@ -161,69 +164,80 @@ function renderBufferPointCollection(collection, frameState, renderContext) {
     renderContext.vertexArray = new VertexArray({
       context,
       attributes: [
+        ...(!useFloat64
+          ? [
+              {
+                index: BufferPointAttributeLocations.position,
+                componentDatatype: collection._positionDatatype,
+                componentsPerAttribute: 3,
+                normalize: collection._positionNormalized,
+                vertexBuffer: Buffer.createVertexBuffer({
+                  typedArray: collection._positionView,
+                  context,
+                  usage: BufferUsage.STATIC_DRAW,
+                }),
+              },
+            ]
+          : [
+              {
+                index: BufferPointAttributeLocationsFloat64.positionHigh,
+                componentDatatype: ComponentDatatype.FLOAT,
+                componentsPerAttribute: 3,
+                vertexBuffer: Buffer.createVertexBuffer({
+                  typedArray: attributeArrays.positionHigh,
+                  context,
+                  usage: BufferUsage.STATIC_DRAW,
+                }),
+              },
+              {
+                index: BufferPointAttributeLocationsFloat64.positionLow,
+                componentDatatype: ComponentDatatype.FLOAT,
+                componentsPerAttribute: 3,
+                vertexBuffer: Buffer.createVertexBuffer({
+                  typedArray: attributeArrays.positionLow,
+                  context,
+                  usage: BufferUsage.STATIC_DRAW,
+                }),
+              },
+            ]),
         {
-          index: BufferPointAttributeLocations.positionHigh,
-          componentDatatype: ComponentDatatype.FLOAT,
-          componentsPerAttribute: 3,
-          vertexBuffer: Buffer.createVertexBuffer({
-            typedArray: attributeArrays.positionHigh,
-            context,
-            // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-            usage: BufferUsage.STATIC_DRAW,
-          }),
-        },
-        {
-          index: BufferPointAttributeLocations.positionLow,
-          componentDatatype: ComponentDatatype.FLOAT,
-          componentsPerAttribute: 3,
-          vertexBuffer: Buffer.createVertexBuffer({
-            typedArray: attributeArrays.positionLow,
-            context,
-            // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-            usage: BufferUsage.STATIC_DRAW,
-          }),
-        },
-        {
-          index: BufferPointAttributeLocations.pickColor,
+          index: attributeLocations.pickColor,
           componentDatatype: ComponentDatatype.UNSIGNED_BYTE,
           componentsPerAttribute: 4,
           vertexBuffer: Buffer.createVertexBuffer({
             typedArray: attributeArrays.pickColor,
             context,
-            // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
             usage: BufferUsage.STATIC_DRAW,
           }),
         },
         {
-          index: BufferPointAttributeLocations.showSizeAndColor,
+          index: attributeLocations.showSizeColorAlpha,
           componentDatatype: ComponentDatatype.FLOAT,
-          componentsPerAttribute: 3,
+          componentsPerAttribute: 4,
           vertexBuffer: Buffer.createVertexBuffer({
-            typedArray: attributeArrays.showSizeAndColor,
+            typedArray: attributeArrays.showSizeColorAlpha,
             context,
-            // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
             usage: BufferUsage.STATIC_DRAW,
           }),
         },
         {
-          index: BufferPointAttributeLocations.outlineWidthAndOutlineColor,
+          index: attributeLocations.outlineWidthColorAlpha,
           componentDatatype: ComponentDatatype.FLOAT,
-          componentsPerAttribute: 2,
+          componentsPerAttribute: 3,
           vertexBuffer: Buffer.createVertexBuffer({
-            typedArray: attributeArrays.outlineWidthAndOutlineColor,
+            typedArray: attributeArrays.outlineWidthColorAlpha,
             context,
-            // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
             usage: BufferUsage.STATIC_DRAW,
           }),
         },
       ],
     });
   } else if (collection._dirtyCount > 0) {
-    for (const key in BufferPointAttributeLocations) {
-      if (Object.hasOwn(BufferPointAttributeLocations, key)) {
+    for (const key in attributeLocations) {
+      if (Object.hasOwn(attributeLocations, key)) {
         const attribute = /** @type {BufferPointAttribute} */ (key);
         renderContext.vertexArray.copyAttributeFromRange(
-          BufferPointAttributeLocations[attribute],
+          attributeLocations[attribute],
           renderContext.attributeArrays[attribute],
           collection._dirtyOffset,
           collection._dirtyCount,
@@ -234,7 +248,10 @@ function renderBufferPointCollection(collection, frameState, renderContext) {
 
   if (!defined(renderContext.renderState)) {
     renderContext.renderState = RenderState.fromCache({
-      blending: BlendingState.ALPHA_BLEND,
+      blending:
+        collection._blendOption === BlendOption.OPAQUE
+          ? BlendingState.DISABLED
+          : BlendingState.ALPHA_BLEND,
       depthTest: { enabled: true },
     });
   }
@@ -244,34 +261,45 @@ function renderBufferPointCollection(collection, frameState, renderContext) {
       context,
       vertexShaderSource: new ShaderSource({
         sources: [BufferPointMaterialVS],
+        defines: useFloat64 ? ["USE_FLOAT64"] : [],
       }),
       fragmentShaderSource: new ShaderSource({
         sources: [BufferPointMaterialFS],
       }),
-      attributeLocations: BufferPointAttributeLocations,
+      attributeLocations,
     });
   }
 
-  if (
-    !defined(renderContext.command) ||
-    isCommandDirty(collection, renderContext.command)
-  ) {
+  if (!defined(renderContext.command)) {
     renderContext.command = new DrawCommand({
       vertexArray: renderContext.vertexArray,
       renderState: renderContext.renderState,
       shaderProgram: renderContext.shaderProgram,
       primitiveType: PrimitiveType.POINTS,
-      pass: Pass.OPAQUE,
-      pickId: "v_pickColor",
+      pass:
+        collection._blendOption === BlendOption.OPAQUE
+          ? Pass.OPAQUE
+          : Pass.TRANSLUCENT,
+      pickId: collection._allowPicking ? "v_pickColor" : undefined,
       owner: collection,
       count: collection.primitiveCount,
-      modelMatrix: collection.modelMatrix,
-      boundingVolume: collection.boundingVolumeWC,
+      modelMatrix: collection.modelMatrix, // shared reference
+      boundingVolume: collection.boundingVolume, // shared reference
       debugShowBoundingVolume: collection.debugShowBoundingVolume,
     });
   }
 
-  frameState.commandList.push(renderContext.command);
+  const command = renderContext.command;
+
+  if (command.count !== collection.primitiveCount) {
+    command.count = collection.primitiveCount;
+  }
+
+  if (command.debugShowBoundingVolume !== collection.debugShowBoundingVolume) {
+    command.debugShowBoundingVolume = collection.debugShowBoundingVolume;
+  }
+
+  frameState.commandList.push(command);
 
   collection._dirtyCount = 0;
   collection._dirtyOffset = 0;
@@ -279,31 +307,6 @@ function renderBufferPointCollection(collection, frameState, renderContext) {
   return renderContext;
 }
 
-/**
- * Returns true if DrawCommand is out of date for the given collection.
- * @param {BufferPointCollection} collection
- * @param {DrawCommand} command
- * @ignore
- */
-function isCommandDirty(collection, command) {
-  const isModelMatrixEqual = Matrix4.equals(
-    collection.modelMatrix,
-    command._modelMatrix,
-  );
-
-  const isBoundingVolumeEqual = BoundingSphere.equals(
-    collection.boundingVolumeWC,
-    command._boundingVolume,
-  );
-
-  return (
-    collection.primitiveCount !== command._count ||
-    collection.debugShowBoundingVolume !== command.debugShowBoundingVolume ||
-    !isModelMatrixEqual ||
-    !isBoundingVolumeEqual
-  );
-}
-
 /**
  * Destroys render context resources. Deleting properties from the context
  * object isn't necessary, as collection.destroy() will discard the object.
@@ -323,12 +326,6 @@ function destroyRenderContext() {
   if (defined(context.renderState)) {
     RenderState.removeFromCache(context.renderState);
   }
-
-  if (defined(context.pickIds)) {
-    for (const pickId of context.pickIds) {
-      pickId.destroy();
-    }
-  }
 }
 
 export default renderBufferPointCollection;