topologicpy 0.8.46__py3-none-any.whl → 0.8.48__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
topologicpy/Cell.py CHANGED
@@ -27,7 +27,7 @@ class Cell():
27
27
  cell : topologic_core.Cell
28
28
  The cell.
29
29
  mantissa : int , optional
30
- The desired length of the mantissa. The default is 6.
30
+ The number of decimal places to round the result to. Default is 6.
31
31
 
32
32
  Returns
33
33
  -------
@@ -55,25 +55,25 @@ class Cell():
55
55
  Parameters
56
56
  ----------
57
57
  origin : topologic_core.Vertex , optional
58
- The origin location of the box. The default is None which results in the box being placed at (0, 0, 0).
58
+ The origin location of the box. Default is None which results in the box being placed at (0, 0, 0).
59
59
  width : float , optional
60
- The width of the box. The default is 1.
60
+ The width of the box. Default is 1.
61
61
  length : float , optional
62
- The length of the box. The default is 1.
62
+ The length of the box. Default is 1.
63
63
  height : float , optional
64
64
  The height of the box.
65
65
  uSides : int , optional
66
- The number of sides along the width. The default is 1.
66
+ The number of sides along the width. Default is 1.
67
67
  vSides : int , optional
68
- The number of sides along the length. The default is 1.
68
+ The number of sides along the length. Default is 1.
69
69
  wSides : int , optional
70
- The number of sides along the height. The default is 1.
70
+ The number of sides along the height. Default is 1.
71
71
  direction : list , optional
72
- The vector representing the up direction of the box. The default is [0, 0, 1].
72
+ The vector representing the up direction of the box. Default is [0, 0, 1].
73
73
  placement : str , optional
74
- The description of the placement of the origin of the box. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
74
+ The description of the placement of the origin of the box. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
75
75
  tolerance : float , optional
76
- The desired tolerance. The default is 0.0001.
76
+ The desired tolerance. Default is 0.0001.
77
77
 
78
78
  Returns
79
79
  -------
@@ -95,11 +95,11 @@ class Cell():
95
95
  faces : list
96
96
  The input list of faces.
97
97
  planarize : bool, optional
98
- If set to True, the input faces are planarized before building the cell. Otherwise, they are not. The default is False.
98
+ If set to True, the input faces are planarized before building the cell. Otherwise, they are not. Default is False.
99
99
  tolerance : float , optional
100
- The desired tolerance. The default is 0.0001.
100
+ The desired tolerance. Default is 0.0001.
101
101
  silent : bool , optional
102
- If set to True, error and warning messages are suppressed. The default is False.
102
+ If set to True, error and warning messages are suppressed. Default is False.
103
103
 
104
104
  Returns
105
105
  -------
@@ -197,9 +197,9 @@ class Cell():
197
197
  cell : topologic_core.Cell
198
198
  The input cell.
199
199
  offset : float , optional
200
- The desired offset distance. The default is 1.0.
200
+ The desired offset distance. Default is 1.0.
201
201
  tolerance : float , optional
202
- The desired tolerance. The default is 0.0001.
202
+ The desired tolerance. Default is 0.0001.
203
203
 
204
204
  Returns
205
205
  -------
@@ -235,9 +235,9 @@ class Cell():
235
235
  shell : topologic_core.Shell
236
236
  The input shell. The shell must be closed for this method to succeed.
237
237
  planarize : bool, optional
238
- If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. The default is False.
238
+ If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. Default is False.
239
239
  tolerance : float , optional
240
- The desired tolerance. The default is 0.0001.
240
+ The desired tolerance. Default is 0.0001.
241
241
 
242
242
  Returns
243
243
  -------
@@ -264,11 +264,11 @@ class Cell():
264
264
  externalBoundary : topologic_core.Shell
265
265
  The input external boundary.
266
266
  internalBoundaries : list , optional
267
- The input list of internal boundaries (closed shells). The default is an empty list.
267
+ The input list of internal boundaries (closed shells). Default is an empty list.
268
268
  tolerance : float , optional
269
- The desired tolerance. The default is 0.0001.
269
+ The desired tolerance. Default is 0.0001.
270
270
  silent : bool , optional
271
- If set to True, error and warning messages are suppressed. The default is False.
271
+ If set to True, error and warning messages are suppressed. Default is False.
272
272
 
273
273
  Returns
274
274
  -------
@@ -310,17 +310,17 @@ class Cell():
310
310
  face : topologic_core.Face
311
311
  The input face to be thickened.
312
312
  thickness : float , optional
313
- The desired thickness. The default is 1.0.
313
+ The desired thickness. Default is 1.0.
314
314
  bothSides : bool
315
- If True, the cell will be lofted to each side of the face. Otherwise, it will be lofted in the direction of the normal to the input face. The default is True.
315
+ If True, the cell will be lofted to each side of the face. Otherwise, it will be lofted in the direction of the normal to the input face. Default is True.
316
316
  reverse : bool
317
- If True, the cell will be lofted in the opposite direction of the normal to the face. The default is False.
317
+ If True, the cell will be lofted in the opposite direction of the normal to the face. Default is False.
318
318
  planarize : bool, optional
319
- If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. The default is False.
319
+ If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. Default is False.
320
320
  tolerance : float , optional
321
- The desired tolerance. The default is 0.0001.
321
+ The desired tolerance. Default is 0.0001.
322
322
  silent : bool , optional
323
- If set to True, error and warning messages are suppressed. The default is False.
323
+ If set to True, error and warning messages are suppressed. Default is False.
324
324
 
325
325
  Returns
326
326
  -------
@@ -367,17 +367,17 @@ class Cell():
367
367
  shell : topologic_core.Shell
368
368
  The input shell to be thickened.
369
369
  thickness : float , optional
370
- The desired thickness. The default is 1.0.
370
+ The desired thickness. Default is 1.0.
371
371
  bothSides : bool
372
- If True, the cell will be lofted to each side of the shell. Otherwise, it will be lofted along the input direction. The default is True.
372
+ If True, the cell will be lofted to each side of the shell. Otherwise, it will be lofted along the input direction. Default is True.
373
373
  reverse : bool
374
- If True, the cell will be lofted along the opposite of the input direction. The default is False.
374
+ If True, the cell will be lofted along the opposite of the input direction. Default is False.
375
375
  planarize : bool, optional
376
- If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. The default is False.
376
+ If set to True, the input faces of the input shell are planarized before building the cell. Otherwise, they are not. Default is False.
377
377
  tolerance : float , optional
378
- The desired tolerance. The default is 0.0001.
378
+ The desired tolerance. Default is 0.0001.
379
379
  silent : bool , optional
380
- If set to True, error and warning messages are suppressed. The default is False.
380
+ If set to True, error and warning messages are suppressed. Default is False.
381
381
 
382
382
  Returns
383
383
  -------
@@ -425,17 +425,17 @@ class Cell():
425
425
  wires : list
426
426
  The input list of wires.
427
427
  close : bool , optional
428
- If set to True, the last wire in the list of input wires will be connected to the first wire in the list of input wires. The default is False.
428
+ If set to True, the last wire in the list of input wires will be connected to the first wire in the list of input wires. Default is False.
429
429
  triangulate : bool , optional
430
- If set to True, the faces will be triangulated. The default is True.
430
+ If set to True, the faces will be triangulated. Default is True.
431
431
  planarize : bool, optional
432
- If set to True, the created faces are planarized before building the cell. Otherwise, they are not. The default is False.
432
+ If set to True, the created faces are planarized before building the cell. Otherwise, they are not. Default is False.
433
433
  mantissa : int , optional
434
- The desired length of the mantissa. The default is 6.
434
+ The number of decimal places to round the result to. Default is 6.
435
435
  tolerance : float , optional
436
- The desired tolerance. The default is 0.0001.
436
+ The desired tolerance. Default is 0.0001.
437
437
  silent : bool , optional
438
- If set to True, error and warning messages are suppressed. The default is False.
438
+ If set to True, error and warning messages are suppressed. Default is False.
439
439
 
440
440
  Raises
441
441
  ------
@@ -559,11 +559,11 @@ class Cell():
559
559
  cluster : Cluster
560
560
  The input Cluster of wires.
561
561
  close : bool , optional
562
- If set to True, the last wire in the cluster of input wires will be connected to the first wire in the cluster of input wires. The default is False.
562
+ If set to True, the last wire in the cluster of input wires will be connected to the first wire in the cluster of input wires. Default is False.
563
563
  triangulate : bool , optional
564
- If set to True, the faces will be triangulated. The default is True.
564
+ If set to True, the faces will be triangulated. Default is True.
565
565
  tolerance : float , optional
566
- The desired tolerance. The default is 0.0001.
566
+ The desired tolerance. Default is 0.0001.
567
567
 
568
568
  Raises
569
569
  ------
@@ -592,23 +592,23 @@ class Cell():
592
592
  Parameters
593
593
  ----------
594
594
  origin : topologic_core.Vertex , optional
595
- The location of the origin of the cylinder. The default is None which results in the cylinder being placed at (0, 0, 0).
595
+ The location of the origin of the cylinder. Default is None which results in the cylinder being placed at (0, 0, 0).
596
596
  radius : float , optional
597
- The radius of the capsule. The default is 0.25.
597
+ The radius of the capsule. Default is 0.25.
598
598
  height : float , optional
599
- The height of the capsule. The default is 1.
599
+ The height of the capsule. Default is 1.
600
600
  uSides : int , optional
601
- The number of circle segments of the capsule. The default is 16.
601
+ The number of circle segments of the capsule. Default is 16.
602
602
  vSidesEnds : int , optional
603
- The number of vertical segments of the end hemispheres. The default is 8.
603
+ The number of vertical segments of the end hemispheres. Default is 8.
604
604
  vSidesMiddle : int , optional
605
- The number of vertical segments of the middle cylinder. The default is 1.
605
+ The number of vertical segments of the middle cylinder. Default is 1.
606
606
  direction : list , optional
607
- The vector representing the up direction of the capsule. The default is [0, 0, 1].
607
+ The vector representing the up direction of the capsule. Default is [0, 0, 1].
608
608
  placement : str , optional
609
- The description of the placement of the origin of the capsule. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "bottom".
609
+ The description of the placement of the origin of the capsule. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "bottom".
610
610
  tolerance : float , optional
611
- The desired tolerance. The default is 0.0001.
611
+ The desired tolerance. Default is 0.0001.
612
612
 
613
613
  Returns
614
614
  -------
@@ -656,23 +656,23 @@ class Cell():
656
656
  Parameters
657
657
  ----------
658
658
  origin : topologic_core.Vertex, optional
659
- The location of the origin of the CHS. The default is None which results in the CHS being placed at (0, 0, 0).
659
+ The location of the origin of the CHS. Default is None which results in the CHS being placed at (0, 0, 0).
660
660
  radius : float , optional
661
- The outer radius of the CHS. The default is 1.0.
661
+ The outer radius of the CHS. Default is 1.0.
662
662
  thickness : float , optional
663
- The thickness of the CHS. The default is 0.25.
663
+ The thickness of the CHS. Default is 0.25.
664
664
  height : float , optional
665
- The height of the CHS. The default is 1.0.
665
+ The height of the CHS. Default is 1.0.
666
666
  sides : int , optional
667
- The desired number of sides of the CSH. The default is 16.
667
+ The desired number of sides of the CSH. Default is 16.
668
668
  direction : list , optional
669
- The vector representing the up direction of the RHS. The default is [0, 0, 1].
669
+ The vector representing the up direction of the RHS. Default is [0, 0, 1].
670
670
  placement : str , optional
671
- The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
671
+ The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
672
672
  tolerance : float , optional
673
- The desired tolerance. The default is 0.0001.
673
+ The desired tolerance. Default is 0.0001.
674
674
  silent : bool , optional
675
- If set to True, error and warning messages are suppressed. The default is False.
675
+ If set to True, error and warning messages are suppressed. Default is False.
676
676
 
677
677
  Returns
678
678
  -------
@@ -732,9 +732,9 @@ class Cell():
732
732
  cell : topologic_core.Cell
733
733
  The input cell.
734
734
  reference : str , optional
735
- The desired reference to which to compare this compactness. The options are "sphere" and "cube". It is case insensitive. The default is "sphere".
735
+ The desired reference to which to compare this compactness. The options are "sphere" and "cube". It is case insensitive. Default is "sphere".
736
736
  mantissa : int , optional
737
- The desired length of the mantissa. The default is 6.
737
+ The number of decimal places to round the result to. Default is 6.
738
738
 
739
739
  Returns
740
740
  -------
@@ -772,25 +772,25 @@ class Cell():
772
772
  Parameters
773
773
  ----------
774
774
  origin : topologic_core.Vertex , optional
775
- The location of the origin of the cone. The default is None which results in the cone being placed at (0, 0, 0).
775
+ The location of the origin of the cone. Default is None which results in the cone being placed at (0, 0, 0).
776
776
  baseRadius : float , optional
777
- The radius of the base circle of the cone. The default is 0.5.
777
+ The radius of the base circle of the cone. Default is 0.5.
778
778
  topRadius : float , optional
779
- The radius of the top circle of the cone. The default is 0.
779
+ The radius of the top circle of the cone. Default is 0.
780
780
  height : float , optional
781
- The height of the cone. The default is 1.
781
+ The height of the cone. Default is 1.
782
782
  uSides : int , optional
783
- The number of circle segments of the cylinder. The default is 16.
783
+ The number of circle segments of the cylinder. Default is 16.
784
784
  vSides : int , optional
785
- The number of vertical segments of the cylinder. The default is 1.
785
+ The number of vertical segments of the cylinder. Default is 1.
786
786
  direction : list , optional
787
- The vector representing the up direction of the cone. The default is [0, 0, 1].
787
+ The vector representing the up direction of the cone. Default is [0, 0, 1].
788
788
  placement : str , optional
789
- The description of the placement of the origin of the cone. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
789
+ The description of the placement of the origin of the cone. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
790
790
  mantissa : int , optional
791
- The desired length of the mantissa. The default is 6
791
+ The desired length of the mantissa. Default is 6
792
792
  tolerance : float , optional
793
- The desired tolerance. The default is 0.0001.
793
+ The desired tolerance. Default is 0.0001.
794
794
 
795
795
  Returns
796
796
  -------
@@ -901,7 +901,7 @@ class Cell():
901
901
  vertex : topologic_core.Vertex
902
902
  The input vertex.
903
903
  tolerance : float , optional
904
- The desired tolerance. The default is 0.0001.
904
+ The desired tolerance. Default is 0.0001.
905
905
 
906
906
  Returns
907
907
  -------
@@ -950,29 +950,29 @@ class Cell():
950
950
  Parameters
951
951
  ----------
952
952
  origin : topologic_core.Vertex , optional
953
- The location of the origin of the T-shape. The default is None which results in the Cross-shape being placed at (0, 0, 0).
953
+ The location of the origin of the T-shape. Default is None which results in the Cross-shape being placed at (0, 0, 0).
954
954
  width : float , optional
955
- The overall width of the Cross-shape. The default is 1.0.
955
+ The overall width of the Cross-shape. Default is 1.0.
956
956
  length : float , optional
957
- The overall length of the Cross-shape. The default is 1.0.
957
+ The overall length of the Cross-shape. Default is 1.0.
958
958
  height : float , optional
959
- The overall height of the C-shape. The default is 1.0.
959
+ The overall height of the C-shape. Default is 1.0.
960
960
  a : float , optional
961
- The hortizontal thickness of the vertical arm of the Cross-shape. The default is 0.25.
961
+ The hortizontal thickness of the vertical arm of the Cross-shape. Default is 0.25.
962
962
  b : float , optional
963
- The vertical thickness of the horizontal arm of the Cross-shape. The default is 0.25.
963
+ The vertical thickness of the horizontal arm of the Cross-shape. Default is 0.25.
964
964
  c : float , optional
965
- The distance of the vertical symmetry axis measured from the left side of the Cross-shape. The default is None which results in the Cross-shape being symmetrical on the Y-axis.
965
+ The distance of the vertical symmetry axis measured from the left side of the Cross-shape. Default is None which results in the Cross-shape being symmetrical on the Y-axis.
966
966
  d : float , optional
967
- The distance of the horizontal symmetry axis measured from the bottom side of the Cross-shape. The default is None which results in the Cross-shape being symmetrical on the X-axis.
967
+ The distance of the horizontal symmetry axis measured from the bottom side of the Cross-shape. Default is None which results in the Cross-shape being symmetrical on the X-axis.
968
968
  direction : list , optional
969
- The vector representing the up direction of the Cross-shape. The default is [0, 0, 1].
969
+ The vector representing the up direction of the Cross-shape. Default is [0, 0, 1].
970
970
  placement : str , optional
971
- The description of the placement of the origin of the Cross-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
971
+ The description of the placement of the origin of the Cross-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
972
972
  tolerance : float , optional
973
- The desired tolerance. The default is 0.0001.
973
+ The desired tolerance. Default is 0.0001.
974
974
  silent : bool , optional
975
- If set to True, error and warning messages are suppressed. The default is False.
975
+ If set to True, error and warning messages are suppressed. Default is False.
976
976
 
977
977
  Returns
978
978
  -------
@@ -1139,35 +1139,35 @@ class Cell():
1139
1139
  Parameters
1140
1140
  ----------
1141
1141
  origin : topologic_core.Vertex , optional
1142
- The location of the origin of the C-shape. The default is None which results in the C-shape being placed at (0, 0, 0).
1142
+ The location of the origin of the C-shape. Default is None which results in the C-shape being placed at (0, 0, 0).
1143
1143
  width : float , optional
1144
- The overall width of the C-shape. The default is 1.0.
1144
+ The overall width of the C-shape. Default is 1.0.
1145
1145
  length : float , optional
1146
- The overall length of the C-shape. The default is 1.0.
1146
+ The overall length of the C-shape. Default is 1.0.
1147
1147
  height : float , optional
1148
- The overall height of the C-shape. The default is 1.0.
1148
+ The overall height of the C-shape. Default is 1.0.
1149
1149
  wSides : int , optional
1150
- The desired number of sides along the Z-axis. The default is 1.
1150
+ The desired number of sides along the Z-axis. Default is 1.
1151
1151
  a : float , optional
1152
- The hortizontal thickness of the vertical arm of the C-shape. The default is 0.25.
1152
+ The hortizontal thickness of the vertical arm of the C-shape. Default is 0.25.
1153
1153
  b : float , optional
1154
- The vertical thickness of the bottom horizontal arm of the C-shape. The default is 0.25.
1154
+ The vertical thickness of the bottom horizontal arm of the C-shape. Default is 0.25.
1155
1155
  c : float , optional
1156
- The vertical thickness of the top horizontal arm of the C-shape. The default is 0.25.
1156
+ The vertical thickness of the top horizontal arm of the C-shape. Default is 0.25.
1157
1157
  flipHorizontal : bool , optional
1158
- if set to True, the shape is flipped horizontally. The default is False.
1158
+ if set to True, the shape is flipped horizontally. Default is False.
1159
1159
  flipVertical : bool , optional
1160
- if set to True, the shape is flipped vertically. The default is False.
1160
+ if set to True, the shape is flipped vertically. Default is False.
1161
1161
  direction : list , optional
1162
- The vector representing the up direction of the C-shape. The default is [0, 0, 1].
1162
+ The vector representing the up direction of the C-shape. Default is [0, 0, 1].
1163
1163
  placement : str , optional
1164
- The description of the placement of the origin of the C-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
1164
+ The description of the placement of the origin of the C-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
1165
1165
  mantissa: int , optional
1166
- The desired length of the mantissa. The default is 6.
1166
+ The number of decimal places to round the result to. Default is 6.
1167
1167
  tolerance : float , optional
1168
- The desired tolerance. The default is 0.0001.
1168
+ The desired tolerance. Default is 0.0001.
1169
1169
  silent : bool , optional
1170
- If set to True, error and warning messages are suppressed. The default is False.
1170
+ If set to True, error and warning messages are suppressed. Default is False.
1171
1171
 
1172
1172
  Returns
1173
1173
  -------
@@ -1303,21 +1303,21 @@ class Cell():
1303
1303
  Parameters
1304
1304
  ----------
1305
1305
  origin : topologic_core.Vertex , optional
1306
- The origin location of the cube. The default is None which results in the cube being placed at (0, 0, 0).
1306
+ The origin location of the cube. Default is None which results in the cube being placed at (0, 0, 0).
1307
1307
  size : float , optional
1308
- The size of the cube. The default is 1.
1308
+ The size of the cube. Default is 1.
1309
1309
  uSides : int , optional
1310
- The number of sides along the width. The default is 1.
1310
+ The number of sides along the width. Default is 1.
1311
1311
  vSides : int , optional
1312
- The number of sides along the length. The default is 1.
1312
+ The number of sides along the length. Default is 1.
1313
1313
  wSides : int , optional
1314
- The number of sides along the height. The default is 1.
1314
+ The number of sides along the height. Default is 1.
1315
1315
  direction : list , optional
1316
- The vector representing the up direction of the cube. The default is [0, 0, 1].
1316
+ The vector representing the up direction of the cube. Default is [0, 0, 1].
1317
1317
  placement : str , optional
1318
- The description of the placement of the origin of the cube. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
1318
+ The description of the placement of the origin of the cube. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
1319
1319
  tolerance : float , optional
1320
- The desired tolerance. The default is 0.0001.
1320
+ The desired tolerance. Default is 0.0001.
1321
1321
 
1322
1322
  Returns
1323
1323
  -------
@@ -1338,23 +1338,23 @@ class Cell():
1338
1338
  Parameters
1339
1339
  ----------
1340
1340
  origin : topologic_core.Vertex , optional
1341
- The location of the origin of the cylinder. The default is None which results in the cylinder being placed at (0, 0, 0).
1341
+ The location of the origin of the cylinder. Default is None which results in the cylinder being placed at (0, 0, 0).
1342
1342
  radius : float , optional
1343
- The radius of the cylinder. The default is 0.5.
1343
+ The radius of the cylinder. Default is 0.5.
1344
1344
  height : float , optional
1345
- The height of the cylinder. The default is 1.
1345
+ The height of the cylinder. Default is 1.
1346
1346
  uSides : int , optional
1347
- The number of circle segments of the cylinder. The default is 16.
1347
+ The number of circle segments of the cylinder. Default is 16.
1348
1348
  vSides : int , optional
1349
- The number of vertical segments of the cylinder. The default is 1.
1349
+ The number of vertical segments of the cylinder. Default is 1.
1350
1350
  direction : list , optional
1351
- The vector representing the up direction of the cylinder. The default is [0, 0, 1].
1351
+ The vector representing the up direction of the cylinder. Default is [0, 0, 1].
1352
1352
  placement : str , optional
1353
- The description of the placement of the origin of the cylinder. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "bottom".
1353
+ The description of the placement of the origin of the cylinder. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "bottom".
1354
1354
  mantissa : int , optional
1355
- The desired length of the mantissa. The default is 6.
1355
+ The number of decimal places to round the result to. Default is 6.
1356
1356
  tolerance : float , optional
1357
- The desired tolerance. The default is 0.0001.
1357
+ The desired tolerance. Default is 0.0001.
1358
1358
 
1359
1359
  Returns
1360
1360
  -------
@@ -1411,9 +1411,9 @@ class Cell():
1411
1411
  cell : topologic_core.Cell
1412
1412
  the input cell.
1413
1413
  tiltAngle : float , optional
1414
- The threshold tilt angle in degrees to determine if a face is vertical, horizontal, or tilted. The tilt angle is measured from the nearest cardinal direction. The default is 10.
1414
+ The threshold tilt angle in degrees to determine if a face is vertical, horizontal, or tilted. The tilt angle is measured from the nearest cardinal direction. Default is 10.
1415
1415
  tolerance : float , optional
1416
- The desired tolerance. The default is 0.0001.
1416
+ The desired tolerance. Default is 0.0001.
1417
1417
 
1418
1418
  Returns
1419
1419
  -------
@@ -1514,15 +1514,15 @@ class Cell():
1514
1514
  Parameters
1515
1515
  ----------
1516
1516
  origin : topologic_core.Vertex , optional
1517
- The origin location of the dodecahedron. The default is None which results in the dodecahedron being placed at (0, 0, 0).
1517
+ The origin location of the dodecahedron. Default is None which results in the dodecahedron being placed at (0, 0, 0).
1518
1518
  radius : float , optional
1519
- The radius of the dodecahedron's circumscribed sphere. The default is 0.5.
1519
+ The radius of the dodecahedron's circumscribed sphere. Default is 0.5.
1520
1520
  direction : list , optional
1521
- The vector representing the up direction of the dodecahedron. The default is [0, 0, 1].
1521
+ The vector representing the up direction of the dodecahedron. Default is [0, 0, 1].
1522
1522
  placement : str , optional
1523
- The description of the placement of the origin of the dodecahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
1523
+ The description of the placement of the origin of the dodecahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
1524
1524
  tolerance : float , optional
1525
- The desired tolerance. The default is 0.0001.
1525
+ The desired tolerance. Default is 0.0001.
1526
1526
 
1527
1527
  Returns
1528
1528
  -------
@@ -1614,19 +1614,19 @@ class Cell():
1614
1614
  Parameters
1615
1615
  ----------
1616
1616
  origin : topologic_core.Vertex , optional
1617
- The origin location of the sphere. The default is None which results in the egg-shaped cell being placed at (0, 0, 0).
1617
+ The origin location of the sphere. Default is None which results in the egg-shaped cell being placed at (0, 0, 0).
1618
1618
  height : float , optional
1619
- The desired height of of the egg-shaped cell. The default is 1.0.
1619
+ The desired height of of the egg-shaped cell. Default is 1.0.
1620
1620
  uSides : int , optional
1621
- The desired number of sides along the longitude of the egg-shaped cell. The default is 16.
1621
+ The desired number of sides along the longitude of the egg-shaped cell. Default is 16.
1622
1622
  vSides : int , optional
1623
- The desired number of sides along the latitude of the egg-shaped cell. The default is 8.
1623
+ The desired number of sides along the latitude of the egg-shaped cell. Default is 8.
1624
1624
  direction : list , optional
1625
- The vector representing the up direction of the egg-shaped cell. The default is [0, 0, 1].
1625
+ The vector representing the up direction of the egg-shaped cell. Default is [0, 0, 1].
1626
1626
  placement : str , optional
1627
- The description of the placement of the origin of the egg-shaped cell. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
1627
+ The description of the placement of the origin of the egg-shaped cell. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
1628
1628
  tolerance : float , optional
1629
- The desired tolerance. The default is 0.0001.
1629
+ The desired tolerance. Default is 0.0001.
1630
1630
 
1631
1631
  Returns
1632
1632
  -------
@@ -1751,25 +1751,25 @@ class Cell():
1751
1751
  Parameters
1752
1752
  ----------
1753
1753
  origin : topologic_core.Vertex , optional
1754
- The location of the origin of the hyperboloid. The default is None which results in the hyperboloid being placed at (0, 0, 0).
1754
+ The location of the origin of the hyperboloid. Default is None which results in the hyperboloid being placed at (0, 0, 0).
1755
1755
  baseRadius : float , optional
1756
- The radius of the base circle of the hyperboloid. The default is 0.5.
1756
+ The radius of the base circle of the hyperboloid. Default is 0.5.
1757
1757
  topRadius : float , optional
1758
- The radius of the top circle of the hyperboloid. The default is 0.5.
1758
+ The radius of the top circle of the hyperboloid. Default is 0.5.
1759
1759
  height : float , optional
1760
- The height of the cone. The default is 1.
1760
+ The height of the cone. Default is 1.
1761
1761
  sides : int , optional
1762
- The number of sides of the cone. The default is 24.
1762
+ The number of sides of the cone. Default is 24.
1763
1763
  direction : list , optional
1764
- The vector representing the up direction of the hyperboloid. The default is [0, 0, 1].
1764
+ The vector representing the up direction of the hyperboloid. Default is [0, 0, 1].
1765
1765
  twist : float , optional
1766
- The angle to twist the base cylinder. The default is 60.
1766
+ The angle to twist the base cylinder. Default is 60.
1767
1767
  placement : str , optional
1768
- The description of the placement of the origin of the hyperboloid. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
1768
+ The description of the placement of the origin of the hyperboloid. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
1769
1769
  mantissa : int , optional
1770
- The desired length of the mantissa. The default is 6
1770
+ The desired length of the mantissa. Default is 6
1771
1771
  tolerance : float , optional
1772
- The desired tolerance. The default is 0.0001.
1772
+ The desired tolerance. Default is 0.0001.
1773
1773
 
1774
1774
  Returns
1775
1775
  -------
@@ -1856,15 +1856,15 @@ class Cell():
1856
1856
  Parameters
1857
1857
  ----------
1858
1858
  origin : topologic_core.Vertex , optional
1859
- The origin location of the icosahedron. The default is None which results in the icosahedron being placed at (0, 0, 0).
1859
+ The origin location of the icosahedron. Default is None which results in the icosahedron being placed at (0, 0, 0).
1860
1860
  radius : float , optional
1861
- The radius of the icosahedron's circumscribed sphere. The default is 0.5.
1861
+ The radius of the icosahedron's circumscribed sphere. Default is 0.5.
1862
1862
  direction : list , optional
1863
- The vector representing the up direction of the icosahedron. The default is [0, 0, 1].
1863
+ The vector representing the up direction of the icosahedron. Default is [0, 0, 1].
1864
1864
  placement : str , optional
1865
- The description of the placement of the origin of the icosahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
1865
+ The description of the placement of the origin of the icosahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
1866
1866
  tolerance : float , optional
1867
- The desired tolerance. The default is 0.0001.
1867
+ The desired tolerance. Default is 0.0001.
1868
1868
 
1869
1869
  Returns
1870
1870
  -------
@@ -1960,9 +1960,9 @@ class Cell():
1960
1960
  cell : topologic_core.Cell
1961
1961
  The input cell.
1962
1962
  tolerance : float , optional
1963
- The desired tolerance. The default is 0.0001.
1963
+ The desired tolerance. Default is 0.0001.
1964
1964
  silent : bool , optional
1965
- If set to True, error and warning messages are suppressed. The default is False.
1965
+ If set to True, error and warning messages are suppressed. Default is False.
1966
1966
 
1967
1967
  Returns
1968
1968
  -------
@@ -2005,35 +2005,35 @@ class Cell():
2005
2005
  Parameters
2006
2006
  ----------
2007
2007
  origin : topologic_core.Vertex , optional
2008
- The location of the origin of the I-shape. The default is None which results in the I-shape being placed at (0, 0, 0).
2008
+ The location of the origin of the I-shape. Default is None which results in the I-shape being placed at (0, 0, 0).
2009
2009
  width : float , optional
2010
- The overall width of the I-shape. The default is 1.0.
2010
+ The overall width of the I-shape. Default is 1.0.
2011
2011
  length : float , optional
2012
- The overall length of the I-shape. The default is 1.0.
2012
+ The overall length of the I-shape. Default is 1.0.
2013
2013
  height : float , optional
2014
- The overall height of the I-shape. The default is 1.0.
2014
+ The overall height of the I-shape. Default is 1.0.
2015
2015
  wSides : int , optional
2016
- The desired number of sides along the Z-Axis. The default is 1.
2016
+ The desired number of sides along the Z-Axis. Default is 1.
2017
2017
  a : float , optional
2018
- The hortizontal thickness of the central vertical arm of the I-shape. The default is 0.25.
2018
+ The hortizontal thickness of the central vertical arm of the I-shape. Default is 0.25.
2019
2019
  b : float , optional
2020
- The vertical thickness of the bottom horizontal arm of the I-shape. The default is 0.25.
2020
+ The vertical thickness of the bottom horizontal arm of the I-shape. Default is 0.25.
2021
2021
  c : float , optional
2022
- The vertical thickness of the top horizontal arm of the I-shape. The default is 0.25.
2022
+ The vertical thickness of the top horizontal arm of the I-shape. Default is 0.25.
2023
2023
  flipHorizontal : bool , optional
2024
- if set to True, the shape is flipped horizontally. The default is False.
2024
+ if set to True, the shape is flipped horizontally. Default is False.
2025
2025
  flipVertical : bool , optional
2026
- if set to True, the shape is flipped vertically. The default is False.
2026
+ if set to True, the shape is flipped vertically. Default is False.
2027
2027
  direction : list , optional
2028
- The vector representing the up direction of the I-shape. The default is [0, 0, 1].
2028
+ The vector representing the up direction of the I-shape. Default is [0, 0, 1].
2029
2029
  placement : str , optional
2030
- The description of the placement of the origin of the I-shape. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
2030
+ The description of the placement of the origin of the I-shape. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
2031
2031
  mantissa : int , optional
2032
- The desired length of the mantissa. The default is 6.
2032
+ The number of decimal places to round the result to. Default is 6.
2033
2033
  tolerance : float , optional
2034
- The desired tolerance. The default is 0.0001.
2034
+ The desired tolerance. Default is 0.0001.
2035
2035
  silent : bool , optional
2036
- If set to True, error and warning messages are suppressed. The default is False.
2036
+ If set to True, error and warning messages are suppressed. Default is False.
2037
2037
 
2038
2038
  Returns
2039
2039
  -------
@@ -2160,7 +2160,7 @@ class Cell():
2160
2160
  vertex : topologic_core.Vertex
2161
2161
  The input vertex.
2162
2162
  tolerance : float , optional
2163
- The desired tolerance. The default is 0.0001.
2163
+ The desired tolerance. Default is 0.0001.
2164
2164
 
2165
2165
  Returns
2166
2166
  -------
@@ -2203,33 +2203,33 @@ class Cell():
2203
2203
  Parameters
2204
2204
  ----------
2205
2205
  origin : topologic_core.Vertex , optional
2206
- The location of the origin of the L-shape. The default is None which results in the L-shape being placed at (0, 0, 0).
2206
+ The location of the origin of the L-shape. Default is None which results in the L-shape being placed at (0, 0, 0).
2207
2207
  width : float , optional
2208
- The overall width of the L-shape. The default is 1.0.
2208
+ The overall width of the L-shape. Default is 1.0.
2209
2209
  length : float , optional
2210
- The overall length of the L-shape. The default is 1.0.
2210
+ The overall length of the L-shape. Default is 1.0.
2211
2211
  height : float , optional
2212
- The overall height of the L-shape. The default is 1.0.
2212
+ The overall height of the L-shape. Default is 1.0.
2213
2213
  wSides : int , optional
2214
- The desired number of sides along the Z-axis. The default is 1.
2214
+ The desired number of sides along the Z-axis. Default is 1.
2215
2215
  a : float , optional
2216
- The hortizontal thickness of the vertical arm of the L-shape. The default is 0.25.
2216
+ The hortizontal thickness of the vertical arm of the L-shape. Default is 0.25.
2217
2217
  b : float , optional
2218
- The vertical thickness of the horizontal arm of the L-shape. The default is 0.25.
2218
+ The vertical thickness of the horizontal arm of the L-shape. Default is 0.25.
2219
2219
  flipHorizontal : bool , optional
2220
- if set to True, the shape is flipped horizontally. The default is False.
2220
+ if set to True, the shape is flipped horizontally. Default is False.
2221
2221
  flipVertical : bool , optional
2222
- if set to True, the shape is flipped vertically. The default is False.
2222
+ if set to True, the shape is flipped vertically. Default is False.
2223
2223
  direction : list , optional
2224
- The vector representing the up direction of the L-shape. The default is [0, 0, 1].
2224
+ The vector representing the up direction of the L-shape. Default is [0, 0, 1].
2225
2225
  placement : str , optional
2226
- The description of the placement of the origin of the L-shape. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
2226
+ The description of the placement of the origin of the L-shape. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
2227
2227
  manitssa : int , optional
2228
- The desired length of the mantissa. The default is 6.
2228
+ The number of decimal places to round the result to. Default is 6.
2229
2229
  tolerance : float , optional
2230
- The desired tolerance. The default is 0.0001.
2230
+ The desired tolerance. Default is 0.0001.
2231
2231
  silent : bool , optional
2232
- If set to True, error and warning messages are suppressed. The default is False.
2232
+ If set to True, error and warning messages are suppressed. Default is False.
2233
2233
 
2234
2234
  Returns
2235
2235
  -------
@@ -2358,15 +2358,15 @@ class Cell():
2358
2358
  Parameters
2359
2359
  ----------
2360
2360
  origin : topologic_core.Vertex , optional
2361
- The origin location of the octahedron. The default is None which results in the octahedron being placed at (0, 0, 0).
2361
+ The origin location of the octahedron. Default is None which results in the octahedron being placed at (0, 0, 0).
2362
2362
  radius : float , optional
2363
- The radius of the octahedron's circumscribed sphere. The default is 0.5.
2363
+ The radius of the octahedron's circumscribed sphere. Default is 0.5.
2364
2364
  direction : list , optional
2365
- The vector representing the up direction of the octahedron. The default is [0, 0, 1].
2365
+ The vector representing the up direction of the octahedron. Default is [0, 0, 1].
2366
2366
  placement : str , optional
2367
- The description of the placement of the origin of the octahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
2367
+ The description of the placement of the origin of the octahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
2368
2368
  tolerance : float , optional
2369
- The desired tolerance. The default is 0.0001.
2369
+ The desired tolerance. Default is 0.0001.
2370
2370
 
2371
2371
  Returns
2372
2372
  -------
@@ -2420,29 +2420,29 @@ class Cell():
2420
2420
  Parameters
2421
2421
  ----------
2422
2422
  origin : topologic_core.Vertex , optional
2423
- The origin location of the parabolic surface. The default is None which results in the parabolic surface being placed at (0, 0, 0).
2423
+ The origin location of the parabolic surface. Default is None which results in the parabolic surface being placed at (0, 0, 0).
2424
2424
  focalLength : float , optional
2425
- The focal length of the parabola. The default is 0.125.
2425
+ The focal length of the parabola. Default is 0.125.
2426
2426
  width : float , optional
2427
- The width of the parabolic surface. The default is 1.
2427
+ The width of the parabolic surface. Default is 1.
2428
2428
  length : float , optional
2429
- The length of the parabolic surface. The default is 1.
2429
+ The length of the parabolic surface. Default is 1.
2430
2430
  height : float , optional
2431
- The additional height of the parabolic surface. Please note this is not the height from the spring point to the apex. It is in addition to that to form a base. The default is 0.
2431
+ The additional height of the parabolic surface. Please note this is not the height from the spring point to the apex. It is in addition to that to form a base. Default is 0.
2432
2432
  uSides : int , optional
2433
- The number of sides along the width. The default is 16.
2433
+ The number of sides along the width. Default is 16.
2434
2434
  vSides : int , optional
2435
- The number of sides along the length. The default is 16.
2435
+ The number of sides along the length. Default is 16.
2436
2436
  direction : list , optional
2437
- The vector representing the up direction of the parabolic surface. The default is [0, 0, 1].
2437
+ The vector representing the up direction of the parabolic surface. Default is [0, 0, 1].
2438
2438
  placement : str , optional
2439
- The description of the placement of the origin of the parabolic surface. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
2439
+ The description of the placement of the origin of the parabolic surface. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
2440
2440
  mantissa : int , optional
2441
- The desired length of the mantissa. The default is 6.
2441
+ The number of decimal places to round the result to. Default is 6.
2442
2442
  tolerance : float , optional
2443
- The desired tolerance. The default is 0.0001.
2443
+ The desired tolerance. Default is 0.0001.
2444
2444
  silent : bool , optional
2445
- If set to True, error and warning messages are suppressed. The default is False.
2445
+ If set to True, error and warning messages are suppressed. Default is False.
2446
2446
 
2447
2447
  Returns
2448
2448
  -------
@@ -2547,21 +2547,21 @@ class Cell():
2547
2547
  edge : topologic_core.Edge
2548
2548
  The centerline of the pipe.
2549
2549
  profile : topologic_core.Wire , optional
2550
- The profile of the pipe. It is assumed that the profile is in the XY plane. If set to None, a circle of radius 0.5 will be used. The default is None.
2550
+ The profile of the pipe. It is assumed that the profile is in the XY plane. If set to None, a circle of radius 0.5 will be used. Default is None.
2551
2551
  radius : float , optional
2552
- The radius of the pipe. The default is 0.5.
2552
+ The radius of the pipe. Default is 0.5.
2553
2553
  sides : int , optional
2554
- The number of sides of the pipe. The default is 16.
2554
+ The number of sides of the pipe. Default is 16.
2555
2555
  startOffset : float , optional
2556
- The offset distance from the start vertex of the centerline edge. The default is 0.
2556
+ The offset distance from the start vertex of the centerline edge. Default is 0.
2557
2557
  endOffset : float , optional
2558
- The offset distance from the end vertex of the centerline edge. The default is 0.
2558
+ The offset distance from the end vertex of the centerline edge. Default is 0.
2559
2559
  endcapA, optional
2560
2560
  The topology to place at the start vertex of the centerline edge. The positive Z direction of the end cap will be oriented in the direction of the centerline edge.
2561
2561
  endcapB, optional
2562
2562
  The topology to place at the end vertex of the centerline edge. The positive Z direction of the end cap will be oriented in the inverse direction of the centerline edge.
2563
2563
  mantissa : int , optional
2564
- The desired length of the mantissa. The default is 6
2564
+ The desired length of the mantissa. Default is 6
2565
2565
 
2566
2566
  Returns
2567
2567
  -------
@@ -2677,27 +2677,27 @@ class Cell():
2677
2677
  Parameters
2678
2678
  ----------
2679
2679
  origin : topologic_core.Vertex , optional
2680
- The origin location of the prism. The default is None which results in the prism being placed at (0, 0, 0).
2680
+ The origin location of the prism. Default is None which results in the prism being placed at (0, 0, 0).
2681
2681
  width : float , optional
2682
- The width of the prism. The default is 1.
2682
+ The width of the prism. Default is 1.
2683
2683
  length : float , optional
2684
- The length of the prism. The default is 1.
2684
+ The length of the prism. Default is 1.
2685
2685
  height : float , optional
2686
2686
  The height of the prism.
2687
2687
  uSides : int , optional
2688
- The number of sides along the width. The default is 1.
2688
+ The number of sides along the width. Default is 1.
2689
2689
  vSides : int , optional
2690
- The number of sides along the length. The default is 1.
2690
+ The number of sides along the length. Default is 1.
2691
2691
  wSides : int , optional
2692
- The number of sides along the height. The default is 1.
2692
+ The number of sides along the height. Default is 1.
2693
2693
  direction : list , optional
2694
- The vector representing the up direction of the prism. The default is [0, 0, 1].
2694
+ The vector representing the up direction of the prism. Default is [0, 0, 1].
2695
2695
  placement : str , optional
2696
- The description of the placement of the origin of the prism. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
2696
+ The description of the placement of the origin of the prism. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
2697
2697
  mantissa : int , optional
2698
- The desired length of the mantissa. The default is 6.
2698
+ The number of decimal places to round the result to. Default is 6.
2699
2699
  tolerance : float , optional
2700
- The desired tolerance. The default is 0.0001.
2700
+ The desired tolerance. Default is 0.0001.
2701
2701
 
2702
2702
  Returns
2703
2703
  -------
@@ -2771,11 +2771,11 @@ class Cell():
2771
2771
  cell : topologic_core.Cell
2772
2772
  The input cell.
2773
2773
  angTolerance : float , optional
2774
- The desired angular tolerance. The default is 0.1.
2774
+ The desired angular tolerance. Default is 0.1.
2775
2775
  tolerance : float , optional
2776
- The desired tolerance. The default is 0.0001.
2776
+ The desired tolerance. Default is 0.0001.
2777
2777
  silent : bool , optional
2778
- If set to True, error and warning messages are suppressed. The default is False.
2778
+ If set to True, error and warning messages are suppressed. Default is False.
2779
2779
 
2780
2780
  Returns
2781
2781
  -------
@@ -2808,29 +2808,29 @@ class Cell():
2808
2808
  Parameters
2809
2809
  ----------
2810
2810
  origin : topologic_core.Vertex, optional
2811
- The location of the origin of the RHS. The default is None which results in the RHS being placed at (0, 0, 0).
2811
+ The location of the origin of the RHS. Default is None which results in the RHS being placed at (0, 0, 0).
2812
2812
  width : float , optional
2813
- The width of the RHS. The default is 1.0.
2813
+ The width of the RHS. Default is 1.0.
2814
2814
  length : float , optional
2815
- The length of the RHS. The default is 1.0.
2815
+ The length of the RHS. Default is 1.0.
2816
2816
  thickness : float , optional
2817
- The thickness of the RHS. The default is 0.25.
2817
+ The thickness of the RHS. Default is 0.25.
2818
2818
  height : float , optional
2819
- The height of the RHS. The default is 1.0.
2819
+ The height of the RHS. Default is 1.0.
2820
2820
  outerFillet : float , optional
2821
- The outer fillet multiplication factor based on the thickness (e.g. 1t). The default is 0.
2821
+ The outer fillet multiplication factor based on the thickness (e.g. 1t). Default is 0.
2822
2822
  innerFillet : float , optional
2823
- The inner fillet multiplication factor based on the thickness (e.g. 1.5t). The default is 0.
2823
+ The inner fillet multiplication factor based on the thickness (e.g. 1.5t). Default is 0.
2824
2824
  sides : int , optional
2825
- The desired number of sides of the fillets. The default is 16.
2825
+ The desired number of sides of the fillets. Default is 16.
2826
2826
  direction : list , optional
2827
- The vector representing the up direction of the RHS. The default is [0, 0, 1].
2827
+ The vector representing the up direction of the RHS. Default is [0, 0, 1].
2828
2828
  placement : str , optional
2829
- The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
2829
+ The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
2830
2830
  tolerance : float , optional
2831
- The desired tolerance. The default is 0.0001.
2831
+ The desired tolerance. Default is 0.0001.
2832
2832
  silent : bool , optional
2833
- If set to True, error and warning messages are suppressed. The default is False.
2833
+ If set to True, error and warning messages are suppressed. Default is False.
2834
2834
 
2835
2835
  Returns
2836
2836
  -------
@@ -2907,11 +2907,11 @@ class Cell():
2907
2907
  face : topologic_core.Face
2908
2908
  The input face.
2909
2909
  angle : float , optional
2910
- The desired angle in degrees of the roof. The default is 45.
2910
+ The desired angle in degrees of the roof. Default is 45.
2911
2911
  epsilon : float , optional
2912
- The desired epsilon (another form of tolerance for distance from plane). The default is 0.01. (This is set to a larger number as it was found to work better)
2912
+ The desired epsilon (another form of tolerance for distance from plane). Default is 0.01. (This is set to a larger number as it was found to work better)
2913
2913
  tolerance : float , optional
2914
- The desired tolerance. The default is 0.001. (This is set to a larger number as it was found to work better)
2914
+ The desired tolerance. Default is 0.001. (This is set to a larger number as it was found to work better)
2915
2915
 
2916
2916
  Returns
2917
2917
  -------
@@ -2946,7 +2946,7 @@ class Cell():
2946
2946
  superCells : list
2947
2947
  The list of super cells.
2948
2948
  tolerance : float , optional
2949
- The desired tolerance. The default is 0.0001.
2949
+ The desired tolerance. Default is 0.0001.
2950
2950
 
2951
2951
  Returns
2952
2952
  -------
@@ -3027,29 +3027,29 @@ class Cell():
3027
3027
  Parameters
3028
3028
  ----------
3029
3029
  origin : topologic_core.Vertex, optional
3030
- The location of the origin of the SHS. The default is None which results in the SHS being placed at (0, 0, 0).
3030
+ The location of the origin of the SHS. Default is None which results in the SHS being placed at (0, 0, 0).
3031
3031
  size : float , optional
3032
- The size of the SHS. The default is 1.0.
3032
+ The size of the SHS. Default is 1.0.
3033
3033
  length : float , optional
3034
- The length of the SHS. The default is 1.0.
3034
+ The length of the SHS. Default is 1.0.
3035
3035
  thickness : float , optional
3036
- The thickness of the SHS. The default is 0.25.
3036
+ The thickness of the SHS. Default is 0.25.
3037
3037
  height : float , optional
3038
- The height of the SHS. The default is 1.0.
3038
+ The height of the SHS. Default is 1.0.
3039
3039
  outerFillet : float , optional
3040
- The outer fillet multiplication factor based on the thickness (e.g. 1t). The default is 0.
3040
+ The outer fillet multiplication factor based on the thickness (e.g. 1t). Default is 0.
3041
3041
  innerFillet : float , optional
3042
- The inner fillet multiplication factor based on the thickness (e.g. 1.5t). The default is 0.
3042
+ The inner fillet multiplication factor based on the thickness (e.g. 1.5t). Default is 0.
3043
3043
  sides : int , optional
3044
- The desired number of sides of the fillets. The default is 16.
3044
+ The desired number of sides of the fillets. Default is 16.
3045
3045
  direction : list , optional
3046
- The vector representing the up direction of the SHS. The default is [0, 0, 1].
3046
+ The vector representing the up direction of the SHS. Default is [0, 0, 1].
3047
3047
  placement : str , optional
3048
- The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3048
+ The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3049
3049
  tolerance : float , optional
3050
- The desired tolerance. The default is 0.0001.
3050
+ The desired tolerance. Default is 0.0001.
3051
3051
  silent : bool , optional
3052
- If set to True, error and warning messages are suppressed. The default is False.
3052
+ If set to True, error and warning messages are suppressed. Default is False.
3053
3053
 
3054
3054
  Returns
3055
3055
  -------
@@ -3098,19 +3098,19 @@ class Cell():
3098
3098
  Parameters
3099
3099
  ----------
3100
3100
  origin : topologic_core.Vertex , optional
3101
- The origin location of the sphere. The default is None which results in the sphere being placed at (0, 0, 0).
3101
+ The origin location of the sphere. Default is None which results in the sphere being placed at (0, 0, 0).
3102
3102
  radius : float , optional
3103
- The radius of the sphere. The default is 0.5.
3103
+ The radius of the sphere. Default is 0.5.
3104
3104
  uSides : int , optional
3105
- The number of sides along the longitude of the sphere. The default is 16.
3105
+ The number of sides along the longitude of the sphere. Default is 16.
3106
3106
  vSides : int , optional
3107
- The number of sides along the latitude of the sphere. The default is 8.
3107
+ The number of sides along the latitude of the sphere. Default is 8.
3108
3108
  direction : list , optional
3109
- The vector representing the up direction of the sphere. The default is [0, 0, 1].
3109
+ The vector representing the up direction of the sphere. Default is [0, 0, 1].
3110
3110
  placement : str , optional
3111
- The description of the placement of the origin of the sphere. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
3111
+ The description of the placement of the origin of the sphere. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
3112
3112
  tolerance : float , optional
3113
- The desired tolerance. The default is 0.0001.
3113
+ The desired tolerance. Default is 0.0001.
3114
3114
 
3115
3115
  Returns
3116
3116
  -------
@@ -3154,7 +3154,7 @@ class Cell():
3154
3154
  cell : topologic_core.Cell
3155
3155
  The cell.
3156
3156
  mantissa : int , optional
3157
- The desired length of the mantissa. The default is 6.
3157
+ The number of decimal places to round the result to. Default is 6.
3158
3158
 
3159
3159
  Returns
3160
3160
  -------
@@ -3172,19 +3172,19 @@ class Cell():
3172
3172
  Parameters
3173
3173
  ----------
3174
3174
  origin : topologic_core.Vertex , optional
3175
- The origin location of the tetrahedron. The default is None which results in the tetrahedron being placed at (0, 0, 0).
3175
+ The origin location of the tetrahedron. Default is None which results in the tetrahedron being placed at (0, 0, 0).
3176
3176
  length : float , optional
3177
- The length of the edge of the tetrahedron. The default is 1.
3177
+ The length of the edge of the tetrahedron. Default is 1.
3178
3178
  depth : int , optional
3179
3179
  The desired maximum number of recrusive subdivision levels.
3180
3180
  direction : list , optional
3181
- The vector representing the up direction of the tetrahedron. The default is [0, 0, 1].
3181
+ The vector representing the up direction of the tetrahedron. Default is [0, 0, 1].
3182
3182
  placement : str , optional
3183
- The description of the placement of the origin of the tetrahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
3183
+ The description of the placement of the origin of the tetrahedron. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
3184
3184
  mantissa : int , optional
3185
- The desired length of the mantissa. The default is 6.
3185
+ The number of decimal places to round the result to. Default is 6.
3186
3186
  tolerance : float , optional
3187
- The desired tolerance. The default is 0.0001.
3187
+ The desired tolerance. Default is 0.0001.
3188
3188
 
3189
3189
  Returns
3190
3190
  -------
@@ -3322,21 +3322,21 @@ class Cell():
3322
3322
  Parameters
3323
3323
  ----------
3324
3324
  origin : topologic_core.Vertex , optional
3325
- The origin location of the torus. The default is None which results in the torus being placed at (0, 0, 0).
3325
+ The origin location of the torus. Default is None which results in the torus being placed at (0, 0, 0).
3326
3326
  majorRadius : float , optional
3327
- The major radius of the torus. The default is 0.5.
3327
+ The major radius of the torus. Default is 0.5.
3328
3328
  minorRadius : float , optional
3329
- The minor radius of the torus. The default is 0.1.
3329
+ The minor radius of the torus. Default is 0.1.
3330
3330
  uSides : int , optional
3331
- The number of sides along the longitude of the torus. The default is 16.
3331
+ The number of sides along the longitude of the torus. Default is 16.
3332
3332
  vSides : int , optional
3333
- The number of sides along the latitude of the torus. The default is 8.
3333
+ The number of sides along the latitude of the torus. Default is 8.
3334
3334
  direction : list , optional
3335
- The vector representing the up direction of the torus. The default is [0, 0, 1].
3335
+ The vector representing the up direction of the torus. Default is [0, 0, 1].
3336
3336
  placement : str , optional
3337
- The description of the placement of the origin of the torus. This can be "bottom", "center", or "lowerleft". It is case insensitive. The default is "center".
3337
+ The description of the placement of the origin of the torus. This can be "bottom", "center", or "lowerleft". It is case insensitive. Default is "center".
3338
3338
  tolerance : float , optional
3339
- The desired tolerance. The default is 0.0001.
3339
+ The desired tolerance. Default is 0.0001.
3340
3340
 
3341
3341
  Returns
3342
3342
  -------
@@ -3389,33 +3389,33 @@ class Cell():
3389
3389
  Parameters
3390
3390
  ----------
3391
3391
  origin : topologic_core.Vertex , optional
3392
- The location of the origin of the T-shape. The default is None which results in the T-shape being placed at (0, 0, 0).
3392
+ The location of the origin of the T-shape. Default is None which results in the T-shape being placed at (0, 0, 0).
3393
3393
  width : float , optional
3394
- The overall width of the T-shape. The default is 1.0.
3394
+ The overall width of the T-shape. Default is 1.0.
3395
3395
  length : float , optional
3396
- The overall length of the T-shape. The default is 1.0.
3396
+ The overall length of the T-shape. Default is 1.0.
3397
3397
  height : float , optional
3398
- the overall height of the T-shape. The default is 1.0.
3398
+ the overall height of the T-shape. Default is 1.0.
3399
3399
  wSides : int , optional
3400
- The desired number of sides along the Z-axis. The default is 1.
3400
+ The desired number of sides along the Z-axis. Default is 1.
3401
3401
  a : float , optional
3402
- The hortizontal thickness of the vertical arm of the T-shape. The default is 0.25.
3402
+ The hortizontal thickness of the vertical arm of the T-shape. Default is 0.25.
3403
3403
  b : float , optional
3404
- The vertical thickness of the horizontal arm of the T-shape. The default is 0.25.
3404
+ The vertical thickness of the horizontal arm of the T-shape. Default is 0.25.
3405
3405
  flipHorizontal : bool , optional
3406
- if set to True, the shape is flipped horizontally. The default is False.
3406
+ if set to True, the shape is flipped horizontally. Default is False.
3407
3407
  flipVertical : bool , optional
3408
- if set to True, the shape is flipped vertically. The default is False.
3408
+ if set to True, the shape is flipped vertically. Default is False.
3409
3409
  direction : list , optional
3410
- The vector representing the up direction of the T-shape. The default is [0, 0, 1].
3410
+ The vector representing the up direction of the T-shape. Default is [0, 0, 1].
3411
3411
  placement : str , optional
3412
- The description of the placement of the origin of the T-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3412
+ The description of the placement of the origin of the T-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3413
3413
  mantissa: int , optional
3414
- The desired length of the mantissa. The default is 6.
3414
+ The number of decimal places to round the result to. Default is 6.
3415
3415
  tolerance : float , optional
3416
- The desired tolerance. The default is 0.0001.
3416
+ The desired tolerance. Default is 0.0001.
3417
3417
  silent : bool , optional
3418
- If set to True, error and warning messages are suppressed. The default is False.
3418
+ If set to True, error and warning messages are suppressed. Default is False.
3419
3419
 
3420
3420
  Returns
3421
3421
  -------
@@ -3538,23 +3538,23 @@ class Cell():
3538
3538
  Parameters
3539
3539
  ----------
3540
3540
  origin : topologic_core.Vertex, optional
3541
- The location of the origin of the CHS. The default is None which results in the CHS being placed at (0, 0, 0).
3541
+ The location of the origin of the CHS. Default is None which results in the CHS being placed at (0, 0, 0).
3542
3542
  radius : float , optional
3543
- The outer radius of the CHS. The default is 1.0.
3543
+ The outer radius of the CHS. Default is 1.0.
3544
3544
  thickness : float , optional
3545
- The thickness of the CHS. The default is 0.25.
3545
+ The thickness of the CHS. Default is 0.25.
3546
3546
  height : float , optional
3547
- The height of the CHS. The default is 1.0.
3547
+ The height of the CHS. Default is 1.0.
3548
3548
  sides : int , optional
3549
- The desired number of sides of the CSH. The default is 16.
3549
+ The desired number of sides of the CSH. Default is 16.
3550
3550
  direction : list , optional
3551
- The vector representing the up direction of the RHS. The default is [0, 0, 1].
3551
+ The vector representing the up direction of the RHS. Default is [0, 0, 1].
3552
3552
  placement : str , optional
3553
- The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3553
+ The description of the placement of the origin of the RHS. This can be "center", "bottom", "top", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3554
3554
  tolerance : float , optional
3555
- The desired tolerance. The default is 0.0001.
3555
+ The desired tolerance. Default is 0.0001.
3556
3556
  silent : bool , optional
3557
- If set to True, error and warning messages are suppressed. The default is False.
3557
+ If set to True, error and warning messages are suppressed. Default is False.
3558
3558
 
3559
3559
  Returns
3560
3560
  -------
@@ -3617,7 +3617,7 @@ class Cell():
3617
3617
  cell : topologic_core.Cell
3618
3618
  The input cell.
3619
3619
  manitssa: int , optional
3620
- The desired length of the mantissa. The default is 6.
3620
+ The number of decimal places to round the result to. Default is 6.
3621
3621
 
3622
3622
  Returns
3623
3623
  -------
@@ -3655,21 +3655,21 @@ class Cell():
3655
3655
  Parameters
3656
3656
  ----------
3657
3657
  origin : topologic_core.Vertex , optional
3658
- The location of the origin of the Wedge. The default is None which results in the Wedge being placed at (0, 0, 0).
3658
+ The location of the origin of the Wedge. Default is None which results in the Wedge being placed at (0, 0, 0).
3659
3659
  width : float , optional
3660
- The overall width of the Wedge. The default is 1.0.
3660
+ The overall width of the Wedge. Default is 1.0.
3661
3661
  length : float , optional
3662
- The overall length of the Wedge. The default is 1.0.
3662
+ The overall length of the Wedge. Default is 1.0.
3663
3663
  height : float , optional
3664
- The overall height of the Wedge. The default is 1.0.
3664
+ The overall height of the Wedge. Default is 1.0.
3665
3665
  direction : list , optional
3666
- The vector representing the up direction of the Wedge. The default is [0, 0, 1].
3666
+ The vector representing the up direction of the Wedge. Default is [0, 0, 1].
3667
3667
  placement : str , optional
3668
- The description of the placement of the origin of the Wedge. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3668
+ The description of the placement of the origin of the Wedge. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3669
3669
  tolerance : float , optional
3670
- The desired tolerance. The default is 0.0001.
3670
+ The desired tolerance. Default is 0.0001.
3671
3671
  silent : bool , optional
3672
- If set to True, error and warning messages are suppressed. The default is False.
3672
+ If set to True, error and warning messages are suppressed. Default is False.
3673
3673
 
3674
3674
  Returns
3675
3675
  -------