BooleanOperation

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

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)