@ifc-lite/create 2.7.0 → 2.9.2

package/dist/ifc-creator.js

@@ -5,7 +5,12 @@ import { esc, stepLine, num, vecLen, vecNorm, vecCross, optStr, optEnum, NON_ELE
 import { emitWorkCalendar, emitTaskTime } from './ifc-creator-scheduling.js';
 import { assertCostSchema, emitCostItem, emitCostSchedule, emitCostValue, emitMeasureWithUnit, emitMonetaryUnit, emitPhysicalQuantity, emitRelAssignsToProduct, emitSIUnit, } from './ifc-creator-cost.js';
 import { emitElementQuantity, emitPropertySet } from './ifc-creator-definitions.js';
+import { createTerrainWriter } from './ifc-creator-terrain.js';
+import { emitRelFillsElement, emitSpatialRelationships } from './ifc-creator-relationships.js';
+import { emitDefaultStyle, emitStyledItems } from './ifc-creator-styles.js';
+import { buildStepHeader } from './ifc-creator-header.js';
 import { generateIfcGuid, isValidIfcGuid } from '@ifc-lite/encoding';
+import { fileSchemaIdentifier } from '@ifc-lite/data';
 // ============================================================================
 // IfcCreator
 // ============================================================================
@@ -50,6 +55,15 @@ export class IfcCreator {
     dirX = 0;
     worldPlacementId = 0;
     unitAssignmentId = 0;
+    // Products contained directly in the site rather than a storey: terrain and
+    // survey annotations have no storey, and inventing one would put them on a
+    // datum the source never declared.
+    siteElements = [];
+    /** Products aggregated by the project itself — `IfcAlignment` (§11 of the LandXML mapping). */
+    projectElements = [];
+    georeferenced = false;
+    /** The length `IfcNamedUnit` `IfcProjectedCRS.MapUnit` points at. */
+    lengthUnitId = 0;
     // Guard against repeated toIfc() calls (relationships are not idempotent)
     finalized = false;
     // Default surface style (applied to elements without custom color)
@@ -79,6 +93,9 @@ export class IfcCreator {
     constructor(params = {}) {
         this.projectParams = params;
         this.schema = params.Schema ?? 'IFC4';
+        if (params.FileSchemaIdentifier !== undefined && this.schema !== 'IFC4X3') {
+            throw new Error(`IfcCreator: FileSchemaIdentifier '${params.FileSchemaIdentifier}' requires Schema 'IFC4X3', not '${this.schema}'`);
+        }
         this.fixedTimestampMs = params.Timestamp === undefined
             ? null
             : typeof params.Timestamp === 'number' ? params.Timestamp : params.Timestamp.getTime();
@@ -1177,6 +1194,53 @@ export class IfcCreator {
         return beamId;
     }
     // ============================================================================
+    // Public API — Terrain & survey (IFC4X3, LandXML→IFC mapping)
+    // ============================================================================
+    /**
+     * The terrain/survey authoring surface: TIN surfaces, survey points, their
+     * property sets and the file's georeferencing.
+     *
+     * One accessor rather than four methods: each needs the same creator
+     * internals and nothing else. `ifc-creator-terrain.ts` documents each call.
+     */
+    terrain() {
+        return createTerrainWriter(this.terrainContext(), {
+            trackSiteProduct: (expressId, type, name) => {
+                this.siteElements.push(expressId);
+                this.entities.push({ expressId, type, Name: name });
+            },
+            lengthUnitRef: () => `#${this.lengthUnitId}`,
+            siteId: () => this.siteId,
+            trackProjectProduct: (expressId, type, name) => {
+                this.projectElements.push(expressId);
+                this.entities.push({ expressId, type, Name: name });
+            },
+            claimGeoreferencing: () => {
+                if (this.georeferenced) {
+                    throw new Error('setGeoreferencing: already called — a file has at most one IfcMapConversion for its model context');
+                }
+                this.georeferenced = true;
+            },
+        });
+    }
+    /** The creator hooks `ifc-creator-terrain.ts`'s emitters need. */
+    terrainContext() {
+        return {
+            emit: this.emitEntity,
+            newGlobalId: () => this.newGlobalId(),
+            ownerRef: `#${this.ownerHistoryId}`,
+            modelContextRef: `#${this.contextId}`,
+            bodyContextRef: `#${this.subContextBody}`,
+            axisContextRef: `#${this.subContextAxis}`,
+            sitePlacementRef: `#${this.worldPlacementId}`,
+            assertSchema: (feature) => {
+                if (this.schema !== 'IFC4X3') {
+                    throw new Error(`${feature} requires the IFC4X3 schema — IfcTriangulatedIrregularNetwork and the survey/terrain predefined types do not exist in ${this.schema}`);
+                }
+            },
+        };
+    }
+    // ============================================================================
     // Public API — Properties & Quantities
     // ============================================================================
     /** Attach a property set to an element */
@@ -1533,19 +1597,7 @@ export class IfcCreator {
         };
     }
     buildHeader() {
-        const now = new Date(this.nowMs()).toISOString().replace(/\.\d{3}Z$/, ''); // ISO 8601 time_stamp: keep '-'/':', drop only ms+'Z'
-        const desc = 'Created by ifc-lite';
-        const author = this.projectParams.Author ?? '';
-        const org = this.projectParams.Organization ?? '';
-        const app = 'ifc-lite';
-        const filename = 'created.ifc';
-        return `ISO-10303-21;
-HEADER;
-FILE_DESCRIPTION(('${esc(desc)}'),'2;1');
-FILE_NAME('${filename}','${now}',('${esc(author)}'),('${esc(org)}'),'${app}','${app}','');
-FILE_SCHEMA(('${this.schema}'));
-ENDSEC;
-`;
+        return buildStepHeader(this.nowMs(), this.projectParams.Author ?? '', this.projectParams.Organization ?? '', fileSchemaIdentifier(this.schema));
     }
     // ============================================================================
     // Internal — Preamble (project, site, building, contexts, units, style)
@@ -1581,7 +1633,7 @@ ENDSEC;
         // Units
         this.unitAssignmentId = this.buildUnits(params.LengthUnit ?? 'METRE', params.Currency);
         // Default surface style — light grey with some specularity
-        this.defaultStyleId = this.buildDefaultStyle();
+        this.defaultStyleId = emitDefaultStyle({ emit: this.emitEntity });
         // IfcProject
         this.projectId = this.id();
         const projectGlobalId = this.newGlobalId();
@@ -1624,59 +1676,19 @@ ENDSEC;
             assertCostSchema(this.schema, 'ProjectParams.Currency'); // IFC2X3 Currency is an enum
             units.push(emitMonetaryUnit(currency, this.emitEntity));
         }
+        this.lengthUnitId = lengthUnitId;
         const assignmentId = this.id();
         this.line(assignmentId, 'IFCUNITASSIGNMENT', `(${units.map(id => `#${id}`).join(',')})`);
         return assignmentId;
     }
-    /** Create a default IfcSurfaceStyle with a neutral colour (RGB 0.75, 0.73, 0.68) */
-    buildDefaultStyle() {
-        // IfcColourRgb — warm concrete grey
-        const colourId = this.id();
-        this.line(colourId, 'IFCCOLOURRGB', `$,0.75,0.73,0.68`);
-        // IfcSurfaceStyleRendering — surface + specular
-        const renderingId = this.id();
-        this.line(renderingId, 'IFCSURFACESTYLERENDERING', `#${colourId},0.,$,$,$,$,IFCNORMALISEDRATIOMEASURE(0.5),IFCSPECULAREXPONENT(64.),.NOTDEFINED.`);
-        // IfcSurfaceStyle
-        const styleId = this.id();
-        this.line(styleId, 'IFCSURFACESTYLE', `'Default',.BOTH.,(#${renderingId})`);
-        return styleId;
-    }
-    /** Create all IfcStyledItem entities — custom colour or default per element */
+    /**
+     * Create all `IfcStyledItem` rows — a custom colour where one was assigned,
+     * the default grey otherwise. See `ifc-creator-styles.ts`.
+     */
     finalizeStyles() {
-        // Cache: colour key → styleId so identical colours share one style entity
-        const styleCache = new Map();
-        for (const [elementId, solidIds] of this.elementSolids) {
-            const color = this.elementColors.get(elementId);
-            let styleId;
-            if (color) {
-                const key = `${color.name}|${color.rgb.join(',')}`;
-                const cached = styleCache.get(key);
-                if (cached !== undefined) {
-                    styleId = cached;
-                }
-                else {
-                    styleId = this.buildColorStyle(color.name, color.rgb);
-                    styleCache.set(key, styleId);
-                }
-            }
-            else {
-                styleId = this.defaultStyleId;
-            }
-            for (const solidId of solidIds) {
-                const styledItemId = this.id();
-                this.line(styledItemId, 'IFCSTYLEDITEM', `#${solidId},(#${styleId}),$`);
-            }
-        }
-    }
-    /** Create a named IfcSurfaceStyle with the given RGB colour */
-    buildColorStyle(name, rgb) {
-        const colourId = this.id();
-        this.line(colourId, 'IFCCOLOURRGB', `$,${num(rgb[0])},${num(rgb[1])},${num(rgb[2])}`);
-        const renderingId = this.id();
-        this.line(renderingId, 'IFCSURFACESTYLERENDERING', `#${colourId},0.,$,$,$,$,IFCNORMALISEDRATIOMEASURE(0.5),IFCSPECULAREXPONENT(64.),.NOTDEFINED.`);
-        const styleId = this.id();
-        this.line(styleId, 'IFCSURFACESTYLE', `'${esc(name)}',.BOTH.,(#${renderingId})`);
-        return styleId;
+        emitStyledItems(this.elementSolids, this.elementColors, this.defaultStyleId, {
+            emit: this.emitEntity,
+        });
     }
     // ============================================================================
     // Internal — Material helpers
@@ -1713,12 +1725,16 @@ ENDSEC;
     // ============================================================================
     // Internal — Geometry helpers
     // ============================================================================
+    // Every builder's Position/Start/opening point is written here (#5217).
     addCartesianPoint(p) {
+        assertFinitePoint3({ IfcCartesianPoint: p }, 'IfcCreator');
         const id = this.id();
         this.line(id, 'IFCCARTESIANPOINT', `(${num(p[0])},${num(p[1])},${num(p[2])})`);
         return id;
     }
     addCartesianPoint2D(p) {
+        if (!p.every(Number.isFinite))
+            throw new Error('IfcCreator: IfcCartesianPoint must have finite coordinates');
         const id = this.id();
         this.line(id, 'IFCCARTESIANPOINT', `(${num(p[0])},${num(p[1])})`);
         return id;
@@ -1742,14 +1758,8 @@ ENDSEC;
      */
     addLocalPlacement(relativeTo, placement) {
         const originId = this.addCartesianPoint(placement.Location);
-        let axisId;
-        let refDirId;
-        if (placement.Axis) {
-            axisId = this.addDirection(placement.Axis);
-        }
-        if (placement.RefDirection) {
-            refDirId = this.addDirection(placement.RefDirection);
-        }
+        const axisId = placement.Axis ? this.addDirection(placement.Axis) : undefined;
+        const refDirId = placement.RefDirection ? this.addDirection(placement.RefDirection) : undefined;
         const axis2Id = this.addAxis2Placement3D(originId, axisId, refDirId);
         const id = this.id();
         this.line(id, 'IFCLOCALPLACEMENT', `#${relativeTo},#${axis2Id}`);
@@ -2171,33 +2181,23 @@ ENDSEC;
     // Internal — Relationship finalization
     // ============================================================================
     finalizeRelationships() {
-        this.addIfcRelAggregates(this.projectId, [this.siteId]);
-        this.addIfcRelAggregates(this.siteId, [this.buildingId]);
-        if (this.storeyIds.length > 0) {
-            this.addIfcRelAggregates(this.buildingId, this.storeyIds);
-        }
-        for (const [storeyId, elementIds] of this.storeyElements) {
-            if (elementIds.length > 0) {
-                this.addIfcRelContainedInSpatialStructure(storeyId, elementIds);
-            }
-        }
-    }
-    addIfcRelAggregates(relatingId, relatedIds) {
-        const relId = this.id();
-        const globalId = this.newGlobalId();
-        const refs = relatedIds.map(id => `#${id}`).join(',');
-        this.line(relId, 'IFCRELAGGREGATES', `'${globalId}',#${this.ownerHistoryId},$,$,#${relatingId},(${refs})`);
-    }
-    addIfcRelContainedInSpatialStructure(storeyId, elementIds) {
-        const relId = this.id();
-        const globalId = this.newGlobalId();
-        const refs = elementIds.map(id => `#${id}`).join(',');
-        this.line(relId, 'IFCRELCONTAINEDINSPATIALSTRUCTURE', `'${globalId}',#${this.ownerHistoryId},$,$,(${refs}),#${storeyId}`);
+        emitSpatialRelationships({
+            emit: this.emitEntity,
+            newGlobalId: () => this.newGlobalId(),
+            ownerRef: `#${this.ownerHistoryId}`,
+            projectId: this.projectId,
+            siteId: this.siteId,
+            buildingId: this.buildingId,
+            storeyIds: this.storeyIds,
+            storeyElements: this.storeyElements,
+            siteElements: this.siteElements,
+            projectElements: this.projectElements,
+        });
     }
     addIfcRelFillsElement(openingId, fillingId) {
-        const relId = this.id();
-        const globalId = this.newGlobalId();
-        this.line(relId, 'IFCRELFILLSELEMENT', `'${globalId}',#${this.ownerHistoryId},$,$,#${openingId},#${fillingId}`);
+        emitRelFillsElement(openingId, fillingId, {
+            emit: this.emitEntity, newGlobalId: () => this.newGlobalId(), ownerRef: `#${this.ownerHistoryId}`,
+        });
     }
     // ============================================================================
     // Internal — Utilities