@loaders.gl/i3s 3.2.0-alpha.1 → 3.2.0-alpha.4

package/src/lib/helpers/i3s-nodepages-tiles.ts

@@ -28,6 +28,7 @@ export default class I3SNodePagesTiles {
   options: LoaderOptions;
   lodSelectionMetricType?: string;
   textureDefinitionsSelectedFormats: ({format: I3STextureFormat; name: string} | null)[] = [];
+  nodesInNodePages: number;
   private textureLoaderOptions: {[key: string]: any} = {};
 
   /**
@@ -41,6 +42,7 @@ export default class I3SNodePagesTiles {
     this.nodesPerPage = tileset.nodePages?.nodesPerPage || 64;
     this.lodSelectionMetricType = tileset.nodePages?.lodSelectionMetricType;
     this.options = options;
+    this.nodesInNodePages = 0;
 
     this.initSelectedFormatsForTextureDefinitions(tileset);
   }
@@ -61,6 +63,7 @@ export default class I3SNodePagesTiles {
         promise: load(nodePageUrl, I3SNodePageLoader, this.options)
       };
       this.nodePages[pageIndex] = await this.pendingNodePages[pageIndex].promise;
+      this.nodesInNodePages += this.nodePages[pageIndex].nodes.length;
       this.pendingNodePages[pageIndex].status = 'Done';
     }
     if (this.pendingNodePages[pageIndex].status === 'Pending') {
@@ -74,14 +77,19 @@ export default class I3SNodePagesTiles {
    * Forms tile header using node and tileset data
    * @param id - id of node through all node pages
    */
-  // eslint-disable-next-line complexity
+  // eslint-disable-next-line complexity, max-statements
   async formTileFromNodePages(id: number): Promise<I3STileHeader> {
     const node: NodeInPage = await this.getNodeById(id);
     const children: {id: string; obb: Obb}[] = [];
+    const childNodesPromises: Promise<NodeInPage>[] = [];
     for (const child of node.children || []) {
-      const childNode = await this.getNodeById(child);
+      childNodesPromises.push(this.getNodeById(child));
+    }
+
+    const childNodes = await Promise.all(childNodesPromises);
+    for (const childNode of childNodes) {
       children.push({
-        id: child.toString(),
+        id: childNode.index.toString(),
         obb: childNode.obb
       });
     }

package/src/lib/parsers/parse-arcgis-webscene.ts

@@ -0,0 +1,51 @@
+import type {ArcGisWebSceneData, OperationalLayer} from '../../types';
+
+const ARCGIS_SCENE_SERVER_LAYER_TYPE = 'ArcGISSceneServiceLayer';
+const BUILDING_SCENE_LAYER = 'BuildingSceneLayer';
+const INTEGRATED_MESH_LAYER = 'IntegratedMeshLayer';
+
+/**
+ * Supported layers list
+ * Possible operational layers in WebScene: https://developers.arcgis.com/web-scene-specification/objects/operationalLayers/
+ */
+const SUPPORTED_LAYERS_TYPES = [
+  ARCGIS_SCENE_SERVER_LAYER_TYPE,
+  INTEGRATED_MESH_LAYER,
+  BUILDING_SCENE_LAYER
+];
+
+/**
+ * Parses ArcGIS WebScene
+ * @param data
+ */
+export async function parseWebscene(data: ArrayBuffer): Promise<ArcGisWebSceneData> {
+  const layer0 = JSON.parse(new TextDecoder().decode(data));
+  const {operationalLayers} = layer0;
+
+  return {
+    header: layer0,
+    layers: parseOperationalLayers(operationalLayers)
+  };
+}
+
+/**
+ * Recursively parses WebScene operational layers.
+ * @param layersList
+ */
+function parseOperationalLayers(layersList: OperationalLayer[]): OperationalLayer[] {
+  let layers: OperationalLayer[] = [];
+
+  for (let index = 0; index < layersList.length; index++) {
+    const layer = layersList[index];
+
+    if (SUPPORTED_LAYERS_TYPES.includes(layer.layerType)) {
+      layers.push(layer);
+    }
+
+    if (layer.layers?.length) {
+      layers = [...layers, ...parseOperationalLayers(layer.layers)];
+    }
+  }
+
+  return layers;
+}

package/src/lib/parsers/parse-i3s-tile-content.ts

@@ -109,6 +109,7 @@ async function parseI3SNodeGeometry(
   }
 
   const content = tile.content;
+  const contentByteLength = arrayBuffer.byteLength;
   let attributes: I3SMeshAttributes;
   let vertexCount: number;
   let byteOffset: number = 0;
@@ -216,7 +217,7 @@ async function parseI3SNodeGeometry(
   }
 
   content.vertexCount = vertexCount;
-  content.byteLength = arrayBuffer.byteLength;
+  content.byteLength = contentByteLength;
 
   return tile;
 }

package/src/lib/parsers/parse-i3s.ts

@@ -82,7 +82,7 @@ export async function normalizeTilesetData(tileset : I3STilesetHeader, options :
 
   if (tileset.nodePages) {
     tileset.nodePagesTile = new I3SNodePagesTiles(tileset, options);
-    tileset.root = await tileset.nodePagesTile.formTileFromNodePages(0);
+    tileset.root = tileset.nodePagesTile.formTileFromNodePages(0);
   } else {
     const rootNodeUrl = getUrlWithToken(`${tileset.url}/nodes/root`, options.i3s?.token);
     // eslint-disable-next-line no-use-before-define

package/src/types.ts

@@ -1,4 +1,3 @@
-import type {GLTFMaterial} from '@loaders.gl/gltf';
 import type {Matrix4, Quaternion, Vector3} from '@math.gl/core';
 import type {TypedArray, MeshAttribute, TextureLevel} from '@loaders.gl/schema';
 
@@ -222,34 +221,34 @@ export type I3SMaterialDefinition = {
   /** A set of parameter values that are used to define the metallic-roughness material model from Physically-Based Rendering (PBR) methodology. When not specified, all the default values of pbrMetallicRoughness apply. */
   pbrMetallicRoughness: I3SPbrMetallicRoughness;
   /** The normal texture map. */
-  normalTexture: I3SMaterialTexture;
+  normalTexture?: I3SMaterialTexture;
   /** The occlusion texture map. */
-  occlusionTexture: I3SMaterialTexture;
+  occlusionTexture?: I3SMaterialTexture;
   /** The emissive texture map. */
-  emissiveTexture: I3SMaterialTexture;
+  emissiveTexture?: I3SMaterialTexture;
   /** The emissive color of the material. */
-  emissiveFactor: [number, number, number];
+  emissiveFactor?: [number, number, number];
   /** Defines the meaning of the alpha-channel/alpha-mask. */
   alphaMode: 'opaque' | 'mask' | 'blend';
   /** The alpha cutoff value of the material. */
-  alphaCutoff: number;
+  alphaCutoff?: number;
   /** Specifies whether the material is double sided. */
-  doubleSided: boolean;
+  doubleSided?: boolean;
   /** Winding order is counterclockwise. */
-  cullFace: 'none' | 'front' | 'back';
+  cullFace?: 'none' | 'front' | 'back';
 };
 /** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/pbrMetallicRoughness.cmn.md */
 export type I3SPbrMetallicRoughness = {
   /** The material's base color factor. default=[1,1,1,1] */
-  baseColorFactor: [number, number, number, number];
+  baseColorFactor?: [number, number, number, number];
   /** The base color texture. */
-  baseColorTexture: I3SMaterialTexture;
+  baseColorTexture?: I3SMaterialTexture;
   /** the metalness of the material. default=1.0 */
   metallicFactor: number;
   /** the roughness of the material. default=1.0 */
   roughnessFactor: number;
   /** the metallic-roughness texture. */
-  metallicRoughnessTexture: I3SMaterialTexture;
+  metallicRoughnessTexture?: I3SMaterialTexture;
 };
 /** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialTexture.cmn.md */
 export type I3SMaterialTexture = {
@@ -398,27 +397,83 @@ export type NodeInPage = {
   mesh?: NodeMesh;
 };
 
+/**
+ * https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialDefinitionInfo.cmn.md
+ */
+export type MaterialDefinitionInfo = {
+  /** A name for the material as assigned in the creating application. */
+  name?: string;
+  /** Indicates the material type, chosen from the supported values. */
+  type?: 'standard' | 'water' | 'billboard' | 'leafcard' | 'reference';
+  /** The href that resolves to the shared resource bundle in which the material definition is contained. */
+  $ref?: string;
+  /** Parameter defined for the material.
+   * https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialParams.cmn.md
+   */
+  params: {
+    /** Indicates transparency of this material; 0 = opaque, 1 = fully transparent. */
+    transparency?: number;
+    /** Indicates reflectivity of this material. */
+    reflectivity?: number;
+    /** Indicates shininess of this material. */
+    shininess?: number;
+    /** Ambient color of this material. Ambient color is the color of an object where it is in shadow.
+     * This color is what the object reflects when illuminated by ambient light rather than direct light. */
+    ambient?: number[];
+    /** Diffuse color of this material. Diffuse color is the most instinctive meaning of the color of an object.
+     * It is that essential color that the object reveals under pure white light. It is perceived as the color
+     * of the object itself rather than a reflection of the light. */
+    diffuse?: number[];
+    /** Specular color of this material. Specular color is the color of the light of a specular reflection
+     * (specular reflection is the type of reflection that is characteristic of light reflected from a shiny
+     * surface). */
+    specular?: number[];
+    /** Rendering mode. */
+    renderMode: 'textured' | 'solid' | 'untextured' | 'wireframe';
+    /** TRUE if features with this material should cast shadows. */
+    castShadows?: boolean;
+    /** TRUE if features with this material should receive shadows */
+    receiveShadows?: boolean;
+    /** Indicates the material culling options {back, front, none}. */
+    cullFace?: string;
+    /** This flag indicates that the vertex color attribute of the geometry should be used to color the geometry
+     * for rendering. If texture is present, the vertex colors are multiplied by this color.
+     * e.g. pixel_color = [interpolated]vertex_color * texel_color. Default is false. */
+    vertexColors?: boolean;
+    /** This flag indicates that the geometry has uv region vertex attributes. These are used for adressing
+     * subtextures in a texture atlas. The uv coordinates are relative to this subtexture in this case.
+     * This is mostly useful for repeated textures in a texture atlas. Default is false. */
+    vertexRegions?: boolean;
+    /** Indicates whether Vertex Colors also contain a transparency channel. Default is false. */
+    useVertexColorAlpha?: boolean;
+  };
+};
+
+/** https://github.com/Esri/i3s-spec/blob/master/docs/1.8/sharedResource.cmn.md */
 export type SharedResources = {
-  materialDefinitions?: GLTFMaterial[];
-  textureDefinitions?: TextureDefinitionInfo[];
-  nodePath: string;
+  /** Materials describe how a Feature or a set of Features is to be rendered. */
+  materialDefinitions?: {[key: string]: MaterialDefinitionInfo};
+  /** A Texture is a set of images, with some parameters specific to the texture/uv mapping to geometries. */
+  textureDefinitions?: {[key: string]: TextureDefinitionInfo};
 };
 
+/** https://github.com/Esri/i3s-spec/blob/master/docs/1.8/image.cmn.md */
 type TextureImage = {
+  /** A unique ID for each image. Generated using the BuildID function. */
   id: string;
+  /** width of this image, in pixels. */
   size?: number;
+  /** The maximum size of a single pixel in world units.
+   * This property is used by the client to pick the image to load and render. */
   pixelInWorldUnits?: number;
+  /** The href to the image(s), one per encoding, in the same order as the encodings. */
   href?: string[];
+  /** The byte offset of this image's encodings. There is one per encoding,
+   * in the same order as the encodings, in the block in which this texture image resides. */
   byteOffset?: string[];
+  /** The length in bytes of this image's encodings. There is one per encoding,
+   * in the same order as the encodings. */
   length?: number[];
-  mimeType?: string;
-  bufferView?: {
-    data: ArrayBuffer;
-  };
-  image?: {
-    height: number;
-    width: number;
-  };
 };
 
 export type Attribute = 'OBJECTID' | 'string' | 'double' | 'Int32' | string;
@@ -527,28 +582,37 @@ export type SpatialReference = {
 };
 
 /** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/fullExtent.cmn.md */
-type FullExtent = {
-  /** left */
+export type FullExtent = {
+  /** left longitude in decimal degrees */
   xmin: number;
-  /** right */
+  /** right longitude in decimal degrees */
   xmax: number;
-  /** bottom */
+  /** bottom latitude in decimal degrees*/
   ymin: number;
-  /** top */
+  /** top latitude in decimal degrees*/
   ymax: number;
-  /** lowest elevation */
+  /** lowest elevation in meters */
   zmin: number;
-  /** highest elevation */
+  /** highest elevation in meters */
   zmax: number;
   spatialReference?: SpatialReference;
 };
 
-type TextureDefinitionInfo = {
-  encoding: string[];
+/**
+ * https://github.com/Esri/i3s-spec/blob/master/docs/1.8/textureDefinitionInfo.cmn.md
+ */
+export type TextureDefinitionInfo = {
+  /** MIMEtype - The encoding/content type that is used by all images in this map */
+  encoding?: string[];
+  /** UV wrapping modes, from {none, repeat, mirror}. */
   wrap?: string[];
+  /** TRUE if the Map represents a texture atlas. */
   atlas?: boolean;
+  /** The name of the UV set to be used as texture coordinates. */
   uvSet?: string;
+  /** Indicates channels description. */
   channels?: 'rbg' | 'rgba' | string;
+  /** An image is a binary resource, containing a single raster that can be used to texture a feature or symbol. */
   images: TextureImage[];
 };
 
@@ -707,3 +771,192 @@ export type FieldInfo = {
   isEditable: boolean;
   label: string;
 };
+
+export type ArcGisWebSceneData = {
+  header: ArcGisWebScene;
+  layers: OperationalLayer[];
+};
+
+/**
+ * ArcGis WebScene spec - https://developers.arcgis.com/web-scene-specification/objects/webscene/
+ */
+export type ArcGisWebScene = {
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/applicationProperties/
+   * Configuration of application and UI elements.
+   */
+  applicationProperties?: any;
+  /**
+   * Operational layers contain business data which are used to make thematic scenes.
+   */
+  operationalLayers: OperationalLayer[];
+  /**
+   * Basemaps give the web scene a geographic context.
+   */
+  baseMap: BaseMap;
+  /**
+   * Ground defines the main surface of the web scene, based on elevation layers.
+   */
+  ground: Ground;
+  /**
+   * An object that defines the characteristics of the vertical coordinate system used by the web scene.
+   */
+  heightModelInfo: HeightModelInfo;
+  /**
+   * Root element in the web scene specifying a string value indicating the web scene version.
+   * Valid values: 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27
+   */
+  version: string;
+  /**
+   * String value indicating the application which authored the webmap
+   */
+  authoringApp: string;
+  /**
+   * String value indicating the authoring App's version number.
+   */
+  authoringAppVersion: string;
+  /**
+   * A presentation consists of multiple slides, where each slide is a specific view into the web scene.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/presentation/
+   * @todo Add presentation type.
+   */
+  presentation: any;
+  /**
+   * An object that provides information about the initial environment settings and viewpoint of the web scene.
+   */
+  initialState: InitialState;
+  /**
+   * An object used to specify the spatial reference of the given geometry.
+   */
+  spatialReference: SpatialReference;
+  viewingMode: 'global' | 'local';
+  /**
+   * @todo add type.
+   * Defines area to be clipped for display.
+   */
+  clippingArea?: any;
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/mapFloorInfo/
+   * Contains floor-awareness information for the web scene.
+   */
+  mapFloorInfo?: any;
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/mapRangeInfo/
+   * Map Range Information
+   */
+  mapRangeInfo?: any;
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/table/
+   * An array of table objects.
+   */
+  tables?: any;
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/transportationNetwork/
+   * Used to specify the transportation networks of the scene.
+   */
+  transportationNetworks?: any;
+  /**
+   * @todo add type.
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/widgets/
+   * The widgets object contains widgets that should be exposed to the user.
+   */
+  widgets?: any;
+};
+
+/**
+ * Operational layers contain your data. Usually, a basemap sits beneath your operational layers to give them geographic context.
+ * Spec- https://developers.arcgis.com/web-scene-specification/objects/operationalLayers/
+ */
+export type OperationalLayer = {
+  id: string;
+  opacity: number;
+  title: string;
+  url: string;
+  visibility: boolean;
+  itemId: string;
+  layerType: string;
+  LayerDefinition: LayerDefinition;
+  screenSizePerspective: boolean;
+  showLabels?: boolean;
+  disablePopup?: boolean;
+  showLegend?: boolean;
+  layers?: OperationalLayer[];
+};
+
+type LayerDefinition = {
+  elevationInfo: ElevationInfo;
+  drawingInfo: DrawingInfo;
+};
+
+type BaseMap = {
+  id: string;
+  title: string;
+  baseMapLayers: BaseMapLayer[];
+  elevationLayers: ElevationLayer[];
+};
+
+type BaseMapLayer = {
+  id: string;
+  opacity: number;
+  title: string;
+  url: string;
+  visibility: boolean;
+  layerType: string;
+};
+
+type ElevationLayer = {
+  id: string;
+  listMode: string;
+  title: string;
+  url: string;
+  visibility: boolean;
+  layerType: string;
+};
+
+type Ground = {
+  layers: ElevationLayer[];
+  transparency: number;
+  navigationConstraint: NavigationConstraint;
+};
+
+type NavigationConstraint = {
+  type: string;
+};
+
+type InitialState = {
+  environment: Enviroment;
+  viewpoint: ViewPoint;
+};
+
+type Enviroment = {
+  lighting: Lighting;
+  atmosphereEnabled?: string;
+  starsEnabled?: string;
+};
+
+type Lighting = {
+  datetime?: number;
+  displayUTCOffset?: number;
+};
+
+type ViewPoint = {
+  camera: Camera;
+};
+
+type Camera = {
+  position: CameraPosition;
+  heading: number;
+  tilt: number;
+};
+
+type CameraPosition = {
+  spatialReference: SpatialReference;
+  x: number;
+  y: number;
+  z: number;
+};