Merge branch 'master' into master

Author: adam-urbanczyk

.github/ISSUE_TEMPLATE/modelling-question.md

@@ -18,7 +18,7 @@ are appreciated.
 If you want to discuss something in a more casual environment, we have other options under [Getting help in the README.md](https://github.com/CadQuery/cadquery#getting-help). There are also additional examples in the [cadquery-contrib repository](https://github.com/CadQuery/cadquery-contrib).
 -->
 
-<!-- We are all volunteers here, you can help us help you by making this question quick to answer. Minimal examples, trimmed of all unreleated code are appreciated. It also helps if you provide code that can be cut and pasted into CQ-Editor. ie. instead of:
+<!-- We are all volunteers here, you can help us help you by making this question quick to answer. Minimal examples, trimmed of all unrelated code are appreciated. It also helps if you provide code that can be cut and pasted into CQ-Editor. ie. instead of:
 
 > I have a box, how to I fillet a top corner?
 

.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.
 
@@ -25,7 +25,7 @@ CadQuery is often compared to [OpenSCAD](http://www.openscad.org/). Like OpenSCA
 * 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.
 * 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, curvelinear extrudes, parametric curves and lofts.
+* Offer advanced modeling capabilities such as fillets, curvilinear extrudes, parametric curves and lofts.
 * Build nested assemblies out of individual parts and other assemblies.
 
 ### Why this fork
@@ -175,7 +175,7 @@ If you are going to contribute code, make sure to follow this steps:
   start working on your changes
 - Create a conda development environment with something like:
   - `conda env create -n cq-dev -f environment.yml`
-- Activate the new conda enviornment:
+- Activate the new conda environment:
   - `conda activate cq-dev`
 - If desired, install the master branch of cq-editor (Note; a release version may not be compatible with the master branch of cadquery):
   - `conda install -c cadquery -c conda-forge cq-editor=master`

cadquery/assembly.py

@@ -26,7 +26,7 @@
 
 PATH_DELIM = "/"
 
-# enitity selector grammar definiiton
+# entity selector grammar definiiton
 def _define_grammar():
 
     from pyparsing import (
@@ -83,11 +83,11 @@ def __init__(
         """
         Construct a constraint.
 
-        :param objects: object names refernced in the constraint
+        :param objects: object names referenced in the constraint
         :param args: subshapes (e.g. faces or edges) of the objects
         :param sublocs: locations of the objects (only relevant if the objects are nested in a sub-assembly)
         :param kind: constraint kind
-        :param param: optional arbitrary paramter passed to the solver
+        :param param: optional arbitrary parameter passed to the solver
         """
 
         self.objects = objects
@@ -357,7 +357,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()
@@ -411,7 +411,7 @@ def constrain(self, *args, param=None):
         elif len(args) == 6:
             id1, s1, id2, s2, kind, param = args
         else:
-            raise ValueError(f"Incompatibile arguments: {args}")
+            raise ValueError(f"Incompatible arguments: {args}")
 
         loc1, id1_top = self._subloc(id1)
         loc2, id2_top = self._subloc(id2)

cadquery/cq.py

@@ -130,7 +130,7 @@ def popPendingWires(self, errorOnEmpty: bool = True) -> List[Wire]:
 
 class Workplane(object):
     """
-    Defines a coordinate system in space, in which 2-d coordinates can be used.
+    Defines a coordinate system in space, in which 2D coordinates can be used.
 
     :param plane: the plane in which the workplane will be done
     :type plane: a Plane object, or a string in (XY|YZ|XZ|front|back|top|bottom|left|right)
@@ -305,7 +305,7 @@ def split(self: T, *args, **kwargs) -> T:
             )
             rv = [solid.split(*tools)]
 
-        # split using the current wokrplane
+        # split using the current workplane
         else:
 
             # boilerplate for arg/kwarg parsing
@@ -501,7 +501,7 @@ def workplane(
         origin: Optional[VectorLike] = None,
     ) -> T:
         """
-        Creates a new 2-D workplane, located relative to the first face on the stack.
+        Creates a new 2D workplane, located relative to the first face on the stack.
 
         :param offset:  offset for the work plane in the Z direction. Default
         :param invert:  invert the Z direction from that of the face.
@@ -518,7 +518,7 @@ def workplane(
         item on the chain immediately before the vertex must be a
         face.
 
-        The result will be a 2-d working plane
+        The result will be a 2D working plane
         with a new coordinate system set up as follows:
 
            * The centerOption parameter sets how the center is defined.
@@ -1087,7 +1087,7 @@ def rotateAboutCenter(self: T, axisEndPoint: VectorLike, angleDegrees: float) ->
         Future Enhancements:
             * A version of this method that returns a transformed copy, rather than modifying
               the originals
-            * This method doesnt expose a very good interface, because the axis of rotation
+            * This method doesn't expose a very good interface, because the axis of rotation
               could be inconsistent between multiple objects.  This is because the beginning
               of the axis is variable, while the end is fixed. This is fine when operating on
               one object, but is not cool for multiple.
@@ -1212,7 +1212,7 @@ def shell(
 
         :param thickness: a positive float, representing the thickness of the desired shell.
             Negative values shell inwards, positive values shell outwards.
-        :param kind: kind of joints, intersetion or arc (default: arc).
+        :param kind: kind of joints, intersection or arc (default: arc).
         :raises ValueError: if the current stack contains objects that are not faces of a solid
              further up in the chain.
         :returns: a CQ object with the resulting shelled solid selected.
@@ -1531,7 +1531,7 @@ def polarArray(
     def pushPoints(self: T, pntList: Iterable[Union[VectorLike, Location]]) -> T:
         """
         Pushes a list of points onto the stack as vertices.
-        The points are in the 2-d coordinate space of the workplane face
+        The points are in the 2D coordinate space of the workplane face
 
         :param pntList: a list of points to push onto the stack
         :type pntList: list of 2-tuples, in *local* coordinates
@@ -1687,7 +1687,7 @@ def polarLineTo(
         self: T, distance: float, angle: float, forConstruction: bool = False
     ) -> T:
         """
-        Make a line from the current point to the given polar co-ordinates
+        Make a line from the current point to the given polar coordinates
 
         Useful if it is more convenient to specify the end location rather than
         the distance and angle from the current point
@@ -1817,11 +1817,11 @@ def spline(
             where a tangent constraint is specified.
         :param periodic: creation of periodic curves
         :param parameters: the value of the parameter at each interpolation point.
-            (The intepolated curve is represented as a vector-valued function of a
+            (The interpolated curve is represented as a vector-valued function of a
             scalar parameter.)
 
             If periodic == True, then len(parameters) must be
-            len(intepolation points) + 1, otherwise len(parameters) must be equal to
+            len(interpolation points) + 1, otherwise len(parameters) must be equal to
             len(interpolation points).
         :param scale: whether to scale the specified tangent vectors before
             interpolating.
@@ -2356,11 +2356,11 @@ def wire(self: T, forConstruction: bool = False) -> T:
         :param forConstruction: whether the wire should be used to make a solid, or if it is just
             for reference
 
-        This method is primarily of use to plugin developers making utilities for 2-d construction.
-        This method should be called when a user operation implies that 2-d construction is
+        This method is primarily of use to plugin developers making utilities for 2D construction.
+        This method should be called when a user operation implies that 2D construction is
         finished, and we are ready to begin working in 3d.
 
-        SEE '2-d construction concepts' for a more detailed explanation of how CadQuery handles
+        SEE '2D construction concepts' for a more detailed explanation of how CadQuery handles
         edges, wires, etc.
 
         Any non edges will still remain.
@@ -2693,11 +2693,11 @@ def polyline(
 
     def close(self: T) -> T:
         """
-        End 2-d construction, and attempt to build a closed wire.
+        End 2D construction, and attempt to build a closed wire.
 
         :return: a CQ object with a completed wire on the stack, if possible.
 
-        After 2-d drafting with methods such as lineTo, threePointArc,
+        After 2D drafting with methods such as lineTo, threePointArc,
         tangentArcPoint and polyline, it is necessary to convert the edges
         produced by these into one or more wires.
 
@@ -2710,7 +2710,7 @@ def close(self: T) -> T:
         endPoint = self._findFromPoint(True)
 
         if self.ctx.firstPoint is None:
-            raise ValueError("Not start point specified - cannot close")
+            raise ValueError("No start point specified - cannot close")
         else:
             startPoint = self.ctx.firstPoint
 
@@ -2767,7 +2767,7 @@ def cutEach(
 
         return self.newObject([s])
 
-    # but parameter list is different so a simple function pointer wont work
+    # but parameter list is different so a simple function pointer won't work
     def cboreHole(
         self: T,
         diameter: float,
@@ -2813,7 +2813,7 @@ def cboreHole(
         # first make the hole
         hole = Solid.makeCylinder(
             diameter / 2.0, depth, center, boreDir
-        )  # local coordianates!
+        )  # local coordinates!
 
         # add the counter bore
         cbore = Solid.makeCylinder(cboreDiameter / 2.0, cboreDepth, Vector(), boreDir)
@@ -2822,7 +2822,7 @@ def cboreHole(
         return self.cutEach(lambda loc: r.moved(loc), True, clean)
 
     # TODO: almost all code duplicated!
-    # but parameter list is different so a simple function pointer wont work
+    # but parameter list is different so a simple function pointer won't work
     def cskHole(
         self: T,
         diameter: float,
@@ -2879,7 +2879,7 @@ def cskHole(
         return self.cutEach(lambda loc: res.moved(loc), True, clean)
 
     # TODO: almost all code duplicated!
-    # but parameter list is different so a simple function pointer wont work
+    # but parameter list is different so a simple function pointer won't work
     def hole(
         self: T, diameter: float, depth: Optional[float] = None, clean: bool = True,
     ) -> T:
@@ -3463,7 +3463,7 @@ def _extrude(
         eDir = self.plane.zDir.multiply(distance)
 
         # one would think that fusing faces into a compound and then extruding would work,
-        # but it doesnt-- the resulting compound appears to look right, ( right number of faces, etc)
+        # but it doesn't-- the resulting compound appears to look right, ( right number of faces, etc)
         # but then cutting it from the main solid fails with BRep_NotDone.
         # the work around is to extrude each and then join the resulting solids, which seems to work
 
@@ -3589,15 +3589,15 @@ def interpPlate(
         maxSegments: int = 9,
     ) -> 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 very ressources intensive depending on the complexity of the shape. In this case set combine=False.
+        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 very resources intensive depending on the complexity of the shape. In this case set combine=False.
 
         :param surf_edges
         :type 1 surf_edges: list of [x,y,z] float ordered coordinates
         :type 2 surf_edges: list of ordered or unordered CadQuery wires
         :param surf_pts = [] (uses only edges if [])
         :type surf_pts: list of [x,y,z] float coordinates
         :param thickness = 0 (returns 2D surface if 0)
-        :type thickness: float (may be negative or positive depending on thicknening direction)
+        :type thickness: float (may be negative or positive depending on thickening direction)
         :param combine: should the results be combined with other solids on the stack
             (and each other)?
         :type combine: true to combine shapes, false otherwise.
@@ -3608,8 +3608,8 @@ def interpPlate(
         :type: NbPtsOnCur Integer >= 15
         :param NbIter = 2 (OCCT default)
         :type: NbIterInteger >= 2
-        :param Anisotropie = False (OCCT default)
-        :type Anisotropie: Boolean
+        :param anisotropy = False (OCCT default)
+        :type anisotropy: Boolean
         :param: Tol2d = 0.00001 (OCCT default)
         :type Tol2d: float > 0
         :param Tol3d = 0.0001 (OCCT default)
@@ -3800,6 +3800,69 @@ def sphere(
         else:
             return self.union(spheres, clean=clean)
 
+    def cylinder(
+        self: T,
+        height: float,
+        radius: float,
+        direct: Vector = Vector(0, 0, 1),
+        angle: float = 360,
+        centered: Union[bool, Tuple[bool, bool, bool]] = True,
+        combine: bool = True,
+        clean: bool = True,
+    ) -> T:
+        """
+        Returns a cylinder with the specified radius and height for each point on the stack
+
+        :param height: The height of the cylinder
+        :type height: float > 0
+        :param radius: The radius of the cylinder
+        :type radius: float > 0
+        :param direct: The direction axis for the creation of the cylinder
+        :type direct: A three-tuple
+        :param angle: The angle to sweep the cylinder arc through
+        :type angle: float > 0
+        :param centered: If True, the cylinder will be centered around the reference point. If False,
+            the corner of a bounding box around the cylinder will be on the reference point and it
+            will extend in the positive x, y and z directions. Can also use a 3-tuple to specify
+            centering along each axis.
+        :param combine: Whether the results should be combined with other solids on the stack
+            (and each other)
+        :type combine: true to combine shapes, false otherwise
+        :param clean: call :py:meth:`clean` afterwards to have a clean shape
+        :return: A cylinder object for each point on the stack
+
+        One cylinder is created for each item on the current stack. If no items are on the stack, one
+        cylinder is created using the current workplane center.
+
+        If combine is true, the result will be a single object on the stack. If a solid was found
+        in the chain, the result is that solid with all cylinders produced fused onto it otherwise,
+        the result is the combination of all the produced cylinders.
+
+        If combine is false, the result will be a list of the cylinders produced.
+        """
+
+        if isinstance(centered, bool):
+            centered = (centered, centered, centered)
+
+        offset = Vector()
+        if not centered[0]:
+            offset += Vector(radius, 0, 0)
+        if not centered[1]:
+            offset += Vector(0, radius, 0)
+        if centered[2]:
+            offset += Vector(0, 0, -height / 2)
+
+        s = Solid.makeCylinder(radius, height, offset, direct, angle)
+
+        # We want a cylinder for each point on the workplane
+        cylinders = self.eachpoint(lambda loc: s.moved(loc), True)
+
+        # If we don't need to combine everything, just return the created cylinders
+        if not combine:
+            return cylinders
+        else:
+            return self.union(cylinders, clean=clean)
+
     def wedge(
         self: T,
         dx: float,

cadquery/cqgi.py

@@ -153,7 +153,7 @@ def __init__(self):
 class BuildResult(object):
     """
     The result of executing a CadQuery script.
-    The success property contains whether the exeuction was successful.
+    The success property contains whether the execution was successful.
 
     If successful, the results property contains a list of all results,
     and the first_result property contains the first result.

cadquery/occ_impl/exporters/dxf.py

@@ -76,16 +76,23 @@ def _dxf_spline(e: Edge, msp: ezdxf.layouts.Modelspace, plane: Plane):
         curve, adaptor.FirstParameter(), adaptor.LastParameter(), CURVE_TOLERANCE
     )
 
+    # need to apply the transform on the geometry level
+    spline.Transform(plane.fG.wrapped.Trsf())
+
     order = spline.Degree() + 1
     knots = list(spline.KnotSequence())
     poles = [(p.X(), p.Y(), p.Z()) for p in spline.Poles()]
+    weights = (
+        [spline.Weight(i) for i in range(1, spline.NbPoles() + 1)]
+        if spline.IsRational()
+        else None
+    )
 
-    weights = list(spline.Weights()) if spline.IsRational() else None
+    if spline.IsPeriodic():
+        pad = spline.NbKnots() - spline.LastUKnotIndex()
+        poles += poles[:pad]
 
-    if spline.IsClosed():
-        dxf_spline = ezdxf.math.BSplineClosed(poles, order, knots, weights)
-    else:
-        dxf_spline = ezdxf.math.BSpline(poles, order, knots, weights)
+    dxf_spline = ezdxf.math.BSpline(poles, order, knots, weights)
 
     msp.add_spline().apply_construction_tool(dxf_spline)