Skip to content

Commit a03648c

Browse files
adam-urbanczykadam-urbanczyk
authored
Change to ProjectedOrigin (#532)
* Change to ProjectedOrigin * Fix most tests * Fix remaining tests * Fix example building * Update selector docs * Fix the bottle+formatting changes * Renamed centered to xycentered * Ignore utils for coverage calculation
1 parent 52ae385 commit a03648c

File tree

7 files changed

+48
-30
lines changed

7 files changed

+48
-30
lines changed

‎.coveragerc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[run]
22
branch = True
3+
omit = cadquery/utils.py
34

45
[report]
56
exclude_lines =

‎cadquery/cq.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -413,14 +413,13 @@ def toOCC(self) -> Any:
413413

414414
return self.val().wrapped
415415

416-
@deprecate_kwarg("centerOption", "ProjectedOrigin")
417416
def workplane(
418417
self,
419418
offset: float = 0.0,
420419
invert: bool = False,
421420
centerOption: Literal[
422421
"CenterOfMass", "ProjectedOrigin", "CenterOfBoundBox"
423-
] = "CenterOfMass",
422+
] = "ProjectedOrigin",
424423
origin: Optional[VectorLike] = None,
425424
) -> "Workplane":
426425
"""

‎doc/examples.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ how deep the part is
436436
.. cadquery::
437437

438438
result = cq.Workplane("front").box(3,2, 0.5) #make a basic prism
439-
result = result.faces(">Z").vertices("<XY").workplane() #select the lower left vertex and make a workplane
439+
result = result.faces(">Z").vertices("<XY").workplane(centerOption="CenterOfMass") #select the lower left vertex and make a workplane
440440
result = result.circle(1.0).cutThruAll() #cut the corner out
441441

442442
.. topic:: Api References
@@ -776,7 +776,7 @@ ones at 13 lines, but that's very short compared to the pythonOCC version, which
776776
.mirrorX().extrude(30.0,True))
777777

778778
#make the neck
779-
p = p.faces(">Z").workplane().circle(3.0).extrude(2.0,True)
779+
p = p.faces(">Z").workplane(centerOption="CenterOfMass").circle(3.0).extrude(2.0,True)
780780

781781
#make a shell
782782
result = p.faces(">Z").shell(0.3)
@@ -1160,35 +1160,35 @@ Panel With Various Connector Holes
11601160

11611161
h_sep = 60
11621162
for idx in range(4):
1163-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(157,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
1163+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(157,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
11641164

11651165
for idx in range(4):
1166-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(157,-30-idx*h_sep).moveTo(-16.65,0).circle(1.6).moveTo(16.65,0).circle(1.6).moveTo(-10.1889,-5.7).threePointArc((-12.59306,-4.70416),(-13.5889,-2.3)).lineTo(-14.4,2.3).threePointArc((-13.40416,4.70416),(-11,5.7)).lineTo(11,5.7).threePointArc((13.40416,4.70416),(14.4,2.3)).lineTo(13.5889,-2.3).threePointArc((12.59306,-4.70416),(10.1889,-5.7)).close().cutThruAll()
1166+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(157,-30-idx*h_sep).moveTo(-16.65,0).circle(1.6).moveTo(16.65,0).circle(1.6).moveTo(-10.1889,-5.7).threePointArc((-12.59306,-4.70416),(-13.5889,-2.3)).lineTo(-14.4,2.3).threePointArc((-13.40416,4.70416),(-11,5.7)).lineTo(11,5.7).threePointArc((13.40416,4.70416),(14.4,2.3)).lineTo(13.5889,-2.3).threePointArc((12.59306,-4.70416),(10.1889,-5.7)).close().cutThruAll()
11671167

11681168
h_sep4DB9 = 30
11691169
for idx in range(8):
1170-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(91,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
1170+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(91,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
11711171

11721172
for idx in range(4):
1173-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(25,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
1173+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(25,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
11741174

11751175
for idx in range(4):
1176-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(25,-30-idx*h_sep).moveTo(-16.65,0).circle(1.6).moveTo(16.65,0).circle(1.6).moveTo(-10.1889,-5.7).threePointArc((-12.59306,-4.70416),(-13.5889,-2.3)).lineTo(-14.4,2.3).threePointArc((-13.40416,4.70416),(-11,5.7)).lineTo(11,5.7).threePointArc((13.40416,4.70416),(14.4,2.3)).lineTo(13.5889,-2.3).threePointArc((12.59306,-4.70416),(10.1889,-5.7)).close().cutThruAll()
1176+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(25,-30-idx*h_sep).moveTo(-16.65,0).circle(1.6).moveTo(16.65,0).circle(1.6).moveTo(-10.1889,-5.7).threePointArc((-12.59306,-4.70416),(-13.5889,-2.3)).lineTo(-14.4,2.3).threePointArc((-13.40416,4.70416),(-11,5.7)).lineTo(11,5.7).threePointArc((13.40416,4.70416),(14.4,2.3)).lineTo(13.5889,-2.3).threePointArc((12.59306,-4.70416),(10.1889,-5.7)).close().cutThruAll()
11771177

11781178
for idx in range(8):
1179-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(-41,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
1179+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(-41,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
11801180

11811181
for idx in range(4):
1182-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(-107,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
1182+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(-107,210-idx*h_sep).moveTo(-23.5,0).circle(1.6).moveTo(23.5,0).circle(1.6).moveTo(-17.038896,-5.7).threePointArc((-19.44306,-4.70416),(-20.438896,-2.3)).lineTo(-21.25,2.3).threePointArc((-20.25416,4.70416),(-17.85,5.7)).lineTo(17.85,5.7).threePointArc((20.25416,4.70416),(21.25,2.3)).lineTo(20.438896,-2.3).threePointArc((19.44306,-4.70416),(17.038896,-5.7)).close().cutThruAll()
11831183

11841184
for idx in range(4):
1185-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(-107,-30-idx*h_sep).circle(14).rect(24.7487,24.7487, forConstruction=True).vertices().hole(3.2).cutThruAll()
1185+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(-107,-30-idx*h_sep).circle(14).rect(24.7487,24.7487, forConstruction=True).vertices().hole(3.2).cutThruAll()
11861186

11871187
for idx in range(8):
1188-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(-173,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
1188+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(-173,225-idx*h_sep4DB9).moveTo(-12.5,0).circle(1.6).moveTo(12.5,0).circle(1.6).moveTo(-6.038896,-5.7).threePointArc((-8.44306,-4.70416),(-9.438896,-2.3)).lineTo(-10.25,2.3).threePointArc((-9.25416,4.70416),(-6.85,5.7)).lineTo(6.85,5.7).threePointArc((9.25416,4.70416),(10.25,2.3)).lineTo(9.438896,-2.3).threePointArc((8.44306,-4.70416),(6.038896,-5.7)).close().cutThruAll()
11891189

11901190
for idx in range(4):
1191-
result = result.workplane(offset=1, centerOption='CenterOfBoundBox').center(-173,-30-idx*h_sep).moveTo(-2.9176,-5.3).threePointArc((-6.05,0),(-2.9176,5.3)).lineTo(2.9176,5.3).threePointArc((6.05,0),(2.9176,-5.3)).close().cutThruAll()
1191+
result = result.workplane(offset=1, centerOption="CenterOfBoundBox").center(-173,-30-idx*h_sep).moveTo(-2.9176,-5.3).threePointArc((-6.05,0),(-2.9176,5.3)).lineTo(2.9176,5.3).threePointArc((6.05,0),(2.9176,-5.3)).close().cutThruAll()
11921192

11931193

11941194
Cycloidal gear

‎doc/selectors.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Selector Selects Selector Class
7272
%Plane Faces of type plane :py:class:`cadquery.TypeSelector` 0..many
7373
>Y Face farthest in the positive y dir :py:class:`cadquery.DirectionMinMaxSelector` 0..many
7474
<Y Face farthest in the negative y dir :py:class:`cadquery.DirectionMinMaxSelector` 0..many
75-
>Y[-2] 2nd Face farthest in the positive y dir :py:class:`cadquery.DirectionMinMaxSelector` 0..many
76-
<Y[0] 1st closest Face in the negative y dir :py:class:`cadquery.DirectionMinMaxSelector` 0..many
75+
>Y[-2] 2nd farthest Face normal to the y dir :py:class:`cadquery.DirectionNthSelector` 0..many
76+
<Y[0] 1st closest Face normal to the y dir :py:class:`cadquery.DirectionNthSelector` 0..many
7777
========= ======================================= ======================================================= ==========================
7878

7979

‎tests/__init__.py‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,15 @@ def makeUnitSquareWire():
2525
)
2626

2727

28-
def makeUnitCube():
29-
return makeCube(1.0)
28+
def makeUnitCube(centered=True):
29+
return makeCube(1.0, centered)
3030

3131

32-
def makeCube(size):
33-
return Solid.makeBox(size, size, size)
32+
def makeCube(size, xycentered=True):
33+
if xycentered:
34+
return Workplane().rect(size, size).extrude(size).val()
35+
else:
36+
return Solid.makeBox(size, size, size)
3437

3538

3639
def toTuple(v):

‎tests/test_cadquery.py‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -941,11 +941,11 @@ def testMultisectionSweep(self):
941941
.workplane(offset=-5)
942942
.moveTo(0, 4)
943943
.circle(1.5)
944-
.workplane(offset=5)
944+
.workplane(offset=5, centerOption="CenterOfMass")
945945
.circle(1.5)
946946
.moveTo(0, -8)
947947
.circle(1.0)
948-
.workplane(offset=-5)
948+
.workplane(offset=-5, centerOption="CenterOfMass")
949949
.circle(1.0)
950950
.sweep(path, multisection=True)
951951
)
@@ -1400,7 +1400,12 @@ def testCutThroughAll(self):
14001400
self.assertEqual(11, t.faces().size())
14011401

14021402
# side hole, thru all
1403-
t = t.faces(">Y").workplane().circle(0.125).cutThruAll()
1403+
t = (
1404+
t.faces(">Y")
1405+
.workplane(centerOption="CenterOfMass")
1406+
.circle(0.125)
1407+
.cutThruAll()
1408+
)
14041409
self.saveModel(t)
14051410
self.assertEqual(13, t.faces().size())
14061411

@@ -1473,12 +1478,22 @@ def testBasicLines(self):
14731478
self.assertEqual(5, r.faces().size())
14741479

14751480
# now add a circle through a side face
1476-
r1 = r.faces("+XY").workplane().circle(0.08).cutThruAll()
1481+
r1 = (
1482+
r.faces("+XY")
1483+
.workplane(centerOption="CenterOfMass")
1484+
.circle(0.08)
1485+
.cutThruAll()
1486+
)
14771487
self.assertEqual(6, r1.faces().size())
14781488
r1.val().exportStep(os.path.join(OUTDIR, "testBasicLinesXY.STEP"))
14791489

14801490
# now add a circle through a top
1481-
r2 = r1.faces("+Z").workplane().circle(0.08).cutThruAll()
1491+
r2 = (
1492+
r1.faces("+Z")
1493+
.workplane(centerOption="CenterOfMass")
1494+
.circle(0.08)
1495+
.cutThruAll()
1496+
)
14821497
self.assertEqual(9, r2.faces().size())
14831498
r2.val().exportStep(os.path.join(OUTDIR, "testBasicLinesZ.STEP"))
14841499

@@ -2246,7 +2261,7 @@ def testClean(self):
22462261
.rect(10, 5)
22472262
.cutBlind(-5)
22482263
.faces(">Z")
2249-
.workplane()
2264+
.workplane(centerOption="CenterOfMass")
22502265
.center(0, 2.5)
22512266
.rect(5, 5)
22522267
.cutThruAll()

‎tests/test_selectors.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def testCompounds(self):
7676
self.assertEqual(0, c.solids().size())
7777

7878
def testSolid(self):
79-
c = CQ(makeUnitCube())
79+
c = CQ(makeUnitCube(False))
8080
# make sure all the counts are right for a cube
8181
self.assertEqual(1, c.solids().size())
8282
self.assertEqual(6, c.faces().size())
@@ -267,7 +267,7 @@ def testNthDistance(self):
267267
)
268268

269269
def testNearestTo(self):
270-
c = CQ(makeUnitCube())
270+
c = CQ(makeUnitCube(centered=False))
271271

272272
# nearest vertex to origin is (0,0,0)
273273
t = (0.1, 0.1, 0.1)
@@ -286,7 +286,7 @@ def testNearestTo(self):
286286
self.assertEqual(1, len(s))
287287

288288
def testBox(self):
289-
c = CQ(makeUnitCube())
289+
c = CQ(makeUnitCube(centered=False))
290290

291291
# test vertice selection
292292
test_data_vertices = [
@@ -561,7 +561,7 @@ def testFaceCount(self):
561561

562562
def testVertexFilter(self):
563563
"test selecting vertices on a face"
564-
c = CQ(makeUnitCube())
564+
c = CQ(makeUnitCube(centered=False))
565565

566566
# TODO: filters work ok, but they are in global coordinates which sux. it would be nice
567567
# if they were available in coordinates local to the selected face

0 commit comments

Comments
 (0)