Clip elements
clip_elementsCuts bodies at a plane and keeps one side, or subtracts the body of a cutter element (a beam ending at a round column); exactly one of plane and cutter. New revision, effect report (n_changed, rejected, cloned, carried). A call that succeeds is not a job that's done. Target: guid, guids or a set from find_elements/get_selection, never a filter. Beyond the named: PLAN_REQUIRED, run its plan_id with expect_beyond. It only removes: a target the plane does not cut, or would take whole, is refused, never counted, and grows to no plane. A mesh body is cut where it is closed; terrain: edit_terrain. The colour stays; read_as names the hull before and after and how many separate bodies are left.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "clip_elements"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| set | No | A set id from find_elements or get_selection: writes exactly the elements seen there, nothing that matches later. An element changed since reading is rejected alone; the others are written | |
| guid | No | One element (GlobalId) | |
| keep | No | With plane: side kept relative to the normal, default below | |
| note | No | Your note, stored with the new revision | |
| guids | No | These elements (GlobalIds) | |
| plane | No | The cutting plane | |
| cutter | No | Instead of plane: subtract this body, checked exactly before writing | |
| dry_run | No | Preview: the planned effect and a plan_id, nothing written | |
| plan_id | No | Execute exactly the plan a dry_run returned, all or nothing; the plan holds target and fields. Plans that clone the same shared object (type, material) run one after the other: plan the second after the first ran, else PLAN_CHANGED | |
| request_id | No | Your id for this call: a repeat answers the first result and writes nothing | |
| expect_count | No | With set: how many elements the set holds - guards against a mixed-up set id | |
| expect_beyond | No | With plan_id: how many elements the plan reaches beyond those named (n_beyond of PLAN_REQUIRED or the dry_run) | |
| expect_contacts | No | Intended contacts: checks.contacts splits into as_expected, missing, surprises; an omitted kind is not judged |