@loaders.gl/tile-converter 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/i3s-converter/helpers/feature-attributes.js

@@ -1,128 +1,191 @@
 import { AttributeType } from "../types.js";
 import { EXT_FEATURE_METADATA, EXT_STRUCTURAL_METADATA } from '@loaders.gl/gltf';
+/**
+ * Takes attributes from property table based on featureIdsMap.
+ * If there is no property value for particular featureId (index) the property will be null.
+ * Example:
+ * Initial data:
+ *   OBJECTID: {0: 0, 3: 33, 4: 333}
+ *   component: ['Windows', 'Frames', 'Wall', 'Roof', 'Skylight']
+ * Result:
+ *   OBJECTID: [0, 33, 333]
+ *   component: ['Windows', 'Roof', 'Skylight']
+ * @param featureIdsMap
+ * @param propertyTable
+ */
 export function flattenPropertyTableByFeatureIds(featureIdsMap, propertyTable) {
-  const resultPropertyTable = {};
-  for (const propertyName in propertyTable) {
-    const properties = propertyTable[propertyName];
-    resultPropertyTable[propertyName] = getPropertiesByFeatureIds(properties, featureIdsMap);
-  }
-  return resultPropertyTable;
+    const resultPropertyTable = {};
+    for (const propertyName in propertyTable) {
+        const properties = propertyTable[propertyName];
+        resultPropertyTable[propertyName] = getPropertiesByFeatureIds(properties, featureIdsMap);
+    }
+    return resultPropertyTable;
 }
+/**
+ * Getting properties by featureId index
+ * @param properties
+ * @param featureIdsMap
+ */
 function getPropertiesByFeatureIds(properties, featureIdsMap) {
-  const resultProperties = [];
-  if (properties) {
-    for (const featureIdKey in featureIdsMap) {
-      const property = properties[featureIdKey] || null;
-      resultProperties.push(property);
+    const resultProperties = [];
+    if (properties) {
+        for (const featureIdKey in featureIdsMap) {
+            const property = properties[featureIdKey] || null;
+            resultProperties.push(property);
+        }
     }
-  }
-  return resultProperties;
+    return resultProperties;
 }
+/**
+ * Check that all attributes in propertyTable have the same length as FeatureIds.
+ * If there are differencies between lengths we should flatten property table based on exiesting featureIds.
+ * @param featureIds
+ * @param propertyTable
+ * @returns
+ */
 export function checkPropertiesLength(featureIds, propertyTable) {
-  let needFlatten = false;
-  for (const attribute of Object.values(propertyTable)) {
-    if (!featureIds || !attribute || featureIds.length !== attribute.length) {
-      needFlatten = true;
+    let needFlatten = false;
+    for (const attribute of Object.values(propertyTable)) {
+        if (!featureIds || !attribute || featureIds.length !== attribute.length) {
+            needFlatten = true;
+        }
     }
-  }
-  return needFlatten;
+    return needFlatten;
 }
+/**
+ * Get the attribute type for attributeStorageInfo https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param attribute - attribute taken from propertyTable
+ */
 export function getAttributeType(attribute) {
-  if (typeof attribute === 'string' || typeof attribute === 'bigint') {
+    if (typeof attribute === 'string' || typeof attribute === 'bigint') {
+        return AttributeType.STRING_TYPE;
+    }
+    else if (typeof attribute === 'number') {
+        return Number.isInteger(attribute) ? AttributeType.SHORT_INT_TYPE : AttributeType.DOUBLE_TYPE;
+    }
     return AttributeType.STRING_TYPE;
-  } else if (typeof attribute === 'number') {
-    return Number.isInteger(attribute) ? AttributeType.SHORT_INT_TYPE : AttributeType.DOUBLE_TYPE;
-  }
-  return AttributeType.STRING_TYPE;
 }
+/**
+ * Gets attribute's types based on the property table records.
+ * @param propertyTable - Table with layer meta data.
+ * @returns set of attribute types
+ * @example of returned object:
+ * {
+ *   "opt_uint8":  "Int32",
+ *   "opt_uint64": "string"
+ * }
+ */
 export function getAttributeTypesMapFromPropertyTable(propertyTable) {
-  const attributeTypesMap = {};
-  for (const key in propertyTable) {
-    const firstAttribute = propertyTable[key][0];
-    const attributeType = getAttributeType(firstAttribute);
-    attributeTypesMap[key] = attributeType;
-  }
-  return attributeTypesMap;
+    const attributeTypesMap = {};
+    for (const key in propertyTable) {
+        // Get attribute type based on the first element of each property.
+        const firstAttribute = propertyTable[key][0];
+        const attributeType = getAttributeType(firstAttribute);
+        attributeTypesMap[key] = attributeType;
+    }
+    return attributeTypesMap;
 }
+/**
+ * Gets attribute's types from the extension schema selected by the class name 'metadataClass'.
+ * @param gltfJson - JSON part of GLB content
+ * @param metadataClass - name of the schema class
+ * @returns set of attribute's types
+ * @example of returned object:
+ * {
+ *   "opt_uint8":  "Int32",
+ *   "opt_uint64": "string"
+ * }
+ */
 export const getAttributeTypesMapFromSchema = (gltfJson, metadataClass) => {
-  var _gltfJson$extensions, _gltfJson$extensions$, _gltfJson$extensions$2, _gltfJson$extensions$3, _gltfJson$extensions2, _gltfJson$extensions3, _gltfJson$extensions4, _gltfJson$extensions5;
-  const attributeTypesMap = {};
-  const extFeatureMetadataSchemaClass = (_gltfJson$extensions = gltfJson.extensions) === null || _gltfJson$extensions === void 0 ? void 0 : (_gltfJson$extensions$ = _gltfJson$extensions[EXT_FEATURE_METADATA]) === null || _gltfJson$extensions$ === void 0 ? void 0 : (_gltfJson$extensions$2 = _gltfJson$extensions$.schema) === null || _gltfJson$extensions$2 === void 0 ? void 0 : (_gltfJson$extensions$3 = _gltfJson$extensions$2.classes) === null || _gltfJson$extensions$3 === void 0 ? void 0 : _gltfJson$extensions$3[metadataClass];
-  if (extFeatureMetadataSchemaClass) {
-    for (let propertyName in extFeatureMetadataSchemaClass.properties) {
-      const property = extFeatureMetadataSchemaClass.properties[propertyName];
-      const attributeProperty = getAttributeTypeFromExtFeatureMetadata(property);
-      attributeTypesMap[propertyName] = attributeProperty;
+    const attributeTypesMap = {};
+    const extFeatureMetadataSchemaClass = gltfJson.extensions?.[EXT_FEATURE_METADATA]?.schema?.classes?.[metadataClass];
+    if (extFeatureMetadataSchemaClass) {
+        for (let propertyName in extFeatureMetadataSchemaClass.properties) {
+            const property = extFeatureMetadataSchemaClass.properties[propertyName];
+            const attributeProperty = getAttributeTypeFromExtFeatureMetadata(property);
+            attributeTypesMap[propertyName] = attributeProperty;
+        }
+        return attributeTypesMap;
     }
-    return attributeTypesMap;
-  }
-  const extStructuralMetadataSchemaClass = (_gltfJson$extensions2 = gltfJson.extensions) === null || _gltfJson$extensions2 === void 0 ? void 0 : (_gltfJson$extensions3 = _gltfJson$extensions2[EXT_STRUCTURAL_METADATA]) === null || _gltfJson$extensions3 === void 0 ? void 0 : (_gltfJson$extensions4 = _gltfJson$extensions3.schema) === null || _gltfJson$extensions4 === void 0 ? void 0 : (_gltfJson$extensions5 = _gltfJson$extensions4.classes) === null || _gltfJson$extensions5 === void 0 ? void 0 : _gltfJson$extensions5[metadataClass];
-  if (extStructuralMetadataSchemaClass) {
-    for (let propertyName in extStructuralMetadataSchemaClass.properties) {
-      const property = extStructuralMetadataSchemaClass.properties[propertyName];
-      const attributeProperty = getAttributeTypeFromExtStructuralMetadata(property);
-      attributeTypesMap[propertyName] = attributeProperty;
+    const extStructuralMetadataSchemaClass = gltfJson.extensions?.[EXT_STRUCTURAL_METADATA]?.schema?.classes?.[metadataClass];
+    if (extStructuralMetadataSchemaClass) {
+        for (let propertyName in extStructuralMetadataSchemaClass.properties) {
+            const property = extStructuralMetadataSchemaClass.properties[propertyName];
+            const attributeProperty = getAttributeTypeFromExtStructuralMetadata(property);
+            attributeTypesMap[propertyName] = attributeProperty;
+        }
+        return attributeTypesMap;
     }
-    return attributeTypesMap;
-  }
-  return null;
+    return null;
 };
-const getAttributeTypeFromExtFeatureMetadata = property => {
-  let attributeType;
-  switch (property.type) {
-    case 'INT8':
-    case 'UINT8':
-    case 'INT16':
-    case 'UINT16':
-    case 'INT32':
-    case 'UINT32':
-      attributeType = AttributeType.SHORT_INT_TYPE;
-      break;
-    case 'FLOAT32':
-    case 'FLOAT64':
-      attributeType = AttributeType.DOUBLE_TYPE;
-      break;
-    case 'INT64':
-    case 'UINT64':
-    case 'BOOLEAN':
-    case 'ENUM':
-    case 'STRING':
-    case 'ARRAY':
-      attributeType = AttributeType.STRING_TYPE;
-      break;
-    default:
-      attributeType = AttributeType.STRING_TYPE;
-      break;
-  }
-  return attributeType;
+/**
+ * Gets the attribute type according to the Ext_feature_metadata extension class schema
+ * @see https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param property - schema of the class property for Ext_feature_metadata
+ * @returns attribute's type
+ */
+const getAttributeTypeFromExtFeatureMetadata = (property) => {
+    let attributeType;
+    switch (property.type) {
+        case 'INT8':
+        case 'UINT8':
+        case 'INT16':
+        case 'UINT16':
+        case 'INT32':
+        case 'UINT32':
+            attributeType = AttributeType.SHORT_INT_TYPE;
+            break;
+        case 'FLOAT32':
+        case 'FLOAT64':
+            attributeType = AttributeType.DOUBLE_TYPE;
+            break;
+        case 'INT64':
+        case 'UINT64':
+        case 'BOOLEAN':
+        case 'ENUM':
+        case 'STRING':
+        case 'ARRAY':
+            attributeType = AttributeType.STRING_TYPE;
+            break;
+        default:
+            attributeType = AttributeType.STRING_TYPE;
+            break;
+    }
+    return attributeType;
 };
-const getAttributeTypeFromExtStructuralMetadata = property => {
-  let attributeType;
-  if (property.array) {
-    attributeType = AttributeType.STRING_TYPE;
-  } else {
-    switch (property.componentType) {
-      case 'INT8':
-      case 'UINT8':
-      case 'INT16':
-      case 'UINT16':
-      case 'INT32':
-      case 'UINT32':
-        attributeType = AttributeType.SHORT_INT_TYPE;
-        break;
-      case 'FLOAT32':
-      case 'FLOAT64':
-        attributeType = AttributeType.DOUBLE_TYPE;
-        break;
-      case 'INT64':
-      case 'UINT64':
+/**
+ * Gets the attribute type according to the Ext_structural_metadata extension class schema
+ * @see https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param property - schema of the class property for Ext_structural_metadata
+ * @returns attribute's type
+ */
+const getAttributeTypeFromExtStructuralMetadata = (property) => {
+    let attributeType;
+    if (property.array) {
         attributeType = AttributeType.STRING_TYPE;
-        break;
-      default:
-        attributeType = AttributeType.STRING_TYPE;
-        break;
     }
-  }
-  return attributeType;
+    else {
+        switch (property.componentType) {
+            case 'INT8':
+            case 'UINT8':
+            case 'INT16':
+            case 'UINT16':
+            case 'INT32':
+            case 'UINT32':
+                attributeType = AttributeType.SHORT_INT_TYPE;
+                break;
+            case 'FLOAT32':
+            case 'FLOAT64':
+                attributeType = AttributeType.DOUBLE_TYPE;
+                break;
+            case 'INT64':
+            case 'UINT64':
+                attributeType = AttributeType.STRING_TYPE;
+                break;
+            default:
+                attributeType = AttributeType.STRING_TYPE;
+                break;
+        }
+    }
+    return attributeType;
 };
-//# sourceMappingURL=feature-attributes.js.map

package/dist/i3s-converter/helpers/geometry-attributes.d.ts

@@ -1,4 +1,4 @@
-import type { GeometryAttributes, ConvertedAttributes } from '../types';
+import type { GeometryAttributes, ConvertedAttributes } from "../types.js";
 /**
  * Generate geometry attributes with faceRange and featureCount
  * @param attributes

package/dist/i3s-converter/helpers/geometry-attributes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geometry-attributes.d.ts","sourceRoot":"","sources":["../../../src/i3s-converter/helpers/geometry-attributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EAGpB,MAAM,UAAU,CAAC;AAMlB;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,GAAG,kBAAkB,CAyBtF"}
+{"version":3,"file":"geometry-attributes.d.ts","sourceRoot":"","sources":["../../../src/i3s-converter/helpers/geometry-attributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EAGpB,oBAAiB;AAMlB;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,GAAG,kBAAkB,CAyBtF"}