intersect
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import intersect
Signature
def intersect(*solids: 'Union[Solid, Sequence[Solid]]') -> 'Solid'
Description
Compute the boolean intersection of solids.
Other public imports
from cadflow import intersect_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. |
Returns
Type: 'Solid'
Solid: The overlap region as a single solid.
Usage: Accepts one or more solids, including nested sequences, and returns a single Solid. If the inputs do not overlap meaningfully, the API raises a clear error instead of returning an empty list.
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 intersect