@loaders.gl/i3s 3.3.0-alpha.1 → 3.3.0-alpha.11

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

@@ -13,7 +13,7 @@ import {
 } from '../../types';
 import type {LoaderOptions, LoaderContext} from '@loaders.gl/loader-utils';
 
-export function normalizeTileData(tile : Node3DIndexDocument, options : LoaderOptions, context: LoaderContext): I3STileHeader {
+export function normalizeTileData(tile : Node3DIndexDocument, context: LoaderContext): I3STileHeader {
   const url: string = context.url || '';
   let contentUrl: string | undefined;
   if (tile.geometryData) {

package/src/lib/utils/customizeColors.ts

@@ -0,0 +1,129 @@
+import type {MeshAttribute} from '@loaders.gl/schema';
+import type {COLOR, I3STileOptions, I3STilesetOptions} from '../../types';
+
+import {load} from '@loaders.gl/core';
+import {getAttributeValueType, I3SAttributeLoader} from '../../i3s-attribute-loader';
+import {I3SLoaderOptions} from '../../i3s-loader';
+import {getUrlWithToken} from '../utils/url-utils';
+
+/**
+ * Modify vertex colors array to visualize 3D objects in a attribute driven way
+ * @param colors - vertex colors attribute
+ * @param featureIds - feature Ids attribute
+ * @param tileOptions - tile - related options
+ * @param tilesetOptions - tileset-related options
+ * @param options - loader options
+ * @returns midified colors attribute
+ */
+export async function customizeColors(
+  colors: MeshAttribute,
+  featureIds: MeshAttribute,
+  tileOptions: I3STileOptions,
+  tilesetOptions: I3STilesetOptions,
+  options?: I3SLoaderOptions
+): Promise<MeshAttribute> {
+  if (!options?.i3s?.colorsByAttribute) {
+    return colors;
+  }
+
+  const colorizeAttributeField = tilesetOptions.fields.find(
+    ({name}) => name === options?.i3s?.colorsByAttribute?.attributeName
+  );
+  if (
+    !colorizeAttributeField ||
+    !['esriFieldTypeDouble', 'esriFieldTypeInteger', 'esriFieldTypeSmallInteger'].includes(
+      colorizeAttributeField.type
+    )
+  ) {
+    return colors;
+  }
+
+  const colorizeAttributeData = await loadFeatureAttributeData(
+    colorizeAttributeField.name,
+    tileOptions,
+    tilesetOptions,
+    options
+  );
+  if (!colorizeAttributeData) {
+    return colors;
+  }
+
+  const objectIdField = tilesetOptions.fields.find(({type}) => type === 'esriFieldTypeOID');
+  if (!objectIdField) {
+    return colors;
+  }
+
+  const objectIdAttributeData = await loadFeatureAttributeData(
+    objectIdField.name,
+    tileOptions,
+    tilesetOptions,
+    options
+  );
+  if (!objectIdAttributeData) {
+    return colors;
+  }
+
+  const attributeValuesMap: {[key: number]: COLOR} = {};
+  for (let i = 0; i < objectIdAttributeData[objectIdField.name].length; i++) {
+    attributeValuesMap[objectIdAttributeData[objectIdField.name][i]] = calculateColorForAttribute(
+      colorizeAttributeData[colorizeAttributeField.name][i] as number,
+      options
+    );
+  }
+
+  for (let i = 0; i < featureIds.value.length; i++) {
+    const color = attributeValuesMap[featureIds.value[i]];
+    if (!color) {
+      continue; // eslint-disable-line no-continue
+    }
+    colors.value.set(color, i * 4);
+  }
+
+  return colors;
+}
+
+/**
+ * Calculate rgba color from the attribute value
+ * @param attributeValue - value of the attribute
+ * @param options - loader options
+ * @returns - color array for a specific attribute value
+ */
+function calculateColorForAttribute(attributeValue: number, options?: I3SLoaderOptions): COLOR {
+  if (!options?.i3s?.colorsByAttribute) {
+    return [255, 255, 255, 255];
+  }
+  const {minValue, maxValue, minColor, maxColor} = options.i3s.colorsByAttribute;
+  const rate = (attributeValue - minValue) / (maxValue - minValue);
+  const color: COLOR = [255, 255, 255, 255];
+  for (let i = 0; i < minColor.length; i++) {
+    color[i] = Math.round((maxColor[i] - minColor[i]) * rate + minColor[i]);
+  }
+  return color;
+}
+
+/**
+ * Load feature attribute data from the ArcGIS rest service
+ * @param attributeName - attribute name
+ * @param tileOptions - tile-related options
+ * @param tilesetOptions - tileset-related options
+ * @param options - loader options
+ * @returns - Array-like list of the attribute values
+ */
+async function loadFeatureAttributeData(
+  attributeName: string,
+  {attributeUrls}: I3STileOptions,
+  {attributeStorageInfo}: I3STilesetOptions,
+  options?: I3SLoaderOptions
+): Promise<{[key: string]: string[] | Uint32Array | Uint16Array | Float64Array} | null> {
+  const attributeIndex = attributeStorageInfo.findIndex(({name}) => attributeName === name);
+  if (attributeIndex === -1) {
+    return null;
+  }
+  const objectIdAttributeUrl = getUrlWithToken(attributeUrls[attributeIndex], options?.i3s?.token);
+  const attributeType = getAttributeValueType(attributeStorageInfo[attributeIndex]);
+  const objectIdAttributeData = await load(objectIdAttributeUrl, I3SAttributeLoader, {
+    attributeName,
+    attributeType
+  });
+  return objectIdAttributeData;
+}

package/src/types.ts

@@ -1,5 +1,6 @@
 import type {Matrix4, Quaternion, Vector3} from '@math.gl/core';
 import type {TypedArray, MeshAttribute, TextureLevel} from '@loaders.gl/schema';
+import {Tile3D, Tileset3D} from '@loaders.gl/tiles';
 
 export enum DATA_TYPE {
   UInt8 = 'UInt8',
@@ -12,6 +13,9 @@ export enum DATA_TYPE {
   Float32 = 'Float32',
   Float64 = 'Float64'
 }
+
+export type COLOR = [number, number, number, number];
+
 /**
  * spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/3DSceneLayer.cmn.md
  */
@@ -80,6 +84,60 @@ export type I3STileHeader = {
   lodSelection?: LodSelection[];
   [key: string]: any;
 };
+
+export type I3SParseOptions = {
+  /** ArcGIS access token */
+  token?: string;
+  /** Is 3DSceneLayer json expected in response */
+  isTileset?: string;
+  /** Is 3DNodeIndexDocument json expected in response */
+  isTileHeader?: string;
+  /** Tile3D instance. This property used only to load tile content */
+  /** @deprecated */
+  tile?: Tile3D | I3STileOptions;
+  /** Tileset3D instance. This property used only to load tile content */
+  /** @deprecated */
+  tileset?: Tileset3D | I3STilesetOptions;
+  /** Tile-specific options */
+  _tileOptions?: I3STileOptions;
+  /** Tileset-specific options */
+  _tilesetOptions?: I3STilesetOptions;
+  /** Load Draco Compressed geometry if available */
+  useDracoGeometry?: boolean;
+  /** Load compressed textures if available */
+  useCompressedTextures?: boolean;
+  /** Set false if don't need to parse textures */
+  decodeTextures?: boolean;
+  /** deck.gl compatible coordinate system.
+   * https://github.com/visgl/deck.gl/blob/master/docs/developer-guide/coordinate-systems.md
+   * Supported coordinate systems: METER_OFFSETS, LNGLAT_OFFSETS
+   */
+  coordinateSystem?: number;
+  colorsByAttribute?: {
+    attributeName: string;
+    minValue: number;
+    maxValue: number;
+    minColor: COLOR;
+    maxColor: COLOR;
+  };
+};
+
+export type I3STileOptions = {
+  isDracoGeometry: boolean;
+  textureUrl?: string;
+  textureFormat?: I3STextureFormat;
+  textureLoaderOptions?: any;
+  materialDefinition?: I3SMaterialDefinition;
+  attributeUrls: string[];
+  mbs: Mbs;
+};
+
+export type I3STilesetOptions = {
+  store: Store;
+  attributeStorageInfo: AttributeStorageInfo[];
+  fields: Field[];
+};
+
 // TODO Replace "[key: string]: any" with actual defenition
 export type I3STileContent = {
   attributes: I3SMeshAttributes;
@@ -112,7 +170,7 @@ export type BoundingVolumes = {
 export type Obb = {
   center: number[] | Vector3;
   halfSize: number[] | Vector3;
-  quaternion: Quaternion;
+  quaternion: number[] | Quaternion;
 };
 
 export type Mbs = [number, number, number, number];
@@ -305,7 +363,6 @@ export type PopupInfo = {
 export type Node3DIndexDocument = {
   id: string;
   version?: string;
-  path?: string;
   level?: number;
   mbs?: Mbs;
   obb?: Obb;
@@ -775,6 +832,7 @@ export type FieldInfo = {
 export type ArcGisWebSceneData = {
   header: ArcGisWebScene;
   layers: OperationalLayer[];
+  unsupportedLayers: OperationalLayer[];
 };
 
 /**
@@ -821,7 +879,7 @@ export type ArcGisWebScene = {
    * Spec - https://developers.arcgis.com/web-scene-specification/objects/presentation/
    * @todo Add presentation type.
    */
-  presentation: any;
+  presentation: ArcGisPresentation;
   /**
    * An object that provides information about the initial environment settings and viewpoint of the web scene.
    */
@@ -868,6 +926,100 @@ export type ArcGisWebScene = {
   widgets?: any;
 };
 
+/**
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html
+ */
+type ArcGisPresentation = {
+  slides: Slide[];
+};
+
+/**
+ * A slide stores a snapshot of several pre-set properties of the WebScene and SceneView,
+ * such as the basemap, viewpoint and visible layers.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html
+ */
+type Slide = {
+  id: string;
+  title: {
+    text: string;
+  };
+  thumbnail: {
+    url: string;
+  };
+  description: {
+    text: string;
+  };
+  ground: {
+    transparency: number;
+  };
+  baseMap: ArcGisBaseMap;
+  visibleLayers: ArcGisVisibleLayer[];
+  viewpoint: ArcGisViewPoint;
+};
+
+/**
+ * The basemap of the scene. Only the base and reference layers of the basemap are stored in a slide.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html
+ */
+type ArcGisBaseMap = {
+  id: string;
+  title: string;
+  baseMapLayers: ArcGisBaseMapLayer[];
+};
+
+/**
+ * The visible layers of the scene.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Slide.html#visibleLayers
+ */
+type ArcGisVisibleLayer = {
+  id: string;
+  sublayerIds: number[];
+};
+/**
+ * The basemap of the scene.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html
+ */
+type ArcGisBaseMapLayer = {
+  id: string;
+  title: string;
+  url: string;
+  layerType: string;
+  visibility: boolean;
+};
+
+/**
+ * The viewpoint of the slide. This acts like a bookmark, saving a predefined location or point of view from which to view the scene.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html
+ */
+type ArcGisViewPoint = {
+  scale: number;
+  rotation?: number;
+  /**
+   * Spec - https://developers.arcgis.com/web-scene-specification/objects/viewpoint/
+   */
+  targetGeometry: any;
+  camera: ArcGisCamera;
+};
+
+/**
+ * The camera defines the position, tilt, and heading of the point from which the SceneView's visible extent is observed.
+ * It is not associated with device hardware. This class only applies to 3D SceneViews.
+ * Spec - https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html
+ */
+export type ArcGisCamera = {
+  position: {
+    x: number;
+    y: number;
+    z: number;
+  };
+  spatialReference: {
+    wkid: number;
+    latestWkid: number;
+  };
+  heading: number;
+  tilt: number;
+};
+
 /**
  * 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/
@@ -960,3 +1112,46 @@ type CameraPosition = {
   y: number;
   z: number;
 };
+
+/**
+ * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/statsInfo.cmn.md
+ */
+export type StatsInfo = {
+  /** Represents the count of the value. */
+  totalValuesCount?: number;
+  /** Minimum attribute value for the entire layer. */
+  min?: number;
+  /** Maximum attribute value for the entire layer. */
+  max?: number;
+  /** Count for the entire layer. */
+  count?: number;
+  /** Sum of the attribute values over the entire layer. */
+  sum?: number;
+  /** Representing average or mean value. For example, sum/count. */
+  avg?: number;
+  /** Representing the standard deviation. */
+  stddev?: number;
+  /**	Representing variance. For example, stats.stddev *stats.stddev. */
+  variance?: number;
+  /** Represents the histogram. */
+  histogram?: Histogram;
+  /** An array of most frequently used values within the point cloud scene layer. */
+  mostFrequentValues?: ValueCount[];
+};
+
+/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/histogram.cmn.md */
+export type Histogram = {
+  /** Minimum attribute value for the entire layer. */
+  minimum: number;
+  /** Maximum attribute value for the entire layer. Maximum array size for stats.histo.counts is 256. */
+  maximum: number;
+  /** Count for the entire layer. */
+  counts: number[];
+};
+
+export type ValueCount = {
+  /** Type of the attribute values after decompression, if applicable. Please note that string is not supported for point cloud scene layer attributes. */
+  value: number | string;
+  /** Count of the number of values. May exceed 32 bits. */
+  count: number;
+};

package/src/workers/i3s-content-nodejs-worker.ts

@@ -0,0 +1,5 @@
+import {createLoaderWorker} from '@loaders.gl/loader-utils';
+import '@loaders.gl/polyfills';
+import {I3SContentLoader} from '../i3s-content-loader';
+
+createLoaderWorker(I3SContentLoader);