Skip to main content

make_2d_cut_rface

Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import make_2d_cut_rface

Signature

def make_2d_cut_rface(body: 'Face', tool: 'Face') -> 'Face'

Description

Subtract one 2D face from another (2D boolean difference).

Subtract one 2D face from another (2D boolean difference).

Parameters ---------- body : Face The face to subtract from. tool : Face The face to subtract (the cutter).

Returns ------- Face The resulting face after subtraction. The result may contain inner wires (holes) if the tool was fully inside the body.

Parameters

NameTypeRequiredDefaultSource description
body'Face'yes-Not explicitly described in the source docstring.
tool'Face'yes-Not explicitly described in the source docstring.

Returns

Type: 'Face'

The source docstring does not declare additional return semantics.

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 make_2d_cut_rface

See also