@loaders.gl/i3s 3.1.0-alpha.4 → 3.1.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/i3s",
-  "version": "3.1.0-alpha.4",
+  "version": "3.1.0-beta.5",
   "description": "i3s .",
   "license": "MIT",
   "publishConfig": {
@@ -17,7 +17,7 @@
     "tile",
     "mesh"
   ],
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
   "main": "dist/es5/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -28,22 +28,24 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle && npm run build-worker",
-    "build-bundle": "webpack --display=minimal --config ../../scripts/webpack/bundle.js",
-    "build-worker": "webpack --entry ./src/workers/i3s-content-worker.ts --output ./dist/i3s-content-worker.js --config ../../scripts/webpack/worker.js"
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/bundle.js",
+    "build-worker": "esbuild src/workers/i3s-content-worker.ts --bundle --outfile=dist/i3s-content-worker.js"
   },
   "dependencies": {
-    "@loaders.gl/core": "3.1.0-alpha.4",
-    "@loaders.gl/draco": "3.1.0-alpha.4",
-    "@loaders.gl/images": "3.1.0-alpha.4",
-    "@loaders.gl/loader-utils": "3.1.0-alpha.4",
-    "@loaders.gl/schema": "3.1.0-alpha.4",
-    "@loaders.gl/textures": "3.1.0-alpha.4",
-    "@loaders.gl/tiles": "3.1.0-alpha.4",
+    "@loaders.gl/draco": "3.1.0-beta.5",
+    "@loaders.gl/images": "3.1.0-beta.5",
+    "@loaders.gl/loader-utils": "3.1.0-beta.5",
+    "@loaders.gl/schema": "3.1.0-beta.5",
+    "@loaders.gl/textures": "3.1.0-beta.5",
+    "@loaders.gl/tiles": "3.1.0-beta.5",
     "@luma.gl/constants": "^8.5.4",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
     "@math.gl/geospatial": "^3.5.1",
     "probe.gl": "^3.4.0"
   },
-  "gitHead": "e309784af37ef9f3640c7733c7851124c72e1fa3"
+  "peerDependencies": {
+    "@loaders.gl/core": "3.1.0-beta.1"
+  },
+  "gitHead": "5d66468457cc878d2dbff3d7807d737ceb181c9a"
 }

package/src/i3s-attribute-loader.ts

@@ -37,7 +37,7 @@ async function parse(data, options) {
  */
 // eslint-disable-next-line complexity
 export async function loadFeatureAttributes(tile, featureId, options = {}) {
-  const {attributeStorageInfo, attributeUrls} = getAttributesData(tile);
+  const {attributeStorageInfo, attributeUrls, tilesetFields} = getAttributesData(tile);
 
   if (!attributeStorageInfo || !attributeUrls || !featureId) {
     return null;
@@ -66,15 +66,20 @@ export async function loadFeatureAttributes(tile, featureId, options = {}) {
     return null;
   }
 
-  return generateAttributesByFeatureId(attributes, attributeStorageInfo, featureId);
+  return generateAttributesByFeatureId(attributes, attributeStorageInfo, featureId, tilesetFields);
 }
 
+/**
+ * Gets attributes data from tile.
+ * @param tile 
+ * @returns 
+ */
 function getAttributesData(tile) {
-  const attributeStorageInfo =
-    tile && tile.tileset && tile.tileset.tileset && tile.tileset.tileset.attributeStorageInfo;
-  const attributeUrls = tile && tile.header && tile.header.attributeUrls;
+  const attributeStorageInfo = tile.tileset?.tileset?.attributeStorageInfo;
+  const attributeUrls = tile.header?.attributeUrls;
+  const tilesetFields = tile.tileset?.tileset?.fields || [];
 
-  return {attributeStorageInfo, attributeUrls};
+  return {attributeStorageInfo, attributeUrls, tilesetFields};
 }
 
 /**
@@ -91,6 +96,17 @@ function getAttributeValueType(attribute) {
   return '';
 }
 
+/**
+ * Find in attributeStorageInfo attribute name responsible for feature ids list.
+ * @param attributeStorageInfo 
+ * @returns Feature ids attribute name
+ */
+function getFeatureIdsAttributeName(attributeStorageInfo) {
+  const objectIdsAttribute = attributeStorageInfo.find(attribute => attribute.name.includes('OBJECTID'));
+
+  return objectIdsAttribute?.name;
+}
+
 /**
  * Generates mapping featureId to feature attributes
  * @param {Array} attributes
@@ -98,20 +114,21 @@ function getAttributeValueType(attribute) {
  * @param {number} featureId
  * @returns {Object}
  */
-function generateAttributesByFeatureId(attributes, attributeStorageInfo, featureId) {
-  const objectIds = attributes.find((attribute) => attribute.value.OBJECTID);
+function generateAttributesByFeatureId(attributes, attributeStorageInfo, featureId, tilesetFields) {
+  const objectIdsAttributeName = getFeatureIdsAttributeName(attributeStorageInfo);
+  const objectIds = attributes.find((attribute) => attribute.value[objectIdsAttributeName]);
 
   if (!objectIds) {
     return null;
   }
 
-  const attributeIndex = objectIds.value.OBJECTID.indexOf(featureId);
+  const attributeIndex = objectIds.value[objectIdsAttributeName].indexOf(featureId);
 
   if (attributeIndex < 0) {
     return null;
   }
 
-  return getFeatureAttributesByIndex(attributes, attributeIndex, attributeStorageInfo);
+  return getFeatureAttributesByIndex(attributes, attributeIndex, attributeStorageInfo, tilesetFields);
 }
 
 /**
@@ -121,18 +138,31 @@ function generateAttributesByFeatureId(attributes, attributeStorageInfo, feature
  * @param {Object} attributeStorageInfo
  * @returns {Object}
  */
-function getFeatureAttributesByIndex(attributes, featureIdIndex, attributeStorageInfo) {
+function getFeatureAttributesByIndex(attributes, featureIdIndex, attributeStorageInfo, tilesetFields) {
   const attributesObject = {};
 
   for (let index = 0; index < attributeStorageInfo.length; index++) {
     const attributeName = attributeStorageInfo[index].name;
+    const codedValues = getAttributeCodedValues(attributeName, tilesetFields);
     const attribute = getAttributeByIndexAndAttributeName(attributes, index, attributeName);
-    attributesObject[attributeName] = formatAttributeValue(attribute, featureIdIndex);
+    attributesObject[attributeName] = formatAttributeValue(attribute, featureIdIndex, codedValues);
   }
 
   return attributesObject;
 }
 
+/**
+ * Get coded values list from tileset.
+ * @param attributeName 
+ * @param tilesetFields 
+ */
+function getAttributeCodedValues(attributeName, tilesetFields) {
+  const attributeField = tilesetFields
+    .find(field => field.name === attributeName || field.alias === attributeName);
+
+  return attributeField?.domain?.codedValues || [];
+}
+
 /**
  * Return attribute value if it presents in atrributes list
  * @param {array} attributes
@@ -155,12 +185,19 @@ function getAttributeByIndexAndAttributeName(attributes, index, attributesName)
  * @param {Number} featureIdIndex
  * @returns {String}
  */
-function formatAttributeValue(attribute, featureIdIndex) {
-  return attribute && attribute[featureIdIndex]
-    ? attribute[featureIdIndex]
-      .toString()
+function formatAttributeValue(attribute, featureIdIndex, codedValues) {
+  let value = EMPTY_VALUE;
+
+  if (attribute && (featureIdIndex in attribute)) {
     // eslint-disable-next-line no-control-regex
-      .replace(/\u0000/g, '')
-      .trim()
-    : EMPTY_VALUE;
+    value = String(attribute[featureIdIndex]).replace(/\u0000|NaN/g, '').trim();
+  }
+
+  // Check if coded values are existed. If so we use them.
+  if (codedValues.length) {
+    const codeValue = codedValues.find(codedValue => codedValue.code === Number(value));
+    value = codeValue?.name || EMPTY_VALUE;
+  }
+
+  return value;
 }

package/src/i3s-loader.ts

@@ -2,6 +2,7 @@ import type {LoaderWithParser} from '@loaders.gl/loader-utils';
 import {load, parse} from '@loaders.gl/core';
 import {I3SContentLoader} from './i3s-content-loader';
 import {normalizeTileData, normalizeTilesetData} from './lib/parsers/parse-i3s';
+import {COORDINATE_SYSTEM} from './lib/parsers/constants';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
@@ -31,7 +32,9 @@ export const I3SLoader: LoaderWithParser = {
       tile: null,
       tileset: null,
       useDracoGeometry: true,
-      useCompressedTextures: true
+      useCompressedTextures: true,
+      decodeTextures: true,
+      coordinateSystem: COORDINATE_SYSTEM.METER_OFFSETS
     }
   }
 };

package/src/index.ts

@@ -24,3 +24,4 @@ export type {
   Extent,
   FeatureAttribute
 } from './types';
+export {COORDINATE_SYSTEM} from './lib/parsers/constants';

package/src/lib/parsers/constants.ts

@@ -1,14 +1,24 @@
 import GL from '@luma.gl/constants';
+import {DATA_TYPE} from '../../types';
 
-export const TYPE_ARRAY_MAP = {
-  UInt8: Uint8Array,
-  UInt16: Uint16Array,
-  UInt32: Uint32Array,
-  Float32: Float32Array,
-  UInt64: Float64Array
-};
+export function getConstructorForDataFormat(dataType: string) {
+  switch (dataType) {
+    case DATA_TYPE.UInt8:
+      return Uint8Array;
+    case DATA_TYPE.UInt16:
+      return Uint16Array;
+    case DATA_TYPE.UInt32:
+      return Uint32Array;
+    case DATA_TYPE.Float32:
+      return Float32Array;
+    case DATA_TYPE.UInt64:
+      return Float64Array;
+    default:
+      return null;
+  }
+}
 
-export const GL_TYPE_MAP = {
+export const GL_TYPE_MAP: {[key: string]: number} = {
   UInt8: GL.UNSIGNED_BYTE,
   UInt16: GL.UNSIGNED_INT,
   Float32: GL.FLOAT,
@@ -29,21 +39,66 @@ export const I3S_NAMED_GEOMETRY_ATTRIBUTES = {
   featureAttributeOrder: 'featureAttributeOrder',
   featureAttributes: 'featureAttributes'
 };
-
+// TODO Remove Named Attributes and replase with Typescipt types
 export const I3S_NAMED_HEADER_ATTRIBUTES = {
-  header: 'header',
+  // header: 'header',
   vertexCount: 'vertexCount',
   featureCount: 'featureCount'
 };
-
-export const SIZEOF = {
-  UInt8: 1,
-  UInt16: 2,
-  UInt32: 4,
-  Float32: 4,
-  UInt64: 8
-};
+/**
+ * Returns how many bytes a type occupies
+ * @param dataType
+ * @returns
+ */
+export function sizeOf(dataType: string): number {
+  switch (dataType) {
+    case DATA_TYPE.UInt8:
+      return 1;
+    case DATA_TYPE.UInt16:
+    case DATA_TYPE.Int16:
+      return 2;
+    case DATA_TYPE.UInt32:
+    case DATA_TYPE.Int32:
+    case DATA_TYPE.Float32:
+      return 4;
+    case DATA_TYPE.UInt64:
+    case DATA_TYPE.Int64:
+    case DATA_TYPE.Float64:
+      return 8;
+    default:
+      return NaN;
+  }
+}
 
 export const STRING_ATTRIBUTE_TYPE = 'String';
 export const OBJECT_ID_ATTRIBUTE_TYPE = 'Oid32';
 export const FLOAT_64_TYPE = 'Float64';
+export const INT_16_ATTRIBUTE_TYPE = 'Int16';
+
+// https://github.com/visgl/deck.gl/blob/9548f43cba2234a1f4877b6b17f6c88eb35b2e08/modules/core/src/lib/constants.js#L27
+// Describes the format of positions
+export enum COORDINATE_SYSTEM {
+  /**
+   * `LNGLAT` if rendering into a geospatial viewport, `CARTESIAN` otherwise
+   */
+  DEFAULT = -1,
+  /**
+   * Positions are interpreted as [lng, lat, elevation]
+   * lng lat are degrees, elevation is meters. distances as meters.
+   */
+  LNGLAT = 1,
+  /**
+   * Positions are interpreted as meter offsets, distances as meters
+   */
+  METER_OFFSETS = 2,
+  /**
+   * Positions are interpreted as lng lat offsets: [deltaLng, deltaLat, elevation]
+   * deltaLng, deltaLat are delta degrees, elevation is meters.
+   * distances as meters.
+   */
+  LNGLAT_OFFSETS = 3,
+  /**
+   * Non-geospatial
+   */
+  CARTESIAN = 0
+}

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

@@ -1,4 +1,9 @@
-import {STRING_ATTRIBUTE_TYPE, OBJECT_ID_ATTRIBUTE_TYPE, FLOAT_64_TYPE} from './constants';
+import {
+  STRING_ATTRIBUTE_TYPE,
+  OBJECT_ID_ATTRIBUTE_TYPE,
+  FLOAT_64_TYPE,
+  INT_16_ATTRIBUTE_TYPE
+} from './constants';
 
 /**
  * Get particular tile and creates attribute object inside.
@@ -31,6 +36,8 @@ function parseAttribute(attributeType, arrayBuffer) {
       return parseShortNumberAttribute(arrayBuffer);
     case FLOAT_64_TYPE:
       return parseFloatAttribute(arrayBuffer);
+    case INT_16_ATTRIBUTE_TYPE:
+      return parseInt16ShortNumberAttribute(arrayBuffer);
     default:
       return parseShortNumberAttribute(arrayBuffer);
   }
@@ -47,6 +54,17 @@ function parseShortNumberAttribute(arrayBuffer) {
   return new Uint32Array(arrayBuffer, countOffset);
 }
 
+/**
+ * Parse Int16 short number attribute.
+ * Parsing of such data is not documented. Added to handle Building Scene Layer Tileset attributes data.
+ * @param {ArrayBuffer} arrayBuffer
+ * @returns {Int16Array}
+ */
+function parseInt16ShortNumberAttribute(arrayBuffer) {
+  const countOffset = 4;
+  return new Int16Array(arrayBuffer, countOffset);
+}
+
 /**
  * Parse float attribute.
  * Double Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md

package/src/lib/parsers/parse-i3s-building-scene-layer.ts

@@ -34,7 +34,7 @@ function parseSublayersTree(
 
   for (let index = 0; index < sublayers.length; index++) {
     const subLayer = sublayers[index];
-    const {id, layerType, ...rest} = subLayer;
+    const {id, layerType, visibility = true, ...rest} = subLayer;
 
     // Add support only for 3DObject layer type for I3S purposes.
     if (layerType === OBJECT_3D_LAYER_TYPE) {
@@ -44,6 +44,7 @@ function parseSublayersTree(
         url: sublayerUrl,
         id,
         layerType,
+        visibility,
         ...rest
       });
     }