Cut
Extends SceneObject
Inherited from SceneObject
name()
name(value: string): this
Sets a custom display name for this object, overriding the default type-based name.
| Parameter | Type | Description |
|---|---|---|
value | string | The display name to assign. |
guide()
guide(): this
Marks this object as construction geometry. Guide objects are excluded from final geometry output unless explicitly included.
reusable()
reusable(): this
Marks this object as reusable. Reusable objects retain their shapes when
consumed by features (e.g., extrude, revolve), allowing multiple features
to reference the same source geometry. Use remove(obj) to force-remove
shapes from a reusable object.
Methods
symmetric()
symmetric(): this
Enables symmetric mode — cuts equally in both directions from the sketch plane.
remove()
remove(...objects: SceneObject[]): this
Narrows the cut scope to specific objects instead of all scene objects.
| Parameter | Type | Description |
|---|---|---|
...objects | SceneObject[] | The target objects to cut from. (optional) |
draft()
draft(value: number | [number, number]): this
Applies a draft (taper) angle to the cut walls.
| Parameter | Type | Description |
|---|---|---|
value | number | [number, number] | A single angle for uniform draft, or a [start, end] tuple for asymmetric draft. |
endOffset()
endOffset(value: number): this
Offsets the cut end face by a specified distance along the cut direction.
| Parameter | Type | Description |
|---|---|---|
value | number | The offset distance. |
startEdges()
startEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject
Selects edges at the start of the cut path, classified by signed distance from the cut plane.
Returns: SceneObject
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
endEdges()
endEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject
Selects edges at the end of the cut path, classified by signed distance from the cut plane.
Returns: SceneObject
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
internalEdges()
internalEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject
Selects internal edges created by the cut that are not on the cut plane boundary.
Returns: SceneObject
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
internalFaces()
internalFaces(...args: (number | FaceFilterBuilder)[]): SceneObject
Selects internal faces exposed by the cut — newly created surfaces not from the original stock.
Returns: SceneObject
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
pick()
pick(...points: Point2DLike[]): this
Restricts the cut to only the sketch regions containing the given points.
| Parameter | Type | Description |
|---|---|---|
...points | Point2DLike[] | 2D points in the sketch plane identifying regions to cut. (optional) |
thin()
thin(offset: number): this
Enables thin cut mode — offsets the profile edges to cut a thin-walled shape instead of cutting filled faces. Positive values offset outward, negative values offset inward.
| Parameter | Type | Description |
|---|---|---|
offset | number | The wall offset distance. Positive = outward, negative = inward. |
thin()
thin(offset1: number, offset2: number): this
Enables thin cut mode with two offset directions. The two offsets must go in opposite directions. If both have the same sign, the second offset is automatically flipped.
| Parameter | Type | Description |
|---|---|---|
offset1 | number | The first wall offset distance. Positive = outward, negative = inward. |
offset2 | number | The second wall offset distance, in the opposite direction of offset1. |