BufferPrimitiveCollection: Add 3D renderers

.github/workflows/dev.yml

@@ -1,7 +1,7 @@
 name: dev
-on: 
+on:
   push:
-    branches: 
+    branches:
       - main
   pull_request:
 concurrency:
@@ -24,6 +24,8 @@ jobs:
         run: npm run markdownlint
       - name: format code
         run: npm run prettier-check
+      - name: build
+        run: npm run build
       - name: tsc
         run: npm run tsc
   coverage:
@@ -80,4 +82,4 @@ jobs:
         run: npm pack &> /dev/null
       - name: package workspace modules
         run: npm pack --workspaces &> /dev/null
-      - uses: ./.github/actions/verify-package
+      - uses: ./.github/actions/verify-package

.github/workflows/prod.yml

@@ -30,6 +30,8 @@ jobs:
         run: npm run markdownlint
       - name: format code
         run: npm run prettier-check
+      - name: build
+        run: npm run build
       - name: tsc
         run: npm run tsc
 

packages/engine/Source/Renderer/RenderState.js

@@ -496,7 +496,7 @@ RenderState.fromCache = function (renderState) {
 };
 
 /**
- * @private
+ * @ignore
  */
 RenderState.removeFromCache = function (renderState) {
   const states = new RenderState(renderState);

packages/engine/Source/Renderer/VertexArray.js

@@ -12,6 +12,9 @@ import Buffer from "./Buffer.js";
 import BufferUsage from "./BufferUsage.js";
 import ContextLimits from "./ContextLimits.js";
 import AttributeType from "../Scene/AttributeType.js";
+import assert from "../Core/assert.js";
+
+/** @import {TypedArray, TypedArrayConstructor} from "../Core/globalTypes.js"; */
 
 function addAttribute(attributes, attribute, index, context) {
   const hasVertexBuffer = defined(attribute.vertexBuffer);
@@ -801,6 +804,83 @@ function setConstantAttributes(vertexArray, gl) {
   }
 }
 
+/**
+ * Copies into a vertex attribute buffer from the given array, at a given
+ * range specified as offset and count, in number of (VECN) vertices. Array
+ * and vertex attribute must have the same length, which can be larger
+ * than the specified range to update.
+ * @param {number} attributeIndex
+ * @param {TypedArray} array
+ * @param {number} vertexOffset
+ * @param {number} vertexCount
+ */
+VertexArray.prototype.copyAttributeFromRange = function (
+  attributeIndex,
+  array,
+  vertexOffset,
+  vertexCount,
+) {
+  const attribute = this.getAttribute(attributeIndex);
+  const buffer = /** @type {Buffer} */ (attribute.vertexBuffer);
+  const elementsPerVertex = attribute.componentsPerAttribute;
+
+  //>>includeStart('debug', pragmas.debug);
+  assert(buffer.sizeInBytes === array.byteLength, "Invalid buffer length");
+  //>>includeEnd('debug');
+
+  const ArrayConstructor = /** @type {TypedArrayConstructor} */ (
+    array.constructor
+  );
+
+  const byteOffset =
+    vertexOffset * elementsPerVertex * ArrayConstructor.BYTES_PER_ELEMENT;
+
+  // Create a zero-copy ArrayView onto the specified range of the source array.
+  const rangeArrayView = new ArrayConstructor(
+    /** @type {ArrayBuffer} */ (array.buffer),
+    array.byteOffset + byteOffset,
+    vertexCount * elementsPerVertex,
+  );
+
+  buffer.copyFromArrayView(rangeArrayView, byteOffset);
+};
+
+/**
+ * Copies into the index buffer from the given array, at a given range
+ * specified as offset and count, in number of (uint) indices. Array
+ * and index buffer must have the same length, which can be larger
+ * than the specified range to update.
+ * @param {TypedArray} array
+ * @param {number} indexOffset
+ * @param {number} indexCount
+ */
+VertexArray.prototype.copyIndexFromRange = function (
+  array,
+  indexOffset,
+  indexCount,
+) {
+  const buffer = /** @type {Buffer} */ (this._indexBuffer);
+
+  //>>includeStart('debug', pragmas.debug);
+  assert(buffer.sizeInBytes === array.byteLength, "Invalid buffer length");
+  //>>includeEnd('debug');
+
+  const ArrayConstructor = /** @type {TypedArrayConstructor} */ (
+    array.constructor
+  );
+
+  const byteOffset = indexOffset * ArrayConstructor.BYTES_PER_ELEMENT;
+
+  // Create a zero-copy ArrayView onto the specified range of the source array.
+  const rangeArrayView = new ArrayConstructor(
+    /** @type {ArrayBuffer} */ (array.buffer),
+    array.byteOffset + byteOffset,
+    indexCount,
+  );
+
+  buffer.copyFromArrayView(rangeArrayView, byteOffset);
+};
+
 VertexArray.prototype._bind = function () {
   if (defined(this._vao)) {
     this._context.glBindVertexArray(this._vao);

packages/engine/Source/Scene/BufferPointCollection.js

@@ -4,12 +4,15 @@ import BufferPrimitiveCollection from "./BufferPrimitiveCollection.js";
 import BufferPoint from "./BufferPoint.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import Frozen from "../Core/Frozen.js";
+import renderPoints from "./renderBufferPointCollection.js";
 
 /** @import Color from "../Core/Color.js"; */
-/** @import FrameState from "./FrameState.js" */
+/** @import Matrix4 from "../Core/Matrix4.js"; */
+/** @import FrameState from "./FrameState.js"; */
 
 /**
  * @typedef {object} BufferPointOptions
+ * @property {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] Transforms geometry from model to world coordinates.
  * @property {boolean} [show=true]
  * @property {Color} [color=Color.WHITE]
  * @property {Cartesian3} [position=Cartesian3.ZERO]
@@ -116,6 +119,10 @@ class BufferPointCollection extends BufferPrimitiveCollection {
    */
   update(frameState) {
     super.update(frameState);
+
+    if (this.show) {
+      this._renderContext = renderPoints(this, frameState, this._renderContext);
+    }
   }
 }
 

packages/engine/Source/Scene/BufferPolygonCollection.js

@@ -5,17 +5,20 @@ import BufferPrimitiveCollection from "./BufferPrimitiveCollection.js";
 import BufferPolygon from "./BufferPolygon.js";
 import Frozen from "../Core/Frozen.js";
 import assert from "../Core/assert.js";
-import ComponentDatatype from "../Core/ComponentDatatype.js";
 import IndexDatatype from "../Core/IndexDatatype.js";
+import renderPolygons from "./renderBufferPolygonCollection.js";
 
 /** @import { TypedArray } from "../Core/globalTypes.js"; */
 /** @import Color from "../Core/Color.js"; */
+/** @import Matrix4 from "../Core/Matrix4.js"; */
 /** @import FrameState from "./FrameState.js" */
+/** @import ComponentDatatype from "../Core/ComponentDatatype.js"; */
 
 const { ERR_CAPACITY } = BufferPrimitiveCollection.Error;
 
 /**
  * @typedef {object} BufferPolygonOptions
+ * @property {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] Transforms geometry from model to world coordinates.
  * @property {boolean} [show=true]
  * @property {Color} [color=Color.WHITE]
  * @property {TypedArray} [positions]
@@ -73,7 +76,6 @@ class BufferPolygonCollection extends BufferPrimitiveCollection {
    * @param {number} [options.holeCountMax=BufferPrimitiveCollection.DEFAULT_CAPACITY]
    * @param {number} [options.triangleCountMax=BufferPrimitiveCollection.DEFAULT_CAPACITY]
    * @param {ComponentDatatype} [options.positionDatatype=ComponentDatatype.DOUBLE]
-   * @param {IndexDatatype} [options.indexDatatype=IndexDatatype.UNSIGNED_INT]
    * @param {boolean} [options.show=true]
    * @param {boolean} [options.debugShowBoundingVolume=false]
    */
@@ -120,15 +122,8 @@ class BufferPolygonCollection extends BufferPrimitiveCollection {
      */
     this._triangleIndexView = null;
 
-    this._allocateHoleIndexBuffer(
-      // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-      options.indexDatatype ?? IndexDatatype.UNSIGNED_INT,
-    );
-
-    this._allocateTriangleIndexBuffer(
-      // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-      options.indexDatatype ?? IndexDatatype.UNSIGNED_INT,
-    );
+    this._allocateHoleIndexBuffer();
+    this._allocateTriangleIndexBuffer();
   }
 
   _getCollectionClass() {
@@ -143,27 +138,25 @@ class BufferPolygonCollection extends BufferPrimitiveCollection {
   // COLLECTION LIFECYCLE
 
   /**
-   * @param {IndexDatatype} datatype
    * @private
    * @ignore
    */
-  _allocateHoleIndexBuffer(datatype) {
+  _allocateHoleIndexBuffer() {
     // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-    this._holeIndexView = ComponentDatatype.createTypedArray(
-      datatype,
+    this._holeIndexView = IndexDatatype.createTypedArray(
+      this._positionCountMax,
       this._holeCountMax,
     );
   }
 
   /**
-   * @param {IndexDatatype} datatype
    * @private
    * @ignore
    */
-  _allocateTriangleIndexBuffer(datatype) {
+  _allocateTriangleIndexBuffer() {
     // @ts-expect-error Requires https://github.com/CesiumGS/cesium/pull/13203.
-    this._triangleIndexView = ComponentDatatype.createTypedArray(
-      datatype,
+    this._triangleIndexView = IndexDatatype.createTypedArray(
+      this._positionCountMax,
       this._triangleCountMax * 3,
     );
   }
@@ -292,6 +285,14 @@ class BufferPolygonCollection extends BufferPrimitiveCollection {
    */
   update(frameState) {
     super.update(frameState);
+
+    if (this.show) {
+      this._renderContext = renderPolygons(
+        this,
+        frameState,
+        this._renderContext,
+      );
+    }
   }
 
   /////////////////////////////////////////////////////////////////////////////

packages/engine/Source/Scene/BufferPolylineCollection.js

@@ -3,13 +3,16 @@
 import defined from "../Core/defined.js";
 import BufferPrimitiveCollection from "./BufferPrimitiveCollection.js";
 import BufferPolyline from "./BufferPolyline.js";
+import renderPolylines from "./renderBufferPolylineCollection.js";
 
 /** @import { TypedArray } from "../Core/globalTypes.js"; */
 /** @import Color from "../Core/Color.js"; */
+/** @import Matrix4 from "../Core/Matrix4.js"; */
 /** @import FrameState from "./FrameState.js" */
 
 /**
  * @typedef {object} BufferPolylineOptions
+ * @property {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] Transforms geometry from model to world coordinates.
  * @property {boolean} [show=true]
  * @property {Color} [color=Color.WHITE]
  * @property {TypedArray} [positions]
@@ -115,6 +118,14 @@ class BufferPolylineCollection extends BufferPrimitiveCollection {
    */
   update(frameState) {
     super.update(frameState);
+
+    if (this.show) {
+      this._renderContext = renderPolylines(
+        this,
+        frameState,
+        this._renderContext,
+      );
+    }
   }
 }
 

packages/engine/Source/Scene/BufferPrimitiveCollection.js

@@ -5,8 +5,10 @@ import Color from "../Core/Color.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import Frozen from "../Core/Frozen.js";
+import Matrix4 from "../Core/Matrix4.js";
 import assert from "../Core/assert.js";
 import ComponentDatatype from "../Core/ComponentDatatype.js";
+import defined from "../Core/defined.js";
 
 /** @import { TypedArray, TypedArrayConstructor } from "../Core/globalTypes.js"; */
 /** @import BufferPrimitive from "./BufferPrimitive.js"; */
@@ -63,13 +65,14 @@ class BufferPrimitiveCollection {
    * implementations, so the collection should be ignorant of the renderer's implementation
    * and context data. A collection only has one renderer active at a time.
    *
-   * @type {unknown}
+   * @type {{destroy: Function}|null}
    * @ignore
    */
   _renderContext = null;
 
   /**
    * @param {object} options
+   * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] Transforms geometry from model to world coordinates.
    * @param {number} [options.primitiveCountMax=BufferPrimitiveCollection.DEFAULT_CAPACITY]
    * @param {number} [options.vertexCountMax=BufferPrimitiveCollection.DEFAULT_CAPACITY]
    * @param {boolean} [options.show=true]
@@ -85,12 +88,26 @@ class BufferPrimitiveCollection {
     this.show = options.show ?? true;
 
     /**
-     * Bounding volume for all primitives in the collection, including both
+     * Transforms geometry from model to world coordinates.
+     * @type {Matrix4}
+     * @default Matrix4.IDENTITY
+     */
+    this.modelMatrix = Matrix4.clone(options.modelMatrix ?? Matrix4.IDENTITY);
+
+    /**
+     * Local bounding volume for all primitives in the collection, including both
      * shown and hidden primitives.
      * @type {BoundingSphere}
      */
     this.boundingVolume = new BoundingSphere();
 
+    /**
+     * World bounding volume for all primitives in the collection, including both
+     * shown and hidden primitives.
+     * @type {BoundingSphere}
+     */
+    this.boundingVolumeWC = new BoundingSphere();
+
     /**
      * This property is for debugging only; it is not for production use nor is it optimized.
      * <p>
@@ -234,6 +251,16 @@ class BufferPrimitiveCollection {
     return false;
   }
 
+  /** Destroys collection and its GPU resources. */
+  destroy() {
+    if (defined(this._renderContext)) {
+      this._renderContext.destroy();
+      this._renderContext = undefined;
+      this._dirtyOffset = 0;
+      this._dirtyCount = this.primitiveCount;
+    }
+  }
+
   /**
    * Sorts primitives of the collection.
    *
@@ -390,7 +417,11 @@ class BufferPrimitiveCollection {
       3,
       this.boundingVolume,
     );
-
+    BoundingSphere.transform(
+      this.boundingVolume,
+      this.modelMatrix,
+      this.boundingVolumeWC,
+    );
     this._dirtyBoundingVolume = false;
   }