cut
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import cut
Signature
def cut(*solids: 'Union[Solid, Sequence[Solid]]', skip_non_intersecting: 'bool' = True, tracking_policy: 'TrackingPolicy | str' = <TrackingPolicy.FULL: 'full'>) -> 'Solid'
Description
Compute the boolean difference of solids.
Other public imports
from cadflow import cut_rsolid
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
solids | 'Union[Solid, Sequence[Solid]]' | no | - | One or more Solid objects or sequences of Solid. Nested sequences are flattened before processing; the first solid is the base, the rest are subtracted in order. |
skip_non_intersecting | 'bool' | no | True | When True, tools with no meaningful intersection are ignored for interactive convenience. Graph replay records this flag and should use False for strict diagnostic workflows. |
tracking_policy | 'TrackingPolicy | str' | no | <TrackingPolicy.FULL: 'full'> | FULL computes topology history and lineage. GRAPH keeps the replayable operation node without computing a TopoDelta. |
Returns
Type: 'Solid'
Solid: The cut result solid.
Usage: Accepts a base solid followed by one or more tool solids, including nested sequences, and returns a single Solid.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import cut