Merge branch 'master' into master

Author: jpoles1

.coveragerc

@@ -3,6 +3,7 @@ branch = True
 omit = 
     cadquery/utils.py
     cadquery/cq_directive.py
+    tests/*
 
 [report]
 exclude_lines =

README.md

@@ -25,12 +25,12 @@ CadQuery is often compared to [OpenSCAD](http://www.openscad.org/). Like OpenSCA
 2. CadQuery's CAD kernel Open CASCADE Technology ([OCCT](https://en.wikipedia.org/wiki/Open_Cascade_Technology)) is much more powerful than the [CGAL](https://en.wikipedia.org/wiki/CGAL) used by OpenSCAD. Features supported natively by OCCT include NURBS, splines, surface sewing, STL repair, STEP import/export, and other complex operations, in addition to the standard CSG operations supported by CGAL
 3. Ability to import/export [STEP](https://en.wikipedia.org/wiki/ISO_10303) and the ability to begin with a STEP model, created in a CAD package, and then add parametric features. This is possible in OpenSCAD using STL, but STL is a lossy format.
 4. CadQuery scripts require less code to create most objects, because it is possible to locate features based on the position of other features, workplanes, vertices, etc.
-5. CadQuery scripts can build STL, STEP, and AMF faster than OpenSCAD.
+5. CadQuery scripts can build STL, STEP, AMF and 3MF faster than OpenSCAD.
 
 ### Key features
 * Build 3D models with scripts that are as close as possible to how you would describe the object to a human.
 * Create parametric models that can be very easily customized by end users.
-* Output high quality (loss-less) CAD formats like STEP and DXF in addition to STL, VRML and AMF.
+* Output high quality (loss-less) CAD formats like STEP and DXF in addition to STL, VRML, AMF and 3MF.
 * Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser.
 * Offer advanced modeling capabilities such as fillets, curvilinear extrudes, parametric curves and lofts.
 * Build nested assemblies out of individual parts and other assemblies.
@@ -53,19 +53,8 @@ There are currently 4 different ways to use CadQuery for designing your next pro
     * Linux [installation video](https://youtu.be/sjLTePOq8bQ)
     * Windows [installation video](https://youtu.be/3Tg_RJhqZRg)
 
-There are two ways to install the CadQuery library and its dependencies. One is using conda, and the other is using pip. Pip is shown first below, followed by two sections on installing CadQuery via conda, and a non-intrusive way to install conda on a system.
 
-### CQ-editor GUI
-
-CQ-editor is an IDE that allows users to edit CadQuery model scripts in a GUI environment. It includes features such as:
-
-* A graphical debugger that allows you to step through your scripts.
-* A CadQuery stack inspector.
-* Export to various formats, including STEP and STL, directly from the menu.
-
-The installation instructions for CQ-editor can be found [here](https://github.com/CadQuery/CQ-editor#installation).
-
-<img src="https://raw.githubusercontent.com/CadQuery/CQ-editor/master/screenshots/screenshot3.png" alt="CQ editor screenshot" width="800"/>
+There are two ways to install CadQuery and its dependencies. One is using conda, and the other is using pip. Pip is shown first below, followed by two sections on installing CadQuery via conda, and a non-intrusive way to install conda on a system. Note that conda is the better supported option.
 
 ### CadQuery Installation Via Pip
 
@@ -77,9 +66,9 @@ python3 -m pip install --upgrade pip
 ```
 Once a current version of pip is installed, CadQuery can be installed using the following command line.
 ```
-pip install cadquery==2.2.0b0
+pip install --pre cadquery
 ```
-Notice that the version number is pinned to a beta version. This is because CadQuery has only recently returned to PyPI, and a full release has not happened yet. When the final release of CadQuery 2.2 is published, it will be possible to simply type `pip install cadquery`. However, if the version number pin is not used for now, a 1.x version of CadQuery will be installed, which is extremely out of date.
+NB: CadQuery has only recently returned to PyPI, and a full release has not happened yet. When the final release of CadQuery 2.2 is published, it will be possible to simply type `pip install cadquery`.
 
 It is also possible to install the very latest changes directly from CadQuery's GitHub repository, with the understanding that sometimes breaking changes can occur. To install from the git repository, run the following command line.
 ```

appveyor.yml

@@ -28,7 +28,7 @@ install:
     - cmd: conda init cmd.exe
     - conda env create -f environment.yml
     - conda activate cadquery
-    - pip install git+https://github.com/CadQuery/OCP-stubs.git@7.5.1
+    - pip install git+https://github.com/CadQuery/OCP-stubs.git@7.6.3
 
 build: false
 

cadquery/cq.py

@@ -530,7 +530,7 @@ def workplane(
         :type invert: boolean or None=False
         :type centerOption: string or None='ProjectedOrigin'
         :type origin: Vector or None
-        :rtype: Workplane object 
+        :rtype: Workplane object
 
         The first element on the stack must be a face, a set of
         co-planar faces or a vertex.  If a vertex, then the parent
@@ -3019,7 +3019,7 @@ def extrude(
           passed, the extrusion extends this far and a negative value is in the opposite direction
           to the normal of the plane. The string "next" extrudes until the next face orthogonal to
           the wire normal. "last" extrudes to the last face. If a object of type Face is passed then
-          the extrusion will extend until this face. **Note that the Workplane must contain a Solid for extruding to a given face.**        
+          the extrusion will extend until this face. **Note that the Workplane must contain a Solid for extruding to a given face.**
         :param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
         :param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
         :param boolean both: extrude in both directions symmetrically
@@ -3524,7 +3524,7 @@ def loft(
         :param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
 
         :return: a Workplane object containing the created loft
-        
+
         """
 
         if self.ctx.pendingWires:
@@ -3765,7 +3765,7 @@ def interpPlate(
     ) -> T:
         """
         Returns a plate surface that is 'thickness' thick, enclosed by 'surf_edge_pts' points,  and going
-        through 'surf_pts' points.  Using pushPoints directly with interpPlate and combine=True, can be 
+        through 'surf_pts' points.  Using pushPoints directly with interpPlate and combine=True, can be
         very resources intensive depending on the complexity of the shape. In this case set combine=False.
 
         :param surf_edges
@@ -3833,7 +3833,7 @@ def interpPlate(
         # thicken if needed
         s = f.thicken(thickness) if thickness > 0 else f
 
-        return self.eachpoint(lambda loc: s.moved(loc), True, combine)
+        return self.eachpoint(lambda loc: s.moved(loc), True, combine, clean)
 
     def box(
         self: T,
@@ -3903,7 +3903,7 @@ def box(
 
         box = Solid.makeBox(length, width, height, offset)
 
-        return self.eachpoint(lambda loc: box.moved(loc), True, combine)
+        return self.eachpoint(lambda loc: box.moved(loc), True, combine, clean)
 
     def sphere(
         self: T,
@@ -3967,7 +3967,7 @@ def sphere(
         s = Solid.makeSphere(radius, offset, direct, angle1, angle2, angle3)
 
         # We want a sphere for each point on the workplane
-        return self.eachpoint(lambda loc: s.moved(loc), True, combine)
+        return self.eachpoint(lambda loc: s.moved(loc), True, combine, clean)
 
     def cylinder(
         self: T,
@@ -4024,7 +4024,7 @@ def cylinder(
         s = Solid.makeCylinder(radius, height, offset, direct, angle)
 
         # We want a cylinder for each point on the workplane
-        return self.eachpoint(lambda loc: s.moved(loc), True, combine)
+        return self.eachpoint(lambda loc: s.moved(loc), True, combine, clean)
 
     def wedge(
         self: T,
@@ -4094,7 +4094,7 @@ def wedge(
         w = Solid.makeWedge(dx, dy, dz, xmin, zmin, xmax, zmax, offset, dir)
 
         # We want a wedge for each point on the workplane
-        return self.eachpoint(lambda loc: w.moved(loc), True, combine)
+        return self.eachpoint(lambda loc: w.moved(loc), True, combine, clean)
 
     def clean(self: T) -> T:
         """

cadquery/occ_impl/exporters/__init__.py

@@ -14,6 +14,7 @@
 from .svg import getSVG
 from .json import JsonMesh
 from .amf import AmfWriter
+from .threemf import ThreeMFWriter
 from .dxf import exportDXF
 from .vtk import exportVTP
 from .utils import toCompound
@@ -28,9 +29,12 @@ class ExportTypes:
     DXF = "DXF"
     VRML = "VRML"
     VTP = "VTP"
+    THREEMF = "3MF"
 
 
-ExportLiterals = Literal["STL", "STEP", "AMF", "SVG", "TJS", "DXF", "VRML", "VTP"]
+ExportLiterals = Literal[
+    "STL", "STEP", "AMF", "SVG", "TJS", "DXF", "VRML", "VTP", "3MF"
+]
 
 
 def export(
@@ -93,6 +97,11 @@ def export(
         with open(fname, "wb") as f:
             aw.writeAmf(f)
 
+    elif exportType == ExportTypes.THREEMF:
+        tmfw = ThreeMFWriter(shape, tolerance, angularTolerance, **opt or {})
+        with open(fname, "wb") as f:
+            tmfw.write3mf(f)
+
     elif exportType == ExportTypes.DXF:
         if isinstance(w, Workplane):
             exportDXF(w, fname)
@@ -106,7 +115,12 @@ def export(
             shape.exportStep(fname)
 
     elif exportType == ExportTypes.STL:
-        shape.exportStl(fname, tolerance, angularTolerance)
+        if opt:
+            useascii = opt.get("ascii", False) or opt.get("ASCII", False)
+        else:
+            useascii = False
+
+        shape.exportStl(fname, tolerance, angularTolerance, useascii)
 
     elif exportType == ExportTypes.VRML:
         shape.mesh(tolerance, angularTolerance)
@@ -175,6 +189,9 @@ def tessellate(shape, angularTolerance):
         tess = tessellate(shape, angularTolerance)
         aw = AmfWriter(tess)
         aw.writeAmf(fileLike)
+    elif exportType == ExportTypes.THREEMF:
+        tmfw = ThreeMFWriter(shape, tolerance, angularTolerance)
+        tmfw.write3mf(fileLike)
     else:
 
         # all these types required writing to a file and then
@@ -187,7 +204,7 @@ def tessellate(shape, angularTolerance):
         if exportType == ExportTypes.STEP:
             shape.exportStep(outFileName)
         elif exportType == ExportTypes.STL:
-            shape.exportStl(outFileName, tolerance, angularTolerance)
+            shape.exportStl(outFileName, tolerance, angularTolerance, True)
         else:
             raise ValueError("No idea how i got here")
 

cadquery/occ_impl/exporters/threemf.py

@@ -0,0 +1,164 @@
+from datetime import datetime
+from os import PathLike
+import xml.etree.cElementTree as ET
+from typing import IO, List, Literal, Tuple, Union
+from zipfile import ZipFile, ZIP_DEFLATED, ZIP_STORED
+
+from ...cq import Compound, Shape, Vector
+
+
+class CONTENT_TYPES(object):
+    MODEL = "application/vnd.ms-package.3dmanufacturing-3dmodel+xml"
+    RELATION = "application/vnd.openxmlformats-package.relationships+xml"
+
+
+class SCHEMAS(object):
+    CONTENT_TYPES = "http://schemas.openxmlformats.org/package/2006/content-types"
+    RELATION = "http://schemas.openxmlformats.org/package/2006/relationships"
+    CORE = "http://schemas.microsoft.com/3dmanufacturing/core/2015/02"
+    MODEL = "http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel"
+
+
+Unit = Literal["micron", "millimeter", "centimeter", "meter", "inch", "foot"]
+
+
+class ThreeMFWriter(object):
+    def __init__(
+        self,
+        shape: Shape,
+        tolerance: float,
+        angularTolerance: float,
+        unit: Unit = "millimeter",
+    ):
+        """
+        Initialize the writer.
+        Used to write the given Shape to a 3MF file.
+        """
+        self.unit = unit
+
+        if isinstance(shape, Compound):
+            shapes = list(shape)
+        else:
+            shapes = [shape]
+
+        tessellations = [s.tessellate(tolerance, angularTolerance) for s in shapes]
+        # Remove shapes that did not tesselate
+        self.tessellations = [t for t in tessellations if all(t)]
+
+    def write3mf(
+        self, outfile: Union[PathLike, str, IO[bytes]],
+    ):
+        """ 
+        Write to the given file. 
+        """
+
+        try:
+            import zlib
+
+            compression = ZIP_DEFLATED
+        except ImportError:
+            compression = ZIP_STORED
+
+        with ZipFile(outfile, "w", compression) as zf:
+            zf.writestr("_rels/.rels", self._write_relationships())
+            zf.writestr("[Content_Types].xml", self._write_content_types())
+            zf.writestr("3D/3dmodel.model", self._write_3d())
+
+    def _write_3d(self) -> str:
+
+        no_meshes = len(self.tessellations)
+
+        model = ET.Element(
+            "model", {"xml:lang": "en-US", "xmlns": SCHEMAS.CORE,}, unit=self.unit,
+        )
+
+        # Add meta data
+        ET.SubElement(
+            model, "metadata", name="Application"
+        ).text = "CadQuery 3MF Exporter"
+        ET.SubElement(
+            model, "metadata", name="CreationDate"
+        ).text = datetime.now().isoformat()
+
+        resources = ET.SubElement(model, "resources")
+
+        # Add all meshes to resources
+        for i, tessellation in enumerate(self.tessellations):
+            self._add_mesh(resources, str(i), tessellation)
+
+        # Create a component of all meshes
+        comp_object = ET.SubElement(
+            resources,
+            "object",
+            id=str(no_meshes),
+            name=f"CadQuery Component",
+            type="model",
+        )
+        components = ET.SubElement(comp_object, "components")
+
+        # Add all meshes to the component
+        for i in range(no_meshes):
+            ET.SubElement(
+                components, "component", objectid=str(i),
+            )
+
+        # Add the component to the build
+        build = ET.SubElement(model, "build")
+        ET.SubElement(build, "item", objectid=str(no_meshes))
+
+        return ET.tostring(model, xml_declaration=True, encoding="utf-8")
+
+    def _add_mesh(
+        self,
+        to: ET.Element,
+        id: str,
+        tessellation: Tuple[List[Vector], List[Tuple[int, int, int]]],
+    ):
+        object = ET.SubElement(
+            to, "object", id=id, name=f"CadQuery Shape {id}", type="model"
+        )
+        mesh = ET.SubElement(object, "mesh")
+
+        # add vertices
+        vertices = ET.SubElement(mesh, "vertices")
+        for v in tessellation[0]:
+            ET.SubElement(vertices, "vertex", x=str(v.x), y=str(v.y), z=str(v.z))
+
+        # add triangles
+        volume = ET.SubElement(mesh, "triangles")
+        for t in tessellation[1]:
+            ET.SubElement(volume, "triangle", v1=str(t[0]), v2=str(t[1]), v3=str(t[2]))
+
+    def _write_content_types(self) -> str:
+
+        root = ET.Element("Types")
+        root.set("xmlns", SCHEMAS.CONTENT_TYPES)
+        ET.SubElement(
+            root,
+            "Override",
+            PartName="/3D/3dmodel.model",
+            ContentType=CONTENT_TYPES.MODEL,
+        )
+        ET.SubElement(
+            root,
+            "Override",
+            PartName="/_rels/.rels",
+            ContentType=CONTENT_TYPES.RELATION,
+        )
+
+        return ET.tostring(root, xml_declaration=True, encoding="utf-8")
+
+    def _write_relationships(self) -> str:
+
+        root = ET.Element("Relationships")
+        root.set("xmlns", SCHEMAS.RELATION)
+        ET.SubElement(
+            root,
+            "Relationship",
+            Target="/3D/3dmodel.model",
+            Id="rel-1",
+            Type=SCHEMAS.MODEL,
+            TargetMode="Internal",
+        )
+
+        return ET.tostring(root, xml_declaration=True, encoding="utf-8")

cadquery/occ_impl/jupyter_tools.py

@@ -36,7 +36,7 @@
         const mapper = vtk.Rendering.Core.vtkMapper.newInstance();
         mapper.setInputConnection(reader.getOutputPort());
         mapper.setResolveCoincidentTopologyToPolygonOffset();
-        mapper.setResolveCoincidentTopologyPolygonOffsetParameters(0.5,100);
+        mapper.setResolveCoincidentTopologyPolygonOffsetParameters(0.9,20);
 
         const actor = vtk.Rendering.Core.vtkActor.newInstance();
         actor.setMapper(mapper);