AI_Assistant/grid-apps-cmms
Watch
1
0
Fork
You've already forked grid-apps-cmms
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix broken formatting

Browse source
This commit is contained in:
bakedpotatolord 2025-06-18 16:59:51 -06:00
commit 49dc8c0a24
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/kiri-moto/engine-apis.md
View file

@ -16,13 +16,13 @@ you can view some example of how to use the engine [here](https://grid.space/kir
## Methods
| Method | Description | Returns |
| --------------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------- | ------- | ------- | -------- |
| --------------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------- |
| `load(url)` | Loads an [STL](<https://en.wikipedia.org/wiki/STL_(file_format)>) file from a given URL and centers the model. | `Promise<Engine>` |
| `clear()` | Clears all objects from workspace. | `void` |
| `parse(data)` | Parses raw [STL](<https://en.wikipedia.org/wiki/STL_(file_format)>) data and loads it as a centered widget. | `Promise<Engine>` |
| `setListener(listener)` | Sets an event listener function to receive engine progress updates | `Engine` |
| `setRender(bool)` | Enables or disables rendering. | `Engine` |
| `setMode(mode)` | Sets the slicing mode where mode is "CAM" | "FDM" | "LASER" | "SLA" . | `Engine` |
| `setMode(mode)` | Sets the slicing mode where mode is "CAM" \| "FDM" \| "LASER" \| "SLA" . | `Engine` |
| `setDevice(device)` | Merges a custom device profile into the current settings. | `Engine` |
| `setProcess(process)` | Merges custom slicing process parameters. | `Engine` |
| `setController(controller)` | Sets the slicing controller settings and starts/stops the worker pool accordingly. | `Engine` |
@ -43,12 +43,13 @@ you can view some example of how to use the engine [here](https://grid.space/kir
If a listener is set via `setListener(fn)`, it will be called with events such as:
- `{ loaded, vertices }` — when an STL file is loaded
- `{ parsed, vertices }` — when raw data is parsed
- `{ slice: msg }` — when slicing is complete
- `{ prepare: { update } }` — during toolpath preparation
- `{ prepare: { done: true } }` — when preparation is complete
- `{ export: { segment } }` — during G-code segment export
- `{ export: { done } }` — when export is finished
- `{ loaded, vertices }` — when an STL file is loaded
- `{ parsed, vertices }` — when raw data is parsed
- `{ slice: msg }` — when slicing is complete
- `{ prepare: { update } }` — during toolpath preparation
- `{ prepare: { done: true } }` — when preparation is complete
- `{ export: { segment } }` — during G-code segment export
- `{ export: { done } }` — when export is finished
These allow for building progress indicators or responding to processing stages.