@ifc-lite/geometry 7.1.0 → 7.2.0

package/dist/world-frame.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Render frame <-> IFC world coordinates: the one implementation (#4879).
+ *
+ * Meshes out of this package are NOT in the file's own coordinates. The wasm
+ * mesh pass subtracts an RTC offset (`CoordinateInfo.wasmRtcOffset`, IFC
+ * Z-up) and `CoordinateHandler` may subtract a further origin shift
+ * (`CoordinateInfo.originShift`, already in the Y-up mesh axes), both to keep
+ * f32 precision usable for georeferenced models. Everything read off those
+ * meshes (renderer camera, section plane, entity and clash bounds) is in that
+ * shifted, Y-up "render frame". Anything written for another tool (BCF
+ * viewpoints above all) has to be in IFC world coordinates, Z-up.
+ *
+ * The viewer, the CLI, the MCP playground and the SDK all need the same
+ * answer, so the axis swap and the offset sum live here, next to the
+ * `CoordinateInfo` they read, rather than once per consumer.
+ * `scripts/check-rtc-frame-copies.mjs` keeps it that way.
+ */
+import type { CoordinateInfo, Vec3 } from './coordinate-types.js';
+/** The two recorded offsets; either may be absent (a model near the origin). */
+export type RenderFrameInfo = {
+    originShift?: Readonly<Vec3> | null;
+    wasmRtcOffset?: Readonly<Vec3> | null;
+};
+/**
+ * Convert an IFC Z-up coordinate to the render frame's Y-up axes. `0 - value`
+ * deliberately normalises either sign of zero only on the negated axis.
+ */
+export declare function ifcToViewerAxes(point: Readonly<Vec3>): Vec3;
+/** Convert render-frame Y-up to IFC Z-up with the same negated-axis zero rule. */
+export declare function viewerToIfcAxes(point: Readonly<Vec3>): Vec3;
+/**
+ * Total translation from the render frame to world coordinates, in Y-up
+ * axes. `originShift` is already Y-up; `wasmRtcOffset` is IFC Z-up.
+ */
+export declare function totalYupOffset(info?: RenderFrameInfo | null): Vec3;
+/**
+ * Render frame -> IFC world translation, in IFC Z-up metres: the axes BCF
+ * positions (and the IFC file) use. Add it to a render-frame point that has
+ * already been converted to Z-up. Exactly zero, with no `-0`, for a model
+ * that was not shifted.
+ */
+export declare function renderFrameWorldOffset(info?: RenderFrameInfo | null): Vec3;
+/** A loaded model as far as the federation frame rule is concerned. */
+export interface FrameCandidate {
+    /** Load order; the earliest-loaded model owns the shared frame. */
+    loadedAt: number;
+    geometryResult?: {
+        coordinateInfo?: CoordinateInfo | null;
+    } | null;
+}
+/**
+ * The `CoordinateInfo` whose frame a set of loaded models is drawn in.
+ *
+ * A federation is aligned to the earliest-loaded model's RTC frame at load,
+ * so that model's offsets ARE the scene's offsets; reading a later model's
+ * would describe a frame nothing is drawn in. `fallback` covers a single
+ * model loaded without a federation entry. Null when nothing has geometry.
+ */
+export declare function federationFrameInfo(models: Iterable<FrameCandidate>, fallback?: {
+    coordinateInfo?: CoordinateInfo | null;
+} | null): CoordinateInfo | null;
+//# sourceMappingURL=world-frame.d.ts.map

package/dist/world-frame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"world-frame.d.ts","sourceRoot":"","sources":["../src/world-frame.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAIlE,gFAAgF;AAChF,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACpC,aAAa,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAE3D;AAED,kFAAkF;AAClF,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAE3D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAQlE;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAG1E;AAED,uEAAuE;AACvE,MAAM,WAAW,cAAc;IAC7B,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,EAChC,QAAQ,CAAC,EAAE;IAAE,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;CAAE,GAAG,IAAI,GAC3D,cAAc,GAAG,IAAI,CAWvB"}

package/dist/world-frame.js

@@ -0,0 +1,59 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+const ZERO = { x: 0, y: 0, z: 0 };
+/**
+ * Convert an IFC Z-up coordinate to the render frame's Y-up axes. `0 - value`
+ * deliberately normalises either sign of zero only on the negated axis.
+ */
+export function ifcToViewerAxes(point) {
+    return { x: point.x, y: point.z, z: 0 - point.y };
+}
+/** Convert render-frame Y-up to IFC Z-up with the same negated-axis zero rule. */
+export function viewerToIfcAxes(point) {
+    return { x: point.x, y: 0 - point.z, z: point.y };
+}
+/**
+ * Total translation from the render frame to world coordinates, in Y-up
+ * axes. `originShift` is already Y-up; `wasmRtcOffset` is IFC Z-up.
+ */
+export function totalYupOffset(info) {
+    const shift = info?.originShift ?? ZERO;
+    const rtcYup = ifcToViewerAxes(info?.wasmRtcOffset ?? ZERO);
+    return {
+        x: shift.x + rtcYup.x,
+        y: shift.y + rtcYup.y,
+        z: shift.z + rtcYup.z,
+    };
+}
+/**
+ * Render frame -> IFC world translation, in IFC Z-up metres: the axes BCF
+ * positions (and the IFC file) use. Add it to a render-frame point that has
+ * already been converted to Z-up. Exactly zero, with no `-0`, for a model
+ * that was not shifted.
+ */
+export function renderFrameWorldOffset(info) {
+    const offset = viewerToIfcAxes(totalYupOffset(info));
+    return { x: offset.x + 0, y: offset.y + 0, z: offset.z + 0 };
+}
+/**
+ * The `CoordinateInfo` whose frame a set of loaded models is drawn in.
+ *
+ * A federation is aligned to the earliest-loaded model's RTC frame at load,
+ * so that model's offsets ARE the scene's offsets; reading a later model's
+ * would describe a frame nothing is drawn in. `fallback` covers a single
+ * model loaded without a federation entry. Null when nothing has geometry.
+ */
+export function federationFrameInfo(models, fallback) {
+    let earliest = Infinity;
+    let info = null;
+    for (const model of models) {
+        const candidate = model.geometryResult?.coordinateInfo;
+        if (candidate && model.loadedAt < earliest) {
+            earliest = model.loadedAt;
+            info = candidate;
+        }
+    }
+    return info ?? fallback?.coordinateInfo ?? null;
+}
+//# sourceMappingURL=world-frame.js.map

package/dist/world-frame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"world-frame.js","sourceRoot":"","sources":["../src/world-frame.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AAsB/D,MAAM,IAAI,GAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAQxC;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,KAAqB;IACnD,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;AACpD,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,eAAe,CAAC,KAAqB;IACnD,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,IAA6B;IAC1D,MAAM,KAAK,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC;IACxC,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,aAAa,IAAI,IAAI,CAAC,CAAC;IAC5D,OAAO;QACL,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;QACrB,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;QACrB,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;KACtB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAA6B;IAClE,MAAM,MAAM,GAAG,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/D,CAAC;AASD;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAgC,EAChC,QAA4D;IAE5D,IAAI,QAAQ,GAAG,QAAQ,CAAC;IACxB,IAAI,IAAI,GAA0B,IAAI,CAAC;IACvC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,EAAE,cAAc,CAAC;QACvD,IAAI,SAAS,IAAI,KAAK,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC;YAC3C,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC1B,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,IAAI,QAAQ,EAAE,cAAc,IAAI,IAAI,CAAC;AAClD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ifc-lite/geometry",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "Geometry processing bridge for IFC-Lite - exact-arithmetic CSG, streamed across workers",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,12 +15,17 @@
       "types": "./dist/geometry-class.d.ts",
       "import": "./dist/geometry-class.js",
       "default": "./dist/geometry-class.js"
+    },
+    "./world-frame": {
+      "types": "./dist/world-frame.d.ts",
+      "import": "./dist/world-frame.js",
+      "default": "./dist/world-frame.js"
     }
   },
   "dependencies": {
     "@ifc-lite/data": "^4.4.0",
-    "@ifc-lite/wasm-lifecycle": "^0.2.0",
-    "@ifc-lite/wasm": "^9.1.0"
+    "@ifc-lite/wasm": "^9.1.0",
+    "@ifc-lite/wasm-lifecycle": "^0.2.0"
   },
   "optionalDependencies": {
     "@tauri-apps/api": "^2.11.1"