beckhoff-xts-viewer-3d 5.2.1 → 5.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +35 -8
  2. package/dist/index.cjs +1 -1
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.js +1 -1
  7. package/dist/index.js.map +1 -1
  8. package/docs/screenshots/01-packaging-line.webp +0 -0
  9. package/docs/screenshots/02-standard-at.webp +0 -0
  10. package/docs/screenshots/03-eco-at2200.webp +0 -0
  11. package/docs/screenshots/04-nct-tools.webp +0 -0
  12. package/docs/screenshots/05-hygienic-ath.webp +0 -0
  13. package/docs/screenshots/06-hepco-gfx.webp +0 -0
  14. package/docs/screenshots/07-materials-closeup.webp +0 -0
  15. package/docs/screenshots/08-multi-track.webp +0 -0
  16. package/docs/screenshots/09-stations-areas.webp +0 -0
  17. package/docs/screenshots/10-dimensions.webp +0 -0
  18. package/docs/screenshots/11-stator-heatmap.webp +0 -0
  19. package/docs/screenshots/12-collision.webp +0 -0
  20. package/docs/screenshots/13-drive-status.webp +0 -0
  21. package/docs/screenshots/14-feed-segments.webp +0 -0
  22. package/docs/screenshots/15-measurements.webp +0 -0
  23. package/docs/screenshots/16-selection.webp +0 -0
  24. package/docs/screenshots/17-plan-view.webp +0 -0
  25. package/docs/screenshots/18-shadows.webp +0 -0
  26. package/docs/screenshots/19-perf-stress.webp +0 -0
  27. package/docs/screenshots/README.md +106 -46
  28. package/package.json +3 -2
  29. package/docs/screenshots/01-oval-loop.png +0 -0
  30. package/docs/screenshots/02-multi-track.png +0 -0
  31. package/docs/screenshots/03-stations-areas.png +0 -0
  32. package/docs/screenshots/04-stator-heatmap.png +0 -0
  33. package/docs/screenshots/05-collision.png +0 -0
  34. package/docs/screenshots/06-drive-status.png +0 -0
  35. package/docs/screenshots/07-perf-stress.png +0 -0
  36. package/docs/screenshots/08-shadows.png +0 -0
  37. package/docs/screenshots/09-screenshot-export.png +0 -0
  38. package/docs/screenshots/10-feed-segments.png +0 -0
package/README.md CHANGED
@@ -13,7 +13,7 @@ selection, lighting and camera work.
13
13
  It covers the same ground as the official 2D `Beckhoff.TwinCAT.HMI.XTS.Controls`
14
14
  viewer, using real CAD geometry in three dimensions.
15
15
 
16
- ![Oval loop demo](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/01-oval-loop.png)
16
+ ![A 5 m XTS packaging line rendered by the viewer](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/01-packaging-line.webp)
17
17
 
18
18
  ## Installation
19
19
 
@@ -79,6 +79,23 @@ No asset hosting is required. GLBs stream from the matching
79
79
  [asset hosting](docs/USING-THE-COMPONENT.md#1-glb-assets--zero-config-by-default)
80
80
  to self-host them instead.
81
81
 
82
+ ## Module catalogue
83
+
84
+ Every image on this page comes out of the component itself, through the same
85
+ `exportScreenshot()` a consumer calls, and shows a layout a line would
86
+ actually be built as — a 5 m racetrack with four stations, a buffer loop
87
+ beside it. See [docs/screenshots](docs/screenshots/README.md) for the capture
88
+ script and [`playground/src/configs.ts`](playground/src/configs.ts) for the
89
+ layouts themselves.
90
+
91
+ | | | |
92
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93
+ | ![Standard AT](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/02-standard-at.webp)<br>**Standard AT** — AT2001 infeed, AT2000 straights and the AT2050 180° clothoid reversal. | ![Eco AT2200](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/03-eco-at2200.webp)<br>**Eco AT2200 / AT2202** — 500 mm straights, which pair naturally with the 500 mm reversal. | ![NCT with AT8200 tools](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/04-nct-tools.webp)<br>**NCT AT2002 / AT2102** — high modules carrying AT8200 tool carriers on the movers. |
94
+ | ![Hygienic ATH](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/05-hygienic-ath.webp)<br>**Hygienic ATH** — stainless housings, sealed joints and the ATH9011 mover. | ![Hepco GFX2](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/06-hepco-gfx.webp)<br>**Hepco GFX2** — the procedural GFX rail profile with a GFX2 1TC carriage instead of the Beckhoff guiding rail. | ![Material close-up](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/07-materials-closeup.webp)<br>**Real materials, not CAD colours** — anodised housing, stator packs, printed type plate with its LED row. |
95
+
96
+ The GLBs ship with a named PBR material library rather than the CAD sources'
97
+ placeholder colours — see [Asset pipeline](#asset-pipeline).
98
+
82
99
  ## Features
83
100
 
84
101
  **Geometry and layout.** The full Beckhoff module and mover catalogue —
@@ -160,13 +177,19 @@ for the tools, the snap kinds and the full API.
160
177
 
161
178
  ## Gallery
162
179
 
163
- | | |
164
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
165
- | ![Multi-track](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/02-multi-track.png)<br>Two independent lines composed with `trackTransform`. | ![Stations and areas](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/03-stations-areas.png)<br>Station tubes with stop markers, and zone overlays for cleanroom or safety areas. |
166
- | ![Stator heatmap](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/04-stator-heatmap.png)<br>Vertex-colour gradient along the centerline, fed from live drive currents. | ![Collision detection](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/05-collision.png)<br>Continuous pair-wise arc-length collision monitoring. |
167
- | ![Drive status](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/06-drive-status.png)<br>Emissive blink on the GLB plus camera-facing warning and error icons. | ![Many movers](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/07-perf-stress.png)<br>750 movers animated at 60 Hz with no React commits in steady state. |
168
- | ![Shadows and IBL](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/08-shadows.png)<br>Opt-in PCF-soft 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({ mode: 'top-down' })` orthographic and AABB-fit. |
169
- | ![Feed segments](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/10-feed-segments.png)<br>`feedSegmentHighlights` tints whole electrical strands; the pink one wraps the loop seam. | |
180
+ | | |
181
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
182
+ | ![Two parallel lines](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/08-multi-track.webp)<br>A packaging line and a buffer loop side by side, placed with `trackTransform`. | ![Stations and areas](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/09-stations-areas.webp)<br>Station tubes with their stop markers, ghost movers parked on the stops, and cleanroom / manual-access zones. |
183
+ | ![Dimensions and stations](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/10-dimensions.webp)<br>Dimensions along the track, stepped out from the modules they measure. | ![Stator heatmap](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/11-stator-heatmap.webp)<br>Vertex-colour gradient along the centerline, fed from `(positionMm, value)` samples. |
184
+ | ![Collision detection](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/12-collision.webp)<br>Two movers of the line parked at a 1 mm overlap — `checkMoverCollisions()` reports the penetration. | ![Drive status](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/13-drive-status.webp)<br>Emissive tint on the GLB plus camera-facing warning and error icons, on modules and movers alike. |
185
+ | ![Feed segments](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/14-feed-segments.webp)<br>`feedSegmentHighlights` tints whole electrical strands; the pink one wraps the loop seam. | ![Measurements and annotations](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/15-measurements.webp)<br>A distance across the loop with ΔX/ΔY guides and two annotations, placed through `viewerRef.current.measurements`. |
186
+ | ![Selection](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/16-selection.webp)<br>Selection tints the GLB itself two modules green, one mover orange — rather than overlaying a wireframe. | ![Shadows and IBL](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/18-shadows.webp)<br>Opt-in PCF-soft shadows over the procedurally built indoor environment. |
187
+ | ![Many movers](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/19-perf-stress.webp)<br>750 movers on three ovals, animated at 60 Hz with no React commits in steady state. | |
188
+
189
+ ![Top-down export](https://cdn.jsdelivr.net/npm/beckhoff-xts-viewer-3d/docs/screenshots/17-plan-view.webp)
190
+
191
+ `exportScreenshot({ mode: 'top-down' })` — orthographic, fitted to the scene
192
+ AABB. The same view is available live through `projection="orthographic"`.
170
193
 
171
194
  ## Troubleshooting
172
195
 
@@ -223,6 +246,10 @@ pnpm build
223
246
  feature and lets you switch demos, drive movers, toggle lighting and shadows,
224
247
  compose multi-track layouts and live-edit calibration overrides.
225
248
 
249
+ `pnpm docs:capture-screenshots` re-shoots the whole image strip on this page
250
+ from that playground, unattended — see
251
+ [docs/screenshots](docs/screenshots/README.md).
252
+
226
253
  ### Asset pipeline
227
254
 
228
255
  CAD sources in `stepfiles/*.stp` are converted to runtime GLBs plus per-asset