Streaming support, tidy ups

packages/scene/src/SceneMesh.ts

@@ -49,6 +49,11 @@ export class SceneMesh {
      */
     object: SceneObject | null;
 
+    /**
+     * TODO
+     */
+    streamLayerIndex: number;
+
     #color: FloatArrayParam;
     #matrix: FloatArrayParam;
     #metallic: number;
@@ -70,6 +75,7 @@ export class SceneMesh {
         roughness?: number;
         metallic?: number;
         origin?: FloatArrayParam;
+        streamLayerIndex?: number;
     }) {
         this.id = meshParams.id;
         this.#matrix = meshParams.matrix ? createMat4(meshParams.matrix) : identityMat4();
@@ -81,6 +87,7 @@ export class SceneMesh {
         this.roughness = (meshParams.roughness !== null && meshParams.roughness !== undefined) ? meshParams.roughness : 1;
         this.opacity = (meshParams.opacity !== undefined && meshParams.opacity !== null) ? meshParams.opacity : 1.0;
         this.origin = new Float32Array(meshParams.origin !== undefined ? meshParams.origin : [0, 0, 0]);
+        this.streamLayerIndex = meshParams.streamLayerIndex !== undefined ? meshParams.streamLayerIndex : 0;
     }
 
     /**
@@ -242,6 +249,7 @@ export class SceneMesh {
      */
     getJSON(): SceneMeshParams {
         const meshParams = <SceneMeshParams>{
+            streamLayerIndex: this.streamLayerIndex || 0,
             id: this.id,
             geometryId: this.geometry.id,
             color: Array.from(this.#color),

packages/scene/src/SceneMeshParams.ts

@@ -5,6 +5,11 @@ import type {FloatArrayParam} from "@xeokit/math";
  */
 export interface SceneMeshParams {
 
+    /**
+     * TODO
+     */
+    streamLayerIndex?: number;
+
     /**
      * ID for the new {@link @xeokit/scene!SceneMesh}, unique within the {@link @xeokit/scene!SceneModel}.
      */
@@ -21,7 +26,7 @@ export interface SceneMeshParams {
     geometryId: string;
 
     /**
-     * Optional ID of a {@link Transform} previously created with {@link @xeokit/scene!SceneModel.createTransform | SceneModel.createTransform}.
+     * Optional ID of a {@link SceneTransform} previously created with {@link @xeokit/scene!SceneModel.createTransform | SceneModel.createTransform}.
      */
     transformId?: string;
 
@@ -97,4 +102,4 @@ export interface SceneMeshParams {
      * Optional RTC coordinate origin for the new {@link @xeokit/scene!SceneMesh}.
      */
     origin?:FloatArrayParam;
-}
+}

packages/scene/src/SceneModel.ts

@@ -22,6 +22,7 @@ import type {SceneModelParams} from "./SceneModelParams";
 import type {Scene} from "./Scene";
 import type {SceneModelStats} from "./SceneModelStats";
 import {composeMat4, eulerToQuat, identityMat4, identityQuat} from "@xeokit/matrix";
+import {SceneModelStreamParams} from "./SceneModelStreamParams";
 
 // DTX texture types
 
@@ -88,6 +89,14 @@ TEXTURE_ENCODING_OPTIONS[OCCLUSION_TEXTURE] = {
  */
 export class SceneModel extends Component {
 
+    /**
+     * Indicates what renderer resources will need to be allocated in a {@link @xeokit/viewer!Viewer | Viewer's}
+     * {@link @xeokit/viewer!Renderer | Renderer} to support progressive loading for the {@link @xeokit/scene!SceneModel | SceneModel}.
+     *
+     * See {@link "@xeokit/scene" | @xeokit/scene}  for usage.
+     */
+   public  streamParams?: SceneModelStreamParams;
+
     /**
      * The {@link @xeokit/scene!Scene} that contains this SceneModel.
      */
@@ -222,6 +231,7 @@ export class SceneModel extends Component {
         this.#numObjects = 0;
         this.#meshUsedByObject = {};
 
+        this.streamParams = sceneModelParams.streamParams;
         this.id = sceneModelParams.id || "default";
         this.layerId = sceneModelParams.layerId;
         this.edgeThreshold = 10;
@@ -952,7 +962,9 @@ export class SceneModel extends Component {
             meshes: [],
             objects: []
         };
-
+        if (this.streamParams) {
+            sceneModelParams.streamParams = this.streamParams;
+        }
         Object.entries(this.geometries).forEach(([key, value]) => {
             sceneModelParams.geometriesCompressed.push((<SceneGeometry>value).getJSON());
         });

packages/scene/src/SceneModelParams.ts

@@ -3,10 +3,11 @@ import type {FloatArrayParam} from "@xeokit/math";
 import type {SceneGeometryCompressedParams} from "./SceneGeometryCompressedParams";
 import type {SceneTextureParams} from "./SceneTextureParams";
 import type {SceneTextureSetParams} from "./SceneTextureSetParams";
-import type {SceneObject} from "./SceneObject";
+
 import type {SceneMeshParams} from "./SceneMeshParams";
 import type {SceneGeometryParams} from "./SceneGeometryParams";
 import type {SceneObjectParams} from "./SceneObjectParams";
+import {SceneModelStreamParams} from "./SceneModelStreamParams";
 
 
 /**
@@ -16,6 +17,13 @@ import type {SceneObjectParams} from "./SceneObjectParams";
  */
 export interface SceneModelParams {
 
+
+    /**
+     * Indicates what renderer resources will need to be allocated in a {@link @xeokit/viewer!Viewer | Viewer's}
+     * {@link @xeokit/viewer!Renderer | Renderer} to support progressive loading for a {@link @xeokit/scene!SceneModel | SceneModel}.
+     */
+    streamParams?: SceneModelStreamParams;
+
     /**
      * Unique ID for the SceneModel.
      *

packages/scene/src/SceneModelStreamLayerParams.ts

@@ -0,0 +1,33 @@
+
+/**
+ * Indicates storage to allocate in a renderer layer.
+ *
+ * Stored in {@link @scene/SceneModelStreamParams.layers | SceneModelStreamParams.layers}.
+ */
+export interface SceneModelStreamLayerParams {
+
+    /**
+     * Number of 32-bit geometry indices to allocate in the renderer layer.
+     */
+    numIndices32Bits: number;
+
+    /**
+     * Number of 16-bit geometry indices to allocate in the renderer layer.
+     */
+    numIndices16Bits: number;
+
+    /**
+     * Number of 8-bit geometry indices to allocate in the renderer layer.
+     */
+    numIndices8Bits: number;
+
+    /**
+     * Number of geometry vertices to allocate in the renderer layer.
+     */
+    numVertices: number;
+
+    /**
+     * Number of submeshes to allocate in the renderer layer.
+     */
+    numSubMeshes: number;
+}

packages/scene/src/SceneModelStreamParams.ts

@@ -0,0 +1,17 @@
+import {SceneModelStreamLayerParams} from "./SceneModelStreamLayerParams";
+
+/**
+ * Indicates what renderer resources will need to be allocated in a {@link @xeokit/viewer!Viewer | Viewer's}
+ * {@link @xeokit/viewer!Renderer | Renderer} to support progressive loading for a {@link @xeokit/scene!SceneModel | SceneModel}.
+ *
+ * See {@link "@xeokit/scene" | @xeokit/scene}  for usage.
+ */
+export interface SceneModelStreamParams {
+
+    /**
+     * Indicates what renderer layers will need to be allocated.
+     */
+    streamLayers: SceneModelStreamLayerParams[];
+}
+
+

packages/scene/src/index.ts

@@ -379,6 +379,10 @@
  * const buffers = thetexture.buffers; // ArrayBuffer[]
  * ````
  *
+ * ### Preparing a SceneModel for Progressive Loading
+ *
+ * TODO: Create in separate tutorial - too complex for here
+ *
  * @module @xeokit/scene
  */
 
@@ -410,4 +414,7 @@ export * from "./SceneGeometryParams";
 export * from "./SceneModelParams";
 export * from "./compressGeometryParams";
 
-export * from "./getSceneObjectGeometry";
+export * from "./getSceneObjectGeometry";
+
+export * from "./SceneModelStreamParams";
+export * from "./SceneModelStreamLayerParams";