Wrap

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 the faces lying on the target surface (the base of the wrap).

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 the raised (or recessed) faces offset from the target surface by the wrap thickness.

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 base faces of the wrap.

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 offset faces of the wrap.

Returns: ISelection

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

---

sideFaces()

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

Selects the wall faces created from the outer boundary of each wrapped region.

Returns: ISelection

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

---

sideEdges()

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

Selects edges on the wall faces, excluding edges shared with base/offset faces.

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 the wall faces created from holes inside a wrapped region.

Returns: ISelection

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

---

internalEdges()

internalEdges(...args: (number | EdgeFilterBuilder)[]): ISelection

Selects edges bounding the hole walls of the wrap.

Returns: ISelection

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

---

drill()

drill(value?: boolean): this

Enables or disables drill mode, which partitions the sketch into face regions before wrapping.

Parameter	Type	Description
value	boolean	true to enable (default), false to disable. (optional)

---

region()

region(...names: string[]): this

Restricts wrapping 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)