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. |
Methods
symmetric()
symmetric(): this
Enables symmetric mode — cuts equally in both directions from the sketch plane.
scope()
scope(...objects: SceneObject[]): this
Narrows the cut scope to specific target objects.
Must be chained after .remove().
| Parameter | Type | Description |
|---|---|---|
...objects | SceneObject[] | The target objects to cut from. (optional) |
draft()
draft(value: NumberParam | [NumberParam, NumberParam]): this
Applies a draft (taper) angle to the cut walls.
| Parameter | Type | Description |
|---|---|---|
value | NumberParam | [NumberParam, NumberParam] | A single angle for uniform draft, or a [start, end] tuple for asymmetric draft. |
endOffset()
endOffset(value: NumberParam): this
Offsets the cut end face by a specified distance along the cut direction.
| Parameter | Type | Description |
|---|---|---|
value | NumberParam | The offset distance. |
startEdges()
startEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects the edges at the top of the cut: the rims where the tool entered the material, on whatever face it entered through (a flat top or a curved wall). A symmetric cut starts inside the material, so it only has start edges where the sketch plane lies in a void and the tool meets material further out.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
endEdges()
endEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects the edges at the bottom of the cut: every edge of a floor the tool stopped at, and the rims where a through cut left the material.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
internalEdges()
internalEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects the edges created inside the solid: creases between the cut's own walls, and rims along faces the cut runs parallel to.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
internalFaces()
internalFaces(...args: (number | FaceFilterBuilder)[]): ISelection
Selects internal faces exposed by the cut — newly created surfaces not from the original stock.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
region()
region(...names: string[]): this
Restricts the cut to particular regions of the sketch, by the names
their region() declarations gave them. See IExtrude.region.
| Parameter | Type | Description |
|---|---|---|
...names | string[] | Names of regions the sketch declares. (optional) |
thin()
thin(offset: NumberParam): 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 | NumberParam | The wall offset distance. Positive = outward, negative = inward. |
thin()
thin(offset1: NumberParam, offset2: NumberParam): 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 | NumberParam | The first wall offset distance. Positive = outward, negative = inward. |
offset2 | NumberParam | The second wall offset distance, in the opposite direction of offset1. |