Filters and compile
Filters modify your simulation on the server. The browser sends parameters; mesh-api runs VTK and returns updated geometry.
Available filter types
| Filter | Purpose |
|---|---|
| Warp | Displace vertices by a vector or scalar field |
| Planar clip | Cut geometry with a plane perpendicular to X, Y, or Z |
| Stage visibility | Toggle visibility of mesh geometry (more prim types planned) |
Derived filters appear as child nodes under Source in the scene tree.
Warp
- Open Filters and select Warp.
- In Filter properties:
- Warp mode — None, Warp by vector, or Warp by scalar
- Warp field — Choose from available fields on the source
- Warp scale — Multiplier for displacement magnitude
- The server compiles the warped surface.
- A Warp child node appears in the scene tree.
Use warp to visualize displacement fields, mode shapes, or exaggerated deformation for presentation.
Planar clip
- Select Planar clip in Filters.
- In Filter properties:
- Enable planar clip — Turn clipping on or off
- Clip axis — X, Y, or Z
- Clip offset — Position along the axis (0 = model center; negative/positive moves the plane)
- Show clip plane in viewport — Display a draggable gizmo
- When the gizmo is visible, drag it in the 3D view to reposition the plane.
- A Clip child node appears after compile.
Tip: Toggle visibility on parent and child nodes to compare the full model with the clipped result.
Stage visibility
Toggle Mesh geometry visibility without creating a new derived mesh. Additional prim types (cameras, lights, guide curves) will activate as multi-prim USD stages expand.
Server compile
Volumetric VTK sessions require server compile for warp and clip:
- You will see overlays such as *Applying clip filter* or *Applying warp filter*.
- Wait for the scene tree and viewport to refresh before changing parameters again.
- Rapid slider changes are coalesced, but each settled value triggers a round trip.
Surface-only or pre-compiled sessions may update faster depending on session state.
HUD shortcuts
Some operations overlap with the top HUD:
- Align model — Camera and display styles (not server filters)
- Extract cells / Extract points — Server extract via rubber-band selection (separate from sidebar filters)
- Point probe / Cell probe — Read field values at a picked location (no compile)
Filter properties card
When you select a Clip or Warp row in the scene tree, Filter properties opens with that node's current parameters. Edits recompile the same derived node.
Selecting Source shows the filter type picker again so you can add a new filter.
Troubleshooting
| Symptom | Likely cause |
|---|---|
| Filters card hidden | No model loaded yet |
| Compile never finishes | mesh-api disconnected or overloaded |
| Clip shows empty viewport | Parent hidden, or plane misses geometry — adjust offset |
| Warp looks flat | Scale too small, or wrong field selected |