3-D shapes and Bosl2Solid¶

Pure-Python port of the 3-D shape generators from BOSL2’s shapes3d.scad. Each returns a Bosl2Solid wrapping native geometry, with BOSL2-style anchor/spin/orient support and bbox-backed attachment methods.

Coverage of BOSL2 `shapes3d.scad`¶

BOSL2 shape	Status	Notes
`cube` / `cuboid`	ported	with chamfer / rounding / edge selection
`prismoid`	ported
`regular_prism`	ported
`octahedron` / `wedge`	ported
`cylinder` / `cyl` / `xcyl` / `ycyl` / `zcyl`	ported
`tube` / `rect_tube` / `pie_slice`	ported
`sphere` / `spheroid`	ported
`torus` / `teardrop` / `onion`	ported
`text3d` / `path_text`	ported
`interior_fillet`	ported
`heightfield` / `cylindrical_heightfield`	ported
`ruler`	ported
`plot3d`	ported	`plot3d()` — a `z = f(x, y)` surface plot, with an optional solid base
`fillet`	ported	`fillet()` — the concave edge-fillet mask (90-degree edges only; other dihedral `ang` not ported)
`plot_revolution`	ported	`plot_revolution()` — a surface of revolution modulated by `radius=f(angle, z)` (the `arclength` form is not ported)
`textured_tile`	ported (height-field form)	`textured_tile()` — a tiled scalar height-field texture; VNF-tile and named-texture forms need the BOSL2 texture engine (not ported)

Bosl2Solid & attachment¶

Every 3-D shape is a Bosl2Solid, which carries the transform methods (translate/move, rotate/rot, right/left/back/forward/up/down, mirror, scale, color) and the BOSL2 attachment methods — bounds, anchor_point, reanchor, reorient, orient, position, attach, align, plus the edge/corner/face masking (edge_mask, edge_profile, corner_profile, face_profile). All of these read the object’s native bounding box, so a size never needs to be threaded through the calls — e.g. cuboid([40,30,20]).attach(TOP, sphere(radius=6)) or cyl(height=20, radius=5).orient(RIGHT) just work on the built object.

The BOSL2 attachment framework internals (attachable, attach_geom, named anchors, the tag/diff/intersect tagged-CSG operations, and the show_anchors/description helpers) are not ported — the methods above cover positioning/masking directly on the object.

API reference¶

class bosl2.shapes3d.Bosl2Solid(shape, size=None, anchor=None)[source]¶

Bases: Distributable, Colorable, Partitionable, Miscellaneous

Wraps a PyOpenSCAD solid together with the geometry metadata (nominal size and anchor) that BOSL2’s $parent_geom attachment system would otherwise track, so that edge/corner/face masking (bosl2/masking.py) work as plain chained methods instead of needing size=/anchor= threaded through by hand at every call site. Every function in this file returns an instance of this class (or a subclass).

Every geometry method (translate/rotate/mirror/multmatrix/scale/color, the union/intersection/ difference CSG operators) delegates to the wrapped native shape and returns a new Bosl2Solid carrying the same size/anchor metadata forward. Any other method not explicitly listed here (e.g. resize(), offset()) falls through via __getattr__ to the native shape and returns its raw, unwrapped result, since we can’t know whether the size/anchor metadata still applies.

Only cuboid()-shaped objects (cube(), cuboid() – the only ones in this file with a genuine axis-aligned box size) support the masking methods; every other shape (prismoid, wedge, octahedron, the cylinder family, the sphere family) carries size=None and will assert if a masking method is called on it, since bosl2/masking.py’s edge/corner positioning math only supports cuboid parents.

CAVEAT: this is a plain Python wrapper (composition), not a subclass of the real native PyOpenSCAD C-extension type – there was no way to verify from this environment whether that type even supports subclassing. Calling a method on a Bosl2Solid (shape.translate(…), shape.edge_profile(…)) is safe. But if a Bosl2Solid is ever passed directly as a bare argument into a function that expects a native geometry object – hull(a, b), minkowski(a, b) – rather than having a method called on it, the receiving function needs the raw native object: use .shape to unwrap explicitly.

Parameters:

shape (PyOpenSCAD)
size (Sequence[float] | None)
anchor (Sequence[float] | str | None)

backend = 'csg'¶: which realize backend produced this solid – see bosl2/_backend.py. Bosl2Solid is the exact-CSG (PythonSCAD) backend’s Solid; the libfive/SDF backend uses its own wrapper.

translate(v)[source]¶

Parameters:: v (Sequence[float])
Return type:: Bosl2Solid

move(v)¶

Parameters:: v (Sequence[float])
Return type:: Bosl2Solid

rotate(*a, **k)[source]¶

Return type:: Bosl2Solid

rot(*a, **k)¶

Return type:: Bosl2Solid

mirror(v)[source]¶

Parameters:: v (Sequence[float])
Return type:: Bosl2Solid

right(x)[source]¶

Parameters:: x (float)
Return type:: Bosl2Solid

left(x)[source]¶

Parameters:: x (float)
Return type:: Bosl2Solid

back(y)[source]¶

Parameters:: y (float)
Return type:: Bosl2Solid

forward(y)[source]¶

Parameters:: y (float)
Return type:: Bosl2Solid

fwd(y)¶

Parameters:: y (float)
Return type:: Bosl2Solid

up(z)[source]¶

Parameters:: z (float)
Return type:: Bosl2Solid

down(z)[source]¶

Parameters:: z (float)
Return type:: Bosl2Solid

multmatrix(m)[source]¶

Parameters:: m (Sequence[Sequence[float]])
Return type:: Bosl2Solid

scale(v)[source]¶

Return type:: Bosl2Solid

repair()[source]¶

Force the mesh watertight, healing gaps/non-manifold edges (native repair()).

Return type:: Bosl2Solid

wrap(radius, fn=None)[source]¶

Wrap this solid around a cylinder of radius radius, bending +X into the cylinder’s circumference (native wrap()). fn sets the facet count of the bend.

Parameters:

radius (float)
fn (int | None)

Return type:

3-D shapes and Bosl2Solid¶

Coverage of BOSL2 shapes3d.scad¶

Bosl2Solid & attachment¶

API reference¶

Coverage of BOSL2 `shapes3d.scad`¶