Rib
Extends BooleanOperation
Inherited from BooleanOperation
add()
add(): this
Additive boolean operation — fuses the result with all intersecting scene objects.
Use .scope() to target specific objects.
'new'()
'new'(): this
No boolean operation — keeps the result as a standalone shape, separate from all other scene objects.
remove()
remove(): this
Subtractive boolean operation — cuts the result from all intersecting scene objects.
Use .scope() to target specific objects.
scope()
scope(...objects: SceneObject[]): this
Narrows the boolean operation scope to specific target objects.
Must be chained after .add() or .remove().
| Parameter | Type | Description |
|---|---|---|
...objects | SceneObject[] | The target objects to operate on. (optional) |
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
startFaces()
startFaces(...args: (number | FaceFilterBuilder)[]): ISelection
Selects faces at the start (base) of the rib — the profile face at the sketch plane.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
endFaces()
endFaces(...args: (number | FaceFilterBuilder)[]): ISelection
Selects faces at the end (top) of the rib — where the rib meets the boundary.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
sideFaces()
sideFaces(...args: (number | FaceFilterBuilder)[]): ISelection
Selects the lateral wall faces of the rib.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
capFaces()
capFaces(...args: (number | FaceFilterBuilder)[]): ISelection
Selects the small cap faces at the spine endpoints.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | FaceFilterBuilder)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. (optional) |
startEdges()
startEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects edges on the start faces.
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 edges on the end faces.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
sideEdges()
sideEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects edges on the side faces, excluding edges shared with start/end faces.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
capEdges()
capEdges(...args: (number | EdgeFilterBuilder)[]): ISelection
Selects edges on the cap faces.
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
...args | (number | EdgeFilterBuilder)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional) |
draft()
draft(value: NumberParam | [NumberParam, NumberParam]): this
Applies a draft (taper) angle to the rib walls.
| Parameter | Type | Description |
|---|---|---|
value | NumberParam | [NumberParam, NumberParam] | A single angle for uniform draft, or a [start, end] tuple for asymmetric draft. |
parallel()
parallel(): this
Switches the extrusion direction to parallel to the sketch plane (perpendicular to the spine within the plane) instead of normal to it.
extend()
extend(): this
Extends the rib's side faces at the spine endpoints outward to blend with the target solids' walls.