You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cadquery/cq.py
+14-12Lines changed: 14 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -2405,7 +2405,7 @@ def each(
2405
2405
:param callBackFunction: the function to call for each item on the current stack.
2406
2406
:param useLocalCoordinates: should values be converted from local coordinates first?
2407
2407
:type useLocalCoordinates: boolean
2408
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2408
+
: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.
2409
2409
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
2410
2410
2411
2411
@@ -2462,7 +2462,7 @@ def eachpoint(
2462
2462
2463
2463
:param useLocalCoordinates: should points be in local or global coordinates
2464
2464
:type useLocalCoordinates: boolean
2465
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2465
+
: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.
2466
2466
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
2467
2467
2468
2468
@@ -2976,7 +2976,7 @@ def twistExtrude(
2976
2976
2977
2977
:param distance: the distance to extrude normal to the workplane
2978
2978
:param angle: angle (in degrees) to rotate through the extrusion
2979
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2979
+
: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.
2980
2980
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
2981
2981
:return: a CQ object with the resulting solid selected.
2982
2982
"""
@@ -3014,20 +3014,17 @@ def extrude(
3014
3014
"""
3015
3015
Use all un-extruded wires in the parent chain to create a prismatic solid.
3016
3016
3017
-
:param until: the distance to extrude, normal to the workplane plane
3018
3017
:param until: The distance to extrude, normal to the workplane plane. When a float is
3019
3018
passed, the extrusion extends this far and a negative value is in the opposite direction
3020
3019
to the normal of the plane. The string "next" extrudes until the next face orthogonal to
3021
3020
the wire normal. "last" extrudes to the last face. If a object of type Face is passed then
3022
-
the extrusion will extend until this face.
3023
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
3021
+
the extrusion will extend until this face. **Note that the Workplane must contain a Solid for extruding to a given face.**
3022
+
: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.
3024
3023
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
3025
3024
:param boolean both: extrude in both directions symmetrically
3026
3025
:param float taper: angle for optional tapered extrusion
3027
3026
:return: a CQ object with the resulting solid selected.
3028
3027
3029
-
extrude always *adds* material to a part.
3030
-
3031
3028
The returned object is always a CQ object, and depends on whether combine is True, and
3032
3029
whether a context solid is already defined:
3033
3030
@@ -3085,8 +3082,7 @@ def revolve(
3085
3082
:type axisStart: tuple, a two tuple
3086
3083
:param axisEnd: the end point of the axis of rotation
3087
3084
:type axisEnd: tuple, a two tuple
3088
-
:param combine: True to combine the resulting solid with parent solids if found.
3089
-
:type combine: boolean or string, defines how the result of the operation is combined with the base solid
3085
+
: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.
3090
3086
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
3091
3087
:return: a CQ object with the resulting solid selected.
3092
3088
@@ -3151,7 +3147,7 @@ def sweep(
3151
3147
3152
3148
:param path: A wire along which the pending wires will be swept
3153
3149
:param boolean multiSection: False to create multiple swept from wires on the chain along path. True to create only one solid swept along path with shape following the list of wires on the chain
3154
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
3150
+
: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.
3155
3151
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
3156
3152
:param transition: handling of profile orientation at C1 path discontinuities. Possible values are {'transformed','round', 'right'} (default: 'right').
3157
3153
:param normal: optional fixed normal for extrusion
@@ -3521,7 +3517,13 @@ def loft(
3521
3517
) ->T:
3522
3518
"""
3523
3519
Make a lofted solid, through the set of wires.
3520
+
3521
+
:param boolean ruled: When set to `True` connects each section linearly and without continuity
3522
+
: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.
3523
+
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
3524
+
3524
3525
:return: a Workplane object containing the created loft
3526
+
3525
3527
"""
3526
3528
3527
3529
ifself.ctx.pendingWires:
@@ -4160,7 +4162,7 @@ def text(
4160
4162
:param distance: the distance to extrude or cut, normal to the workplane plane
4161
4163
:type distance: float, negative means opposite the normal direction
4162
4164
:param cut: True to cut the resulting solid from the parent solids if found
4163
-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
4165
+
: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.
4164
4166
:param clean: call :py:meth:`clean` afterwards to have a clean shape
0 commit comments