From 6c81b08b543a43951cdb9ff2d4b97f770e35dc94 Mon Sep 17 00:00:00 2001 From: Elod Csirmaz Date: Sun, 1 Dec 2024 15:52:02 +0000 Subject: [PATCH] Add documentation --- doc/openscad_py/circle.html | 287 +++++++++++++++ doc/openscad_py/collection.html | 271 +++++++++++++++ doc/openscad_py/color.html | 255 ++++++++++++++ doc/openscad_py/cube.html | 258 ++++++++++++++ doc/openscad_py/cylinder.html | 292 ++++++++++++++++ doc/openscad_py/delta_offset.html | 257 ++++++++++++++ doc/openscad_py/difference.html | 255 ++++++++++++++ doc/openscad_py/header.html | 107 ++++++ doc/openscad_py/index.html | 167 +++++++++ doc/openscad_py/intersection.html | 254 ++++++++++++++ doc/openscad_py/linear_extrude.html | 258 ++++++++++++++ doc/openscad_py/object_.html | 310 +++++++++++++++++ doc/openscad_py/path_tube.html | 367 ++++++++++++++++++++ doc/openscad_py/point.html | 373 ++++++++++++++++++++ doc/openscad_py/polygon.html | 253 ++++++++++++++ doc/openscad_py/polyhedron.html | 517 ++++++++++++++++++++++++++++ doc/openscad_py/radial_offset.html | 257 ++++++++++++++ doc/openscad_py/rotate.html | 256 ++++++++++++++ doc/openscad_py/rotate_extrude.html | 260 ++++++++++++++ doc/openscad_py/scale.html | 257 ++++++++++++++ doc/openscad_py/sphere.html | 258 ++++++++++++++ doc/openscad_py/translate.html | 255 ++++++++++++++ doc/openscad_py/union.html | 257 ++++++++++++++ 23 files changed, 6281 insertions(+) create mode 100644 doc/openscad_py/circle.html create mode 100644 doc/openscad_py/collection.html create mode 100644 doc/openscad_py/color.html create mode 100644 doc/openscad_py/cube.html create mode 100644 doc/openscad_py/cylinder.html create mode 100644 doc/openscad_py/delta_offset.html create mode 100644 doc/openscad_py/difference.html create mode 100644 doc/openscad_py/header.html create mode 100644 doc/openscad_py/index.html create mode 100644 doc/openscad_py/intersection.html create mode 100644 doc/openscad_py/linear_extrude.html create mode 100644 doc/openscad_py/object_.html create mode 100644 doc/openscad_py/path_tube.html create mode 100644 doc/openscad_py/point.html create mode 100644 doc/openscad_py/polygon.html create mode 100644 doc/openscad_py/polyhedron.html create mode 100644 doc/openscad_py/radial_offset.html create mode 100644 doc/openscad_py/rotate.html create mode 100644 doc/openscad_py/rotate_extrude.html create mode 100644 doc/openscad_py/scale.html create mode 100644 doc/openscad_py/sphere.html create mode 100644 doc/openscad_py/translate.html create mode 100644 doc/openscad_py/union.html diff --git a/doc/openscad_py/circle.html b/doc/openscad_py/circle.html new file mode 100644 index 0000000..6e2e6cf --- /dev/null +++ b/doc/openscad_py/circle.html @@ -0,0 +1,287 @@ + + + + + + +openscad_py.circle API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.circle

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Circle +(r: float, fn: int | None = None) +
+
+

A 2D primitive, circle. +Creates a circle (or regular polygon) at the origin.

+

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

+
+ +Expand source code + +
class Circle(Object):
+    """A 2D primitive, circle.
+    Creates a circle (or regular polygon) at the origin.
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#circle
+    """
+
+    def __init__(self, r: float, fn: TUnion[int, None] = None):
+        self.r = r
+        self.fn = fn
+        # $fa, $fs, $fn
+
+    @classmethod
+    def triangle(cls, r):
+        """Create a regular triangle"""
+        return cls(r=r, fn=3)
+
+    @classmethod
+    def regular_polygon(cls, r, sides: int):
+        """Create a regular polygon"""
+        return cls(r=r, fn=sides)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        fnstr = '' if self.fn is None else f", $fn={self.fn}"
+        return f"circle(r={self.r}{fnstr});"
+
+

Ancestors

+ +

Static methods

+
+
+def regular_polygon(r, sides: int) +
+
+

Create a regular polygon

+
+
+def triangle(r) +
+
+

Create a regular triangle

+
+
+

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/collection.html b/doc/openscad_py/collection.html new file mode 100644 index 0000000..c2a2d2d --- /dev/null +++ b/doc/openscad_py/collection.html @@ -0,0 +1,271 @@ + + + + + + +openscad_py.collection API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.collection

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Collection +(coll: list) +
+
+

Represents a collection of objects

+
+ +Expand source code + +
class Collection(Object):
+    """Represents a collection of objects"""
+
+    def __init__(self, coll: list):
+        self.collection = coll
+
+    @classmethod
+    def c(cls, coll: TUnion[list, Object]) -> Object:
+        """Ensure the list of objects is a Collection (idempotent)"""
+        if isinstance(coll, Object):
+            return coll
+        return cls(coll)
+
+    def _add(self, obj):
+        return self.__class__(self.collection + [obj])
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return "\n".join([o.render() for o in self.collection])
+
+

Ancestors

+ +

Static methods

+
+
+def c(coll: list | Object) ‑> Object +
+
+

Ensure the list of objects is a Collection (idempotent)

+
+
+

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/color.html b/doc/openscad_py/color.html new file mode 100644 index 0000000..85553a2 --- /dev/null +++ b/doc/openscad_py/color.html @@ -0,0 +1,255 @@ + + + + + + +openscad_py.color API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.color

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Color +(child: Object,
r: float,
g: float,
b: float,
a: float = 1.0) +
+
+

Represents a color applied to an object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color

+
+ +Expand source code + +
class Color(Object):
+    """Represents a color applied to an object.
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
+    """
+
+    def __init__(self, child: Object, r: float, g: float, b: float, a: float = 1.):
+        self.color = [r, g, b, a]
+        self.child = child
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"color(c=[{','.join([str(c) for c in self.color])}]){{ {self.child.render()} }}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/cube.html b/doc/openscad_py/cube.html new file mode 100644 index 0000000..81b7e03 --- /dev/null +++ b/doc/openscad_py/cube.html @@ -0,0 +1,258 @@ + + + + + + +openscad_py.cube API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.cube

+
+
+
+
+
+
+
+
+
+
+

Classes

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

A 3D primitive, cube. +Creates a cube in the first octant. When center is true, the cube is centered on the origin.

+

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

+
+ +Expand source code + +
class Cube(Object):
+    """A 3D primitive, cube.
+    Creates a cube in the first octant. When center is true, the cube is centered on the origin.
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#cube
+    """
+
+    def __init__(self, size: TUnion[list, Point], center: bool = False):
+        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

+ +

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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/cylinder.html b/doc/openscad_py/cylinder.html new file mode 100644 index 0000000..343c893 --- /dev/null +++ b/doc/openscad_py/cylinder.html @@ -0,0 +1,292 @@ + + + + + + +openscad_py.cylinder API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.cylinder

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Cylinder +(h, r=None, r1=None, r2=None, center: bool = False) +
+
+

A 3D primitive, cylinder. +Creates a cylinder or cone centered about the z axis. When center is true, it is also centered vertically along the z axis.

+

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

+
+ +Expand source code + +
class Cylinder(Object):
+    """A 3D primitive, cylinder.
+    Creates a cylinder or cone centered about the z axis. When center is true, it is also centered vertically along the z axis.
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#cylinder
+    """
+
+    def __init__(self, h, r=None, r1=None, r2=None, center: bool = False):
+        self.height = h
+        self.r1 = r if r1 is None else r1
+        self.r2 = r if r2 is None else r2
+        self.center = center
+        # $fa, $fs, $fn
+
+    def render(self):
+        """Render the object into OpenSCAD code"""
+        return f"cylinder(h={self.height}, r1={self.r1}, r2={self.r2}, center={self._center()});"
+
+    @classmethod
+    def from_ends(cls, radius: float, p1: TUnion[list, Point], p2: TUnion[list, Point]) -> Object:
+        """Construct a cylinder between two points"""
+        p1 = Point.c(p1)
+        p2 = Point.c(p2)
+        v = p2.sub(p1)
+        length = v.length()
+        assert length != 0
+        z = Point([0, 0, 1])
+        r = z.cross(v)
+        rangle = v.angle(z)
+        if r.length() == 0:
+            # The cylinder is in the Z direction
+            if abs(abs(rangle) - 180.) < .1:
+                p1 = p2
+            rangle = 0
+            r = z
+        else:
+            r = r.norm()
+        return cls(h=length, r=radius, center=False).rotate(a=rangle, v=r).move(p1)
+
+

Ancestors

+ +

Static methods

+
+
+def from_ends(radius: float,
p1: list | Point,
p2: list | Point) ‑> Object +
+
+

Construct a cylinder between two points

+
+
+

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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/delta_offset.html b/doc/openscad_py/delta_offset.html new file mode 100644 index 0000000..c598a33 --- /dev/null +++ b/doc/openscad_py/delta_offset.html @@ -0,0 +1,257 @@ + + + + + + +openscad_py.delta_offset API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.delta_offset

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class DeltaOffset +(delta,
child: Object,
chamfer: bool = False) +
+
+

A new 2d interior or exterior outline from an existing outline

+

See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset

+
+ +Expand source code + +
class DeltaOffset(Object):
+    """A new 2d interior or exterior outline from an existing outline
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
+    """
+    
+    def __init__(self, delta, child: Object, chamfer: bool = False):
+        self.delta = delta
+        self.child = child
+        self.chamfer = chamfer
+        
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"offset(delta={delta}, chamfer={'true' if self.chamfer else 'false'}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/difference.html b/doc/openscad_py/difference.html new file mode 100644 index 0000000..c55cc29 --- /dev/null +++ b/doc/openscad_py/difference.html @@ -0,0 +1,255 @@ + + + + + + +openscad_py.difference API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.difference

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Difference +(subject: Object,
tool: list | Object) +
+
+

Represents a difference. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#difference

+
+ +Expand source code + +
class Difference(Object):
+    """Represents a difference.
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#difference
+    """
+
+    def __init__(self, subject: Object, tool: TUnion[list, Object]):
+        self.subject = subject
+        self.tool = Collection.c(tool)  # what to remove
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"difference(){{ {self.subject.render()}\n{self.tool.render()} }}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/header.html b/doc/openscad_py/header.html new file mode 100644 index 0000000..63f4e89 --- /dev/null +++ b/doc/openscad_py/header.html @@ -0,0 +1,107 @@ + + + + + + +openscad_py.header API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.header

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Header +(quality: str = 'draft') +
+
+

Render a header (setting global values) of an OpensCAD file

+
+ +Expand source code + +
class Header:
+    """Render a header (setting global values) of an OpensCAD file"""
+
+
+    def __init__(self, quality: str = 'draft'):
+        # See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Other_Language_Features#Circle_resolution:_$fa,_$fs,_and_$fn
+        self.quality = quality
+
+
+    def render(self):
+        """Return OpenSCAD code"""
+        if self.quality == 'draft':
+            return ""
+        if self.quality == 'mid':
+            return "$fa=12;$fs=0.2;"
+        if self.quality == 'best':
+            return "$fa=6;$fs=0.1;"
+        raise ValueError("Unknown quality")
+
+

Methods

+
+
+def render(self) +
+
+

Return OpenSCAD code

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/index.html b/doc/openscad_py/index.html new file mode 100644 index 0000000..f7606cb --- /dev/null +++ b/doc/openscad_py/index.html @@ -0,0 +1,167 @@ + + + + + + +openscad_py API documentation + + + + + + + + + + + +
+
+
+

Package openscad_py

+
+
+
+
+

Sub-modules

+
+
openscad_py.circle
+
+
+
+
openscad_py.collection
+
+
+
+
openscad_py.color
+
+
+
+
openscad_py.cube
+
+
+
+
openscad_py.cylinder
+
+
+
+
openscad_py.delta_offset
+
+
+
+
openscad_py.difference
+
+
+
+
openscad_py.header
+
+
+
+
openscad_py.intersection
+
+
+
+
openscad_py.linear_extrude
+
+
+
+
openscad_py.object_
+
+
+
+
openscad_py.path_tube
+
+
+
+
openscad_py.point
+
+
+
+
openscad_py.polygon
+
+
+
+
openscad_py.polyhedron
+
+
+
+
openscad_py.radial_offset
+
+
+
+
openscad_py.rotate
+
+
+
+
openscad_py.rotate_extrude
+
+
+
+
openscad_py.scale
+
+
+
+
openscad_py.sphere
+
+
+
+
openscad_py.translate
+
+
+
+
openscad_py.union
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/intersection.html b/doc/openscad_py/intersection.html new file mode 100644 index 0000000..087f70c --- /dev/null +++ b/doc/openscad_py/intersection.html @@ -0,0 +1,254 @@ + + + + + + +openscad_py.intersection API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.intersection

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Intersection +(child: list | Object) +
+
+

Represents an intersection applied to an object (usually a collection of objects). +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#intersection

+
+ +Expand source code + +
class Intersection(Object):
+    """Represents an intersection applied to an object (usually a collection of objects).
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#intersection
+    """
+
+    def __init__(self, child: TUnion[Object, list]):
+        self.child = Collection.c(child)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"intersection(){{ {self.child.render()} }}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/linear_extrude.html b/doc/openscad_py/linear_extrude.html new file mode 100644 index 0000000..9554392 --- /dev/null +++ b/doc/openscad_py/linear_extrude.html @@ -0,0 +1,258 @@ + + + + + + +openscad_py.linear_extrude API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.linear_extrude

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class LinearExtrude +(height,
child: Object,
convexity: int = 10,
center: bool = False) +
+
+

Represents a linear extrusion applied to an object. +If center is false the linear extrusion Z range is from 0 to height; if it is true, the range is from -height/2 to height/2.

+
+ +Expand source code + +
class LinearExtrude(Object):
+    """Represents a linear extrusion applied to an object.
+    If center is false the linear extrusion Z range is from 0 to height; if it is true, the range is from -height/2 to height/2.
+    """
+
+    def __init__(self, height, child: Object, convexity: int = 10, center: bool = False):
+        self.height = height
+        self.child = child
+        self.convexity = convexity
+        self.center = center
+        # twist, slices, scale (float/vector), $fn
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"linear_extrude(height={self.height}, center={self._center()}, convexity={self.convexity}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/object_.html b/doc/openscad_py/object_.html new file mode 100644 index 0000000..ea9eabd --- /dev/null +++ b/doc/openscad_py/object_.html @@ -0,0 +1,310 @@ + + + + + + +openscad_py.object_ API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.object_

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Object +
+
+

Base class for an SCAD object. Defines convenience methods to apply transformations.

+
+ +Expand source code + +
class Object:
+    """Base class for an SCAD object. Defines convenience methods to apply transformations."""
+
+    def _center(self) -> str:
+        """Render the `center` flag into string"""
+        return ('true' if self.center else 'false')
+
+    def _add(self, obj: 'Object'):
+        """Add an object, forming a Collection"""
+        from openscad_py.collection import Collection
+        return Collection([self, obj])
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        raise Exception("abstract method")
+
+    def translate(self, v: TUnion[list, Point]) -> 'Object':
+        """Apply a translation and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate
+        """
+        from openscad_py.translate import Translate
+        return Translate(v=v, child=self)
+
+    def move(self, v: TUnion[list, Point]) -> 'Object':
+        """Apply a translation and return a new object. Synonym of `translate()`"""
+        from openscad_py.translate import Translate
+        return Translate(v=v, child=self)
+
+    def rotate(self, a, v: TUnion[list, Point]) -> 'Object':
+        """Apply a rotation and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate
+        """
+        from openscad_py.rotate import Rotate
+        return Rotate(a=a, v=v, child=self)
+
+    def scale(self, v: TUnion[list, Point, float]) -> 'Object':
+        """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 https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#scale
+         """
+        from openscad_py.scale import Scale
+        return Scale(v=v, child=self)
+
+    def color(self, r, g, b, a=1.) -> 'Object':
+        """Apply a color and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
+        """
+        from openscad_py.color import Color
+        return Color(r=r, g=g, b=b, a=a, child=self)
+
+    def extrude(self, height, convexity = 10, center: bool = False) -> 'Object':
+        """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 from -height/2 to height/2.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion
+        """
+        from openscad_py.linear_extrude import LinearExtrude
+        return LinearExtrude(height=height, child=self, convexity=convexity, center=center)
+
+    def rotate_extrude(self, angle, convexity = 10) -> 'Object':
+        """Apply a rotational extrusion and return a new object. For all points x >= 0 must be true.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion
+        """
+        from openscad_py.rotate_extrude import RotateExtrude
+        return RotateExtrude(angle=angle, child=self, convexity=convexity)
+
+    def radial_offset(self, r):
+        """Return a new 2D interior or exterior outline from an existing outline.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
+        """
+        from openscad_py.radial_offset import RadialOffset
+        return RadialOffset(r=r, child=self)
+
+    def delta_offset(self, delta, chamfer=False):
+        """Return a new 2D interior or exterior outline from an existing outline.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
+        """
+        from openscad_py.delta_offset import DeltaOffset
+        return DeltaOffset(delta=delta, child=self, chamfer=chamfer)
+
+    def diff(self, tool: TUnion[list, 'Object']) -> 'Object':
+        """Remove from the object using a difference operator, and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#difference
+        """
+        from openscad_py.difference import Difference
+        return Difference(subject=self, tool=tool)
+
+    def union(self, objects: TUnion[list, 'Object']) -> 'Object':
+        """Form the union of self and an object or list of objects, and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union
+        """
+        from openscad_py.union import Union
+        from openscad_py.collection import Collection
+        return Union(child=Collection.c(objects)._add(self))
+
+    def intersection(self, objects: TUnion[list, 'Object']) -> 'Object':
+        """Get the intersection of self and an object of list of objects, and return a new object.
+        See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#intersection
+        """
+        from openscad_py.intersection import Intersection
+        from openscad_py.collection import Collection
+        return Intersection(child=Collection.c(objects)._add(self))
+
+

Subclasses

+ +

Methods

+
+
+def color(self, r, g, b, a=1.0) ‑> Object +
+
+

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) +
+
+

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 +
+
+

Remove from the object using a difference operator, and return a new object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#difference

+
+
+def extrude(self, height, convexity=10, center: bool = False) ‑> Object +
+
+

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 from -height/2 to height/2. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion

+
+
+def intersection(self,
objects: list | ForwardRef('Object')) ‑> Object +
+
+

Get the intersection of self and an object of list of objects, and return a new object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#intersection

+
+
+def move(self,
v: list | Point) ‑> Object +
+
+

Apply a translation and return a new object. Synonym of translate()

+
+
+def radial_offset(self, r) +
+
+

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) ‑> str +
+
+

Render the object into OpenSCAD code

+
+
+def rotate(self,
a,
v: list | Point) ‑> Object +
+
+

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 +
+
+

Apply a rotational extrusion and return a new object. For all points x >= 0 must be true. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion

+
+
+def scale(self,
v: list | Point | float) ‑> Object +
+
+

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 https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#scale

+
+
+def translate(self,
v: list | Point) ‑> Object +
+
+

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 +
+
+

Form the union of self and an object or list of objects, and return a new object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/path_tube.html b/doc/openscad_py/path_tube.html new file mode 100644 index 0000000..9e56877 --- /dev/null +++ b/doc/openscad_py/path_tube.html @@ -0,0 +1,367 @@ + + + + + + +openscad_py.path_tube API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.path_tube

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class PathTube +(points: List[list | Point],
radius: float | list,
fn: int,
make_torus: bool = False,
convexity: int = 10) +
+
+

Creates a tube-like or toroid polyhedron from a path (list of points).

+

points: The list of points +radius: A float or a list of floats for each point +fn: int, The number of sides +make_torus: bool, Whether to make a torus instead of a pipe with ends. Warning: the last segment may be twisted. +convexity: see openscad

+
+ +Expand source code + +
class PathTube(Object):
+    """Creates a tube-like or toroid polyhedron from a path (list of points)."""
+
+    def __init__(self, points: List[TUnion[list, Point]], radius: TUnion[float, list], fn: int, make_torus: bool = False, convexity: int = 10):
+        """
+        points: The list of points
+        radius: A float or a list of floats for each point
+        fn: int, The number of sides
+        make_torus: bool, Whether to make a torus instead of a pipe with ends. Warning: the last segment may be twisted.
+        convexity: see openscad
+        """
+        self.points = [Point.c(p) for p in points]
+        self.radii = radius if isinstance(radius, list) else [radius for p in points]
+        self.fn = fn
+        self.make_torus = make_torus
+        self.convexity = convexity
+
+    def process(self, debug: bool = False) -> Polyhedron:
+        """Generate a Polyhedron object from the parameters"""
+        points_rows = []
+        
+        for ix, point in enumerate(self.points):
+            if debug: print(f"//LOOP {ix}: {point.render()}")
+            
+            if (not self.make_torus) and ix == 0:
+                # Start of the path
+                v = self.points[1].sub(point)  # vector toward the first point
+                z_point = Point([0,0,1])
+                seam = v.cross(z_point)  # Track a seam along the pipe using this vector pointing from the middle line
+                if seam.length() == 0: # v is in the z direction
+                    seam = Point([1,0,0])
+                seam = seam.norm()
+                seam2 = v.cross(seam).norm()
+                if debug: print(f"//Start. v={v.render()} seam={seam.render()} seam2={seam2.render()}")
+                points = []
+                for i in range(self.fn):
+                    a = math.pi*2*i/self.fn
+                    points.append((seam*math.cos(a) + seam2*math.sin(a))*self.radii[ix] + point)
+                points_rows.append(points)
+                if debug: print(f"//  Row: {', '.join([p.render() for p in points])}")
+                
+            elif (not self.make_torus) and ix == len(self.points) - 1:
+                # End of the path
+                v = point.sub(self.points[-2])
+                seam2 = v.cross(seam).norm()
+                if debug: print(f"//End. v={v.render()} seam={seam.render()} seam2={seam2.render()}")
+                points = []
+                for i in range(self.fn):
+                    a = math.pi*2*i/self.fn
+                    points.append((seam*math.cos(a) + seam2*math.sin(a))*self.radii[ix] + point)
+                points_rows.append(points)
+                if debug: print(f"//  Row: {', '.join([p.render() for p in points])}")
+                
+            else:
+                # Middle of the path
+                iprev = ix - 1 if ix > 0 else len(self.points) - 1
+                inext = ix + 1 if ix < len(self.points) - 1 else 0
+                # (p[-1]) -va-> (p[0]) -vb-> (p[1])
+                va = point.sub(self.points[iprev]).norm()  # vector incoming to this elbow
+                vb = self.points[inext].sub(point).norm()  # vector going out from this elbow
+                if debug: print(f"//Middle. va={va.render()} vb={vb.render()}")
+                # Get the vector perpendicular to va that points to the inside of the cylinder around va according
+                # to the elbow at p[0]. This is the component of vb in a basis defined by va.
+                vdot = va.dot(vb)
+                vb_proj = va.scale(vdot) # The projection of vb onto va
+                vb_perp = vb.sub(vb_proj) # This is perpendicular to va
+                if debug: print(f"//  vb_proj={vb_proj.render()} vb_perp={vb_perp.render()}")
+                va_inner = vb_perp.norm()
+                
+                va_proj = vb.scale(vdot)
+                va_perp = va.sub(va_proj)
+                if debug: print(f"//  va_proj={va_proj.render()} va_perp={va_perp.render()}")
+                vb_inner = va_perp.scale(-1).norm()  # Here we want to project -va onto vb
+                if debug: print(f"//  va_inner={va_inner.render()} vb_inner={vb_inner.render()}")
+                
+                if ix == 0:
+                    # We just choose a seam when making a torus
+                    seam_angle = 0
+                else:
+                    # The new seam on vb (seam_b) has the same angle to vb_inner as it had on va to va_inner
+                    seam_angle = seam.angle(va_inner, mode="rad")
+                    # need to figure out the sign of the angle
+                    if seam_angle != 0:
+                        if va_inner.cross(seam).dot(va) < 0:
+                            seam_angle = -seam_angle
+                vb_inner2 = vb.cross(vb_inner).norm()
+                seam_b = vb_inner*math.cos(seam_angle) + vb_inner2*math.sin(seam_angle)
+                if debug:
+                    if ix == 0:
+                        print(f"//  seam=N/A seam_b={seam_b.render()}")
+                    else:
+                        print(f"//  seam={seam.render()} seam_b={seam_b.render()}")
+                
+                vangle = va.scale(-1).angle(vb, mode="rad")
+                long_inner = (vb-va).norm().scale(1/math.sin(vangle/2))
+                # long_inner is the long axis of the elliptic intersection between the cylinders around va and vb
+                short = va.cross(long_inner).norm()  # the short axis of the ellipse
+                if debug: print(f"//  long_inner={long_inner.render()} short={short.render()} vangle={vangle/math.pi*180}(deg) seam_angle={seam_angle/math.pi*180}(deg)")
+                points = []
+                for i in range(self.fn):
+                    # We draw the ellipse according to long_inner and short, but use seam_angle to get the right points
+                    a = math.pi*2*i/self.fn + seam_angle
+                    points.append((long_inner*math.cos(a) + short*math.sin(a))*self.radii[ix] + point)
+                points_rows.append(points)
+                if debug: print(f"//  Row: {', '.join([p.render() for p in points])}")
+                
+                seam = seam_b
+        
+        return Polyhedron.tube(points=points_rows, convexity=self.convexity, make_torus=self.make_torus)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return self.process().render()
+
+

Ancestors

+ +

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 process(self, debug: bool = False) ‑> Polyhedron +
+
+

Generate a Polyhedron object from the parameters

+
+
+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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/point.html b/doc/openscad_py/point.html new file mode 100644 index 0000000..e8f3cf6 --- /dev/null +++ b/doc/openscad_py/point.html @@ -0,0 +1,373 @@ + + + + + + +openscad_py.point API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.point

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Point +(coords) +
+
+

Represents a point or vector in arbitrary dimensions

+
+ +Expand source code + +
class Point:
+    """Represents a point or vector in arbitrary dimensions"""
+    
+    def __init__(self, coords):
+        self.c = np.array(coords, dtype=NP_TYPE)
+        
+    @classmethod
+    def c(cls, coords: TUnion[list, 'Point']) -> 'Point':
+        """Ensure coords is an instance of Point (idempotent)"""
+        if isinstance(coords, Point):
+            return coords
+        return Point(coords)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return "[" + (",".join([str(c) for c in self.c])) + "]"
+    
+    def render_stl(self) -> str:
+        return " ".join([str(c) for c in self.c])
+
+    def scale(self, x: float) -> 'Point':
+        """Scale the current vector/point by a scalar"""
+        return self.__class__(self.c * x)
+     
+    def add(self, p: 'Point') -> 'Point':
+        assert isinstance(p, Point)
+        assert self.dim() == p.dim()
+        return self.__class__(self.c + p.c)
+    
+    def sub(self, p: 'Point') -> 'Point':
+        assert isinstance(p, Point)
+        assert self.dim() == p.dim()
+        return self.__class__(self.c - p.c)
+    
+    def dim(self) -> int:
+        """Return the number of dimensions"""
+        return self.c.shape[0]
+
+    def is_zero(self) -> bool:
+        """Return whether all coordinates are very close to 0"""
+        return np.all(np.abs(self.c) < EPSILON)
+
+    def length(self) -> float:
+        """Return the length of the vector"""
+        return np.sqrt(np.square(self.c).sum())
+    
+    def norm(self) -> 'Point':
+        l = self.length()
+        if l == 0:
+            raise Exception("normalising 0 vector")
+        return self.__class__(self.c / self.length())
+    
+    def dot(self, p: 'Point') -> float:
+        """Return the dot product"""
+        return np.dot(self.c, p.c)
+    
+    def cross(self, p: 'Point') -> 'Point':
+        """Return the cross product"""
+        assert self.dim() == 3
+        assert p.dim() == 3
+        return Point([
+            self.c[1]*p.c[2] - self.c[2]*p.c[1],
+            self.c[2]*p.c[0] - self.c[0]*p.c[2],
+            self.c[0]*p.c[1] - self.c[1]*p.c[0]
+            
+        ])
+
+    def eq(self, p: 'Point') -> bool:
+        return (self.c == p.c).all()
+    
+    def lt(self, p: 'Point') -> bool:
+        return (self.c < p.c).all()
+
+    def le(self, p: 'Point') -> bool:
+        return (self.c <= p.c).all()
+
+    def gt(self, p: 'Point') -> bool:
+        return (self.c > p.c).all()
+
+    def ge(self, p: 'Point') -> bool:
+        return (self.c >= p.c).all()
+
+    def allclose(self, p: 'Point') -> bool:
+        return self.c.shape == p.c.shape and np.allclose(self.c, p.c)
+    
+    def angle(self, p: 'Point', mode: str = "deg") -> float:
+        """Return the angle between two vectors in degrees or radians"""
+        r = self.dot(p)
+        r = r / self.length() / p.length()
+        r = math.acos(r)
+        if mode == "rad":
+            return r
+        if mode == "deg":
+            return r / math.pi * 180.
+        raise ValueError("Unknown mode")
+    
+    def z_slope(self, mode: str = "deg") -> float:
+        """Return the slope of a vector in degrees or radians"""
+        r = self.c[2] / self.length()
+        r = math.asin(r)
+        if mode == "rad":
+            return r
+        if mode == "deg":
+            return r / math.pi * 180.
+        raise ValueError("Unknown mode")        
+
+    def rotate(self, coords, angle: float) -> 'Point':
+        """Rotate. coords is a list of 2 coordinate indices that we rotate"""
+        assert len(coords) == 2
+        ca, cb = coords
+        s = np.sin(angle / 180. * np.pi)
+        c = np.cos(angle / 180. * np.pi)
+        r = self.clone().reset_cache()
+        r.c[ca] = c * self.c[ca] + s * self.c[cb]
+        r.c[cb] = -s * self.c[ca] + c * self.c[cb]
+        return r
+    
+    # Operator overloading
+
+    def __add__(self, other):
+        return self.add(other)
+
+    def __radd__(self, other):
+        assert isinstance(other, Point)
+        return other.add(self)
+
+    def __sub__(self, other):
+        return self.sub(other)
+
+    def __rsub__(self, other):
+        assert isinstance(other, Point)
+        return other.sub(self)
+
+    def __mul__(self, other):
+        return self.scale(other)
+    
+    def __rmul__(self, other):
+        return self.scale(other)
+    
+    def __neg__(self):
+        return self.scale(-1.)
+
+

Static methods

+
+
+def c(coords: list | ForwardRef('Point')) ‑> Point +
+
+

Ensure coords is an instance of Point (idempotent)

+
+
+

Methods

+
+
+def add(self,
p: Point) ‑> Point +
+
+
+
+
+def allclose(self,
p: Point) ‑> bool +
+
+
+
+
+def angle(self,
p: Point,
mode: str = 'deg') ‑> float +
+
+

Return the angle between two vectors in degrees or radians

+
+
+def cross(self,
p: Point) ‑> Point +
+
+

Return the cross product

+
+
+def dim(self) ‑> int +
+
+

Return the number of dimensions

+
+
+def dot(self,
p: Point) ‑> float +
+
+

Return the dot product

+
+
+def eq(self,
p: Point) ‑> bool +
+
+
+
+
+def ge(self,
p: Point) ‑> bool +
+
+
+
+
+def gt(self,
p: Point) ‑> bool +
+
+
+
+
+def is_zero(self) ‑> bool +
+
+

Return whether all coordinates are very close to 0

+
+
+def le(self,
p: Point) ‑> bool +
+
+
+
+
+def length(self) ‑> float +
+
+

Return the length of the vector

+
+
+def lt(self,
p: Point) ‑> bool +
+
+
+
+
+def norm(self) ‑> Point +
+
+
+
+
+def render(self) ‑> str +
+
+

Render the object into OpenSCAD code

+
+
+def render_stl(self) ‑> str +
+
+
+
+
+def rotate(self, coords, angle: float) ‑> Point +
+
+

Rotate. coords is a list of 2 coordinate indices that we rotate

+
+
+def scale(self, x: float) ‑> Point +
+
+

Scale the current vector/point by a scalar

+
+
+def sub(self,
p: Point) ‑> Point +
+
+
+
+
+def z_slope(self, mode: str = 'deg') ‑> float +
+
+

Return the slope of a vector in degrees or radians

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/polygon.html b/doc/openscad_py/polygon.html new file mode 100644 index 0000000..dfe44f2 --- /dev/null +++ b/doc/openscad_py/polygon.html @@ -0,0 +1,253 @@ + + + + + + +openscad_py.polygon API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.polygon

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Polygon +(points, paths=None, convexity=10) +
+
+

A 2D primitive, polygon. Use points/lists with 2 coordinates.

+
+ +Expand source code + +
class Polygon(Object):
+    """A 2D primitive, polygon. Use points/lists with 2 coordinates."""
+
+    def __init__(self, points, paths=None, convexity=10):
+        assert paths is None  # not implemented yet
+        self.points = [Point.c(p) for p in points]
+        self.convexity = convexity
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"polygon(points=[{','.join([p.render() for p in self.points])}], convexity={self.convexity});"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/polyhedron.html b/doc/openscad_py/polyhedron.html new file mode 100644 index 0000000..a21e23d --- /dev/null +++ b/doc/openscad_py/polyhedron.html @@ -0,0 +1,517 @@ + + + + + + +openscad_py.polyhedron API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.polyhedron

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Polyhedron +(points: List[list | Point],
faces: List[list],
convexity: int = 10) +
+
+

A 3D primitive, a polyhedron defined by a list of points and faces. +Faces are defined by lists of point indices. The points of a face must be listed clockwise when +looking at the face from the outside inward. +Nonplanar faces should be triangulated by OpenSCAD.

+

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

+
+ +Expand source code + +
class Polyhedron(Object):
+    """A 3D primitive, a polyhedron defined by a list of points and faces.
+    Faces are defined by lists of point indices. The points of a face must be listed clockwise when
+    looking at the face from the outside inward.
+    Nonplanar faces should be triangulated by OpenSCAD.
+
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#polyhedron
+    """
+
+    def __init__(self, points: List[TUnion[list, Point]], faces: List[list], convexity: int = 10):
+        self.points = [Point.c(p) for p in points]
+        self.faces = faces
+        self.convexity = convexity
+
+    @classmethod
+    def torus(cls, points: List[List[TUnion[list, Point]]], torus_connect_offset: int = 0, convexity: int = 10):
+        """Construct a torus-like polyhedron from a 2D array of points.
+        Each row of points must be oriented clockwise when looking from the first row (loop) toward the next.
+        The rows of points form loops.
+
+        points: A 2D array of points
+        torus_connect_offset: int, Whether to shift which points are connected in a torus in the last segment
+        convexity: int, see OpensCAD
+        """
+        return cls.tube(points=points, convexity=convexity, make_torus=True, torus_connect_offset=torus_connect_offset)
+
+    @classmethod
+    def tube(cls, points: List[List[TUnion[list, Point]]], make_torus: bool = False, torus_connect_offset: int = 0, convexity: int = 10):
+        """Construct a tube-like polyhedron from a 2D array of points.
+        Each row of points must be oriented clockwise when looking at the pipe at the start inwards.
+        The rows of points form loops.
+        
+        points: A 2D array of points
+        make_torus: bool, Whether to create a torus-like shape instead of a pipe with ends
+        torus_connect_offset: int, Whether to shift which points are connected in a torus in the last segment
+        convexity: int, see OpensCAD
+        """
+        rows = len(points)
+        row_len = len(points[0])
+        point_list = []
+        point_map = {}  # { (row_ix,col_ix) -> list_ix, ...
+        for row_ix, row in enumerate(points):
+            for col_ix, point in enumerate(row):
+                point_map[(row_ix, col_ix)] = len(point_list)
+                point_list.append(point)
+                
+        faces = []
+        
+        # Side faces
+        for row_ix in range(1, rows):
+            for col_ix in range(1, row_len):
+                faces.append([
+                    point_map[(row_ix, col_ix-1)],
+                    point_map[(row_ix, col_ix)],
+                    point_map[(row_ix-1, col_ix)],
+                    point_map[(row_ix-1, col_ix-1)]
+                ])
+            faces.append([
+                point_map[(row_ix, row_len-1)],
+                point_map[(row_ix, 0)],
+                point_map[(row_ix-1, 0)],
+                point_map[(row_ix-1, row_len-1)]
+            ])
+            
+        if not make_torus:
+            
+            # Starting cap
+            faces.append([point_map[(0,x)] for x in range(row_len)])
+            # Ending cap
+            faces.append([point_map[(rows-1,row_len-1-x)] for x in range(row_len)])
+            
+        else:
+            
+            # Connect the end to the start
+            for col_ix in range(row_len):
+                faces.append([
+                    point_map[(0, (col_ix-1+torus_connect_offset)%row_len)],
+                    point_map[(0, (col_ix+torus_connect_offset)%row_len)],
+                    point_map[(rows-1, col_ix%row_len)],
+                    point_map[(rows-1, (col_ix-1)%row_len)]
+                ])
+        
+        return cls(points=point_list, faces=faces, convexity=convexity)
+
+    @classmethod
+    def from_heightmap(cls, heights: List[List[float]], base: float = 0., convexity: int = 10):
+        """Construct a polyhedron from a 2D matrix of heights. If the height at [0,0] is Z, it maps
+        to the point (0, 0, Z).
+
+        heights: The 2D matrix of heights
+        base: The height at which the base will be - in the scale of heights (optional; default 0)
+        convexity: see OpenSCAD
+        """
+        rows = len(heights)
+        row_len = len(heights[0])
+        point_list = []
+        point_map = {}  # { (row_ix,col_ix) -> list_ix, ...
+        bottom_point_map = {}
+        for row_ix, row in enumerate(heights):
+            for col_ix, height in enumerate(row):
+                point = Point([row_ix, col_ix, height])
+                bottom_point = Point([row_ix, col_ix, base])
+                
+                point_map[(row_ix, col_ix)] = len(point_list)
+                point_list.append(point)
+                
+                bottom_point_map[(row_ix, col_ix)] = len(point_list)
+                point_list.append(bottom_point)
+                
+        faces = []
+
+        # Surface (top) faces
+        #  r 10 11
+        # c
+        # 10  1  2
+        # 11  4  3
+        for row_ix in range(1, rows):
+            for col_ix in range(1, row_len):
+                faces.append([
+                    point_map[(row_ix-1, col_ix-1)],
+                    point_map[(row_ix, col_ix-1)],
+                    point_map[(row_ix, col_ix)],
+                    point_map[(row_ix-1, col_ix)]
+                ])
+
+        # Bottom faces
+        for row_ix in range(1, rows):
+            for col_ix in range(1, row_len):
+                faces.append([
+                    bottom_point_map[(row_ix-1, col_ix-1)], # 1
+                    bottom_point_map[(row_ix-1, col_ix)], # 4
+                    bottom_point_map[(row_ix, col_ix)], # 3
+                    bottom_point_map[(row_ix, col_ix-1)] # 2
+                ])
+        
+        # Side faces
+        for row_ix in range(1, rows):
+            m = row_len - 1
+            faces.append([
+                point_map[(row_ix-1, m)],
+                point_map[(row_ix, m)],
+                bottom_point_map[(row_ix, m)],
+                bottom_point_map[(row_ix-1, m)]
+            ])
+            faces.append([
+                point_map[(row_ix, 0)],
+                point_map[(row_ix-1, 0)],
+                bottom_point_map[(row_ix-1, 0)],
+                bottom_point_map[(row_ix, 0)]
+            ])
+        
+        for col_ix in range(1, row_len):
+            m = rows - 1
+            faces.append([
+                point_map[(m, col_ix-1)],
+                point_map[(m, col_ix)],
+                bottom_point_map[(m, col_ix)],
+                bottom_point_map[(m, col_ix-1)]
+            ])
+            faces.append([
+                point_map[(0, col_ix)],
+                point_map[(0, col_ix-1)],
+                bottom_point_map[(0, col_ix-1)],
+                bottom_point_map[(0, col_ix)]
+            ])
+            
+        return cls(points=point_list, faces=faces, convexity=convexity)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        faces_list = [f"[{','.join([str(x) for x in face])}]" for face in self.faces]
+        return f"polyhedron(points=[{','.join([p.render() for p in self.points])}], faces=[{','.join(faces_list)}], convexity={self.convexity});"
+
+    def render_stl(self) -> str:
+        """Export the polyhedron as an STL file"""
+        stl = []
+        
+        def write_triangle(p1, p2, p3):
+            normal = (p2 - p1).cross(p3 - p1)
+            if normal.is_zero():
+                # Degenerate triangle
+                return
+            normal = normal.norm()
+            stl.append("facet normal " + normal.render_stl())
+            stl.append("outer loop")
+            for p in [p1, p2, p3]:
+                stl.append("vertex " + p.render_stl())
+            stl.append("endloop")
+            stl.append("endfacet")
+        
+        stl.append("solid oscpy")
+        for face in self.faces:
+            face = [self.points[i] for i in face]
+            # stl.append(f"# FACE {len(face)} {','.join([p.render() for p in face])}")
+            if len(face) < 3:
+                raise Exception("Face has less than 3 points")
+            elif len(face) == 3:
+                write_triangle(face[0], face[1], face[2])
+            elif len(face) == 4:
+                # Decide which diagonal is best to break on
+                d1 = face[0].sub(face[2]).length()
+                d2 = face[1].sub(face[3]).length()
+                if d1 < d2:
+                    write_triangle(face[0], face[1], face[2])
+                    write_triangle(face[0], face[2], face[3])
+                else:
+                    write_triangle(face[0], face[1], face[3])
+                    write_triangle(face[1], face[2], face[3])
+            else:
+                # Add central point and split face in a star-shaped form
+                # of course this won't always work on concave faces
+                s = None
+                for p in face:
+                    if s is None:
+                        s = p
+                    else:
+                        s += p
+                s = s.scale(1 / len(face))
+                for i in range(len(face)):
+                    i_next = i + 1
+                    if i_next > len(face) - 1:
+                        i_next = 0
+                    write_triangle(face[i], face[i_next], s)
+        stl.append("endsolid oscpy")
+        return "\n".join(stl)
+
+

Ancestors

+ +

Static methods

+
+
+def from_heightmap(heights: List[List[float]], base: float = 0.0, convexity: int = 10) +
+
+

Construct a polyhedron from a 2D matrix of heights. If the height at [0,0] is Z, it maps +to the point (0, 0, Z).

+

heights: The 2D matrix of heights +base: The height at which the base will be - in the scale of heights (optional; default 0) +convexity: see OpenSCAD

+
+
+def torus(points: List[List[list | Point]],
torus_connect_offset: int = 0,
convexity: int = 10) +
+
+

Construct a torus-like polyhedron from a 2D array of points. +Each row of points must be oriented clockwise when looking from the first row (loop) toward the next. +The rows of points form loops.

+

points: A 2D array of points +torus_connect_offset: int, Whether to shift which points are connected in a torus in the last segment +convexity: int, see OpensCAD

+
+
+def tube(points: List[List[list | Point]],
make_torus: bool = False,
torus_connect_offset: int = 0,
convexity: int = 10) +
+
+

Construct a tube-like polyhedron from a 2D array of points. +Each row of points must be oriented clockwise when looking at the pipe at the start inwards. +The rows of points form loops.

+

points: A 2D array of points +make_torus: bool, Whether to create a torus-like shape instead of a pipe with ends +torus_connect_offset: int, Whether to shift which points are connected in a torus in the last segment +convexity: int, see OpensCAD

+
+
+

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) ‑> str +
+
+

+Inherited from: +Object.render +

+

Render the object into OpenSCAD code

+
+
+def render_stl(self) ‑> str +
+
+

Export the polyhedron as an STL file

+
+
+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/radial_offset.html b/doc/openscad_py/radial_offset.html new file mode 100644 index 0000000..78dccb9 --- /dev/null +++ b/doc/openscad_py/radial_offset.html @@ -0,0 +1,257 @@ + + + + + + +openscad_py.radial_offset API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.radial_offset

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class RadialOffset +(r,
child: Object) +
+
+

A new 2d interior or exterior outline from an existing outline

+

See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset

+
+ +Expand source code + +
class RadialOffset(Object):
+    """A new 2d interior or exterior outline from an existing outline
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset
+    """
+
+    def __init__(self, r, child: Object):
+        self.r = r
+        self.child = child
+        # $fa, $fs, and $fn
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"offset(r={self.r}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/rotate.html b/doc/openscad_py/rotate.html new file mode 100644 index 0000000..9e89a7b --- /dev/null +++ b/doc/openscad_py/rotate.html @@ -0,0 +1,256 @@ + + + + + + +openscad_py.rotate API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.rotate

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Rotate +(a,
v: list | Point,
child: Object) +
+
+

Represents a rotation transformation applied to an object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate

+
+ +Expand source code + +
class Rotate(Object):
+    """Represents a rotation transformation applied to an object.
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate
+    """
+
+    def __init__(self, a, v: TUnion[list, Point], child: Object):
+        self.a = a
+        self.v = Point.c(v)
+        self.child = child
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"rotate(a={self.a}, v={self.v.render()}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/rotate_extrude.html b/doc/openscad_py/rotate_extrude.html new file mode 100644 index 0000000..5cac0b4 --- /dev/null +++ b/doc/openscad_py/rotate_extrude.html @@ -0,0 +1,260 @@ + + + + + + +openscad_py.rotate_extrude API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.rotate_extrude

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class RotateExtrude +(angle,
child: Object,
convexity: int = 10) +
+
+

Represents a rotational extrusion of a (2D) object. +For all points, x>=0 must hold.

+

See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion

+
+ +Expand source code + +
class RotateExtrude(Object):
+    """Represents a rotational extrusion of a (2D) object.
+    For all points, x>=0 must hold.
+
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/2D_to_3D_Extrusion
+    """
+
+    def __init__(self, angle, child: Object, convexity: int = 10):
+        self.angle = angle
+        self.child = child
+        self.convexity = convexity
+        # $fa, $fs, $fn
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"rotate_extrude(angle={self.angle}, convexity={self.convexity}) {{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/scale.html b/doc/openscad_py/scale.html new file mode 100644 index 0000000..1dfc481 --- /dev/null +++ b/doc/openscad_py/scale.html @@ -0,0 +1,257 @@ + + + + + + +openscad_py.scale API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.scale

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Scale +(v: list | Point | float | int,
child: Object) +
+
+

Represents a scale transformation applied to an object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#scale

+
+ +Expand source code + +
class Scale(Object):
+    """Represents a scale transformation applied to an object.
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#scale
+    """
+
+    def __init__(self, v: TUnion[list, Point, float, int], child: Object):
+        if isinstance(v, float) or isinstance(v, int):
+            v = [v, v, v]
+        self.v = Point.c(v)
+        self.child = child
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"scale(v={self.v.render()}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/sphere.html b/doc/openscad_py/sphere.html new file mode 100644 index 0000000..7163881 --- /dev/null +++ b/doc/openscad_py/sphere.html @@ -0,0 +1,258 @@ + + + + + + +openscad_py.sphere API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.sphere

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Sphere +(r) +
+
+

A 3D primitive, sphere. +Creates a sphere at the origin of the coordinate system.

+

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

+
+ +Expand source code + +
class Sphere(Object):
+    """A 3D primitive, sphere.
+    Creates a sphere at the origin of the coordinate system.
+    
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#sphere
+    """
+
+    def __init__(self, r):
+        self.r = r
+        # $fa, $fs, $fn
+
+    def render(self):
+        """Render the object into OpenSCAD code"""
+        return f"sphere(r={self.r});"
+
+

Ancestors

+ +

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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/translate.html b/doc/openscad_py/translate.html new file mode 100644 index 0000000..05dd9b4 --- /dev/null +++ b/doc/openscad_py/translate.html @@ -0,0 +1,255 @@ + + + + + + +openscad_py.translate API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.translate

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Translate +(v: list | Point,
child: Object) +
+
+

Represents a translation transformation applied to an object. +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate

+
+ +Expand source code + +
class Translate(Object):
+    """Represents a translation transformation applied to an object.
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate
+    """
+
+    def __init__(self, v: TUnion[list, Point], child: Object):
+        self.v = Point.c(v)
+        self.child = child
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"translate(v={self.v.render()}){{\n{self.child.render()}\n}}"
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 …

+
+
+
+
+
+
+ +
+ + + diff --git a/doc/openscad_py/union.html b/doc/openscad_py/union.html new file mode 100644 index 0000000..89a67e8 --- /dev/null +++ b/doc/openscad_py/union.html @@ -0,0 +1,257 @@ + + + + + + +openscad_py.union API documentation + + + + + + + + + + + +
+
+
+

Module openscad_py.union

+
+
+
+
+
+
+
+
+
+
+

Classes

+
+
+class Union +(child: list | Object) +
+
+

Represents a union applied to an object (usually a collection of objects). +See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union

+
+ +Expand source code + +
class Union(Object):
+    """Represents a union applied to an object (usually a collection of objects).
+    See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union
+    """
+
+    def __init__(self, child: TUnion[Object, list]):
+        self.child = Collection.c(child)
+
+    def render(self) -> str:
+        """Render the object into OpenSCAD code"""
+        return f"union(){{ {self.child.render()} }}"
+
+    def union(self, objects: TUnion[list, Object]) -> Object:
+        return self.__class__(self.child._add(objects))
+
+

Ancestors

+ +

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) ‑> str +
+
+

+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 | Object) ‑> Object +
+
+

+Inherited from: +Object.union +

+

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

+
+
+
+
+
+
+ +
+ + +