-
Notifications
You must be signed in to change notification settings - Fork 11
/
fcfun.py
9481 lines (8159 loc) · 299 KB
/
fcfun.py
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
# ----------------------------------------------------------------------------
# -- FreeCad Functions
# -- comps library
# -- Python functions for FreeCAD
# ----------------------------------------------------------------------------
# -- (c) Felipe Machado
# -- Area of Electronics. Rey Juan Carlos University (urjc.es)
# -- October-2016
# ----------------------------------------------------------------------------
# --- LGPL Licence
# ----------------------------------------------------------------------------
import FreeCAD
import Part
import math
import logging
import DraftVecUtils
#from FreeCAD import Base
# ---------------------- can be taken away after debugging
import os
import sys
# directory this file is
filepath = os.getcwd()
import sys
# to get the components
# In FreeCAD can be added: Preferences->General->Macro->Macro path
sys.path.append(filepath)
# ---------------------- can be taken away after debugging
import kcomp
from kcomp import LAYER3D_H
logging.basicConfig(level=logging.DEBUG)
logger = logging.getLogger(__name__)
# vector constants
V0 = FreeCAD.Vector(0,0,0)
VX = FreeCAD.Vector(1,0,0)
VY = FreeCAD.Vector(0,1,0)
VZ = FreeCAD.Vector(0,0,1)
VXN = FreeCAD.Vector(-1,0,0)
VYN = FreeCAD.Vector(0,-1,0)
VZN = FreeCAD.Vector(0,0,-1)
# color constants
WHITE = (1.0, 1.0, 1.0)
BLACK = (0.0, 0.0, 0.0)
RED = (1.0, 0.0, 0.0)
GREEN = (0.0, 1.0, 0.0)
BLUE = (0.0, 0.0, 1.0)
YELLOW = (1.0, 1.0, 0.0)
MAGENT = (1.0, 0.0, 1.0)
CIAN = (0.0, 1.0, 1.0)
ORANGE = (1.0, 0.5, 0.0)
ORANGE_08 = (1.0, 0.8, 0.0)
RED_05 = (1.0, 0.5, 0.5)
GREEN_05 = (0.5, 1.0, 0.5)
BLUE_05 = (0.5, 0.5, 1.0)
RED_07 = (1.0, 0.7, 0.7)
GREEN_07 = (0.7, 1.0, 0.7)
BLUE_07 = (0.7, 0.7, 1.0)
RED_D07 = (0.7, 0.0, 0.0)
GREEN_D07 = (0.0, 0.7, 0.0)
BLUE_D07 = (0.0, 0.0, 0.7)
YELLOW_05 = (1.0, 1.0, 0.5)
MAGENT_05 = (1.0, 0.5, 1.0)
CIAN_05 = (0.5, 1.0, 1.0)
YELLOW_08 = (1.0, 1.0, 0.8)
MAGENT_08 = (1.0, 0.8, 1.0)
CIAN_08 = (0.8, 1.0, 1.0)
DSKYBLUE = (0.0, 0.7, 1.0)
LSKYBLUE = (0.5, 0.7, 1.0)
GRAY_08 = (0.8, 0.8, 0.8)
GRAY_09 = (0.9, 0.9, 0.9)
YELLOW_095 = (1.0, 1.0, 0.95)
# no rotation vector
V0ROT = FreeCAD.Rotation(VZ,0)
EQUAL_TOL = 0.001 # less than a micron is the same
COS30 = 0.86603
COS45 = 0.707
def pathOfModule():
return os.path.dirname(__file__)
def rotateview(axisX=1.0,axisY=0.0,axisZ=0.0,angle=45.0):
"""Rotate the camara"""
import math
from pivy import coin
try:
cam = Gui.ActiveDocument.ActiveView.getCameraNode()
rot = coin.SbRotation()
rot.setValue(coin.SbVec3f(axisX,axisY,axisZ),math.radians(angle))
nrot = cam.orientation.getValue() * rot
cam.orientation = nrot
print(axisX," ",axisY," ",axisZ," ",angle)
except Exception:
print("Not ActiveView ")
# to compare numbers that they are almost the same, but because of
# floating point calculations they are not exactly the same
def equ (x,y):
"""Compare numbers that are the same but not exactly the same"""
p = DraftVecUtils.precision()
if round(x,p) == round(y,p):
return True
else:
return False
def fc_isperp (fc1, fc2):
""" Return 1 if fc1 and fc2 are perpendicular, 0 if they are not
Parameters
----------
fc1 : FreeCAD.Vector
First vector
fc2 : FreeCAD.Vector
Second vector
Returns
-------
* 1 if fc1 and fc2 are perpendicular
* 0 if they are not
"""
if DraftVecUtils.isNull(fc1) == 1 or DraftVecUtils.isNull(fc2) == 1:
# if any of them are null, they are not perpendicular
return 0
else:
nperp = fc1.dot(fc2)
nperp_round = round(nperp,DraftVecUtils.precision())
if nperp_round == 0:
return 1
else:
return 0
def fc_isparal (fc1, fc2):
""" Return 1 if fc1 and fc2 are parallel (colinear), 0 if they are not
Parameters
----------
fc1 : FreeCAD.Vector
First vector
fc2 : FreeCAD.Vector
Second vector
Returns
-------
* 1 if fc1 and fc2 are parallel
* 0 if they are not
"""
if DraftVecUtils.isNull(fc1) == 1 or DraftVecUtils.isNull(fc2) == 1:
# if any of them are null, they are not parallel
return 0
else:
# scale both to 1, normalize
n1 = DraftVecUtils.scaleTo(fc1,1)
n2 = DraftVecUtils.scaleTo(fc2,1)
n1neg = n1.negative()
if (DraftVecUtils.equals(n1,n2) or
DraftVecUtils.equals(n1neg,n2)):
return 1
else:
return 0
def fc_isparal_nrm (fc1, fc2):
"""
Very similar to fc_isparal, but in this case the arguments are normalized
so, less operations to do.
return 1 if fc1 and fc2 are parallel (colinear), 0 if they are not
Parameters
----------
fc1 : FreeCAD.Vector
First vector
fc2 : FreeCAD.Vector
Second vector
Returns
-------
* 1 if fc1 and fc2 are parallel
* 0 if they are not
"""
if DraftVecUtils.isNull(fc1) == 1 or DraftVecUtils.isNull(fc2) == 1:
# if any of them are null, they are not parallel
return 0
else:
fc1neg = fc1.negative()
if (DraftVecUtils.equals(fc1,fc2) or
DraftVecUtils.equals(fc1neg,fc2)):
return 1
else:
return 0
def fc_isonbase (fcv):
"""
Just tells if a vector has 2 of the coordinates zero
so it is on just a base vector
"""
if fcv.x == 0:
if fcv.y == 0: # (0,0, )
if fcv.z == 0:
# null vector
return 0 # (0,0,0)
else:
return 1 # (0,0,Z)
else: # (0,Y, )
if fcv.z == 0:
return 1 # (0,Y,0)
else:
return 0 # (0,Y,Z)
else: #(X, , )
if fcv.y == 0: # (X,0, )
if fcv.z == 0:
return 1 # (X,0,0)
else:
return 0 # (X,0,Z)
else: # (X,Y, )
return 0
def get_fc_perpend1(fcv):
""" gets a 'random' perpendicular FreeCAD.Vector
Parameters
----------
fcv : FreeCAD.Vector
Vector from which to get perpendicular vector
Returns
-------
FreeCAD.Vector
Random perpendicular vector
"""
if DraftVecUtils.isNull(fcv):
logger.error('null vector')
if fc_isonbase(fcv) == 1: # 2 of the bases are 0
# just move them
fcp = FreeCAD.Vector(fcv.z, fcv.x, fcv.y)
elif fcv.x == 0:
fcp = FreeCAD.Vector(0, fcv.z, -fcv.y)
elif fcv.y == 0:
fcp = FreeCAD.Vector(-fcv.z, 0, fcv.x)
elif fcv.z == 0:
fcp = FreeCAD.Vector(fcv.y, -fcv.x, 0)
else: # none of them are zero (same as before)
fcp = FreeCAD.Vector(fcv.y, -fcv.x, 0)
return fcp
# get_tangent_circle_pt
def get_tangent_circle_pt (ext_pt,
center_pt,
rad,
axis_n,
axis_side = None):
"""
Get the point of the tangent to the circle
::
(difficult to draw in using ASCII text)
external point
: tangent point 1
*--- _
\ / \
\( ) circle
tangent \ _ /
point 2
The 3 points: center(C), ext_pt(E) and tangent_pt(T) form a
rectangle triangle
axis_p
: axis_side
: /
: <90 /
T /
. *. /
. 90 . rad
. .
. alpha beta .
*-----------------------* ---- axis_c (axis going thru centers)
E : C
: : :
:.................: :
: + :
: axis_c_ET_d :
: :
:.......................:
+
EC_d (hypotenuse)
Parameters
----------
ext_pt : FreeCAD.Vector
External point
center_pt : FreeCAD.Vector
Center of the circle
rad : float
Radius of the circle
axis_n : FreeCAD.Vector
Direction of the normal of the circle
axis_side : FreeCAD.Vector
Direction to the side of the tangent point, if not given, it will return both points
The 2 tangent points will be at each side of axis_c. The smaller than 90 degree angle
between axis_side and the 2 possible axis_p
Returns
-------
If axis_side is not given:
returns a list with the 2 points that each point forms a line tangent
to the circle. The 2 lines are defined by one of each point and the
external point.
If axis_side is given:
Only returns a point (FreeCAD.Vector) with the tangent point defined
by the direction of axis_side
If there is an error it will return 0
Notes
-----
**Interesting Parameters**
axis_p (FreeCAD.Vector)
Vector of the circle plane, perpendicular to axis_d. It can have
to possible directions. If parameter axis_side is defined, it will
have the direction that has less than 90 degrees related to axis_side
"""
# normalize axis_n vector (just in case)
axis_n = DraftVecUtils.scaleTo(axis_n,1)
E_pt = ext_pt
C_pt = center_pt
# vector from the external point to the center:
EC = C_pt - E_pt
# normalized vector:
axis_c = DraftVecUtils.scaleTo(EC,1)
if fc_isperp(axis_c, axis_n) == 0:
logger.error('axis_n is not perpendicular to the line formed by the')
logger.error('external point and the circle center')
return 0
#calculation of axis_p vector, and its negative
axis_p = axis_n.cross(axis_c)
axis_pn = axis_p.negative()
if axis_side is not None:
axis_side = DraftVecUtils.scaleTo(axis_side, 1)
if axis_side.dot(axis_p) < 0 :
# axis_p in the other direction
axis_p = axis_pn
axis_pn = V0 # not using the negative direction, just one point
# length (hypotenuse: distance from the circle center to the external point)
EC_d = EC.Length
if rad >= EC_d :
logger.error('The external point has to be out of the circle')
return 0
# calculation of the length of the other cathetus (ET)
ET_d = math.sqrt(EC_d*EC_d - rad*rad)
# calculation of the sine and cosine of alpha angle
cos_alpha = ET_d / EC_d
sin_alpha = rad / EC_d
# projection distance of the cathetus onto (axis_c: EC):
axis_c_ET_d = ET_d * cos_alpha
# projection vector
axis_c_ET = DraftVecUtils.scale(axis_c, axis_c_ET_d)
# projection distance of the cathetus onto (axis_p):
axis_p_ET_d = ET_d * sin_alpha
# projection vector along axis_p
axis_p_ET = DraftVecUtils.scale(axis_p , axis_p_ET_d)
T_1 = E_pt + axis_c_ET + axis_p_ET
if axis_pn == V0:
return T_1
else:
tg_list = []
tg_list.append(T_1)
# projection vector along axis_pn
axis_pn_ET = DraftVecUtils.scale(axis_pn, axis_p_ET_d)
T_2 = E_pt + axis_c_ET + axis_pn_ET
tg_list.append(T_2)
return tg_list
#T = get_tangent_point (ext_pt = V0,
# center_pt = FreeCAD.Vector(5,0,0),
# rad = 2,
# axis_n = VZ)
# #axis_p = VY)
#cir = Part.makeCircle(2,FreeCAD.Vector(5,0,0))
#Part.show(cir)
#line_E_T1 = Part.LineSegment(V0, T[0]).toShape()
#Part.show(line_E_T1)
#line_E_T2 = Part.LineSegment(V0, T[1]).toShape()
#Part.show(line_E_T2)
# get_tangent_2circles
def get_tangent_2circles (center1_pt,
center2_pt,
rad1,
rad2,
axis_n,
axis_side = None):
"""
Returns a list of lists (matrix) with the 2 tangent points for each
of the 2 tangent lines
::
(difficult to draw in using ASCII text)
axis_p
:
T2 : axis_side
. * r1 / ------------
. . / :
. . . / :
T1 . . . r2-r1 (r_diff) + r2*sin(beta)
* . . :
r1 . alpha beta :
*----------------------* ---- axis_c (axis going thru centers)
C1 : C2
:: : :
:: :.....:
:: + :
:: r2*cos(beta):
:: :
::......................:
:: +
:: C1_C2_d (hypotenuse)
::
::
r1*cos(beta)
alpha = atan(r_diff/C1_C2_d)
beta = 90 - alpha
tangent points along axis_c and axis_p
T2_c = C2_c - r2 * cos(beta)
T2_p = C2_p - r2 * sin(beta)
T1_c = C1_c - r1 * cos(beta)
T1_p = C1_p - r1 * sin(beta)
Parameters
----------
center1_pt : FreeCAD.Vector
Center of the circle 1
center2_pt : FreeCAD.Vector
Center of the circle 2
rad1 : float
Radius of the circle 1
rad2 : float
Radius of the circle 2
axis_n : FreeCAD.Vector
Direction of the normal of the circle
axis_side : FreeCAD.Vector
Direction to the side of the tangent line, if not given,
it will return the 2 points of both lines
The 2 tangent lines will be at each side of axis_c. The smaller than
90 degree angle between axis_side and the 2 possible axis_p
Returns
-------
* If axis_side is given:
- Returns a list of lists (matrix)
* Element [0][0] is the point tangent to circle 1 at side axis_side
* Element [0][1] is the point tangent to circle 2 at side axis_side
* Element [1][0] is the point tangent to circle 1 at opposite side of
direction of axis_side
* Element [1][1] is the point tangent to circle 2 at opposite side of
direction of axis_side
* If axis_side is not given, the order of the list of the lines is
arbitrary
* If there is an error it will return 0
Notes
-----
**Interesting variables**
axis_p (FreeCAD.Vecrtor)
Vector of the circle plane, perpendicular to axis_d. It can have
to possible directions. If parameter axis_side is defined, it will
have the direction that has less than 90 degrees related to axis_side
"""
# normalize axis_n vector (just in case)
axis_n = DraftVecUtils.scaleTo(axis_n,1)
# choosing r1 the smaller radius, and r2 the larger
if rad1 < rad2:
C1_pt = center1_pt
C2_pt = center2_pt
r1 = rad1
r2 = rad2
else: #changing circle names
C1_pt = center2_pt
C2_pt = center1_pt
r1 = rad2
r2 = rad1
r_diff = r2 - r1
# vector from center1 to center2:
C1_C2 = C2_pt - C1_pt
# normalized vector:
axis_c = DraftVecUtils.scaleTo(C1_C2,1)
if fc_isperp(axis_c, axis_n) == 0:
logger.error('axis_n is not perpendicular to the line formed by the')
logger.error('external point and the circle center')
return 0
#calculation of axis_p vector, and its negative
axis_p = axis_n.cross(axis_c)
axis_pn = axis_p.negative()
if axis_side is not None:
if axis_side.dot(axis_p) < 0 :
# axis_p in the other direction
axis_p = axis_pn
axis_pn = axis_p.negative()
# if axis_side is not defined, the order is random
# length (hypotenuse: distance from the circle center to the external point)
C1_C2_d = C1_C2.Length
if r_diff >= C1_C2_d :
logger.error('smaller circle is inside the larger')
return 0
# calculation of the length of the other cathetus (T1_T2)
T1_T2_d = math.sqrt(C1_C2_d * C1_C2_d - r_diff * r_diff)
# calculation of the sine and cosine of beta angle
cos_beta = r_diff / C1_C2_d
sin_beta = T1_T2_d / C1_C2_d
# projection distance of the radius onto axis_d
axis_c_r1_d = r1 * cos_beta
axis_c_r2_d = r2 * cos_beta
# projection vector, negative, opposite direction to axis_c
axis_c_r1 = DraftVecUtils.scale(axis_c, -axis_c_r1_d)
axis_c_r2 = DraftVecUtils.scale(axis_c, -axis_c_r2_d)
# projection distance of the radius onto axis_p
axis_p_r1_d = r1 * sin_beta
axis_p_r2_d = r2 * sin_beta
# projection vector, negative, opposite direction to axis_c
axis_p_r1 = DraftVecUtils.scale(axis_p, axis_p_r1_d)
axis_p_r2 = DraftVecUtils.scale(axis_p, axis_p_r2_d)
axis_pn_r1 = DraftVecUtils.scale(axis_pn, axis_p_r1_d)
axis_pn_r2 = DraftVecUtils.scale(axis_pn, axis_p_r2_d)
# tangent line on side axis_p
L1_T1 = C1_pt + axis_c_r1 + axis_p_r1
L1_T2 = C2_pt + axis_c_r2 + axis_p_r2
L2_T1 = C1_pt + axis_c_r1 + axis_pn_r1
L2_T2 = C2_pt + axis_c_r2 + axis_pn_r2
if rad1 < rad2:
L1 = [L1_T1, L1_T2]
L2 = [L2_T1, L2_T2]
else: # the order was changed
L1 = [L1_T2, L1_T1]
L2 = [L2_T2, L2_T1]
L = [L1, L2]
return L
#L = get_tangent_2circles (
# center1_pt = V0,
# center2_pt = FreeCAD.Vector(20,0,0),
# rad1 = 2,
# rad2 = 10,
# axis_n = VZ,
# axis_side = VY)
#cir1 = Part.makeCircle(2,FreeCAD.Vector(0,0,0))
#cir2 = Part.makeCircle(10,FreeCAD.Vector(20,0,0))
#Part.show(cir1)
#Part.show(cir2)
#line_1 = Part.LineSegment(L[0][0], L[0][1]).toShape()
#Part.show(line_1)
#line_2 = Part.LineSegment(L[1][0], L[1][1]).toShape()
#Part.show(line_2)
def fuseshplist (shp_list):
"""
Since multifuse methods needs to be done by a shape and a list,
and usually I have a list that I want to fuse, I make this function
to save the inconvenience of doing every time what I will do here
Fuse multiFuse
"""
if len(shp_list) > 0:
shp1 = shp_list.pop() #remove and get the first element
if len(shp_list) > 0:
shpfuse = shp1.multiFuse(shp_list)
else: #only one element, no fuse:
logger.debug('only one element to fuse')
shpfuse = shp1
else:
logger.debug('empty list to fuse')
return
return (shpfuse)
def add_fcobj(shp, name, doc = None):
""" Just creates a freeCAD object of the shape, just to save one line"""
if doc is None:
doc = FreeCAD.ActiveDocument
fcobj = doc.addObject("Part::Feature", name)
fcobj.Shape = shp
return fcobj
def addBox(x, y, z, name, cx= False, cy=False):
"""
Adds a box, centered on the specified axis x and/or y, with its
Placement and Rotation at zero. So it can be referenced absolutely from
its given position
Parameters
----------
x : float
Length
y : float
Width
z : float
Height
name : str
Object Name
cx : Boolean
Centered in axis x
cy : Boolean
Centered in axis y
Returns
-------
FreeCAD.Object
FreeCAD.Object with the shape of a box
"""
# we have to bring the active document
doc = FreeCAD.ActiveDocument
box = doc.addObject("Part::Box",name)
box.Length = x
box.Width = y
box.Height = z
xpos = 0
ypos = 0
# centered
if cx == True:
xpos = -x/2
if cy == True:
ypos = -y/2
box.Placement.Base =FreeCAD.Vector(xpos,ypos,0)
return box
# adds a box, centered on the specified axis, with its
# Placement and Rotation at zero. So it can be referenced absolutely from
# its given position
def addBox_cen(x, y, z, name, cx= False, cy=False, cz=False):
"""
Adds a box, centered on the specified axis, with its
Placement and Rotation at zero. So it can be referenced absolutely from
its given position
Parameters
----------
x : float
Length
y : float
Width
z : float
Height
name : str
Object Name
cx : Boolean
Centered in the X axis
cy : Boolean
Centered in the Y axis
cz : Boolean
Centered in the Z axis
Returns
-------
FreeCAD.Object
FreeCAD.Object with the shape of a box
"""
# we have to bring the active document
doc = FreeCAD.ActiveDocument
if cx == True:
x0 = -x/2.0
x1 = x/2.0
else:
x0 = 0
x1 = x
if cy == True:
y0 = -y/2.0
y1 = y/2.0
else:
y0 = 0
y1 = y
if cz == True:
z0 = - z/2.0
else:
z0 = 0
p00 = FreeCAD.Vector (x0,y0,z0)
p10 = FreeCAD.Vector (x1,y0,z0)
p11 = FreeCAD.Vector (x1,y1,z0)
p01 = FreeCAD.Vector (x0,y1,z0)
sq_list = [p00, p10, p11, p01]
square = doc.addObject("Part::Polygon",name + "_sq")
square.Nodes =sq_list
square.Close = True
square.ViewObject.Visibility = False
box = doc.addObject ("Part::Extrusion", name)
box.Base = square
box.Dir = (0,0, z)
box.Solid = True
# we need to recompute if we want to do operations on this object
doc.recompute()
return box
# adds a shape of box, referenced on the specified axis, with its
# Placement and Rotation at zero. So it can be referenced absolutely from
# its given position
def shp_boxcen(x, y, z, cx= False, cy=False, cz=False, pos=V0):
"""
Adds a shape of box, referenced on the specified axis, with its
Placement and Rotation at zero. So it can be referenced absolutely from
its given position
Parameters
----------
x : float
Length
y : float
Width
z : float
Height
name : str
Object Name
cx : boolean
Center in the length or not
cy : boolean
Center in the or width not
cz : boolean
Center in the height or not
pos : FreeCAD.Vector
Placement
Returns
--------
TopoShape
Shape of a box
"""
# we have to bring the active document
doc = FreeCAD.ActiveDocument
if cx == True:
x0 = -x/2.0
x1 = x/2.0
else:
x0 = 0
x1 = x
if cy == True:
y0 = -y/2.0
y1 = y/2.0
else:
y0 = 0
y1 = y
if cz == True:
z0 = - z/2.0
else:
z0 = 0
p00 = FreeCAD.Vector (x0,y0,z0) + pos
p10 = FreeCAD.Vector (x1,y0,z0) + pos
p11 = FreeCAD.Vector (x1,y1,z0) + pos
p01 = FreeCAD.Vector (x0,y1,z0) + pos
# the square
shp_wire_sq = Part.makePolygon([p00, p10, p11, p01, p00])
# the face
shp_face_sq = Part.Face(shp_wire_sq)
shp_box = shp_face_sq.extrude(FreeCAD.Vector(0,0,z))
doc.recompute()
return shp_box
# The same as shp_boxcen, but when it is used to cut. So sometimes it is
# useful to leave an extra 1mm on some sides to avoid making cuts sharing
# faces. The extra part is added but not influences on the reference
# Arguments:
# x, y , z: the size of the edges of the box
# cx, cy , cz: if the box will be centered on any of these axis
# cx, cy , cz: if the box will be centered on any of these axis
# xtr_x, xtr_nx, xtr_y, xtr_ny, xtr_z , xtr_nz:
# if an extra mm will be added, the number will determine the size
#
#
#
# | Y cy=1, xtr_ny=1
# |
# 1 |
# _________
# | | |
# | | |
# | | |
# | | |
# |_|_______|
def shp_boxcenxtr(x, y, z, cx= False, cy=False, cz=False,
xtr_nx = 0, xtr_x = 0,
xtr_ny = 0, xtr_y = 0,
xtr_nz = 0, xtr_z = 0,
pos=V0):
"""
The same as shp_boxcen, but when it is used to cut. So sometimes it is
useful to leave an extra 1mm on some sides to avoid making cuts sharing
faces. The extra part is added but not influences on the reference
::
| Y cy=1, xtr_ny=1
|
1 |
_________
| | |
| | |
| | |
| | |
|_|_______|
Parameters
----------
x : float
Length
y : float
Width
z : float
Height
cx : int
Center in the length or not
cy : int
Center in the or width not
cz : int
Center in the height or not
xtr_x : float
Extra mm to add in positive axis of length
xtr_nx : float
Extra mm to add in negative axis of length
xtr_y : float
Extra mm to add in positive axis of width
xtr_ny : float
Extra mm to add in negative axis of width
xtr_z : float
Extra mm to add in positive axis of height
xtr_nz : float
Extra mm to add in negative axis of height
pos : FreeCAD.Vector
Placement
Returns
--------
TopoShape
Shape of a box
"""
# we have to bring the active document
doc = FreeCAD.ActiveDocument
if cx == True:
x0 = -x/2.0 - xtr_nx
x1 = x/2.0 + xtr_x
else:
x0 = 0 - xtr_nx
x1 = x + xtr_x
if cy == True:
y0 = -y/2.0 - xtr_ny
y1 = y/2.0 + xtr_y
else:
y0 = 0 - xtr_ny
y1 = y + xtr_y
if cz == True:
z0 = -z/2.0 - xtr_nz
else:
z0 = 0 - xtr_nz
p00 = FreeCAD.Vector (x0,y0,z0) + pos
p10 = FreeCAD.Vector (x1,y0,z0) + pos
p11 = FreeCAD.Vector (x1,y1,z0) + pos
p01 = FreeCAD.Vector (x0,y1,z0) + pos
# the square
shp_wire_sq = Part.makePolygon([p00, p10, p11, p01, p00])
# the face
shp_face_sq = Part.Face(shp_wire_sq)
shp_box = shp_face_sq.extrude(FreeCAD.Vector(0,0, z+xtr_z+xtr_nz))
doc.recompute()
return shp_box
# same as shp_boxcen but with a filleted dimension
def shp_boxcenfill (x, y, z, fillrad,
fx=False, fy=False, fz=True,
cx= False, cy=False, cz=False, pos=V0):
"""
Same as shp_boxcen but with a filleted dimension
Parameters
----------
x : float
Length
y : float
Width
z : float
Height
fillrad : float
Fillet size
fx : boolean
Fillet in x dimension
fy : boolean
Fillet in y dimension
fz : boolean
Fillet in z dimension
cx : boolean
Center in the length or not
cy : boolean
Center in the or width not
cz : boolean
Center in the height or not
pos : FreeCAD.Vector