@bldrs-ai/conway 0.17.852 → 0.17.882

package/compiled/src/ifc/ifc_geometry_extraction.js

@@ -112,12 +112,12 @@ export class IfcGeometryExtraction {
      *
      * @param conwayModel
      * @param model
+     * @param lowMemoryMode
      */
     constructor(conwayModel, model, lowMemoryMode = false) {
         this.conwayModel = conwayModel;
         this.model = model;
         this.lowMemoryMode = lowMemoryMode;
-        /* eslint-disable no-magic-numbers */
         this.TWO_DIMENSIONS = 2;
         this.THREE_DIMENSIONS = 3;
         this.circleSegments = 12;
@@ -212,9 +212,7 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorGeometry} - a native std::vector<GeometryObject> from the wasm module
      */
     nativeVectorGeometry(initialSize) {
-        const nativeVectorGeometry_ = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.geometryArray)());
+        const nativeVectorGeometry_ = (new (this.wasmModule.geometryArray)());
         if (initialSize) {
             const defaultGeometry = (new (this.wasmModule.IfcGeometry));
             // resize has a required second parameter to set default values
@@ -229,9 +227,7 @@ export class IfcGeometryExtraction {
      * vector of geometry collections
      */
     nativeVectorGeometryCollection() {
-        const nativeVectorGeometryCollection = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.geometryCollectionArray)());
+        const nativeVectorGeometryCollection = (new (this.wasmModule.geometryCollectionArray)());
         return nativeVectorGeometryCollection;
     }
     /**
@@ -240,7 +236,6 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorGlmVec2} - a native std::vector<glm::vec2> from the wasm module
      */
     nativeVectorGlmVec2(initialSize) {
-        // eslint-disable-next-line new-cap
         const nativeVectorGlmVec2_ = new (this.wasmModule.vec2Array)();
         if (initialSize) {
             // resize has a required second parameter to set default values
@@ -255,7 +250,6 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorProfile} - a native std::vector<IfcProfile> from the wasm module
      */
     nativeVectorProfile(initialSize) {
-        // eslint-disable-next-line new-cap
         const nativeVectorProfile_ = new (this.wasmModule.profileArray)();
         if (initialSize) {
             // resize has a required second parameter to set default values
@@ -271,7 +265,6 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorCurve} - a native std::vector<IfcCurve> from the wasm module
      */
     nativeVectorCurve(initialSize) {
-        // eslint-disable-next-line new-cap
         const nativeVectorCurve_ = new (this.wasmModule.curveArray)();
         if (initialSize) {
             // resize has a required second parameter to set default values
@@ -286,9 +279,7 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorGlmVec3} - a native std::vector<glm::vec3> from the wasm module
      */
     nativeVectorGlmVec3(initialSize) {
-        const nativeVectorGlmVec3_ = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.glmVec3Array)());
+        const nativeVectorGlmVec3_ = (new (this.wasmModule.glmVec3Array)());
         if (initialSize) {
             // resize has a required second parameter to set default values
             nativeVectorGlmVec3_.resize(initialSize, { x: 0, y: 0, z: 0 });
@@ -297,13 +288,10 @@ export class IfcGeometryExtraction {
     }
     /**
      *
-     * @param initialSize number - initial size of the vector (optional)
-     * @return {NativeVectorGlmVec3} - a native std::vector<glm::vec3> from the wasm module
+     * @return {StdVector<NativeVectorGlmVec3>} - a native std::vector<glm::vec3> from the wasm module
      */
     nativeVectorVectorGlmdVec3() {
-        const nativeVectorVectorGlmdVec3_ = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.glmdVec3ArrayArray)());
+        const nativeVectorVectorGlmdVec3_ = (new (this.wasmModule.glmdVec3ArrayArray)());
         return nativeVectorVectorGlmdVec3_;
     }
     /**
@@ -312,9 +300,7 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorGlmVec3} - a native std::vector<glm::vec3> from the wasm module
      */
     nativeVectorGlmdVec3(initialSize) {
-        const nativeVectorGlmdVec3_ = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.glmdVec3Array)());
+        const nativeVectorGlmdVec3_ = (new (this.wasmModule.glmdVec3Array)());
         if (initialSize) {
             // resize has a required second parameter to set default values
             nativeVectorGlmdVec3_.resize(initialSize, { x: 0, y: 0, z: 0 });
@@ -327,9 +313,7 @@ export class IfcGeometryExtraction {
      * @return {NativeVectorGlmVec3} - a native std::vector<glm::vec3> from the wasm module
      */
     nativeVectorGlmdVec2(initialSize) {
-        const nativeVectorGlmdVec2_ = 
-        // eslint-disable-next-line new-cap
-        (new (this.wasmModule.glmdVec2Array)());
+        const nativeVectorGlmdVec2_ = (new (this.wasmModule.glmdVec2Array)());
         if (initialSize) {
             // resize has a required second parameter to set default values
             nativeVectorGlmdVec2_.resize(initialSize, { x: 0, y: 0 });
@@ -342,11 +326,11 @@ export class IfcGeometryExtraction {
      * @param initialSize number - initial size of the vector (optional)
      * @return {NativeUintVector} - a native std::vector<uint32_t> from the wasm module
      */
-    nativeUintVector(initialize) {
+    nativeUintVector(initialSize) {
         const nativeUintVector_ = (new (this.wasmModule.UintVector)());
-        if (initialize) {
+        if (initialSize) {
             // resize has a required second parameter to set default values
-            nativeUintVector_.resize(initialize, 0);
+            nativeUintVector_.resize(initialSize, 0);
         }
         return nativeUintVector_;
     }
@@ -356,11 +340,11 @@ export class IfcGeometryExtraction {
      * @param initialSize number - initial size of the vector (optional)
      * @return {NativeULongVector} - a native std::vector<size_t> from the wasm module
      */
-    nativeULongVector(initialize) {
+    nativeULongVector(initialSize) {
         const nativeULongVector_ = new (this.wasmModule.ULongVector)();
-        if (initialize) {
+        if (initialSize) {
             // resize has a required second parameter to set default values
-            nativeULongVector_.resize(initialize, 0);
+            nativeULongVector_.resize(initialSize, 0);
         }
         return nativeULongVector_;
     }
@@ -386,7 +370,7 @@ export class IfcGeometryExtraction {
      * @param initialSize number - initial size of the vector (optional)
      * @return {NativeVectorIndexedPolygonalFace} - a native object from the wasm module
      */
-    nativeIndexedPolygonalFaceVector(initialize) {
+    nativeIndexedPolygonalFaceVector(initialSize) {
         let nativeVectorIndexedPolygonalFace;
         if (this.freeVectorPolygonalFaces_.length > 0) {
             nativeVectorIndexedPolygonalFace = this.freeVectorPolygonalFaces_.pop();
@@ -397,9 +381,9 @@ export class IfcGeometryExtraction {
         else {
             nativeVectorIndexedPolygonalFace = new (this.wasmModule.VectorIndexedPolygonalFace)();
         }
-        if (initialize) {
+        if (initialSize) {
             // resize has a required second parameter to set default values
-            nativeVectorIndexedPolygonalFace.resize(initialize);
+            nativeVectorIndexedPolygonalFace.resize(initialSize);
         }
         return nativeVectorIndexedPolygonalFace;
     }
@@ -419,14 +403,14 @@ export class IfcGeometryExtraction {
     }
     /**
      *
-     * @param initialize
+     * @param initializeSize
      * @return {NativeVectorBound3D}
      */
-    nativeBound3DVector(initialize) {
+    nativeBound3DVector(initializeSize) {
         const nativeVectorBound3D = new (this.wasmModule.Bound3DArray)();
-        if (initialize) {
+        if (initializeSize) {
             // resize has a required second parameter to set default values
-            nativeVectorBound3D.resize(initialize);
+            nativeVectorBound3D.resize(initializeSize);
         }
         return nativeVectorBound3D;
     }
@@ -443,6 +427,8 @@ export class IfcGeometryExtraction {
     }
     /**
      * Destroy geometry processor and deinitialize
+     *
+     * @param modelId
      */
     destroy(modelId = 0) {
         if (this.conwayModel !== void 0) {
@@ -523,6 +509,9 @@ export class IfcGeometryExtraction {
         }
     }
     /**
+     * @param entity
+     * @param temporary
+     * @param isRelVoid
      * @return {ExtractResult}
      */
     extractPolygonalFaceSet(entity, temporary = false, isRelVoid = false) {
@@ -605,7 +594,10 @@ export class IfcGeometryExtraction {
         }
         return result;
     }
-    /** @return {number} Pointer/memory address */
+    /**
+     * @param array
+     * @return {number} Pointer/memory address
+     */
     arrayToWasmHeap(array) {
         // Allocate memory for the array within the Wasm module
         const bytesPerElement = array.BYTES_PER_ELEMENT;
@@ -616,7 +608,10 @@ export class IfcGeometryExtraction {
         arrayWasm.set(new Uint8Array(array.buffer));
         return arrayPtr;
     }
-    /** @return {Uint8Array}  */
+    /**
+     * @param array
+     * @return {Uint8Array}
+     */
     arrayToSharedHeap(array) {
         // Allocate memory for the array within the Wasm module
         const bytesPerElement = array.BYTES_PER_ELEMENT;
@@ -709,6 +704,7 @@ export class IfcGeometryExtraction {
      * Accepts IfcBooleanResult and IfcBooleanClippingResult
      *
      * @param from
+     * @param isRelVoid
      */
     extractBooleanResult(from, isRelVoid = false) {
         if (this.csgMemoization) {
@@ -851,11 +847,13 @@ export class IfcGeometryExtraction {
         }
         this.paramsGetBooleanResultPool.release(parameters);
     }
-    /* eslint-disable default-param-last */
     /**
      * Extract a boolean operand from a boolean result.
      *
      * @param from The operand to extract.
+     * @param isRelVoid
+     * @param representationItem
+     * @param isSecondOperand
      * @return {void}
      */
     extractBooleanOperand(from, isRelVoid = false, representationItem, isSecondOperand = false) {
@@ -998,7 +996,6 @@ export class IfcGeometryExtraction {
             this.paramsGetBooleanResultPool.release(parameters);
         }
     }
-    /* eslint-enable default-param-last */
     /* eslint-disable no-magic-numbers */ // No magic numbers disabled
     // Cos we have *lots* of default material values.
     /**
@@ -1010,8 +1007,7 @@ export class IfcGeometryExtraction {
         const materials = this.materials;
         const material = materials.get(from.localID);
         if (material === void 0) {
-            const readDoubleSided = from.Side === IfcSurfaceSide.BOTH ||
-                from.Side === IfcSurfaceSide.POSITIVE;
+            const readDoubleSided = from.Side === IfcSurfaceSide.BOTH;
             const newMaterial = {
                 name: `#${from.expressID}`,
                 baseColor: [0.8, 0.8, 0.8, 1],
@@ -1124,11 +1120,12 @@ export class IfcGeometryExtraction {
             materials.add(from.localID, newMaterial);
         }
     }
-    /* eslint-enable no-magic-numbers */
     /**
      * Extract a style item.
      *
      * @param from The styled item to extract from
+     * @param representationItem
+     * @param mappedItem
      * @return {number | undefined}
      */
     extractStyledItem(from, representationItem, mappedItem) {
@@ -1210,6 +1207,7 @@ export class IfcGeometryExtraction {
      *
      * @param from
      * @param temporary
+     * @param isRelVoid
      */
     extractHalfspaceSolid(from, temporary = false, isRelVoid = false) {
         if (from.BaseSurface instanceof IfcPlane) {
@@ -1246,6 +1244,7 @@ export class IfcGeometryExtraction {
      *
      * @param from
      * @param temporary
+     * @param isRelVoid
      */
     extractPolygonalBoundedHalfSpace(from, temporary = false, isRelVoid = false) {
         // TODO(nickcastel50):unfinished - not needed at the moment -
@@ -1295,6 +1294,7 @@ export class IfcGeometryExtraction {
      *
      * @param from
      * @param temporary
+     * @param isRelVoid
      */
     extractExtrudedAreaSolid(from, temporary = false, isRelVoid = false) {
         let axis2PlacementTransform = (void 0);
@@ -1914,6 +1914,8 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param parentSense
+     * @param close
      * @return {CurveObject | undefined}
      */
     extractCompositeCurve(from, parentSense = true, close = false) {
@@ -1956,6 +1958,9 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param parentSense
+     * @param isEdge
+     * @param trimmingArguments
      * @return {CurveObject | undefined}
      */
     extractCurve(from, parentSense = true, isEdge = false, trimmingArguments = void 0) {
@@ -2030,6 +2035,8 @@ export class IfcGeometryExtraction {
      * Exctact a BSpline Curve
      *
      * @param from The bspline curve, potentially with knots/rational.
+     * @param parentSense
+     * @param isEdge
      * @return {CurveObject} The constructed curve object.
      */
     extractBSplineCurve(from, parentSense = true, isEdge = false) {
@@ -2049,7 +2056,6 @@ export class IfcGeometryExtraction {
             senseAgreement: parentSense,
             isEdge: isEdge,
         };
-        // eslint-disable-next-line no-magic-numbers
         if (dimensions === 2) {
             const outputPoints = params.points2;
             for (const point of from.ControlPointsList) {
@@ -2061,7 +2067,6 @@ export class IfcGeometryExtraction {
             const outputPoints = params.points3;
             // Logger.info(`express ID: ${from.expressID} controlPointsList: ${from.ControlPointsList}`)
             for (const point of from.ControlPointsList) {
-                // eslint-disable-next-line no-magic-numbers
                 if (point.Dim !== 3) {
                     continue;
                 }
@@ -2101,7 +2106,6 @@ export class IfcGeometryExtraction {
         }
         else {
             // This is just a IfcBsplineCurve, build default parameter lists
-            // eslint-disable-next-line no-lonely-if
             if (dimensions === this.TWO_DIMENSIONS) {
                 // build default knots
                 const outputKnots = params.knots;
@@ -2128,7 +2132,6 @@ export class IfcGeometryExtraction {
         const curveObject = this.conwayModel.getBSplineCurve(params);
         return curveObject;
     }
-    /* eslint-disable default-param-last */
     /**
      * Extract a IfcLine curve
      *
@@ -2194,11 +2197,10 @@ export class IfcGeometryExtraction {
         const curve = this.conwayModel.getIfcLine(parametersIfcCircle);
         return curve;
     }
-    /* eslint-enable default-param-last */
-    /* eslint-disable default-param-last */
     /**
      *
      * @param from
+     * @param parentSense
      * @param parametersTrimmedCurve
      * @return {CurveObject | undefined}
      */
@@ -2244,11 +2246,10 @@ export class IfcGeometryExtraction {
         const curve = this.conwayModel.getIfcCircle(parametersIfcCircle);
         return curve;
     }
-    /* eslint-enable default-param-last */
-    /* eslint-disable default-param-last */
     /**
      *
      * @param from
+     * @param parentSense
      * @param parametersTrimmedCurve
      * @return {CurveObject | undefined}
      */
@@ -2293,10 +2294,11 @@ export class IfcGeometryExtraction {
         const curve = this.conwayModel.getIfcCircle(parametersIfcCircle);
         return curve;
     }
-    /* eslint-enable default-param-last */
     /**
      *
      * @param from
+     * @param parentSense
+     * @param isEdge
      * @return {CurveObject | undefined}
      */
     extractIfcTrimmedCurve(from, parentSense = true, isEdge = false) {
@@ -2481,9 +2483,7 @@ export class IfcGeometryExtraction {
         }
         // 2) Create a Float64Array view into WASM memory
         // We only need to create a subarray up to the capacity
-        const wasmFloat64View = this.wasmModule.HEAPF64.subarray(pointer / bytesPerElement, 
-        // eslint-disable-next-line no-mixed-operators
-        pointer / bytesPerElement + capacity);
+        const wasmFloat64View = this.wasmModule.HEAPF64.subarray(pointer / bytesPerElement, pointer / bytesPerElement + capacity);
         // 3) Single pass to skip consecutive duplicates, fill up the wasm array
         let offset = 0;
         let prevLocalID = -1;
@@ -2506,6 +2506,8 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param parentSense
+     * @param isEdge
      * @return {CurveObject | undefined }
      */
     extractIfcPolyline(from, parentSense = true, isEdge = false) {
@@ -2766,6 +2768,10 @@ export class IfcGeometryExtraction {
      * Extract a mapped item to add its transform to instance an item.
      *
      * @param from The mapped item to extract.
+     * @param owningElement
+     * @param isRelVoid
+     * @param isSpace
+     * @param parents
      */
     extractMappedItem(from, owningElement, isRelVoid = false, isSpace = false, parents = void 0) {
         const representationMap = from.MappingSource;
@@ -2836,6 +2842,10 @@ export class IfcGeometryExtraction {
      * Note - memoized result for instancing.
      *
      * @param from The representation to extract from.
+     * @param owningElementLocalID
+     * @param isRelVoid
+     * @param isSpace
+     * @param isMappedItem
      */
     extractRepresentationItem(from, owningElementLocalID, isRelVoid = false, isSpace = false, isMappedItem = false) {
         const addGeometry = !isRelVoid && !isMappedItem;
@@ -2921,8 +2931,8 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from array of IfcConnectedFaceSet
-     * @param isRelVoid is from a relative void (default false)
      * @param parentLocalID parent element local ID
+     * @param isRelVoid is from a relative void (default false)
      */
     extractConnectedFaceSets(from, parentLocalID, isRelVoid = false) {
         let geometry = (new (this.wasmModule.IfcGeometry));
@@ -2957,6 +2967,8 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param temporary
+     * @param isRelVoid
      */
     extractIfcFacetedBrep(from, temporary = false, isRelVoid = false) {
         const faces = from.Outer.CfsFaces;
@@ -2965,6 +2977,9 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param owningElementLocalID
+     * @param isRelVoid
+     * @param isSpace
      */
     extractIfcShellBasedSurfaceModel(from, owningElementLocalID, isRelVoid = false, isSpace = false) {
         const sbsmBoundary = from.SbsmBoundary;
@@ -2981,6 +2996,7 @@ export class IfcGeometryExtraction {
      * @param from
      * @param parentLocalID
      * @param geometry_
+     * @param temporary
      * @param isRelVoid
      * @return {GeometryObject}
      */
@@ -3084,6 +3100,8 @@ export class IfcGeometryExtraction {
      *
      * @param from The bspline surface to extract
      * @param to The surface to extract to
+     * @param start
+     * @param end
      */
     extractToDoubleVector(from, to, start = 0, end = from.length) {
         to.resize(end - start, 0);
@@ -3196,7 +3214,6 @@ export class IfcGeometryExtraction {
                             let trimmingEnd;
                             if (edgeStart instanceof IfcVertexPoint) {
                                 const startPoint = edgeStart.VertexGeometry;
-                                // eslint-disable-next-line no-magic-numbers
                                 if (startPoint instanceof IfcCartesianPoint && startPoint.Dim === 3) {
                                     const startCoords = startPoint.Coordinates;
                                     trimmingStart = {
@@ -3215,7 +3232,6 @@ export class IfcGeometryExtraction {
                             }
                             if (edgeEnd instanceof IfcVertexPoint) {
                                 const endPoint = edgeEnd.VertexGeometry;
-                                // eslint-disable-next-line no-magic-numbers
                                 if (endPoint instanceof IfcCartesianPoint && endPoint.Dim === 3) {
                                     const endCoords = endPoint.Coordinates;
                                     trimmingEnd = {
@@ -3294,7 +3310,6 @@ export class IfcGeometryExtraction {
                             const start = edge.EdgeStart;
                             if (start instanceof IfcVertexPoint) {
                                 const startPoint = start.VertexGeometry;
-                                // eslint-disable-next-line no-magic-numbers
                                 if (startPoint instanceof IfcCartesianPoint && startPoint.Dim === 3) {
                                     const startCoords = startPoint.Coordinates;
                                     vec3Array.push_back({
@@ -3471,7 +3486,6 @@ export class IfcGeometryExtraction {
                     // Now `result.pointer` is your up-to-date pointer (maybe a new allocation).
                     // `result.length` is how many Float64 coords are valid.
                     // `result.capacity` is how many Float64 coords that pointer can hold.
-                    // eslint-disable-next-line no-unused-vars
                     const { pointer, length, capacity } = result;
                     // Use them in your WASM call
                     const bound3D = this.wasmModule.createSimpleBound3D(pointer, length, bound.Orientation, bound.type === EntityTypesIfc.IFCFACEOUTERBOUND ? 0 : 1);
@@ -3574,7 +3588,6 @@ export class IfcGeometryExtraction {
         };
         return this.conwayModel.getAxis2Placement2D(axis2Placement2DParameters);
     }
-    // eslint-disable-next-line no-dupe-class-members, require-jsdoc
     extractAxis1Placement3D(from, parentLocalId, extractOnly = false) {
         if (from === null) {
             return;
@@ -3610,7 +3623,6 @@ export class IfcGeometryExtraction {
             .getAxis1Placement3D(axis1Placement3DParameters);
         this.scene.addTransform(parentLocalId, axis1PlacementTransform.getValues(), axis1PlacementTransform);
     }
-    // eslint-disable-next-line no-dupe-class-members, require-jsdoc
     extractAxis2Placement3D(from, parentLocalId, extractOnly = false) {
         if (from === null) {
             return;
@@ -3659,7 +3671,6 @@ export class IfcGeometryExtraction {
             .getAxis2Placement3D(axis2Placement3DParameters);
         this.scene.addTransform(parentLocalId, axis2PlacementTransform.getValues(), axis2PlacementTransform);
     }
-    // eslint-disable-next-line no-dupe-class-members, require-jsdoc
     extractAxis2Placement3DRelVoid(from, parentLocalId, extractOnly = false) {
         if (from === null) {
             return;
@@ -3709,6 +3720,7 @@ export class IfcGeometryExtraction {
     /**
      *
      * @param from
+     * @param isRelVoid
      */
     extractPlacement(from, isRelVoid = false) {
         let result;
@@ -3751,9 +3763,11 @@ export class IfcGeometryExtraction {
      *
      * @param from
      * @param relVoidMeshVector
-     * @param flattenedGeometry
-     * @param relVoidLocalID
-     * @param geometryCount
+     * @param owningElementLocalID
+     * @param relVoidLocalIDs
+     * @param materialOverrideId
+     * @param isSpace
+     * @return {void}
      */
     applyRelVoidToRepresentation(from, relVoidMeshVector, owningElementLocalID, relVoidLocalIDs, materialOverrideId, isSpace = false) {
         // get geometry from product and flatten it
@@ -4101,7 +4115,6 @@ export class IfcGeometryExtraction {
      * @return {number | null}
      */
     convertPrefix(prefix) {
-        /* eslint-disable no-magic-numbers */
         switch (prefix) {
             case IfcSIPrefix.EXA:
                 return 1e18;
@@ -4141,7 +4154,7 @@ export class IfcGeometryExtraction {
     }
     /**
      *
-     * @param from
+     * @param outputFilePath
      * @param geometry
      */
     dumpGeometry(outputFilePath, geometry) {
@@ -4155,8 +4168,6 @@ export class IfcGeometryExtraction {
     /**
      * Extract the geometry data from the IFC
      *
-     * @param model - Input IfcStepModel to extract geometry data from
-     * @param logTime boolean - print execution time (default no)
      * @return {[ExtractResult, IfcSceneBuilder]} - Enum indicating extraction result
      * + Geometry array
      */

package/compiled/src/ifc/ifc_geometry_extraction.test.js

@@ -9,6 +9,8 @@ import { ExtractResult } from '../core/shared_constants';
 let conwayModel;
 /**
  *
+ *
+ * @return {Promise< boolean | ExtractResult | void >}
  */
 async function initializeGeometryExtractor() {
     const parser = IfcStepParser.Instance;
@@ -59,6 +61,8 @@ function getMaterialCount() {
 /**
  * Test if a material colour at a particular index matches a value.
  *
+ * @param materialIndex
+ * @param equal
  * @return {boolean} True if a match, false otherwise.
  */
 function materialColorMatches(materialIndex, equal) {

package/compiled/src/ifc/ifc_material_cache.d.ts

@@ -2,10 +2,12 @@ import { CanonicalMaterial } from '../core/canonical_material';
 import IfcStepModel from './ifc_step_model';
 import StepEntityBase from '../step/step_entity_base';
 import EntityTypesIfc from './ifc4_gen/entity_types_ifc.gen';
+import { ModelMaterials } from '../core/model_materials';
+import { SceneNodeGeometry } from '../core/scene_node';
 /**
  * Cache of materials via their local ID
  */
-export declare class IfcMaterialCache {
+export declare class IfcMaterialCache implements ModelMaterials {
     readonly model: IfcStepModel;
     readonly isVoid: boolean;
     private readonly cache_;
@@ -17,6 +19,7 @@ export declare class IfcMaterialCache {
      * Construct this with an IFC step model.
      *
      * @param model The model this is from
+     * @param isVoid
      */
     constructor(model: IfcStepModel, isVoid?: boolean);
     /**
@@ -33,14 +36,14 @@ export declare class IfcMaterialCache {
     /**
      * Get the materials in the cache.
      *
-     * @return {IterableIterator<[number, CanonicalMaterial]>} The iterator for the
+     * @return {IterableIterator} The iterator for the
      * local IDs and their respective materials.
      */
     [Symbol.iterator](): IterableIterator<[number, CanonicalMaterial]>;
     /**
      * Get the materials in the cache (values only).
      *
-     * @return {IterableIterator<CanonicalMaterial>} The iterator for the respective
+     * @return {IterableIterator} The iterator for the respective
      * materials.
      */
     materials(): IterableIterator<CanonicalMaterial>;
@@ -58,11 +61,18 @@ export declare class IfcMaterialCache {
      * @return {CanonicalMaterial | undefined} The material for the matching local ID
      */
     get(localID: number): CanonicalMaterial | undefined;
+    /**
+     * Get the material matching a geometry node.
+     *
+     * @param node The geometry node to match a material for.
+     * @return {CanonicalMaterial | undefined} A material, or undefined if it is not found.
+     */
+    getMaterialFromGeometryNode(node: SceneNodeGeometry): CanonicalMaterial | undefined;
     /**
      * Get a material by its local ID.
      *
      * @param geometryLocalID The local ID of the geometry to fetch
-     * @return {[CanonicalMaterial, number] | undefined} A tuple containing the
+     * @return {number | undefined} A tuple containing the
      * material and its id, or undefined if it is not found.
      */
     getMaterialIDByGeometryID(geometryLocalID: number): number | undefined;

package/compiled/src/ifc/ifc_material_cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ifc_material_cache.d.ts","sourceRoot":"","sources":["../../../src/ifc/ifc_material_cache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAW,MAAM,4BAA4B,CAAA;AACvE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAC3C,OAAO,cAAc,MAAM,0BAA0B,CAAA;AACrD,OAAO,cAAc,MAAM,iCAAiC,CAAA;AAG5D;;GAEG;AACH,qBAAa,gBAAgB;aAkBE,KAAK,EAAE,YAAY;aAAkB,MAAM,EAAE,OAAO;IAhBjF,OAAO,CAAC,QAAQ,CAAC,MAAM,CACiB;IAExC,OAAO,CAAC,QAAQ,CAAC,YAAY,CACA;IAE7B,QAAQ,CAAC,eAAe,sBAA4B;IACpD,QAAQ,CAAC,sBAAsB,sBAA4B;IAC3D,QAAQ,CAAC,aAAa,sBAA4B;IAGlD;;;;OAIG;gBAC0B,KAAK,EAAE,YAAY,EAAkB,MAAM,GAAE,OAAe;IAEzF;;;OAGG;IACI,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAA;IAEjD;;;;OAIG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;;OAKG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAKzE;;;;;OAKG;IACI,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC;IAKvD;;;;;OAKG;IACI,GAAG,CAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB;IAKxD;;;;;OAKG;IACI,GAAG,CAAE,OAAO,EAAE,MAAM,GAAI,iBAAiB,GAAG,SAAS;IAK5D;;;;;;OAMG;IACI,yBAAyB,CAAE,eAAe,EAAE,MAAM,GAAI,MAAM,GAAG,SAAS;IAK/E;;;;;OAKG;IACI,kBAAkB,CAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAI,IAAI;IAKnF;;;;OAIG;IACI,yBAAyB,CAAE,eAAe,EAAE,MAAM,GAAI,IAAI;IAUjE;;;;;;;OAOG;IACI,uBAAuB,CAAE,eAAe,EAAE,MAAM,GACrD;QAAC,iBAAiB;QAAE,MAAM;KAAC,GAAG,SAAS;IAiBzC;;;;OAIG;IACK,IAAI,IAAK,gBAAgB,CAAE,CAAC,cAAc,CAAE,cAAc,CAAE,EAAE,MAAM,CAAC,CAAE;CAiBhF"}
+{"version":3,"file":"ifc_material_cache.d.ts","sourceRoot":"","sources":["../../../src/ifc/ifc_material_cache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAW,MAAM,4BAA4B,CAAA;AACvE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAC3C,OAAO,cAAc,MAAM,0BAA0B,CAAA;AACrD,OAAO,cAAc,MAAM,iCAAiC,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAGtD;;GAEG;AACH,qBAAa,gBAAiB,YAAW,cAAc;aAmBxB,KAAK,EAAE,YAAY;aAAkB,MAAM,EAAE,OAAO;IAjBjF,OAAO,CAAC,QAAQ,CAAC,MAAM,CACiB;IAExC,OAAO,CAAC,QAAQ,CAAC,YAAY,CACA;IAE7B,QAAQ,CAAC,eAAe,sBAA4B;IACpD,QAAQ,CAAC,sBAAsB,sBAA4B;IAC3D,QAAQ,CAAC,aAAa,sBAA4B;IAGlD;;;;;OAKG;gBAC0B,KAAK,EAAE,YAAY,EAAkB,MAAM,GAAE,OAAe;IAEzF;;;OAGG;IACI,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAA;IAEjD;;;;OAIG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;;OAKG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAKzE;;;;;OAKG;IACI,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC;IAKvD;;;;;OAKG;IACI,GAAG,CAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB;IAKxD;;;;;OAKG;IACI,GAAG,CAAE,OAAO,EAAE,MAAM,GAAI,iBAAiB,GAAG,SAAS;IAK5D;;;;;OAKG;IACI,2BAA2B,CAAE,IAAI,EAAE,iBAAiB,GAAI,iBAAiB,GAAG,SAAS;IAoB5F;;;;;;OAMG;IACI,yBAAyB,CAAE,eAAe,EAAE,MAAM,GAAI,MAAM,GAAG,SAAS;IAK/E;;;;;OAKG;IACI,kBAAkB,CAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAI,IAAI;IAKnF;;;;OAIG;IACI,yBAAyB,CAAE,eAAe,EAAE,MAAM,GAAI,IAAI;IAUjE;;;;;;;OAOG;IACI,uBAAuB,CAAE,eAAe,EAAE,MAAM,GACrD;QAAC,iBAAiB;QAAE,MAAM;KAAC,GAAG,SAAS;IAiBzC;;;;OAIG;IACK,IAAI,IAAK,gBAAgB,CAAE,CAAC,cAAc,CAAE,cAAc,CAAE,EAAE,MAAM,CAAC,CAAE;CAiBhF"}