Module `openscad_py.cube`

Classes

class Cube (size: list | Point, center: bool = False)

A 3D primitive, cube.

See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#cube

Creates a cube in the first octant. When center is True, the cube is centered on the origin.

Arguments

size: a Point object or a list of x, y, z sizes
center: if True, the cube is centered on the origin

Expand source code

class Cube(Object):
    """A 3D primitive, cube.

    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#cube
    """

    def __init__(self, size: TUnion[list, Point], center: bool = False):
        """
        Creates a cube in the first octant. When `center` is True, the cube is centered on the origin.

        Arguments:
            - size: a Point object or a list of `x, y, z` sizes
            - center: if True, the cube is centered on the origin
        """
        self.size = Point.c(size)
        self.center = center

    def render(self):
        """Render the object into OpenSCAD code"""
        return f"cube(size={self.size.render()}, center={self._center()});"

Ancestors

Object

Methods

def color(self, r, g, b, a=1.0) ‑> Object: Inherited from: Object.color

Apply a color and return a new object. See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
def delta_offset(self, delta, chamfer=False): Inherited from: Object.delta_offset

Return a new 2D interior or exterior outline from an existing outline. See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
def diff(self, tool: list | ForwardRef('Object')) ‑> Object: Inherited from: Object.diff

Remove from the object using a difference operator, and return a new object. See …
def extrude(self, height, convexity=10, center: bool = False) ‑> Object: Inherited from: Object.extrude

Apply a linear extrusion and return a new object. If center is false, the linear extrusion Z range is from 0 to height; if it is true, the range is …
def intersection(self, objects: list | ForwardRef('Object')) ‑> Object: Inherited from: Object.intersection

Get the intersection of self and an object of list of objects, and return a new object. See …
def move(self, v: list | Point) ‑> Object: Inherited from: Object.move

Apply a translation and return a new object. Synonym of translate()
def radial_offset(self, r): Inherited from: Object.radial_offset

Return a new 2D interior or exterior outline from an existing outline. See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
def render(self): Inherited from: Object.render

Render the object into OpenSCAD code
def rotate(self, a, v: list | Point) ‑> Object: Inherited from: Object.rotate

Apply a rotation and return a new object. See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate
def rotate_extrude(self, angle, convexity=10) ‑> Object: Inherited from: Object.rotate_extrude

Apply a rotational extrusion and return a new object. For all points x >= 0 must be true. See …
def scale(self, v: list | Point | float) ‑> Object: Inherited from: Object.scale

Apply scaling and return a new object. Accepts a vector (a Point object or a list of floats) or a single float for uniform scaling. See …
def translate(self, v: list | Point) ‑> Object: Inherited from: Object.translate

Apply a translation and return a new object. See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate
def union(self, objects: list | ForwardRef('Object')) ‑> Object: Inherited from: Object.union

Form the union of self and an object or list of objects, and return a new object. See …