VMTKMESHCLIPPER(1)

💖 VMTKMESHCLIPPER 💖

okay so bestie, welcome to vmtkmeshclipper — it's a vmtk script and it lives in the User Commands section, and honestly? it's giving "cut a mesh with a box, but make it interactive." 🎀

✨ NAME ✨

vmtkmeshclipper — literally a vmtk script called vmtkmeshclipper, no notes. 💅

🌸 DESCRIPTION 🌸

Automatic piping. vmtkmeshclipper parses all your options, and like… that's the whole gig. ✨

vmtkmeshclipper : interactively clip a mesh with a box 🔥

🧚 Input arguments 🧚

• -id Id (str,1); default=0 — the script id. that's it, that's the vibe.
• -handle Self (self,1) — a handle to self. yes queen, know thyself 💅
• -disabled Disabled (bool,1); default=0 — turns off execution and piping at the same time. one switch, two consequences, iconic.
• -i Mesh (vtkUnstructuredGrid,1) — the input mesh. the main character of this whole operation, fr.
• -ifile MeshInputFileName (str,1) — filename for the default Mesh reader, so it knows where to read from.
• -insideout InsideOut (bool,1); default=0 — toggles switching the output and clipped surfaces. swap 'em around, why not 🦋
• -interactive Interactive (bool,1); default=1 — toggles clipping with a widget vs. clipping with a pre-defined scalar field. two paths, one flag.
• -array ClipArrayName (str,1); default=None — the name of the array to clip with when you're doing non-interactive clipping.
• -value ClipValue (float,1); default=0.0 — the scalar value where the clipping happens, in the non-interactive case.
• -renderer vmtkRenderer (vmtkRenderer,1) — an external renderer, for when you've got your own.
• -ofile MeshOutputFileName (str,1) — filename for the default Mesh writer.
• -osurfacefile SurfaceOutputFileName (str,1) — filename for the default Surface writer.
• -oclippedfile ClippedMeshOutputFileName (str,1) — filename for the default ClippedMesh writer.

🫶 Output arguments 🫶

• -id Id (str,1); default=0 — the script id again. yes, it shows up in both lists. let it live 😭
• -handle Self (self,1) — handle to self again. same energy.
• -o Mesh (vtkUnstructuredGrid,1) — the output mesh 💖
• -osurface Surface (vtkPolyData,1) — the output surface corresponding to the cut ✂️
• -oclipped ClippedMesh (vtkUnstructuredGrid,1) — the clipped mesh 👑

ngl bestie, three outputs means three files if you want 'em — -ofile, -osurfacefile and -oclippedfile are right there. no cap.

and that's the whole page, short and slay 🌈

this lil cutie is vmtkmeshclipper version 1.5, dated April 2026, and it rolled in as part of the User Commands crew. love that for us 💜✂️💖