beckhoff-xts-viewer-3d 3.0.0 → 4.0.0

package/README.md

@@ -3,7 +3,7 @@
 [![npm](https://img.shields.io/npm/v/beckhoff-xts-viewer-3d.svg)](https://www.npmjs.com/package/beckhoff-xts-viewer-3d)
 [![npm assets](https://img.shields.io/npm/v/beckhoff-xts-viewer-3d-assets.svg?label=assets)](https://www.npmjs.com/package/beckhoff-xts-viewer-3d-assets)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-[![Build](https://github.com/philippleidig/beckhoff-xts-viewer-3d/actions/workflows/build.yml/badge.svg)](https://github.com/philippleidig/beckhoff-xts-viewer-3d/actions/workflows/build.yml)
+[![Release](https://github.com/philippleidig/beckhoff-xts-viewer-3d/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/philippleidig/beckhoff-xts-viewer-3d/actions/workflows/release.yml)
 
 A reusable React component that renders **Beckhoff XTS** linear-motor systems
 (plus Hepco GFX rail variants) in 3D. Drop a single `<XtsViewer3D>` into a
@@ -108,8 +108,8 @@ reflections, ACES tone mapping and anisotropic textures are on by default.
 - **Stations, Areas, Dimensions, InfoBars** — full 2D feature parity, plus
   camera-facing mm-value labels, intermediate ticks, and a 7-shape stop-marker
   palette (Diamond / Tick / Sphere / Cone / Cube / Cylinder / None) settable
-  per-station. **Areas** are stop-position-free zone overlays (Reinraum,
-  Sicherheitskreis, manueller Zugriff) — text + colour, multi-part.
+  per-station. **Areas** are stop-position-free zone overlays (cleanroom,
+  safety loop, manual access) — text + colour, multi-part.
   Stop-position values can be track-relative (default) or station-relative.
 - **Stop-position ghost movers** — `display.showStopPositionMovers` renders a
   static, semi-transparent mover GLB at every active stop, tinted to the
@@ -151,7 +151,7 @@ reflections, ACES tone mapping and anisotropic textures are on by default.
 
 |   |   |
 |---|---|
-| ![Multi-track](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/02-multi-track.png)<br>**Multi-track placement** — two independent XTS lines composed via `trackTransform`. | ![Stations + Areas](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/03-stations-areas.png)<br>**Stations + Areas** — Reinraum / Sicherheitsbereich zone overlays, station tubes with stop markers. |
+| ![Multi-track](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/02-multi-track.png)<br>**Multi-track placement** — two independent XTS lines composed via `trackTransform`. | ![Stations + Areas](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/03-stations-areas.png)<br>**Stations + Areas** — cleanroom / safety-area zone overlays, station tubes with stop markers. |
 | ![Stator heatmap](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/04-stator-heatmap.png)<br>**Stator heatmap** — vertex-colour gradient along the centerline, fed from your live drive currents. | ![Collision detection](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/05-collision.png)<br>**Sub-mm collision detection** — continuous monitor with banner; pair-wise 1D arc-length test on the shared chain. |
 | ![Drive status](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/06-drive-status.png)<br>**Drive status** — emissive blink at 1 Hz on the GLB itself + camera-facing 3D icons (▲ warning, ⊙ error). | ![Perf stress](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/07-perf-stress.png)<br>**Perf stress** — 750 movers animated at 60 Hz with zero React commits in steady state. |
 | ![Shadows + IBL](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/08-shadows.png)<br>**PCF-soft shadows + IBL** — opt-in shadows on a transparent canvas; image-based lighting on by default. | ![Top-down export](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/09-screenshot-export.png)<br>**`exportScreenshot('top-down')`** — orthographic, AABB-fit, mirrors the 2D viewer convention. |
@@ -374,7 +374,7 @@ running at full speed, no `preserveDrawingBuffer` perf cost.
 ### 7. Mark zones with Areas
 
 Areas are stop-position-free range overlays — like Stations, but with no
-markers. Use them for Reinraum / Sicherheitsbereich / manueller-Zugriff
+markers. Use them for cleanroom / safety-area / manual-access
 zones that don't drive any mover behaviour:
 
 ```tsx
@@ -384,7 +384,7 @@ zones that don't drive any mover behaviour:
     areas: [
       {
         areaId: 1,
-        description: 'Reinraum',
+        description: 'Cleanroom',
         isEnabled: true,
         partOids: [0],
         startPositionOnPart: 250,
@@ -548,12 +548,14 @@ change.
 
 ## Development setup
 
-Clone the repo, then:
+This repo is a pnpm workspace — `pnpm-lock.yaml` is the source of
+truth and `npm ci` / `npm install` will not work. Get pnpm via
+`npm install -g pnpm@10` (or any other installer), then:
 
 ```bash
-npm install
-npm test               # 166 unit + property tests
-npm run typecheck
+pnpm install
+pnpm test              # 310 unit + property tests
+pnpm typecheck
 ```
 
 ### Run the playground
@@ -563,7 +565,7 @@ feature — selection, calibration, composer, multi-track, shadows, ViewCube,
 drive-status icons, the perf stress test, IBL toggle, intensity slider.
 
 ```bash
-npm run dev            # http://127.0.0.1:5173
+pnpm dev               # http://127.0.0.1:5173
 ```
 
 Sidebar controls let you switch demos, animate movers, toggle shadows /
@@ -573,8 +575,8 @@ and live-edit calibration overrides.
 ### Build the library
 
 ```bash
-npm run build          # → dist/
-npm run playground:build
+pnpm build             # → dist/
+pnpm playground:build
 ```
 
 ### Asset pipeline
@@ -583,10 +585,10 @@ CAD source files (`stepfiles/*.stp`) are converted to runtime-ready GLBs
 and per-asset JSON sidecars. To regenerate after touching a STP:
 
 ```bash
-npm run assets:convert              # STP → GLB via occt-import-js
-npm run assets:inspect              # refresh docs/spec/data/glb-inspection.json
-npm run assets:generate-sidecars    # module .meta.json (origin-correction)
-npm run assets:generate-mover-sidecars
+pnpm assets:convert                 # STP → GLB via occt-import-js
+pnpm assets:inspect                 # refresh docs/data/glb-inspection.json
+pnpm assets:generate-sidecars       # module .meta.json (origin-correction)
+pnpm assets:generate-mover-sidecars
 ```
 
 The sidecar generators are idempotent: existing files are skipped so they
@@ -620,8 +622,8 @@ type registration, sidecar generation, calibration workflow — follow
 │   ├── ADDING-A-MODULE.md            How to register a new module / mover / tool
 │   ├── RELEASING.md                  How to publish a new release
 │   ├── screenshots/                  README + docs gallery
-│   └── spec/                         Full specification (path math, frames, asset rules)
-├── .github/workflows/                build.yml + release.yml
+│   └── data/                         GLB AABB inspection JSON
+├── .github/workflows/                release.yml + release-assets.yml + deploy-docs.yml
 └── README.md
 ```
 
@@ -632,7 +634,7 @@ selection logic, asset URL composition, the composer reducer, dimension
 ticks, and the multi-track transform composition. Run focused:
 
 ```bash
-npx vitest run src/geometry/__tests__/ChainBuilder.test.ts
+pnpm vitest run src/geometry/__tests__/ChainBuilder.test.ts
 ```
 
 ---
@@ -669,7 +671,7 @@ calibration values can never be overwritten by the pipeline.
 Preview the next release locally:
 
 ```bash
-npm run release:dry-run
+pnpm release:dry-run
 ```
 
 See **[docs/RELEASING.md](docs/RELEASING.md)** for the full guide: