@playcanvas/splat-transform 0.9.0 → 0.10.1
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.
- package/README.md +22 -15
- package/dist/index.mjs +177 -81
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
SplatTransform is an open source CLI tool for converting and editing Gaussian splats. It can:
|
|
13
13
|
|
|
14
|
-
📥 Read PLY, Compressed PLY, SPLAT, KSPLAT formats
|
|
14
|
+
📥 Read PLY, Compressed PLY, SPLAT, KSPLAT, SPZ formats
|
|
15
15
|
📤 Write PLY, Compressed PLY, CSV, SOG and HTML viewer formats
|
|
16
16
|
🔗 Merge multiple splats
|
|
17
17
|
🔄 Apply transformations to input splats
|
|
@@ -45,20 +45,18 @@ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] .
|
|
|
45
45
|
|
|
46
46
|
## Supported Formats
|
|
47
47
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
- `.html` - Standalone HTML viewer app
|
|
61
|
-
|
|
48
|
+
| Format | Input | Output | Description |
|
|
49
|
+
| ------ | ----- | ------ | ----------- |
|
|
50
|
+
| `.ply` | ✅ | ✅ | Standard PLY format |
|
|
51
|
+
| `.compressed.ply` | ✅ | ✅ | Compressed PLY format (auto-detected and decompressed on read) |
|
|
52
|
+
| `.ksplat` | ✅ | ❌ | Compressed splat format (mkkellogg format) |
|
|
53
|
+
| `.splat` | ✅ | ❌ | Compressed splat format (antimatter15 format) |
|
|
54
|
+
| `.spz` | ✅ | ❌ | Compressed splat format (Niantic format) |
|
|
55
|
+
| `.mjs` | ✅ | ❌ | Generate a scene using an mjs script (Beta) |
|
|
56
|
+
| `.sog` | ❌ | ✅ | Bundled super-compressed format (recommended) |
|
|
57
|
+
| `meta.json` | ❌ | ✅ | Unbundled super-compressed format (also outputs `.webp` images) |
|
|
58
|
+
| `.csv` | ❌ | ✅ | Comma-separated values spreadsheet |
|
|
59
|
+
| `.html` | ❌ | ✅ | Standalone HTML viewer app |
|
|
62
60
|
## Actions
|
|
63
61
|
|
|
64
62
|
Actions can be repeated and applied in any order:
|
|
@@ -71,6 +69,7 @@ Actions can be repeated and applied in any order:
|
|
|
71
69
|
-c, --filterByValue name,cmp,value Keep splats where <name> <cmp> <value>
|
|
72
70
|
cmp ∈ {lt,lte,gt,gte,eq,neq}
|
|
73
71
|
-b, --filterBands {0|1|2|3} Strip spherical-harmonic bands > N
|
|
72
|
+
-P, --params name=value[,name=value...] Pass parameters to .mjs generator script
|
|
74
73
|
```
|
|
75
74
|
|
|
76
75
|
## Global Options
|
|
@@ -152,6 +151,14 @@ splat-transform -w cloudA.ply -r 0,90,0 cloudB.ply -s 2 merged.compressed.ply
|
|
|
152
151
|
splat-transform input1.ply input2.ply output.ply -p 0,0,10 -e 0.5
|
|
153
152
|
```
|
|
154
153
|
|
|
154
|
+
### Generators (Beta)
|
|
155
|
+
|
|
156
|
+
Generator scripts can be used to synthesize gaussian splat data. See [gen-grid.mjs](generators/gen-grid.mjs) for an example.
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
splat-transform gen-grid.mjs -P width=10,height=10,scale=10,color=0.1 scenes/grid.ply -w
|
|
160
|
+
```
|
|
161
|
+
|
|
155
162
|
## Getting Help
|
|
156
163
|
|
|
157
164
|
```bash
|