# ReadSplat

> ReadSplat node.

Standard Gaussian-splat files (.ply 3DGS incl. SH bands, .splat) into the 3D scene.

| Node | ReadSplat |
|---|---|
| Menu | 3D › ReadSplat |
| **Names in each format** | |
| .oink comp (JSON) | `"type": "OC_N_readsplat"` |
| .nk script | none: written as an Oink node |
| Python | `nuke.createNode("OC_N_readsplat")` |
| Assistant (MCP) | `create_node(type="ReadSplat")` |
| Tab search | `readsplat`, or its initials `rs` |

![ReadSplat properties](/shots/nodes/readsplat@2x.webp)

## Inputs and outputs

| Port | Name | Type |
|---|---|---|
| input 0 | scene | scene |
| output 0 | scene | scene |

## Knobs

Panel tab **Readsplat**, in panel order.

| Knob | Label | Type | Default | Range / values | .nk knob | Description |
|---|---|---|---|---|---|---|
| `file` | file | file |  |  |  |  |
| `info` | info | text |  |  |  |  |
| `display_as` | display as | menu | `splats` | splats, points |  |  |
| `colorspace` | colour | menu | `sRGB` | sRGB (sRGB (3DGS)), linear |  |  |
| `sh_degree` | SH degree | menu | `3` | 0 (0 (DC only)), 1, 2, 3 |  | Spherical-harmonic bands used for view-dependent colour |
| `flip_yz` | y up (flip) | bool | `true` |  |  | 3DGS / COLMAP files are y-down, z-forward: rotate 180 deg about X |
| `units_scale` | units scale | float | `1` | 0.001 to 100 |  |  |
| `render_splats` | render splats | float | `0` | 0 to 20000000 (integer) |  | Most splats rendered, the most visible first (0 = all) |
| `viewer_splats` | viewer splats | float | `3000000` | 1000 to 20000000 (integer) |  |  |
| `viewer_point_size` | viewer point size | float | `2` | 1 to 20 |  |  |
| `xform_order` | transform order | menu | `SRT` | SRT, STR, RST, RTS, TSR, TRS |  |  |
| `rot_order` | rotation order | menu | `ZXY` | XYZ, XZY, YXZ, YZX, ZXY, ZYX |  |  |
| `translate` | translate | vector ×3 | `0, 0, 0` | -100 to 100 |  |  |
| `rotate` | rotate | vector ×3 | `0, 0, 0` | -180 to 180 |  |  |
| `scaling` | scale | vector ×3 | `1, 1, 1` | 0 to 10 |  |  |
| `uniform_scale` | uniform scale | float | `1` | 0 to 10 |  |  |
| `skew` | skew | vector ×3 | `0, 0, 0` | -1 to 1 |  |  |
| `pivot_translate` | pivot translate | vector ×3 | `0, 0, 0` | -100 to 100 |  |  |
| `pivot_rotate` | pivot rotate | vector ×3 | `0, 0, 0` | -180 to 180 |  |  |

### Other knobs (Python, .nk and the assistant; not on the panel)

| Knob | Label | Type | Default | Range / values | .nk knob | Description |
|---|---|---|---|---|---|---|
| `gl_color` | Viewer Controls Color | float ×3 | `0, 0, 0` | 0 to 1 |  |  |
| `postage_stamp_frame` | Static Frame | int | `1` | -2147483648 to 2147483647 |  |  |
| `lifetimeStart` | Lifetime Start | int | `0` | -2147483648 to 2147483647 |  |  |
| `lifetimeEnd` | Lifetime End | int | `100` | -2147483648 to 2147483647 |  |  |
| `useLifetime` | Use Lifetime | boolean | `false` |  |  |  |
| `cached` | Cached | boolean | `false` |  |  |  |
| `bookmark` | Bookmark | boolean | `false` |  |  |  |
| `dope_sheet` | Dope Sheet | boolean | `false` |  |  |  |
| `clone_group` | Clone Group | string |  |  |  |  |
| `link_source` | Link Source | string |  |  |  |  |
| `link_overrides` | Link Overrides | string |  |  |  |  |
| `split_views` | Split Views | string |  |  |  |  |


---
Sources: opencomp_core/nodes/three_d/read_splat.py, opencomp_electron/src/components/properties/knobSchema.ts