Merge branch 'master' into patch-2

Author: adam-urbanczyk

.gitignore

@@ -9,3 +9,13 @@ target/*
 MANIFEST
 out.*
 res?.dxf
+.~*
+assy.wrl
+assy.xml
+assy.zip
+nested.step
+simple.caf
+simple.step
+simple.stp
+simple.xml
+test.brep

README.md

@@ -15,8 +15,8 @@ CadQuery is an intuitive, easy-to-use Python module for building parametric 3D C
 CadQuery is often compared to [OpenSCAD](http://www.openscad.org/). Like OpenSCAD, CadQuery is an open-source, script based, parametric model generator. However, CadQuery stands out in many ways and has several key advantages:
 
 1. The scripts use a standard programming language, Python, and thus can benefit from the associated infrastructure. This includes many standard libraries and IDEs.
-2. CadQuery's CAD kernel Open CASCADE Technology (OCCT) is much more powerful than CGAL. 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 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.
+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.
 

azure-pipelines.yml

@@ -14,29 +14,7 @@ resources:
       name: CadQuery/conda-packages
       endpoint: CadQuery
 
-jobs:
-- template: conda-build.yml@templates
-  parameters:
-    name: Linux_37
-    vmImage: 'ubuntu-18.04'
-    py_maj: 3
-    py_min: 7
-
-- template: conda-build.yml@templates
-  parameters:
-    name: macOS_37
-    vmImage: 'macOS-10.15'
-    py_maj: 3
-    py_min: 7
-
-- template: conda-build.yml@templates
-  parameters:
-    name: Windows_37
-    vmImage: 'vs2017-win2016'
-    py_maj: 3
-    py_min: 7
-    conda_bld: 3.18
-    
+jobs:  
 - template: conda-build.yml@templates
   parameters:
     name: Linux_38

cadquery/__init__.py

@@ -27,6 +27,7 @@
     StringSyntaxSelector,
     Selector,
 )
+from .sketch import Sketch
 from .cq import CQ, Workplane
 from .assembly import Assembly, Color, Constraint
 from . import selectors
@@ -66,6 +67,7 @@
     "StringSyntaxSelector",
     "Selector",
     "plugins",
+    "Sketch",
 ]
 
 __version__ = "2.1"

cadquery/assembly.py

@@ -12,7 +12,13 @@
     ConstraintMarker,
     Constraint as ConstraintPOD,
 )
-from .occ_impl.exporters.assembly import exportAssembly, exportCAF
+from .occ_impl.exporters.assembly import (
+    exportAssembly,
+    exportCAF,
+    exportVTKJS,
+    exportVRML,
+    exportGLTF,
+)
 
 from .selectors import _expression_grammar as _selector_grammar
 from OCP.BRepTools import BRepTools
@@ -22,7 +28,7 @@
 # type definitions
 AssemblyObjects = Union[Shape, Workplane, None]
 ConstraintKinds = Literal["Plane", "Point", "Axis", "PointInPlane"]
-ExportLiterals = Literal["STEP", "XML"]
+ExportLiterals = Literal["STEP", "XML", "GLTF", "VTKJS", "VRML"]
 
 PATH_DELIM = "/"
 
@@ -168,8 +174,7 @@ def toPOD(self) -> ConstraintPOD:
 
 
 class Assembly(object):
-    """Nested assembly of Workplane and Shape objects defining their relative positions.
-    """
+    """Nested assembly of Workplane and Shape objects defining their relative positions."""
 
     loc: Location
     name: str
@@ -357,7 +362,7 @@ def _subloc(self, name: str) -> Tuple[Location, str]:
         """
         Calculate relative location of an object in a subassembly.
 
-        Returns the relative posiitons as well as the name of the top assembly.
+        Returns the relative positions as well as the name of the top assembly.
         """
 
         rv = Location()
@@ -463,18 +468,24 @@ def solve(self) -> "Assembly":
         return self
 
     def save(
-        self, path: str, exportType: Optional[ExportLiterals] = None
+        self,
+        path: str,
+        exportType: Optional[ExportLiterals] = None,
+        tolerance: float = 0.1,
+        angularTolerance: float = 0.1,
     ) -> "Assembly":
         """
         save as STEP or OCCT native XML file
 
         :param path: filepath
         :param exportType: export format (default: None, results in format being inferred form the path)
+        :param tolerance: the deflection tolerance, in model units. Only used for GLTF. Default 0.1.
+        :param angularTolerance: the angular tolerance, in radians. Only used for GLTF. Default 0.1.
         """
 
         if exportType is None:
             t = path.split(".")[-1].upper()
-            if t in ("STEP", "XML"):
+            if t in ("STEP", "XML", "VRML", "VTKJS", "GLTF"):
                 exportType = cast(ExportLiterals, t)
             else:
                 raise ValueError("Unknown extension, specify export type explicitly")
@@ -483,6 +494,12 @@ def save(
             exportAssembly(self, path)
         elif exportType == "XML":
             exportCAF(self, path)
+        elif exportType == "VRML":
+            exportVRML(self, path)
+        elif exportType == "GLTF":
+            exportGLTF(self, path, True, tolerance, angularTolerance)
+        elif exportType == "VTKJS":
+            exportVTKJS(self, path)
         else:
             raise ValueError(f"Unknown format: {exportType}")