-
Notifications
You must be signed in to change notification settings - Fork 191
Expand file tree
/
Copy pathutils.py
More file actions
executable file
·1435 lines (1154 loc) · 45.1 KB
/
utils.py
File metadata and controls
executable file
·1435 lines (1154 loc) · 45.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /usr/bin/env python
from itertools import zip_longest
from math import ceil, sqrt, atan2, degrees
from solid import union, cube, translate, rotate, square, circle, polygon
from solid import difference, intersection, multmatrix, cylinder, color
from solid import text, linear_extrude, resize
from solid import run_euclid_patch
from solid import OpenSCADObject, Vec3
from euclid3 import Point2, Point3, Vector2, Vector3, Line2, Line3
from euclid3 import LineSegment2, LineSegment3, Matrix4
from textwrap import indent
run_euclid_patch()
# ==========
# = TYPING =
# ==========
from typing import Any, Union, Sequence, Optional, Callable, cast # noqa
Point23 = Union[Point2, Point3]
Vector23 = Union[Vector2, Vector3]
PointVec23 = Union[Point2, Point3, Vector2, Vector3]
Line23 = Union[Line2, Line3]
LineSegment23 = Union[LineSegment2, LineSegment3]
Tuple2 = tuple[float, float]
Tuple3 = tuple[float, float, float]
EucOrTuple = Union[Point3, Vector3, Tuple2, Tuple3]
DirectionLR = float # LEFT or RIGHT in 2D
# =============
# = CONSTANTS =
# =============
EPSILON = 0.01
RIGHT, TOP, LEFT, BOTTOM = range(4)
X, Y, Z = (0, 1, 2)
ORIGIN = (0, 0, 0)
UP_VEC = (0, 0, 1)
RIGHT_VEC = (1, 0, 0)
FORWARD_VEC = (0, 1, 0)
DOWN_VEC = (0, 0, -1)
LEFT_VEC = (-1, 0, 0)
BACK_VEC = (0, -1, 0)
# ==========
# = Colors =
# ==========
# Deprecated, but kept for backwards compatibility . Note that OpenSCAD natively
# accepts SVG Color names, as seen here: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
# From Hans Häggström's materials.scad in MCAD: https://github.com/openscad/MCAD
Red = (1, 0, 0)
Green = (0, 1, 0)
Blue = (0, 0, 1)
Cyan = (0, 1, 1)
Magenta = (1, 0, 1)
Yellow = (1, 1, 0)
Black = (0, 0, 0)
White = (1, 1, 1)
Oak = (0.65, 0.50, 0.40)
Pine = (0.85, 0.70, 0.45)
Birch = (0.90, 0.80, 0.60)
FiberBoard = (0.70, 0.67, 0.60)
BlackPaint = (0.20, 0.20, 0.20)
Iron = (0.36, 0.33, 0.33)
Steel = (0.65, 0.67, 0.72)
Stainless = (0.45, 0.43, 0.50)
Aluminum = (0.77, 0.77, 0.80)
Brass = (0.88, 0.78, 0.50)
Transparent = (1, 1, 1, 0.2)
# ==============
# = Grid Plane =
# ==============
def grid_plane(
grid_unit: int = 12, count: int = 10, line_weight: float = 0.1, plane: str = "xz"
) -> OpenSCADObject:
# Draws a grid of thin lines in the specified plane. Helpful for
# reference during debugging.
ls = count * grid_unit
t = union()
t.set_modifier("background")
for i in range(int(-count / 2), int(count / 2 + 1)):
if "xz" in plane:
# xz-plane
h = up(i * grid_unit)(cube([ls, line_weight, line_weight], center=True))
v = right(i * grid_unit)(cube([line_weight, line_weight, ls], center=True))
t.add([h, v])
# xy plane
if "xy" in plane:
h = forward(i * grid_unit)(
cube([ls, line_weight, line_weight], center=True)
)
v = right(i * grid_unit)(cube([line_weight, ls, line_weight], center=True))
t.add([h, v])
# yz plane
if "yz" in plane:
h = up(i * grid_unit)(cube([line_weight, ls, line_weight], center=True))
v = forward(i * grid_unit)(
cube([line_weight, line_weight, ls], center=True)
)
t.add([h, v])
return t
def distribute_in_grid(
objects: Sequence[OpenSCADObject],
max_bounding_box: tuple[float, float],
rows_and_cols: tuple[int, int] = None,
) -> OpenSCADObject:
# Translate each object in objects in a grid with each cell of size
# max_bounding_box.
#
# objects: array of SCAD objects
# max_bounding_box: 2-tuple with x & y dimensions of grid cells.
# if a single number is passed, x & y will both use it
# rows_and_cols: 2-tuple of how many rows and columns to use. If
# not supplied, rows_and_cols will be the smallest square that
# can contain all members of objects (e.g, if len(objects) == 80,
# rows_and_cols will default to (9,9))
# Distributes object in a grid in the xy plane
# with objects spaced max_bounding_box apart
if isinstance(max_bounding_box, (list, tuple)):
x_trans, y_trans = max_bounding_box[0:2]
elif isinstance(max_bounding_box, (int, float, complex)):
x_trans = y_trans = max_bounding_box
else:
pass # TypeError
ret = []
if rows_and_cols:
grid_h, grid_w = rows_and_cols
else:
grid_w = grid_h = int(ceil(sqrt(len(objects))))
objs_placed = 0
for y in range(grid_h):
for x in range(grid_w):
if objs_placed < len(objects):
ret.append(
translate((x * x_trans, y * y_trans, 0))(objects[objs_placed])
)
objs_placed += 1
else:
break
return union()(*ret)
# ==============
# = Directions =
# ==============
def up(z: float) -> OpenSCADObject:
return translate((0, 0, z))
def down(z: float) -> OpenSCADObject:
return translate((0, 0, -z))
def right(x: float) -> OpenSCADObject:
return translate((x, 0, 0))
def left(x: float) -> OpenSCADObject:
return translate((-x, 0, 0))
def forward(y: float) -> OpenSCADObject:
return translate((0, y, 0))
def back(y: float) -> OpenSCADObject:
return translate((0, -y, 0))
# ===========================
# = Box-alignment rotations =
# ===========================
def rot_z_to_up(obj: OpenSCADObject) -> OpenSCADObject:
# NOTE: Null op
return rotate(a=0, v=FORWARD_VEC)(obj)
def rot_z_to_down(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=180, v=FORWARD_VEC)(obj)
def rot_z_to_right(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=90, v=FORWARD_VEC)(obj)
def rot_z_to_left(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=-90, v=FORWARD_VEC)(obj)
def rot_z_to_forward(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=-90, v=RIGHT_VEC)(obj)
def rot_z_to_back(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=90, v=RIGHT_VEC)(obj)
# ================================
# = Box-aligment and translation =
# ================================
def box_align(
obj: OpenSCADObject,
direction_func: Callable[[float], OpenSCADObject] = up,
distance: float = 0,
) -> OpenSCADObject:
# Given a box side (up, left, etc) and a distance,
# rotate obj (assumed to be facing up) in the
# correct direction and move it distance in that
# direction
trans_and_rot = {
up: rot_z_to_up, # Null
down: rot_z_to_down,
right: rot_z_to_right,
left: rot_z_to_left,
forward: rot_z_to_forward,
back: rot_z_to_back,
}
assert direction_func in trans_and_rot
rot = trans_and_rot[direction_func]
return direction_func(distance)(rot(obj))
# =======================
# = 90-degree Rotations =
# =======================
def rot_z_to_x(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=90, v=FORWARD_VEC)(obj)
def rot_z_to_neg_x(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=-90, v=FORWARD_VEC)(obj)
def rot_z_to_neg_y(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=90, v=RIGHT_VEC)(obj)
def rot_z_to_y(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=-90, v=RIGHT_VEC)(obj)
def rot_x_to_y(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=90, v=UP_VEC)(obj)
def rot_x_to_neg_y(obj: OpenSCADObject) -> OpenSCADObject:
return rotate(a=-90, v=UP_VEC)(obj)
# =======
# = Arc =
# =======
def arc(
rad: float, start_degrees: float, end_degrees: float, segments: int = None
) -> OpenSCADObject:
# Note: the circle that this arc is drawn from gets segments,
# not the arc itself. That means a quarter-circle arc will
# have segments/4 segments.
bottom_half_square = back(rad)(square([3 * rad, 2 * rad], center=True))
top_half_square = forward(rad)(square([3 * rad, 2 * rad], center=True))
start_shape = circle(rad, segments=segments)
if abs((end_degrees - start_degrees) % 360) <= 180:
end_angle = end_degrees - 180
ret = difference()(
start_shape,
rotate(a=start_degrees)(bottom_half_square.copy()),
rotate(a=end_angle)(bottom_half_square.copy()),
)
else:
ret = intersection()(
start_shape,
union()(
rotate(a=start_degrees)(top_half_square.copy()),
rotate(a=end_degrees)(bottom_half_square.copy()),
),
)
return ret
def arc_inverted(
rad: float, start_degrees: float, end_degrees: float, segments: int = None
) -> OpenSCADObject:
# Return the segment of an arc *outside* the circle of radius rad,
# bounded by two tangents to the circle. This is the shape
# needed for fillets.
# Note: the circle that this arc is drawn from gets segments,
# not the arc itself. That means a quarter-circle arc will
# have segments/4 segments.
# Leave the portion of a circumscribed square of sides
# 2*rad that is NOT in the arc behind. This is most useful for 90-degree
# segments, since it's what you'll add to create fillets and take away
# to create rounds.
# NOTE: an inverted arc is only valid for end_degrees-start_degrees <= 180.
# If this isn't true, end_degrees and start_degrees will be swapped so
# that an acute angle can be found. end_degrees-start_degrees == 180
# will yield a long rectangle of width 2*radius, since the tangent lines
# will be parallel and never meet.
# Fix start/end degrees as needed; find a way to make an acute angle
if end_degrees < start_degrees:
end_degrees += 360
if end_degrees - start_degrees >= 180:
start_degrees, end_degrees = end_degrees, start_degrees
# We want the area bounded by:
# -- the circle from start_degrees to end_degrees
# -- line tangent to the circle at start_degrees
# -- line tangent to the circle at end_degrees
# Note that this shape is only valid if end_degrees - start_degrees < 180,
# since if the two angles differ by more than 180 degrees,
# the tangent lines don't converge
if end_degrees - start_degrees == 180:
raise ValueError(
"Unable to draw inverted arc over 180 or more "
"degrees. start_degrees: %s end_degrees: %s" % (start_degrees, end_degrees)
)
wide = 1000
high = 1000
top_half_square = translate((-(wide - rad), 0, 0))(
square([wide, high], center=False)
)
bottom_half_square = translate((-(wide - rad), -high, 0))(
square([wide, high], center=False)
)
a = rotate(start_degrees)(top_half_square)
b = rotate(end_degrees)(bottom_half_square)
ret = (a * b) - circle(rad, segments=segments)
return ret
# TODO: arc_to that creates an arc from point to another point.
# This is useful for making paths. See the SVG path command:
# See: http://www.w3.org/TR/SVG/implnote.html#ArcImplementationNotes
# ======================
# = Bounding Box Class =
# ======================
class BoundingBox(object):
# A basic Bounding Box representation to enable some more introspection about
# objects. For instance, a BB will let us say "put this new object on top of
# that old one". Bounding Boxes *can't* be relied on for boolean operations
# without compiling in OpenSCAD, so they're limited, but good for some purposes.
# Be careful to understand what things this BB implementation can and
# can't do -ETJ 15 Oct 2013
# Basically you can use a BoundingBox to describe the extents of an object
# the moment it's created, but once you perform any CSG operation on it, it's
# more or less useless.
def __init__(self, size: list[float], loc: list[float] = None):
loc = loc if loc else [0, 0, 0]
# self.w, self.h, self.d = size
# self.x, self.y, self.z = loc
self.set_size(size)
self.set_position(loc)
def size(self) -> list[float]:
return [self.w, self.h, self.d]
def position(self) -> list[float]:
return [self.x, self.y, self.z]
def set_position(self, position: Sequence[float]):
self.x, self.y, self.z = position
def set_size(self, size: Sequence[float]):
self.w, self.h, self.d = size
def split_planar(
self,
cutting_plane_normal: Vec3 = RIGHT_VEC,
cut_proportion: float = 0.5,
add_wall_thickness: float = 0,
) -> list["BoundingBox"]:
cpd = {
RIGHT_VEC: 0,
LEFT_VEC: 0,
FORWARD_VEC: 1,
BACK_VEC: 1,
UP_VEC: 2,
DOWN_VEC: 2,
}
cutting_plane = cpd.get(cutting_plane_normal, 2)
# Figure what the cutting plane offset should be
dim_center = self.position()[cutting_plane]
dim = self.size()[cutting_plane]
dim_min = dim_center - dim / 2
# dim_max = dim_center + dim / 2
# cut_point = (cut_proportion) * dim_min + (1 - cut_proportion) * dim_max
# Now create bounding boxes with the appropriate sizes
part_bbs = []
a_sum = 0.0
for i, part in enumerate([cut_proportion, (1 - cut_proportion)]):
part_size = self.size()
part_size[cutting_plane] = part_size[cutting_plane] * part
part_loc = self.position()
part_loc[cutting_plane] = dim_min + a_sum + dim * (part / 2)
# If extra walls are requested around the slices, add them here
if add_wall_thickness != 0:
# Expand the walls as requested
for j in [X, Y, Z]:
part_size[j] += 2 * add_wall_thickness
# Don't expand in the direction of the cutting_plane, only away
# from it
part_size[cutting_plane] -= add_wall_thickness
# add +/- add_wall_thickness/2 to the location in the
# slicing dimension so we stay at the center of the piece
loc_offset = -add_wall_thickness / 2 + i * add_wall_thickness
part_loc[cutting_plane] += loc_offset
part_bbs.append(BoundingBox(part_size, part_loc))
a_sum += part * dim
return part_bbs
def cube(self, larger: bool = False) -> OpenSCADObject:
c_size = self.size() if not larger else [s + 2 * EPSILON for s in self.size()]
c = translate(self.position())(cube(c_size, center=True))
return c
# ===================
# = Model Splitting =
# ===================
def split_body_planar(
obj: OpenSCADObject,
obj_bb: BoundingBox,
cutting_plane_normal: Vec3 = UP_VEC,
cut_proportion: float = 0.5,
dowel_holes: bool = False,
dowel_rad: float = 4.5,
hole_depth: float = 15,
add_wall_thickness=0,
) -> tuple[OpenSCADObject, BoundingBox, OpenSCADObject, BoundingBox]:
# Split obj along the specified plane, returning two pieces and
# general bounding boxes for each.
# Note that the bounding boxes are NOT accurate to the sections,
# they just indicate which portion of the original BB is in each
# section. Given the limits of OpenSCAD, this is the best we can do
# -ETJ 17 Oct 2013
# Optionally, leave holes in both bodies to allow the pieces to be put
# back together with short dowels.
# Find the splitting bounding boxes
part_bbs = obj_bb.split_planar(
cutting_plane_normal, cut_proportion, add_wall_thickness=add_wall_thickness
)
# And intersect the bounding boxes with the object itself
slices = [obj * part_bb.cube() for part_bb in part_bbs]
# Make holes for dowels if requested.
# In case the bodies need to be aligned properly, make two holes,
# separated by one dowel-width
if dowel_holes:
cpd = {
RIGHT_VEC: 0,
LEFT_VEC: 0,
FORWARD_VEC: 1,
BACK_VEC: 1,
UP_VEC: 2,
DOWN_VEC: 2,
}
cutting_plane = cpd.get(cutting_plane_normal, 2)
dowel = cylinder(r=dowel_rad, h=hole_depth * 2, center=True)
# rotate dowels to correct axis
if cutting_plane != 2:
rot_vec = RIGHT_VEC if cutting_plane == 1 else FORWARD_VEC
dowel = rotate(a=90, v=rot_vec)(dowel)
cut_point = (
part_bbs[0].position()[cutting_plane]
+ part_bbs[0].size()[cutting_plane] / 2
)
# Move dowels away from center of face by 2*dowel_rad in each
# appropriate direction
dowel_trans_a = part_bbs[0].position()
dowel_trans_a[cutting_plane] = cut_point
separation_index = {0: 1, 1: 2, 2: 0}[cutting_plane]
dowel_trans_a[separation_index] -= 2 * dowel_rad
dowel_trans_b = dowel_trans_a[:]
dowel_trans_b[separation_index] += 4 * dowel_rad
dowel_a = translate(dowel_trans_a)(dowel)
dowel_b = translate(dowel_trans_b)(dowel)
dowels = dowel_a + dowel_b
# subtract dowels from each slice
slices = [s - dowels for s in slices]
slices_and_bbs = (slices[0], part_bbs[0], slices[1], part_bbs[1])
return slices_and_bbs
def section_cut_xz(body: OpenSCADObject, y_cut_point: float = 0) -> OpenSCADObject:
big_w = 10000
d = 2
c = forward(d / 2 + y_cut_point)(cube([big_w, d, big_w], center=True))
return c * body
# =====================
# = Bill of Materials =
# =====================
# Any part defined in a method can be automatically counted using the
# `@bom_part()` decorator. After all parts have been created, call
# `bill_of_materials(<SCAD_OBJ>)`
# to generate a report. See `examples/bom_scad.py` for usage
#
# Additional columns can be added (such as leftover material or URL to part)
# by calling `set_bom_headers()` with a series of string arguments.
#
# Calling `bom_part()` with additional, non-keyworded arguments will
# populate the new columns in order of their addition via bom_headers, or
# keyworded arguments can be used in any order.
g_bom_headers: list[str] = []
def set_bom_headers(*args):
global g_bom_headers
g_bom_headers += args
def bom_part(
description: str = "",
per_unit_price: float = None,
currency: str = "US$",
*args,
**kwargs,
) -> Callable:
def wrap(f):
name = description if description else f.__name__
elements = {
"name": name,
"Count": 0,
"currency": currency,
"Unit Price": per_unit_price,
}
# This update also adds empty key value pairs to prevent key exceptions.
elements.update(dict(zip_longest(g_bom_headers, args, fillvalue="")))
elements.update(kwargs)
def wrapped_f(*wargs, **wkwargs):
scad_obj = f(*wargs, **wkwargs)
scad_obj.add_trait("BOM", elements)
return scad_obj
return wrapped_f
return wrap
def bill_of_materials(root_obj: OpenSCADObject, csv: bool = False) -> str:
traits_dicts = _traits_bom_dicts(root_obj)
# Build a single dictionary from the ones stored on each child object
# (This is an adaptation of an earlier version, and probably not the most
# direct way to accomplish this)
all_bom_traits = {}
for traits_dict in traits_dicts:
name = traits_dict["name"]
if name in all_bom_traits:
all_bom_traits[name]["Count"] += 1
else:
all_bom_traits[name] = traits_dict
all_bom_traits[name]["Count"] = 1
bom = _make_bom(all_bom_traits, csv)
return bom
def _traits_bom_dicts(root_obj: OpenSCADObject) -> list[dict[str, float]]:
all_child_traits = [_traits_bom_dicts(c) for c in root_obj.children]
child_traits = [item for subl in all_child_traits for item in subl if item]
bom_trait = root_obj.get_trait("BOM")
if bom_trait:
child_traits.append(bom_trait)
return child_traits
def _make_bom(
bom_parts_dict: dict[str, float],
csv: bool = False,
) -> str:
field_names = ["Description", "Count", "Unit Price", "Total Price"]
field_names += g_bom_headers
rows = []
all_costs: dict[str, float] = {}
for desc, elements in bom_parts_dict.items():
row = []
count = elements["Count"]
currency = elements["currency"]
price = elements["Unit Price"]
if count > 0:
if price:
total = price * count
if currency not in all_costs:
all_costs[currency] = 0
all_costs[currency] += total
unit_price = _currency_str(price, currency)
total_price = _currency_str(total, currency)
else:
unit_price = total_price = ""
row = [desc, count, unit_price, total_price]
for key in g_bom_headers:
value = elements[key]
row.append(value)
rows.append(row)
# Add total costs if we have values to add
if len(all_costs) > 0:
empty_row = [""] * len(field_names)
rows.append(empty_row)
for currency, cost in all_costs.items():
row = empty_row[:]
row[0] = "Total Cost, {currency:>4}".format(**vars())
row[3] = "{currency:>4} {cost:.2f}".format(**vars())
rows.append(row)
res = _table_string(field_names, rows, csv)
return res
def _currency_str(value: float, currency: str = "$") -> str:
return "{currency:>4} {value:.2f}".format(**vars())
def _table_string(
field_names: Sequence[str], rows: Sequence[Sequence[float]], csv: bool = False
) -> str:
# Output a justified table string using the prettytable module.
# Fall back to Excel-ready tab-separated values if prettytable's not found
# or CSV is requested
if not csv:
try:
import prettytable
table = prettytable.PrettyTable(field_names=field_names)
for row in rows:
table.add_row(row)
res = table.get_string()
except ImportError:
print("Unable to import prettytable module. Outputting in TSV format")
csv = True
if csv:
lines = ["\t".join(field_names)]
for row in rows:
line = "\t".join([str(f) for f in row])
lines.append(line)
res = "\n".join(lines)
return res + "\n"
# ================
# = Bounding Box =
# ================
def bounding_box(points: Sequence[EucOrTuple]) -> tuple[Tuple3, Tuple3]:
all_x = []
all_y = []
all_z = []
for p in points:
all_x.append(p[0])
all_y.append(p[1])
if len(p) > 2:
all_z.append(p[2]) # type:ignore
else:
all_z.append(0)
return ((min(all_x), min(all_y), min(all_z)), (max(all_x), max(all_y), max(all_z)))
# =======================
# = Hardware dimensions =
# =======================
screw_dimensions = {
"m3": {
"nut_thickness": 2.4,
"nut_inner_diam": 5.4,
"nut_outer_diam": 6.1,
"screw_outer_diam": 3.0,
"cap_diam": 5.5,
"cap_height": 3.0,
},
"m4": {
"nut_thickness": 3.1,
"nut_inner_diam": 7.0,
"nut_outer_diam": 7.9,
"screw_outer_diam": 4.0,
"cap_diam": 6.9,
"cap_height": 3.9,
},
"m5": {
"nut_thickness": 4.7,
"nut_inner_diam": 7.9,
"nut_outer_diam": 8.8,
"screw_outer_diam": 5.0,
"cap_diam": 8.7,
"cap_height": 5,
},
}
bearing_dimensions = {
"608": {"inner_d": 8, "outer_d": 22, "thickness": 7},
"688": {"inner_d": 8, "outer_d": 16, "thickness": 5},
"686": {"inner_d": 6, "outer_d": 13, "thickness": 5},
"626": {"inner_d": 6, "outer_d": 19, "thickness": 6},
"625": {"inner_d": 5, "outer_d": 16, "thickness": 5},
"624": {"inner_d": 4, "outer_d": 13, "thickness": 5},
"623": {"inner_d": 3, "outer_d": 10, "thickness": 4},
"603": {"inner_d": 3, "outer_d": 9, "thickness": 5},
"633": {"inner_d": 3, "outer_d": 13, "thickness": 5},
}
def screw(screw_type: str = "m3", screw_length: float = 16) -> OpenSCADObject:
dims = screw_dimensions[screw_type.lower()]
shaft_rad = dims["screw_outer_diam"] / 2
cap_rad = dims["cap_diam"] / 2
cap_height = dims["cap_height"]
ret = union()(
cylinder(shaft_rad, screw_length + EPSILON),
up(screw_length)(cylinder(cap_rad, cap_height)),
)
return ret
def nut(screw_type: str = "m3") -> OpenSCADObject:
dims = screw_dimensions[screw_type.lower()]
outer_rad = dims["nut_outer_diam"]
inner_rad = dims["screw_outer_diam"]
ret = difference()(circle(outer_rad, segments=6), circle(inner_rad))
return ret
def bearing(bearing_type: str = "624") -> OpenSCADObject:
dims = bearing_dimensions[bearing_type.lower()]
outerR = dims["outer_d"] / 2
innerR = dims["inner_d"] / 2
thickness = dims["thickness"]
bearing = cylinder(outerR, thickness)
bearing.add_param("$fs", 1)
hole = cylinder(innerR, thickness + 2)
hole.add_param("$fs", 1)
bearing = difference()(bearing, translate([0, 0, -1])(hole))
return bearing
# =========
# = LABEL =
# =========
def label(
a_str: str,
width: float = 15,
halign: str = "left",
valign: str = "baseline",
size: int = 10,
depth: float = 0.5,
lineSpacing: float = 1.15,
font: str = "MgOpen Modata:style=Bold",
segments: int = 40,
spacing: int = 1,
) -> OpenSCADObject:
"""Renders a multi-line string into a single 3D object.
__author__ = 'NerdFever.com'
__copyright__ = 'Copyright 2018-2019 NerdFever.com'
__version__ = ''
__email__ = 'dave@nerdfever.com'
__status__ = 'Development'
__license__ = Copyright 2018-2019 NerdFever.com
"""
lines = a_str.splitlines()
texts = []
for idx, line in enumerate(lines):
t = text(
text=line, halign=halign, valign=valign, font=font, spacing=spacing
).add_param("$fn", segments)
t = linear_extrude(height=1)(t)
t = translate([0, -size * idx * lineSpacing, 0])(t)
texts.append(t)
result = union()(texts)
result = resize([width, 0, depth])(result)
result = translate([0, (len(lines) - 1) * size / 2, 0])(result)
return result
# ==================
# = PyEuclid Utils =
# ==================
def euclidify(
an_obj: EucOrTuple, intended_class: type = Vector3
) -> Union[Point23, Vector23, list[Union[Point23, Vector23]]]:
"""
Accept an object or list of objects of any relevant type (2-tuples, 3-tuples, Vector2/3, Point2/3)
and return one or more euclid3 objects of intended_class.
# -- 3D input has its z-values dropped when intended_class is 2D
# -- 2D input has its z-values set to 0 when intended_class is 3D
The general idea is to take in data in whatever form is handy to users
and return euclid3 types with vector math capabilities
"""
sequence = (list, tuple)
euclidable = (list, tuple, Vector2, Vector3, Point2, Point3)
# numeric = (int, float)
# If this is a list of lists, return a list of euclid objects
if isinstance(an_obj, sequence) and isinstance(an_obj[0], euclidable):
return list((_euc_obj(ao, intended_class) for ao in an_obj))
elif isinstance(an_obj, euclidable):
return _euc_obj(an_obj, intended_class)
else:
raise TypeError(f"""Object: {an_obj} ought to be PyEuclid class
{intended_class.__name__} or able to form one, but is not.""")
def _euc_obj(an_obj: Any, intended_class: type = Vector3) -> Union[Point23, Vector23]:
"""Take a single object (not a list of them!) and return a euclid type
# If given a euclid obj, return the desired type,
# -- 3d types are projected to z=0 when intended_class is 2D
# -- 2D types are projected to z=0 when intended class is 3D
_euc_obj( Vector3(0,1,2), Vector3) -> Vector3(0,1,2)
_euc_obj( Vector3(0,1,2), Point3) -> Point3(0,1,2)
_euc_obj( Vector2(0,1), Vector3) -> Vector3(0,1,0)
_euc_obj( Vector2(0,1), Point3) -> Point3(0,1,0)
_euc_obj( (0,1), Vector3) -> Vector3(0,1,0)
_euc_obj( (0,1), Point3) -> Point3(0,1,0)
_euc_obj( (0,1), Point2) -> Point2(0,1,0)
_euc_obj( (0,1,2), Point2) -> Point2(0,1)
_euc_obj( (0,1,2), Point3) -> Point3(0,1,2)
"""
elts_in_constructor = 3
if intended_class in (Point2, Vector2):
elts_in_constructor = 2
result = intended_class(*an_obj[:elts_in_constructor])
return result
def euc_to_arr(euc_obj_or_list: EucOrTuple) -> list[float]: # Inverse of euclidify()
# Call as_arr on euc_obj_or_list or on all its members if it's a list
result: list[float] = []
if hasattr(euc_obj_or_list, "as_arr"):
result = euc_obj_or_list.as_arr() # type: ignore
elif isinstance(euc_obj_or_list, (list, tuple)) and hasattr(
euc_obj_or_list[0], "as_arr"
):
result = [euc_to_arr(p) for p in euc_obj_or_list] # type: ignore
else:
# euc_obj_or_list is neither an array-based PyEuclid object,
# nor a list of them. Assume it's a list of points or vectors,
# and return the list unchanged. We could be wrong about this,
# though.
result = euc_obj_or_list # type: ignore
return result
def project_to_2D(euc_obj: Union[Point23, Vector23]) -> Union[Vector2, Point2]:
"""
Given a Point3/Vector3, return a Point2/Vector2 ignoring the original Z coordinate
"""
result: Union[Vector2, Point2] = None
if isinstance(euc_obj, (Point2, Vector2)):
result = euc_obj
elif isinstance(euc_obj, Point3):
result = Point2(euc_obj.x, euc_obj.y)
elif isinstance(euc_obj, Vector3):
result = Vector2(euc_obj.x, euc_obj.y)
else:
raise ValueError(f"Can't transform object {euc_obj} to a Point2 or Vector2")
return result
def is_scad(obj: OpenSCADObject) -> bool:
return isinstance(obj, OpenSCADObject)
def scad_matrix(euclid_matrix4):
a = euclid_matrix4
return [
[a.a, a.b, a.c, a.d],
[a.e, a.f, a.g, a.h],
[a.i, a.j, a.k, a.l],
[a.m, a.n, a.o, a.p],
]
def centroid(points: Sequence[PointVec23]) -> PointVec23:
if not points:
raise ValueError("centroid(): argument `points` is empty")
first = points[0]
is_3d = isinstance(first, (Vector3, Point3))
if is_3d:
total = Vector3(0, 0, 0)
else:
total = Vector2(0, 0)
for p in points:
total += p
total /= len(points)
if isinstance(first, Point2):
return Point2(*total)
elif isinstance(first, Point3):
return Point3(*total)
else:
return total
# ==============
# = Transforms =
# ==============
def transform_to_point(
body: OpenSCADObject,
dest_point: Point3,
dest_normal: Vector3,
src_point: Point3 = Point3(0, 0, 0),
src_normal: Vector3 = Vector3(0, 1, 0),
src_up: Vector3 = Vector3(0, 0, 1),
) -> OpenSCADObject:
# Transform body to dest_point, looking at dest_normal.
# Orientation & offset can be changed by supplying the src arguments
# Body may be:
# -- an openSCAD object
# -- a list of 3-tuples or PyEuclid Point3s
# -- a single 3-tuple or Point3
dest_point = euclidify(dest_point, Point3)
dest_normal = euclidify(dest_normal, Vector3)
at = dest_point + dest_normal
EUC_UP = euclidify(UP_VEC)
EUC_FORWARD = euclidify(FORWARD_VEC)
EUC_ORIGIN = euclidify(ORIGIN, Vector3)
# if dest_normal and src_up are parallel, the transform collapses
# all points to dest_point. Instead, use EUC_FORWARD if needed
if dest_normal.cross(src_up) == EUC_ORIGIN:
if src_up.cross(EUC_UP) == EUC_ORIGIN:
src_up = EUC_FORWARD
else:
src_up = EUC_UP