landxml 0.7.1 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # landxml
 
+## 0.8.0
+
+### Minor Changes
+
+- 6a4a531: Modified "auto" behavior on LandXML files with multiple surfaces to create a combined center (rather than each surface its own cetner)
+
 ## 0.7.1
 
 ### Patch Changes

package/README.md

@@ -19,8 +19,6 @@ Easily transform LandXML surfaces into GeoJSON contours or GLB 3D models for use
 npm install landxml
 ```
 
----
-
 ## Examples
 
 ### Get contours and a GLB model together (recommended)
@@ -36,7 +34,7 @@ const surfaces = await toGlbAndContours(
   landXmlString,
   2, // contour interval (LandXML units)
   true, // generate outline
-  "auto", // GLB centre: "auto" | "origin" | [x, y]
+  "auto", // GLB center: "auto" | "origin" | [x, y]
 );
 
 const { glb, center, geojson, wktString, download } = surfaces[0];
@@ -59,7 +57,7 @@ const landXmlString = `<?xml version="1.0"?>...<LandXML>...</LandXML>`;
 
 const surfaces = await toGeojsonContours(
   landXmlString,
-  2, // contour interval (metres)
+  2, // contour interval (LandXML units)
   true, // include surface outline as a z=0 feature
 );
 
@@ -186,3 +184,13 @@ Returns `Promise<{ name, description, sourceFile, timeStamp, glb, center, downlo
 | `keepOriginalGeometry` | `boolean`           | `true`    | Store original coordinates under `feature.properties._rawGeometry` |
 
 Returns the mutated `FeatureCollection` with updated coordinates.
+
+---
+
+## Multi-surface center behaviour
+
+When a LandXML file contains multiple surfaces and `center` is set to `"auto"` (the default), the package computes a **single shared median center** across all surfaces' points. Every GLB produced in that call is offset by the same origin, so the surfaces remain correctly positioned relative to each other in your 3D scene. This happens automatically — no extra configuration is needed.
+
+If you need each surface to be individually centered (e.g. you are processing them in isolation), pass an explicit `[x, y]` pair instead.
+
+---

package/dist/index.d.mts

@@ -3,7 +3,9 @@ import { FeatureCollection, LineString } from 'geojson';
 
 /**
  * @param landXmlString
- * @param center 3D models don't work well when they're far from origin (coordinate `[0,0,0]`), therefore by default your center is moved to the median of x and y axis of your surface
+ * @param center 3D models don't work well when they're far from origin (coordinate `[0,0,0]`), therefore by default your center is moved to the median of x and y axis of your surface.
+ *   When processing multiple surfaces with `"auto"`, a **single shared center** is computed
+ *   from all surfaces combined so they remain correctly positioned relative to each other.
  * @param surfaceId Surface name or index if your LandXML contains multiple surfaces. By default all surfaces are converted and returns an array of glb Uint8Array
  * @returns {Object[]} glbs - Array of processed glbs (will also return an array when just one surface has been processed)
  * @returns {string} glbs[].name - Name of surface as defined in LandXML
@@ -11,7 +13,7 @@ import { FeatureCollection, LineString } from 'geojson';
  * @returns {string} glbs[].sourceFile - Source file of where the LandXML was generated from.
  * @returns {string} glbs[].timeStamp - Timestamp of when the surface was exported into LandXML
  * @returns {Uint8Array} glbs[].glb - Uint8Array binary data of glb
- * @returns {[number, number]} glbs[].center - Offset center of the processed glb
+ * @returns {[number, number]} glbs[].center - Shared offset center applied to all GLBs
  * @returns {function(): void} glbs[].download - Convenient way to download the GLB, within the filename the new center will be appended.
  */
 declare const toGlb: (landXmlString: string, center?: "auto" | "origin" | [
@@ -67,7 +69,7 @@ type GlbAndContoursResult = {
     wktString?: string;
     /** Binary GLB data */
     glb: Uint8Array;
-    /** XY center used to offset the GLB model from origin */
+    /** Shared XY center used to offset all GLB models from origin */
     center: [x: number, y: number];
     /** Convenience download trigger (browser only) */
     download: () => void;
@@ -84,12 +86,16 @@ type GlbAndContoursResult = {
  * Use this instead of calling `toGlb` + `toGeojsonContours` separately when
  * you need both outputs, as it eliminates all redundant work.
  *
+ * When processing multiple surfaces with `center: "auto"`, a **single shared
+ * center** is computed from all surfaces combined, so every GLB is offset by
+ * the same origin and surfaces remain correctly positioned relative to each other.
+ *
  * @param landXmlString   Raw LandXML string
  * @param contourInterval Vertical interval between contour lines (default 2)
  * @param generateOutline When true, the outline of each surface is appended to
  *                        the GeoJSON as a z=0 feature (default true)
- * @param center          GLB origin strategy: "auto" (median XY), "origin" ([0,0]),
- *                        or an explicit [x, y] pair (default "auto")
+ * @param center          GLB origin strategy: "auto" (combined median XY of all surfaces),
+ *                        "origin" ([0,0]), or an explicit [x, y] pair (default "auto")
  * @param surfaceId       Surface name or 0-based index to process a single
  *                        surface; -1 processes all surfaces (default -1)
  */

package/dist/index.d.ts

@@ -3,7 +3,9 @@ import { FeatureCollection, LineString } from 'geojson';
 
 /**
  * @param landXmlString
- * @param center 3D models don't work well when they're far from origin (coordinate `[0,0,0]`), therefore by default your center is moved to the median of x and y axis of your surface
+ * @param center 3D models don't work well when they're far from origin (coordinate `[0,0,0]`), therefore by default your center is moved to the median of x and y axis of your surface.
+ *   When processing multiple surfaces with `"auto"`, a **single shared center** is computed
+ *   from all surfaces combined so they remain correctly positioned relative to each other.
  * @param surfaceId Surface name or index if your LandXML contains multiple surfaces. By default all surfaces are converted and returns an array of glb Uint8Array
  * @returns {Object[]} glbs - Array of processed glbs (will also return an array when just one surface has been processed)
  * @returns {string} glbs[].name - Name of surface as defined in LandXML
@@ -11,7 +13,7 @@ import { FeatureCollection, LineString } from 'geojson';
  * @returns {string} glbs[].sourceFile - Source file of where the LandXML was generated from.
  * @returns {string} glbs[].timeStamp - Timestamp of when the surface was exported into LandXML
  * @returns {Uint8Array} glbs[].glb - Uint8Array binary data of glb
- * @returns {[number, number]} glbs[].center - Offset center of the processed glb
+ * @returns {[number, number]} glbs[].center - Shared offset center applied to all GLBs
  * @returns {function(): void} glbs[].download - Convenient way to download the GLB, within the filename the new center will be appended.
  */
 declare const toGlb: (landXmlString: string, center?: "auto" | "origin" | [
@@ -67,7 +69,7 @@ type GlbAndContoursResult = {
     wktString?: string;
     /** Binary GLB data */
     glb: Uint8Array;
-    /** XY center used to offset the GLB model from origin */
+    /** Shared XY center used to offset all GLB models from origin */
     center: [x: number, y: number];
     /** Convenience download trigger (browser only) */
     download: () => void;
@@ -84,12 +86,16 @@ type GlbAndContoursResult = {
  * Use this instead of calling `toGlb` + `toGeojsonContours` separately when
  * you need both outputs, as it eliminates all redundant work.
  *
+ * When processing multiple surfaces with `center: "auto"`, a **single shared
+ * center** is computed from all surfaces combined, so every GLB is offset by
+ * the same origin and surfaces remain correctly positioned relative to each other.
+ *
  * @param landXmlString   Raw LandXML string
  * @param contourInterval Vertical interval between contour lines (default 2)
  * @param generateOutline When true, the outline of each surface is appended to
  *                        the GeoJSON as a z=0 feature (default true)
- * @param center          GLB origin strategy: "auto" (median XY), "origin" ([0,0]),
- *                        or an explicit [x, y] pair (default "auto")
+ * @param center          GLB origin strategy: "auto" (combined median XY of all surfaces),
+ *                        "origin" ([0,0]), or an explicit [x, y] pair (default "auto")
  * @param surfaceId       Surface name or 0-based index to process a single
  *                        surface; -1 processes all surfaces (default -1)
  */

package/dist/index.js

@@ -287,19 +287,27 @@ var parse_xml_default = parseXML;
 
 // src/public/to-glb.ts
 var toGlb = (landXmlString, center = "auto", surfaceId = -1) => __async(null, null, function* () {
-  const requestedCenter = center == "origin" ? [0, 0] : center === "auto" ? void 0 : center;
   let requestedParsedSurfaces = filter_by_surfaceId_default(yield parse_xml_default(landXmlString), surfaceId);
+  let resolvedCenter;
+  if (center === "origin") {
+    resolvedCenter = [0, 0];
+  } else if (center === "auto") {
+    const allPoints = requestedParsedSurfaces.flatMap((s) => s.surfaceDefinition.points);
+    resolvedCenter = findXYAxisMedians(allPoints);
+  } else {
+    resolvedCenter = center;
+  }
   const glbs = yield Promise.all(
     requestedParsedSurfaces.map(
       (surface) => new Promise((resolve, reject) => __async(null, null, function* () {
         try {
-          const { glb, center: center2 } = yield get_glb_default(surface, requestedCenter);
+          const { glb } = yield get_glb_default(surface, resolvedCenter);
           const _a = surface, { surfaceDefinition } = _a, rest = __objRest(_a, ["surfaceDefinition"]);
           resolve(__spreadProps(__spreadValues({}, rest), {
             glb,
-            center: center2,
+            center: resolvedCenter,
             download: () => {
-              download_glb_default(glb, surface.name.replace(/\.xml$/, `${JSON.stringify(center2)}.glb`));
+              download_glb_default(glb, surface.name.replace(/\.xml$/, `${JSON.stringify(resolvedCenter)}.glb`));
             }
           }));
         } catch (e) {
@@ -590,13 +598,21 @@ var reproject_geojson_default = reprojectGeoJson;
 
 // src/public/to-glb-and-contours.ts
 var toGlbAndContours = (landXmlString, contourInterval = 2, generateOutline = true, center = "auto", surfaceId = -1) => __async(null, null, function* () {
-  const requestedCenter = center === "origin" ? [0, 0] : center === "auto" ? void 0 : center;
   const requestedParsedSurfaces = filter_by_surfaceId_default(yield parse_xml_default(landXmlString), surfaceId);
+  let resolvedCenter;
+  if (center === "origin") {
+    resolvedCenter = [0, 0];
+  } else if (center === "auto") {
+    const allPoints = requestedParsedSurfaces.flatMap((s) => s.surfaceDefinition.points);
+    resolvedCenter = findXYAxisMedians(allPoints);
+  } else {
+    resolvedCenter = center;
+  }
   const results = yield Promise.all(
     requestedParsedSurfaces.map((surface) => __async(null, null, function* () {
       const precomputed = precomputeSurfaceData(surface);
-      const [{ glb, center: resolvedCenter }, geojson] = yield Promise.all([
-        get_glb_default(surface, requestedCenter),
+      const [{ glb }, geojson] = yield Promise.all([
+        get_glb_default(surface, resolvedCenter),
         get_contours_default(surface, contourInterval, precomputed)
       ]);
       if (generateOutline) {

package/dist/index.mjs

@@ -250,19 +250,27 @@ var parse_xml_default = parseXML;
 
 // src/public/to-glb.ts
 var toGlb = (landXmlString, center = "auto", surfaceId = -1) => __async(null, null, function* () {
-  const requestedCenter = center == "origin" ? [0, 0] : center === "auto" ? void 0 : center;
   let requestedParsedSurfaces = filter_by_surfaceId_default(yield parse_xml_default(landXmlString), surfaceId);
+  let resolvedCenter;
+  if (center === "origin") {
+    resolvedCenter = [0, 0];
+  } else if (center === "auto") {
+    const allPoints = requestedParsedSurfaces.flatMap((s) => s.surfaceDefinition.points);
+    resolvedCenter = findXYAxisMedians(allPoints);
+  } else {
+    resolvedCenter = center;
+  }
   const glbs = yield Promise.all(
     requestedParsedSurfaces.map(
       (surface) => new Promise((resolve, reject) => __async(null, null, function* () {
         try {
-          const { glb, center: center2 } = yield get_glb_default(surface, requestedCenter);
+          const { glb } = yield get_glb_default(surface, resolvedCenter);
           const _a = surface, { surfaceDefinition } = _a, rest = __objRest(_a, ["surfaceDefinition"]);
           resolve(__spreadProps(__spreadValues({}, rest), {
             glb,
-            center: center2,
+            center: resolvedCenter,
             download: () => {
-              download_glb_default(glb, surface.name.replace(/\.xml$/, `${JSON.stringify(center2)}.glb`));
+              download_glb_default(glb, surface.name.replace(/\.xml$/, `${JSON.stringify(resolvedCenter)}.glb`));
             }
           }));
         } catch (e) {
@@ -553,13 +561,21 @@ var reproject_geojson_default = reprojectGeoJson;
 
 // src/public/to-glb-and-contours.ts
 var toGlbAndContours = (landXmlString, contourInterval = 2, generateOutline = true, center = "auto", surfaceId = -1) => __async(null, null, function* () {
-  const requestedCenter = center === "origin" ? [0, 0] : center === "auto" ? void 0 : center;
   const requestedParsedSurfaces = filter_by_surfaceId_default(yield parse_xml_default(landXmlString), surfaceId);
+  let resolvedCenter;
+  if (center === "origin") {
+    resolvedCenter = [0, 0];
+  } else if (center === "auto") {
+    const allPoints = requestedParsedSurfaces.flatMap((s) => s.surfaceDefinition.points);
+    resolvedCenter = findXYAxisMedians(allPoints);
+  } else {
+    resolvedCenter = center;
+  }
   const results = yield Promise.all(
     requestedParsedSurfaces.map((surface) => __async(null, null, function* () {
       const precomputed = precomputeSurfaceData(surface);
-      const [{ glb, center: resolvedCenter }, geojson] = yield Promise.all([
-        get_glb_default(surface, requestedCenter),
+      const [{ glb }, geojson] = yield Promise.all([
+        get_glb_default(surface, resolvedCenter),
         get_contours_default(surface, contourInterval, precomputed)
       ]);
       if (generateOutline) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "landxml",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Parse LandXML surfaces on the modern web.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",