Skip to main content

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().

ParameterTypeDescription
...objectsSceneObject[]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.

ParameterTypeDescription
valuestringThe display name to assign.

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

startFaces()

startFaces(...args: (number | FaceFilterBuilder)[]): SceneObject

Selects faces at the start (base) of the rib — the profile face at the sketch plane.

Returns: SceneObject

ParameterTypeDescription
...args(number | FaceFilterBuilder)[]Numeric indices or FaceFilterBuilder instances to filter the selection. (optional)

endFaces()

endFaces(...args: (number | FaceFilterBuilder)[]): SceneObject

Selects faces at the end (top) of the rib — where the rib meets the boundary.

Returns: SceneObject

ParameterTypeDescription
...args(number | FaceFilterBuilder)[]Numeric indices or FaceFilterBuilder instances to filter the selection. (optional)

sideFaces()

sideFaces(...args: (number | FaceFilterBuilder)[]): SceneObject

Selects the lateral wall faces of the rib.

Returns: SceneObject

ParameterTypeDescription
...args(number | FaceFilterBuilder)[]Numeric indices or FaceFilterBuilder instances to filter the selection. (optional)

capFaces()

capFaces(...args: (number | FaceFilterBuilder)[]): SceneObject

Selects the small cap faces at the spine endpoints.

Returns: SceneObject

ParameterTypeDescription
...args(number | FaceFilterBuilder)[]Numeric indices or FaceFilterBuilder instances to filter the selection. (optional)

startEdges()

startEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject

Selects edges on the start faces.

Returns: SceneObject

ParameterTypeDescription
...args(number | EdgeFilterBuilder)[]Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional)

endEdges()

endEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject

Selects edges on the end faces.

Returns: SceneObject

ParameterTypeDescription
...args(number | EdgeFilterBuilder)[]Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional)

sideEdges()

sideEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject

Selects edges on the side faces, excluding edges shared with start/end faces.

Returns: SceneObject

ParameterTypeDescription
...args(number | EdgeFilterBuilder)[]Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional)

capEdges()

capEdges(...args: (number | EdgeFilterBuilder)[]): SceneObject

Selects edges on the cap faces.

Returns: SceneObject

ParameterTypeDescription
...args(number | EdgeFilterBuilder)[]Numeric indices or EdgeFilterBuilder instances to filter the selection. (optional)

draft()

draft(value: number | [number, number]): this

Applies a draft (taper) angle to the rib walls.

ParameterTypeDescription
valuenumber | [number, number]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.