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.
Files changed (34) hide show
  1. topologicpy/ANN.py +19 -19
  2. topologicpy/BVH.py +5 -5
  3. topologicpy/CSG.py +17 -17
  4. topologicpy/Cell.py +295 -295
  5. topologicpy/CellComplex.py +214 -67
  6. topologicpy/Cluster.py +35 -35
  7. topologicpy/Color.py +8 -8
  8. topologicpy/DGL.py +52 -52
  9. topologicpy/Dictionary.py +22 -22
  10. topologicpy/Edge.py +77 -77
  11. topologicpy/EnergyModel.py +25 -25
  12. topologicpy/Face.py +270 -270
  13. topologicpy/Graph.py +1052 -675
  14. topologicpy/Grid.py +24 -24
  15. topologicpy/Helper.py +8 -8
  16. topologicpy/Honeybee.py +13 -13
  17. topologicpy/Matrix.py +11 -11
  18. topologicpy/Neo4j.py +21 -21
  19. topologicpy/Plotly.py +213 -213
  20. topologicpy/PyG.py +41 -41
  21. topologicpy/ShapeGrammar.py +7 -7
  22. topologicpy/Shell.py +104 -104
  23. topologicpy/Sun.py +46 -46
  24. topologicpy/Topology.py +392 -392
  25. topologicpy/Vector.py +25 -25
  26. topologicpy/Vertex.py +64 -64
  27. topologicpy/Wire.py +264 -250
  28. topologicpy/version.py +1 -1
  29. {topologicpy-0.8.46.dist-info → topologicpy-0.8.48.dist-info}/METADATA +1 -1
  30. topologicpy-0.8.48.dist-info/RECORD +38 -0
  31. topologicpy-0.8.46.dist-info/RECORD +0 -38
  32. {topologicpy-0.8.46.dist-info → topologicpy-0.8.48.dist-info}/WHEEL +0 -0
  33. {topologicpy-0.8.46.dist-info → topologicpy-0.8.48.dist-info}/licenses/LICENSE +0 -0
  34. {topologicpy-0.8.46.dist-info → topologicpy-0.8.48.dist-info}/top_level.txt +0 -0
topologicpy/Wire.py CHANGED
@@ -36,13 +36,13 @@ class Wire():
36
36
  endVertex : topologic_core.Vertex
37
37
  The end vertex of the arc.
38
38
  sides : int , optional
39
- The number of sides of the arc. The default is 16.
39
+ The number of sides of the arc. Default is 16.
40
40
  close : bool , optional
41
41
  If set to True, the arc will be closed by connecting the last vertex to the first vertex. Otherwise, it will be left open.
42
42
  tolerance : float , optional
43
- The desired tolerance. The default is 0.0001.
43
+ The desired tolerance. Default is 0.0001.
44
44
  silent : bool , optional
45
- If set to True, error and warning messages are suppressed. The default is False.
45
+ If set to True, error and warning messages are suppressed. Default is False.
46
46
 
47
47
  Returns
48
48
  -------
@@ -162,18 +162,18 @@ class Wire():
162
162
  edge : topologic_core.Edge
163
163
  The location of the start vertex of the arc.
164
164
  sagitta : float , optional
165
- The length of the sagitta. In mathematics, the sagitta is the line connecting the center of a chord to the apex (or highest point) of the arc subtended by that chord. The default is 1.
165
+ The length of the sagitta. In mathematics, the sagitta is the line connecting the center of a chord to the apex (or highest point) of the arc subtended by that chord. Default is 1.
166
166
  absolute : bool , optional
167
167
  If set to True, the sagitta length is treated as an absolute value. Otherwise, it is treated as a ratio based on the length of the edge.
168
- For example, if the length of the edge is 10, the sagitta is set to 0.5, and absolute is set to False, the sagitta length will be 5. The default is True.
168
+ For example, if the length of the edge is 10, the sagitta is set to 0.5, and absolute is set to False, the sagitta length will be 5. Default is True.
169
169
  sides : int , optional
170
- The number of sides of the arc. The default is 16.
170
+ The number of sides of the arc. Default is 16.
171
171
  close : bool , optional
172
172
  If set to True, the arc will be closed by connecting the last vertex to the first vertex. Otherwise, it will be left open.
173
173
  tolerance : float , optional
174
- The desired tolerance. The default is 0.0001.
174
+ The desired tolerance. Default is 0.0001.
175
175
  silent : bool , optional
176
- If set to True, error and warning messages are suppressed. The default is False.
176
+ If set to True, error and warning messages are suppressed. Default is False.
177
177
 
178
178
  Returns
179
179
  -------
@@ -218,13 +218,13 @@ class Wire():
218
218
  optimize : int , optional
219
219
  If set to an integer from 1 (low optimization) to 10 (high optimization), the method will attempt to optimize the bounding rectangle so that it reduces its surface area.
220
220
  The minimum optimization number of 0 will result in an axis-aligned bounding rectangle.
221
- A maximum optimization number of 10 will attempt to reduce the bounding rectangle's area by 50%. The default is 0.
221
+ A maximum optimization number of 10 will attempt to reduce the bounding rectangle's area by 50%. Default is 0.
222
222
  mantissa : int , optional
223
- The desired length of the mantissa. The default is 6.
223
+ The number of decimal places to round the result to. Default is 6.
224
224
  tolerance : float , optional
225
- The desired tolerance. The default is 0.0001.
225
+ The desired tolerance. Default is 0.0001.
226
226
  silent : bool , optional
227
- If set to True, error and warning messages are suppressed. The default is False.
227
+ If set to True, error and warning messages are suppressed. Default is False.
228
228
 
229
229
  Returns
230
230
  -------
@@ -354,11 +354,11 @@ class Wire():
354
354
  edges : list
355
355
  The input list of edges.
356
356
  orient : bool , optional
357
- If set to True the edges are oriented head to tail. Otherwise, they are not. The default is False.
357
+ If set to True the edges are oriented head to tail. Otherwise, they are not. Default is False.
358
358
  tolerance : float , optional
359
- The desired tolerance. The default is 0.0001.
359
+ The desired tolerance. Default is 0.0001.
360
360
  silent : bool , optional
361
- If set to True, error and warning messages are suppressed. The default is False.
361
+ If set to True, error and warning messages are suppressed. Default is False.
362
362
 
363
363
  Returns
364
364
  -------
@@ -399,7 +399,7 @@ class Wire():
399
399
  cluster : topologic_core.Cluster
400
400
  The input cluster of edges.
401
401
  tolerance : float , optional
402
- The desired tolerance. The default is 0.0001.
402
+ The desired tolerance. Default is 0.0001.
403
403
 
404
404
  Returns
405
405
  -------
@@ -424,29 +424,29 @@ class Wire():
424
424
  wire : topologic_core.Wire
425
425
  The input wire.
426
426
  offset : float , optional
427
- The desired offset distance. The default is 1.0.
427
+ The desired offset distance. Default is 1.0.
428
428
  offsetKey : str , optional
429
- The edge dictionary key under which to find the offset value. If a value cannot be found, the offset input parameter value is used instead. The default is "offset".
429
+ The edge dictionary key under which to find the offset value. If a value cannot be found, the offset input parameter value is used instead. Default is "offset".
430
430
  stepOffsetA : float , optional
431
- The amount to offset along the previous edge when transitioning between parallel edges with different offsets. The default is 0.
431
+ The amount to offset along the previous edge when transitioning between parallel edges with different offsets. Default is 0.
432
432
  stepOffsetB : float , optional
433
- The amount to offset along the next edge when transitioning between parallel edges with different offsets. The default is 0.
433
+ The amount to offset along the next edge when transitioning between parallel edges with different offsets. Default is 0.
434
434
  stepOffsetKeyA : str , optional
435
- The vertex dictionary key under which to find the step offset A value. If a value cannot be found, the stepOffsetA input parameter value is used instead. The default is "stepOffsetA".
435
+ The vertex dictionary key under which to find the step offset A value. If a value cannot be found, the stepOffsetA input parameter value is used instead. Default is "stepOffsetA".
436
436
  stepOffsetKeyB : str , optional
437
- The vertex dictionary key under which to find the step offset B value. If a value cannot be found, the stepOffsetB input parameter value is used instead. The default is "stepOffsetB".
437
+ The vertex dictionary key under which to find the step offset B value. If a value cannot be found, the stepOffsetB input parameter value is used instead. Default is "stepOffsetB".
438
438
  reverse : bool , optional
439
- If set to True, the direction of offsets is reversed. Otherwise, it is not. The default is False.
439
+ If set to True, the direction of offsets is reversed. Otherwise, it is not. Default is False.
440
440
  bisectors : bool , optional
441
- If set to True, The bisectors (seams) edges will be included in the returned wire. The default is False.
441
+ If set to True, The bisectors (seams) edges will be included in the returned wire. Default is False.
442
442
  transferDictionaries : bool , optional
443
- If set to True, the dictionaries of the original wire, its edges, and its vertices are transfered to the new wire. Otherwise, they are not. The default is False.
443
+ If set to True, the dictionaries of the original wire, its edges, and its vertices are transfered to the new wire. Otherwise, they are not. Default is False.
444
444
  epsilon : float , optional
445
- The desired epsilon (another form of tolerance for shortest edge to remove). The default is 0.01. (This is set to a larger number as it was found to work better)
445
+ The desired epsilon (another form of tolerance for shortest edge to remove). Default is 0.01. (This is set to a larger number as it was found to work better)
446
446
  tolerance : float , optional
447
- The desired tolerance. The default is 0.0001.
447
+ The desired tolerance. Default is 0.0001.
448
448
  silent : bool , optional
449
- If set to True, error and warning messages are suppressed. The default is False.
449
+ If set to True, error and warning messages are suppressed. Default is False.
450
450
  numWorkers : int , optional
451
451
  Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
452
452
  The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
@@ -682,21 +682,21 @@ class Wire():
682
682
  area : float
683
683
  The desired area of the created wire.
684
684
  offsetKey : str , optional
685
- The edge dictionary key under which to store the offset value. The default is "offset".
685
+ The edge dictionary key under which to store the offset value. Default is "offset".
686
686
  minOffsetKey : str , optional
687
- The edge dictionary key under which to find the desired minimum edge offset value. If a value cannot be found, the defaultMinOffset input parameter value is used instead. The default is "minOffset".
687
+ The edge dictionary key under which to find the desired minimum edge offset value. If a value cannot be found, the defaultMinOffset input parameter value is used instead. Default is "minOffset".
688
688
  maxOffsetKey : str , optional
689
- The edge dictionary key under which to find the desired maximum edge offset value. If a value cannot be found, the defaultMaxOffset input parameter value is used instead. The default is "maxOffset".
689
+ The edge dictionary key under which to find the desired maximum edge offset value. If a value cannot be found, the defaultMaxOffset input parameter value is used instead. Default is "maxOffset".
690
690
  defaultMinOffset : float , optional
691
- The desired minimum edge offset distance. The default is 0.
691
+ The desired minimum edge offset distance. Default is 0.
692
692
  defaultMaxOffset : float , optional
693
- The desired maximum edge offset distance. The default is 1.
693
+ The desired maximum edge offset distance. Default is 1.
694
694
  maxIterations: int , optional
695
- The desired maximum number of iterations to attempt to converge on a solution. The default is 1.
695
+ The desired maximum number of iterations to attempt to converge on a solution. Default is 1.
696
696
  tolerance : float , optional
697
- The desired tolerance. The default is 0.0001.
697
+ The desired tolerance. Default is 0.0001.
698
698
  silent : bool , optional
699
- If set to True, error and warning messages are suppressed. The default is False.
699
+ If set to True, error and warning messages are suppressed. Default is False.
700
700
  numWorkers : int , optional
701
701
  Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
702
702
  The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
@@ -834,11 +834,11 @@ class Wire():
834
834
  vertices : list
835
835
  the input list of vertices.
836
836
  close : bool , optional
837
- If True the last vertex will be connected to the first vertex to close the wire. The default is True.
837
+ If True the last vertex will be connected to the first vertex to close the wire. Default is True.
838
838
  tolerance : float , optional
839
- The desired tolerance. The default is 0.0001.
839
+ The desired tolerance. Default is 0.0001.
840
840
  silent : bool , optional
841
- If set to True, error and warning messages are suppressed. The default is False.
841
+ If set to True, error and warning messages are suppressed. Default is False.
842
842
 
843
843
  Returns
844
844
  -------
@@ -870,6 +870,7 @@ class Wire():
870
870
  edges.append(e)
871
871
  else:
872
872
  if not silent:
873
+ print("Wire.ByVertices - Warning: Degenerate edge. Skipping.")
873
874
  curframe = inspect.currentframe()
874
875
  calframe = inspect.getouterframes(curframe, 2)
875
876
  print('caller name:', calframe[1][3])
@@ -885,6 +886,7 @@ class Wire():
885
886
  curframe = inspect.currentframe()
886
887
  calframe = inspect.getouterframes(curframe, 2)
887
888
  print('caller name:', calframe[1][3])
889
+
888
890
  if len(edges) < 1:
889
891
  if not silent:
890
892
  print("Wire.ByVertices - Error: The number of edges is less than 1. Returning None.")
@@ -893,9 +895,21 @@ class Wire():
893
895
  print('caller name:', calframe[1][3])
894
896
  return None
895
897
  elif len(edges) == 1:
898
+ if not silent:
899
+ print("Wire.ByVertices - Warning: The wire is made of only one edge.")
896
900
  wire = Wire.ByEdges(edges, orient=False, silent=silent)
897
901
  else:
898
902
  wire = Topology.SelfMerge(Cluster.ByTopologies(edges), tolerance=tolerance)
903
+ if Topology.IsInstance(wire, "Edge"):
904
+ wire = Wire.ByEdges([wire], orient=False, silent=silent)
905
+ # Final Check
906
+ if not Topology.IsInstance(wire, "Wire"):
907
+ if not silent:
908
+ print("Wire.ByVertices - Error: Could not create a wire. Returning None.")
909
+ curframe = inspect.currentframe()
910
+ calframe = inspect.getouterframes(curframe, 2)
911
+ print('caller name:', calframe[1][3])
912
+ return None
899
913
  return wire
900
914
 
901
915
  @staticmethod
@@ -908,11 +922,11 @@ class Wire():
908
922
  cluster : topologic_core.cluster
909
923
  the input cluster of vertices.
910
924
  close : bool , optional
911
- If True the last vertex will be connected to the first vertex to close the wire. The default is True.
925
+ If True the last vertex will be connected to the first vertex to close the wire. Default is True.
912
926
  tolerance : float , optional
913
- The desired tolerance. The default is 0.0001
927
+ The desired tolerance. Default is 0.0001
914
928
  silent : bool , optional
915
- If set to True, error and warning messages are suppressed. The default is False.
929
+ If set to True, error and warning messages are suppressed. Default is False.
916
930
 
917
931
  Returns
918
932
  -------
@@ -937,23 +951,23 @@ class Wire():
937
951
  Parameters
938
952
  ----------
939
953
  origin : topologic_core.Vertex , optional
940
- The location of the origin of the circle. The default is None which results in the circle being placed at (0, 0, 0).
954
+ The location of the origin of the circle. Default is None which results in the circle being placed at (0, 0, 0).
941
955
  radius : float , optional
942
- The radius of the circle. The default is 0.5.
956
+ The radius of the circle. Default is 0.5.
943
957
  sides : int , optional
944
- The desired number of sides of the circle. The default is 16.
958
+ The desired number of sides of the circle. Default is 16.
945
959
  fromAngle : float , optional
946
- The angle in degrees from which to start creating the arc of the circle. The default is 0.
960
+ The angle in degrees from which to start creating the arc of the circle. Default is 0.
947
961
  toAngle : float , optional
948
- The angle in degrees at which to end creating the arc of the circle. The default is 360.
962
+ The angle in degrees at which to end creating the arc of the circle. Default is 360.
949
963
  close : bool , optional
950
964
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
951
965
  direction : list , optional
952
- The vector representing the up direction of the circle. The default is [0, 0, 1].
966
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
953
967
  placement : str , optional
954
- The description of the placement of the origin of the circle. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. The default is "center".
968
+ The description of the placement of the origin of the circle. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. Default is "center".
955
969
  tolerance : float , optional
956
- The desired tolerance. The default is 0.0001.
970
+ The desired tolerance. Default is 0.0001.
957
971
 
958
972
  Returns
959
973
  -------
@@ -1028,9 +1042,9 @@ class Wire():
1028
1042
  wire : topologic_core.Wire
1029
1043
  The input wire.
1030
1044
  mantissa : int , optional
1031
- The desired length of the mantissa. The default is 6.
1045
+ The number of decimal places to round the result to. Default is 6.
1032
1046
  tolerance : float , optional
1033
- The desired tolerance. The default is 0.0001.
1047
+ The desired tolerance. Default is 0.0001.
1034
1048
 
1035
1049
  Returns
1036
1050
  -------
@@ -1098,11 +1112,11 @@ class Wire():
1098
1112
  k : int, optional
1099
1113
  The number of nearest neighbors to consider for each point when building the hull.
1100
1114
  Must be at least 3 for the algorithm to function correctly. Increasing `k` will produce a smoother,
1101
- less concave hull, while decreasing `k` may yield a more detailed, concave shape. The default is 3.
1115
+ less concave hull, while decreasing `k` may yield a more detailed, concave shape. Default is 3.
1102
1116
  mantissa : int , optional
1103
- The desired length of the mantissa. The default is 6.
1117
+ The number of decimal places to round the result to. Default is 6.
1104
1118
  tolerance : float , optional
1105
- The desired tolerance. The default is 0.0001.
1119
+ The desired tolerance. Default is 0.0001.
1106
1120
 
1107
1121
  Returns
1108
1122
  -------
@@ -1309,9 +1323,9 @@ class Wire():
1309
1323
  topology : topologic_core.Topology
1310
1324
  The input topology.
1311
1325
  mantissa : int , optional
1312
- The desired length of the mantissa. The default is 6.
1326
+ The number of decimal places to round the result to. Default is 6.
1313
1327
  tolerance : float , optional
1314
- The desired tolerance. The default is 0.0001.
1328
+ The desired tolerance. Default is 0.0001.
1315
1329
 
1316
1330
  Returns
1317
1331
  -------
@@ -1453,27 +1467,27 @@ class Wire():
1453
1467
  Parameters
1454
1468
  ----------
1455
1469
  origin : topologic_core.Vertex , optional
1456
- 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).
1470
+ The location of the origin of the T-shape. Default is None which results in the Cross-shape being placed at (0, 0, 0).
1457
1471
  width : float , optional
1458
- The overall width of the Cross-shape. The default is 1.0.
1472
+ The overall width of the Cross-shape. Default is 1.0.
1459
1473
  length : float , optional
1460
- The overall length of the Cross-shape. The default is 1.0.
1474
+ The overall length of the Cross-shape. Default is 1.0.
1461
1475
  a : float , optional
1462
- The hortizontal thickness of the vertical arm of the Cross-shape. The default is 0.25.
1476
+ The hortizontal thickness of the vertical arm of the Cross-shape. Default is 0.25.
1463
1477
  b : float , optional
1464
- The vertical thickness of the horizontal arm of the Cross-shape. The default is 0.25.
1478
+ The vertical thickness of the horizontal arm of the Cross-shape. Default is 0.25.
1465
1479
  c : float , optional
1466
- 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.
1480
+ 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.
1467
1481
  d : float , optional
1468
- 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.
1482
+ 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.
1469
1483
  direction : list , optional
1470
- The vector representing the up direction of the Cross-shape. The default is [0, 0, 1].
1484
+ The vector representing the up direction of the Cross-shape. Default is [0, 0, 1].
1471
1485
  placement : str , optional
1472
- 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".
1486
+ 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".
1473
1487
  tolerance : float , optional
1474
- The desired tolerance. The default is 0.0001.
1488
+ The desired tolerance. Default is 0.0001.
1475
1489
  silent : bool , optional
1476
- If set to True, error and warning messages are suppressed. The default is False.
1490
+ If set to True, error and warning messages are suppressed. Default is False.
1477
1491
 
1478
1492
  Returns
1479
1493
  -------
@@ -1639,25 +1653,25 @@ class Wire():
1639
1653
  Parameters
1640
1654
  ----------
1641
1655
  origin : topologic_core.Vertex , optional
1642
- 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).
1656
+ The location of the origin of the C-shape. Default is None which results in the C-shape being placed at (0, 0, 0).
1643
1657
  width : float , optional
1644
- The overall width of the C-shape. The default is 1.0.
1658
+ The overall width of the C-shape. Default is 1.0.
1645
1659
  length : float , optional
1646
- The overall length of the C-shape. The default is 1.0.
1660
+ The overall length of the C-shape. Default is 1.0.
1647
1661
  a : float , optional
1648
- The hortizontal thickness of the vertical arm of the C-shape. The default is 0.25.
1662
+ The hortizontal thickness of the vertical arm of the C-shape. Default is 0.25.
1649
1663
  b : float , optional
1650
- The vertical thickness of the lower horizontal arm of the C-shape. The default is 0.25.
1664
+ The vertical thickness of the lower horizontal arm of the C-shape. Default is 0.25.
1651
1665
  c : float , optional
1652
- The vertical thickness of the upper horizontal arm of the C-shape. The default is 0.25.
1666
+ The vertical thickness of the upper horizontal arm of the C-shape. Default is 0.25.
1653
1667
  direction : list , optional
1654
- The vector representing the up direction of the C-shape. The default is [0, 0, 1].
1668
+ The vector representing the up direction of the C-shape. Default is [0, 0, 1].
1655
1669
  placement : str , optional
1656
- 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".
1670
+ 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".
1657
1671
  tolerance : float , optional
1658
- The desired tolerance. The default is 0.0001.
1672
+ The desired tolerance. Default is 0.0001.
1659
1673
  silent : bool , optional
1660
- If set to True, error and warning messages are suppressed. The default is False.
1674
+ If set to True, error and warning messages are suppressed. Default is False.
1661
1675
 
1662
1676
  Returns
1663
1677
  -------
@@ -1779,9 +1793,9 @@ class Wire():
1779
1793
  wire : topologic_core.Wire
1780
1794
  The input wire.
1781
1795
  maxVertices : int , optional
1782
- The maximum number of vertices of the circuits to be searched. The default is 4.
1796
+ The maximum number of vertices of the circuits to be searched. Default is 4.
1783
1797
  tolerance : float , optional
1784
- The desired tolerance. The default is 0.0001.
1798
+ The desired tolerance. Default is 0.0001.
1785
1799
 
1786
1800
  Returns
1787
1801
  -------
@@ -1917,17 +1931,17 @@ class Wire():
1917
1931
  Parameters
1918
1932
  ----------
1919
1933
  origin : topologic_core.Vertex , optional
1920
- The location of the origin of the tile. The default is None which results in the tiles first vertex being placed at (0, 0, 0).
1934
+ The location of the origin of the tile. Default is None which results in the tiles first vertex being placed at (0, 0, 0).
1921
1935
  radius : float , optional
1922
- The radius of the hexagon determining the size of the tile. The default is 0.5.
1936
+ The radius of the hexagon determining the size of the tile. Default is 0.5.
1923
1937
  direction : list , optional
1924
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
1938
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
1925
1939
  placement : str , optional
1926
- The description of the placement of the origin of the hexagon determining the location of the tile. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
1940
+ The description of the placement of the origin of the hexagon determining the location of the tile. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
1927
1941
  mantissa : int , optional
1928
- The desired length of the mantissa. The default is 6.
1942
+ The number of decimal places to round the result to. Default is 6.
1929
1943
  tolerance : float , optional
1930
- The desired tolerance. The default is 0.0001.
1944
+ The desired tolerance. Default is 0.0001.
1931
1945
  Returns
1932
1946
  -------
1933
1947
  topologic_core.Wire
@@ -1982,40 +1996,40 @@ class Wire():
1982
1996
  Parameters
1983
1997
  ----------
1984
1998
  origin : topologic_core.Vertex , optional
1985
- The location of the origin of the ellipse. The default is None which results in the ellipse being placed at (0, 0, 0).
1999
+ The location of the origin of the ellipse. Default is None which results in the ellipse being placed at (0, 0, 0).
1986
2000
  inputMode : int , optional
1987
- The method by which the ellipse is defined. The default is 1.
2001
+ The method by which the ellipse is defined. Default is 1.
1988
2002
  Based on the inputMode value, only the following inputs will be considered. The options are:
1989
2003
  1. Width and Length (considered inputs: width, length)
1990
2004
  2. Focal Length and Eccentricity (considered inputs: focalLength, eccentricity)
1991
2005
  3. Focal Length and Minor Axis Length (considered inputs: focalLength, minorAxisLength)
1992
2006
  4. Major Axis Length and Minor Axis Length (considered input: majorAxisLength, minorAxisLength)
1993
2007
  width : float , optional
1994
- The width of the ellipse. The default is 2.0. This is considered if the inputMode is 1.
2008
+ The width of the ellipse. Default is 2.0. This is considered if the inputMode is 1.
1995
2009
  length : float , optional
1996
- The length of the ellipse. The default is 1.0. This is considered if the inputMode is 1.
2010
+ The length of the ellipse. Default is 1.0. This is considered if the inputMode is 1.
1997
2011
  focalLength : float , optional
1998
- The focal length of the ellipse. The default is 0.866025. This is considered if the inputMode is 2 or 3.
2012
+ The focal length of the ellipse. Default is 0.866025. This is considered if the inputMode is 2 or 3.
1999
2013
  eccentricity : float , optional
2000
- The eccentricity of the ellipse. The default is 0.866025. This is considered if the inputMode is 2.
2014
+ The eccentricity of the ellipse. Default is 0.866025. This is considered if the inputMode is 2.
2001
2015
  majorAxisLength : float , optional
2002
- The length of the major axis of the ellipse. The default is 1.0. This is considered if the inputMode is 4.
2016
+ The length of the major axis of the ellipse. Default is 1.0. This is considered if the inputMode is 4.
2003
2017
  minorAxisLength : float , optional
2004
- The length of the minor axis of the ellipse. The default is 0.5. This is considered if the inputMode is 3 or 4.
2018
+ The length of the minor axis of the ellipse. Default is 0.5. This is considered if the inputMode is 3 or 4.
2005
2019
  sides : int , optional
2006
- The number of sides of the ellipse. The default is 32.
2020
+ The number of sides of the ellipse. Default is 32.
2007
2021
  fromAngle : float , optional
2008
- The angle in degrees from which to start creating the arc of the ellipse. The default is 0.
2022
+ The angle in degrees from which to start creating the arc of the ellipse. Default is 0.
2009
2023
  toAngle : float , optional
2010
- The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
2024
+ The angle in degrees at which to end creating the arc of the ellipse. Default is 360.
2011
2025
  close : bool , optional
2012
2026
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
2013
2027
  direction : list , optional
2014
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
2028
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
2015
2029
  placement : str , optional
2016
- The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
2030
+ The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
2017
2031
  tolerance : float , optional
2018
- The desired tolerance. The default is 0.0001.
2032
+ The desired tolerance. Default is 0.0001.
2019
2033
 
2020
2034
  Returns
2021
2035
  -------
@@ -2034,40 +2048,40 @@ class Wire():
2034
2048
  Parameters
2035
2049
  ----------
2036
2050
  origin : topologic_core.Vertex , optional
2037
- The location of the origin of the ellipse. The default is None which results in the ellipse being placed at (0, 0, 0).
2051
+ The location of the origin of the ellipse. Default is None which results in the ellipse being placed at (0, 0, 0).
2038
2052
  inputMode : int , optional
2039
- The method by which the ellipse is defined. The default is 1.
2053
+ The method by which the ellipse is defined. Default is 1.
2040
2054
  Based on the inputMode value, only the following inputs will be considered. The options are:
2041
2055
  1. Width and Length (considered inputs: width, length)
2042
2056
  2. Focal Length and Eccentricity (considered inputs: focalLength, eccentricity)
2043
2057
  3. Focal Length and Minor Axis Length (considered inputs: focalLength, minorAxisLength)
2044
2058
  4. Major Axis Length and Minor Axis Length (considered input: majorAxisLength, minorAxisLength)
2045
2059
  width : float , optional
2046
- The width of the ellipse. The default is 2.0. This is considered if the inputMode is 1.
2060
+ The width of the ellipse. Default is 2.0. This is considered if the inputMode is 1.
2047
2061
  length : float , optional
2048
- The length of the ellipse. The default is 1.0. This is considered if the inputMode is 1.
2062
+ The length of the ellipse. Default is 1.0. This is considered if the inputMode is 1.
2049
2063
  focalLength : float , optional
2050
- The focal length of the ellipse. The default is 0.866025. This is considered if the inputMode is 2 or 3.
2064
+ The focal length of the ellipse. Default is 0.866025. This is considered if the inputMode is 2 or 3.
2051
2065
  eccentricity : float , optional
2052
- The eccentricity of the ellipse. The default is 0.866025. This is considered if the inputMode is 2.
2066
+ The eccentricity of the ellipse. Default is 0.866025. This is considered if the inputMode is 2.
2053
2067
  majorAxisLength : float , optional
2054
- The length of the major axis of the ellipse. The default is 1.0. This is considered if the inputMode is 4.
2068
+ The length of the major axis of the ellipse. Default is 1.0. This is considered if the inputMode is 4.
2055
2069
  minorAxisLength : float , optional
2056
- The length of the minor axis of the ellipse. The default is 0.5. This is considered if the inputMode is 3 or 4.
2070
+ The length of the minor axis of the ellipse. Default is 0.5. This is considered if the inputMode is 3 or 4.
2057
2071
  sides : int , optional
2058
- The number of sides of the ellipse. The default is 32.
2072
+ The number of sides of the ellipse. Default is 32.
2059
2073
  fromAngle : float , optional
2060
- The angle in degrees from which to start creating the arc of the ellipse. The default is 0.
2074
+ The angle in degrees from which to start creating the arc of the ellipse. Default is 0.
2061
2075
  toAngle : float , optional
2062
- The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
2076
+ The angle in degrees at which to end creating the arc of the ellipse. Default is 360.
2063
2077
  close : bool , optional
2064
2078
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
2065
2079
  direction : list , optional
2066
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
2080
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
2067
2081
  placement : str , optional
2068
- The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
2082
+ The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
2069
2083
  tolerance : float , optional
2070
- The desired tolerance. The default is 0.0001.
2084
+ The desired tolerance. Default is 0.0001.
2071
2085
 
2072
2086
  Returns
2073
2087
  -------
@@ -2203,9 +2217,9 @@ class Wire():
2203
2217
  wire : topologic_core.Wire
2204
2218
  The input wire.
2205
2219
  tolerance : float , optional
2206
- The desired tolerance. The default is 0.0001.
2220
+ The desired tolerance. Default is 0.0001.
2207
2221
  mantissa : int , optional
2208
- The length of the desired mantissa. The default is 6.
2222
+ The length of the desired mantissa. Default is 6.
2209
2223
 
2210
2224
  Returns
2211
2225
  -------
@@ -2264,13 +2278,13 @@ class Wire():
2264
2278
  radius : float
2265
2279
  The desired radius of the fillet.
2266
2280
  radiusKey : str , optional
2267
- If specified, the dictionary of the vertices will be queried for this key to specify the desired fillet radius. The default is None.
2281
+ If specified, the dictionary of the vertices will be queried for this key to specify the desired fillet radius. Default is None.
2268
2282
  sides : int , optional
2269
- The number of sides (segments) of the fillet. The default is 16.
2283
+ The number of sides (segments) of the fillet. Default is 16.
2270
2284
  tolerance : float , optional
2271
- The desired tolerance. The default is 0.0001.
2285
+ The desired tolerance. Default is 0.0001.
2272
2286
  silent : bool , optional
2273
- If set to True, error and warning messages are suppressed. The default is False.
2287
+ If set to True, error and warning messages are suppressed. Default is False.
2274
2288
 
2275
2289
  Returns
2276
2290
  -------
@@ -2384,9 +2398,9 @@ class Wire():
2384
2398
  wire : topologic_core.Wire
2385
2399
  The input wire.
2386
2400
  tolerance : float , optional
2387
- The desired tolerance. The default is 0.0001.
2401
+ The desired tolerance. Default is 0.0001.
2388
2402
  mantissa : int , optional
2389
- The desired length of the mantissa. The default is 6.
2403
+ The number of decimal places to round the result to. Default is 6.
2390
2404
 
2391
2405
  Returns
2392
2406
  -------
@@ -2444,18 +2458,18 @@ class Wire():
2444
2458
  wireB : topologic_core.Wire
2445
2459
  The second input wire.
2446
2460
  n : int , optional
2447
- The number of intermediate wires to create. The default is 5.
2461
+ The number of intermediate wires to create. Default is 5.
2448
2462
  outputType : str , optional
2449
- The desired type of output. The options are case insensitive. The default is "contour". The options are:
2463
+ The desired type of output. The options are case insensitive. Default is "contour". The options are:
2450
2464
  - "Default" or "Contours" (wires are not connected)
2451
2465
  - "Raster or "Zigzag" or "Toolpath" (the wire ends are connected to create a continuous path)
2452
2466
  - "Grid" (the wire ends are connected to create a grid).
2453
2467
  mapping : str , optional
2454
- The desired type of mapping for wires with different number of vertices. It is case insensitive. The default is "default". The options are:
2468
+ The desired type of mapping for wires with different number of vertices. It is case insensitive. Default is "default". The options are:
2455
2469
  - "Default" or "Repeat" which repeats the last vertex of the wire with the least number of vertices
2456
2470
  - "Nearest" which maps the vertices of one wire to the nearest vertex of the next wire creating a list of equal number of vertices.
2457
2471
  tolerance : float , optional
2458
- The desired tolerance. The default is 0.0001.
2472
+ The desired tolerance. Default is 0.0001.
2459
2473
 
2460
2474
  Returns
2461
2475
  -------
@@ -2563,7 +2577,7 @@ class Wire():
2563
2577
  wire : topologic_core.Wire
2564
2578
  The input wire.
2565
2579
  tolerance : float , optional
2566
- The desired tolerance. The default is 0.0001.
2580
+ The desired tolerance. Default is 0.0001.
2567
2581
 
2568
2582
  Returns
2569
2583
  -------
@@ -2611,7 +2625,7 @@ class Wire():
2611
2625
  wire : topologic_core.Wire
2612
2626
  The input wire.
2613
2627
  silent : bool , optional
2614
- If set to True, error and warning messages are suppressed. The default is False.
2628
+ If set to True, error and warning messages are suppressed. Default is False.
2615
2629
 
2616
2630
  Returns
2617
2631
  -------
@@ -2649,9 +2663,9 @@ class Wire():
2649
2663
  wireB : topologic_core.Wire
2650
2664
  The second input wire.
2651
2665
  angTolerance : float , optional
2652
- The desired angular tolerance. The default is 0.1.
2666
+ The desired angular tolerance. Default is 0.1.
2653
2667
  tolerance : float , optional
2654
- The desired tolerance. The default is 0.0001.
2668
+ The desired tolerance. Default is 0.0001.
2655
2669
 
2656
2670
  Returns
2657
2671
  -------
@@ -2757,29 +2771,29 @@ class Wire():
2757
2771
  Parameters
2758
2772
  ----------
2759
2773
  origin : topologic_core.Vertex , optional
2760
- 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).
2774
+ The location of the origin of the I-shape. Default is None which results in the I-shape being placed at (0, 0, 0).
2761
2775
  width : float , optional
2762
- The overall width of the I-shape. The default is 1.0.
2776
+ The overall width of the I-shape. Default is 1.0.
2763
2777
  length : float , optional
2764
- The overall length of the I-shape. The default is 1.0.
2778
+ The overall length of the I-shape. Default is 1.0.
2765
2779
  a : float , optional
2766
- The hortizontal thickness of the central vertical arm of the I-shape. The default is 0.25.
2780
+ The hortizontal thickness of the central vertical arm of the I-shape. Default is 0.25.
2767
2781
  b : float , optional
2768
- The vertical thickness of the lower horizontal arm of the I-shape. The default is 0.25.
2782
+ The vertical thickness of the lower horizontal arm of the I-shape. Default is 0.25.
2769
2783
  c : float , optional
2770
- The vertical thickness of the upper horizontal arm of the I-shape. The default is 0.25.
2784
+ The vertical thickness of the upper horizontal arm of the I-shape. Default is 0.25.
2771
2785
  flipHorizontal : bool , optional
2772
- if set to True, the shape is flipped horizontally. The default is False.
2786
+ if set to True, the shape is flipped horizontally. Default is False.
2773
2787
  flipVertical : bool , optional
2774
- if set to True, the shape is flipped vertically. The default is False.
2788
+ if set to True, the shape is flipped vertically. Default is False.
2775
2789
  direction : list , optional
2776
- The vector representing the up direction of the I-shape. The default is [0, 0, 1].
2790
+ The vector representing the up direction of the I-shape. Default is [0, 0, 1].
2777
2791
  placement : str , optional
2778
- The description of the placement of the origin of the I-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
2792
+ The description of the placement of the origin of the I-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
2779
2793
  tolerance : float , optional
2780
- The desired tolerance. The default is 0.0001.
2794
+ The desired tolerance. Default is 0.0001.
2781
2795
  silent : bool , optional
2782
- If set to True, error and warning messages are suppressed. The default is False.
2796
+ If set to True, error and warning messages are suppressed. Default is False.
2783
2797
 
2784
2798
  Returns
2785
2799
  -------
@@ -2905,7 +2919,7 @@ class Wire():
2905
2919
  wire : topologic_core.Wire
2906
2920
  The input wire.
2907
2921
  mantissa : int , optional
2908
- The desired length of the mantissa. The default is 6.
2922
+ The number of decimal places to round the result to. Default is 6.
2909
2923
 
2910
2924
  Returns
2911
2925
  -------
@@ -2939,13 +2953,13 @@ class Wire():
2939
2953
  Parameters
2940
2954
  ----------
2941
2955
  origin : topologic_core.Vertex , optional
2942
- The origin location of the box. The default is None which results in the edge being placed at (0, 0, 0).
2956
+ The origin location of the box. Default is None which results in the edge being placed at (0, 0, 0).
2943
2957
  length : float , optional
2944
- The desired length of the edge. The default is 1.0.
2958
+ The desired length of the edge. Default is 1.0.
2945
2959
  direction : list , optional
2946
- The desired direction (vector) of the edge. The default is [1, 0, 0] (along the X-axis).
2960
+ The desired direction (vector) of the edge. Default is [1, 0, 0] (along the X-axis).
2947
2961
  sides : int , optional
2948
- The desired number of sides/segments. The minimum number of sides is 2. The default is 2.
2962
+ The desired number of sides/segments. The minimum number of sides is 2. Default is 2.
2949
2963
  placement : str , optional
2950
2964
  The desired placement of the edge. The options are:
2951
2965
  1. "center" which places the center of the edge at the origin.
@@ -2953,7 +2967,7 @@ class Wire():
2953
2967
  3. "end" which places the end of the edge at the origin.
2954
2968
  The default is "center".
2955
2969
  tolerance : float , optional
2956
- The desired tolerance. The default is 0.0001.
2970
+ The desired tolerance. Default is 0.0001.
2957
2971
 
2958
2972
  Returns
2959
2973
  -------
@@ -3009,23 +3023,23 @@ class Wire():
3009
3023
  Parameters
3010
3024
  ----------
3011
3025
  origin : topologic_core.Vertex , optional
3012
- 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).
3026
+ The location of the origin of the L-shape. Default is None which results in the L-shape being placed at (0, 0, 0).
3013
3027
  width : float , optional
3014
- The overall width of the L-shape. The default is 1.0.
3028
+ The overall width of the L-shape. Default is 1.0.
3015
3029
  length : float , optional
3016
- The overall length of the L-shape. The default is 1.0.
3030
+ The overall length of the L-shape. Default is 1.0.
3017
3031
  a : float , optional
3018
- The hortizontal thickness of the vertical arm of the L-shape. The default is 0.25.
3032
+ The hortizontal thickness of the vertical arm of the L-shape. Default is 0.25.
3019
3033
  b : float , optional
3020
- The vertical thickness of the horizontal arm of the L-shape. The default is 0.25.
3034
+ The vertical thickness of the horizontal arm of the L-shape. Default is 0.25.
3021
3035
  direction : list , optional
3022
- The vector representing the up direction of the L-shape. The default is [0, 0, 1].
3036
+ The vector representing the up direction of the L-shape. Default is [0, 0, 1].
3023
3037
  placement : str , optional
3024
- The description of the placement of the origin of the L-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3038
+ The description of the placement of the origin of the L-shape. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3025
3039
  tolerance : float , optional
3026
- The desired tolerance. The default is 0.0001.
3040
+ The desired tolerance. Default is 0.0001.
3027
3041
  silent : bool , optional
3028
- If set to True, error and warning messages are suppressed. The default is False.
3042
+ If set to True, error and warning messages are suppressed. Default is False.
3029
3043
 
3030
3044
  Returns
3031
3045
  -------
@@ -3143,11 +3157,11 @@ class Wire():
3143
3157
  offset : float
3144
3158
  The desired offset length of the miter along each edge.
3145
3159
  offsetKey : str , optional
3146
- If specified, the dictionary of the vertices will be queried for this key to specify the desired offset length. The default is None.
3160
+ If specified, the dictionary of the vertices will be queried for this key to specify the desired offset length. Default is None.
3147
3161
  tolerance : float , optional
3148
- The desired tolerance. The default is 0.0001.
3162
+ The desired tolerance. Default is 0.0001.
3149
3163
  silent : bool , optional
3150
- If set to True, error and warning messages are suppressed. The default is False.
3164
+ If set to True, error and warning messages are suppressed. Default is False.
3151
3165
 
3152
3166
  Returns
3153
3167
  -------
@@ -3247,9 +3261,9 @@ class Wire():
3247
3261
  wire : topologic_core.Wire
3248
3262
  The input wire.
3249
3263
  outputType : string , optional
3250
- The string defining the desired output. This can be any subset or permutation of "xyz". It is case insensitive. The default is "xyz".
3264
+ The string defining the desired output. This can be any subset or permutation of "xyz". It is case insensitive. Default is "xyz".
3251
3265
  mantissa : int , optional
3252
- The desired length of the mantissa. The default is 6.
3266
+ The number of decimal places to round the result to. Default is 6.
3253
3267
 
3254
3268
  Returns
3255
3269
  -------
@@ -3358,9 +3372,9 @@ class Wire():
3358
3372
  vertexA : topologic_core.Vertex
3359
3373
  The desired start vertex of the wire.
3360
3374
  transferDictionaries : bool , optional
3361
- If set to True, the dictionaries of the original wire are transfered to the new wire. Otherwise, they are not. The default is False.
3375
+ If set to True, the dictionaries of the original wire are transfered to the new wire. Otherwise, they are not. Default is False.
3362
3376
  tolerance : float, optional
3363
- The desired tolerance. The default is 0.0001.
3377
+ The desired tolerance. Default is 0.0001.
3364
3378
 
3365
3379
  Returns
3366
3380
  -------
@@ -3432,11 +3446,11 @@ class Wire():
3432
3446
  wire : topologic_core.Wire
3433
3447
  The input wire.
3434
3448
  tolerance : float, optional
3435
- The desired tolerance. The default is 0.0001.
3449
+ The desired tolerance. Default is 0.0001.
3436
3450
  origin : topologic_core.Vertex , optional
3437
- The desired origin of the plane unto which the planar wire will be projected. If set to None, the centroid of the input wire will be chosen. The default is None.
3451
+ The desired origin of the plane unto which the planar wire will be projected. If set to None, the centroid of the input wire will be chosen. Default is None.
3438
3452
  mantissa : int , optional
3439
- The desired length of the mantissa. The default is 6.
3453
+ The number of decimal places to round the result to. Default is 6.
3440
3454
 
3441
3455
  Returns
3442
3456
  -------
@@ -3492,11 +3506,11 @@ class Wire():
3492
3506
  face : topologic_core.Face
3493
3507
  The face unto which to project the input wire.
3494
3508
  direction : list, optional
3495
- The vector representing the direction of the projection. If None, the reverse vector of the receiving face normal will be used. The default is None.
3509
+ The vector representing the direction of the projection. If None, the reverse vector of the receiving face normal will be used. Default is None.
3496
3510
  mantissa : int , optional
3497
- The desired length of the mantissa. The default is 6.
3511
+ The number of decimal places to round the result to. Default is 6.
3498
3512
  tolerance : float , optional
3499
- The desired tolerance. The default is 0.0001.
3513
+ The desired tolerance. Default is 0.0001.
3500
3514
 
3501
3515
  Returns
3502
3516
  -------
@@ -3551,21 +3565,21 @@ class Wire():
3551
3565
  Parameters
3552
3566
  ----------
3553
3567
  origin : topologic_core.Vertex , optional
3554
- The location of the origin of the rectangle. The default is None which results in the rectangle being placed at (0, 0, 0).
3568
+ The location of the origin of the rectangle. Default is None which results in the rectangle being placed at (0, 0, 0).
3555
3569
  width : float , optional
3556
- The width of the rectangle. The default is 1.0.
3570
+ The width of the rectangle. Default is 1.0.
3557
3571
  length : float , optional
3558
- The length of the rectangle. The default is 1.0.
3572
+ The length of the rectangle. Default is 1.0.
3559
3573
  direction : list , optional
3560
- The vector representing the up direction of the rectangle. The default is [0, 0, 1].
3574
+ The vector representing the up direction of the rectangle. Default is [0, 0, 1].
3561
3575
  placement : str , optional
3562
- The description of the placement of the origin of the rectangle. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3576
+ The description of the placement of the origin of the rectangle. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3563
3577
  angTolerance : float , optional
3564
- The desired angular tolerance. The default is 0.1.
3578
+ The desired angular tolerance. Default is 0.1.
3565
3579
  tolerance : float , optional
3566
- The desired tolerance. The default is 0.0001.
3580
+ The desired tolerance. Default is 0.0001.
3567
3581
  silent : bool , optional
3568
- If set to True, error and warning messages are suppressed. The default is False.
3582
+ If set to True, error and warning messages are suppressed. Default is False.
3569
3583
 
3570
3584
  Returns
3571
3585
  -------
@@ -3631,11 +3645,11 @@ class Wire():
3631
3645
  wire : topologic_core.Wire
3632
3646
  The input wire.
3633
3647
  angTolerance : float, optional
3634
- The desired angular tolerance. The default is 0.1.
3648
+ The desired angular tolerance. Default is 0.1.
3635
3649
  tolerance : float, optional
3636
- The desired tolerance. The default is 0.0001.
3650
+ The desired tolerance. Default is 0.0001.
3637
3651
  silent : bool, optional
3638
- If set to True, error and warning messages are suppressed. The default is False.
3652
+ If set to True, error and warning messages are suppressed. Default is False.
3639
3653
 
3640
3654
  Returns
3641
3655
  -------
@@ -3724,13 +3738,13 @@ class Wire():
3724
3738
  wire : topologic_core.Wire
3725
3739
  The input wire.
3726
3740
  normalize : bool , optional
3727
- If set to True, the lengths in the list are normalized so that the shortest edge has a length of 1. the default is True.
3741
+ If set to True, the lengths in the list are normalized so that the shortest edge has a length of 1. Default is True.
3728
3742
  rotate : bool , optional
3729
3743
  If set to True, the list is rotated such that the shortest edge appears first.
3730
3744
  mantissa : int , optional
3731
- The desired length of the mantissa. The default is 6.
3745
+ The number of decimal places to round the result to. Default is 6.
3732
3746
  tolerance : float , optional
3733
- The desired tolerance. The default is 0.0001.
3747
+ The desired tolerance. Default is 0.0001.
3734
3748
 
3735
3749
  Returns
3736
3750
  -------
@@ -3806,11 +3820,11 @@ class Wire():
3806
3820
  wire : topologic_core.Wire
3807
3821
  The input wire.
3808
3822
  transferDictionaries : bool , optional
3809
- If set to True the dictionaries of the input wire are transferred to the new wire. Othwerwise, they are not. The default is False.
3823
+ If set to True the dictionaries of the input wire are transferred to the new wire. Othwerwise, they are not. Default is False.
3810
3824
  tolerance : float , optional
3811
- The desired tolerance. The default is 0.0001.
3825
+ The desired tolerance. Default is 0.0001.
3812
3826
  silent : bool, optional
3813
- If set to True, error and warning messages are suppressed. The default is False.
3827
+ If set to True, error and warning messages are suppressed. Default is False.
3814
3828
 
3815
3829
  Returns
3816
3830
  -------
@@ -3858,11 +3872,11 @@ class Wire():
3858
3872
  face : topologic_core.Face
3859
3873
  The input face.
3860
3874
  angle : float , optioal
3861
- The desired angle in degrees of the roof. The default is 45.
3875
+ The desired angle in degrees of the roof. Default is 45.
3862
3876
  boundary : bool , optional
3863
- If set to True the original boundary is returned as part of the roof. Otherwise it is not. The default is True.
3877
+ If set to True the original boundary is returned as part of the roof. Otherwise it is not. Default is True.
3864
3878
  tolerance : float , optional
3865
- The desired tolerance. The default is 0.001. (This is set to a larger number as it was found to work better)
3879
+ The desired tolerance. Default is 0.001. (This is set to a larger number as it was found to work better)
3866
3880
 
3867
3881
  Returns
3868
3882
  -------
@@ -3985,7 +3999,7 @@ class Wire():
3985
3999
  between any point and the current line segment; points falling within this distance are discarded.
3986
4000
  The default is 0.0001.
3987
4001
  silent : bool , optional
3988
- If set to True, error and warning messages are suppressed. The default is False.
4002
+ If set to True, error and warning messages are suppressed. Default is False.
3989
4003
 
3990
4004
  Returns
3991
4005
  -------
@@ -4152,9 +4166,9 @@ class Wire():
4152
4166
  face : topologic_core.Face
4153
4167
  The input face.
4154
4168
  boundary : bool , optional
4155
- If set to True the original boundary is returned as part of the roof. Otherwise it is not. The default is True.
4169
+ If set to True the original boundary is returned as part of the roof. Otherwise it is not. Default is True.
4156
4170
  tolerance : float , optional
4157
- The desired tolerance. The default is 0.001. (This is set to a larger number as it was found to work better)
4171
+ The desired tolerance. Default is 0.001. (This is set to a larger number as it was found to work better)
4158
4172
 
4159
4173
  Returns
4160
4174
  -------
@@ -4174,27 +4188,27 @@ class Wire():
4174
4188
  Parameters
4175
4189
  ----------
4176
4190
  origin : topologic_core.Vertex , optional
4177
- The location of the origin of the spiral. The default is None which results in the spiral being placed at (0, 0, 0).
4191
+ The location of the origin of the spiral. Default is None which results in the spiral being placed at (0, 0, 0).
4178
4192
  radiusA : float , optional
4179
- The initial radius of the spiral. The default is 0.05.
4193
+ The initial radius of the spiral. Default is 0.05.
4180
4194
  radiusB : float , optional
4181
- The final radius of the spiral. The default is 0.5.
4195
+ The final radius of the spiral. Default is 0.5.
4182
4196
  height : float , optional
4183
- The height of the spiral. The default is 1.
4197
+ The height of the spiral. Default is 1.
4184
4198
  turns : int , optional
4185
- The number of turns of the spiral. The default is 10.
4199
+ The number of turns of the spiral. Default is 10.
4186
4200
  sides : int , optional
4187
- The number of sides of one full turn in the spiral. The default is 36.
4201
+ The number of sides of one full turn in the spiral. Default is 36.
4188
4202
  clockwise : bool , optional
4189
- If set to True, the spiral will be oriented in a clockwise fashion. Otherwise, it will be oriented in an anti-clockwise fashion. The default is False.
4203
+ If set to True, the spiral will be oriented in a clockwise fashion. Otherwise, it will be oriented in an anti-clockwise fashion. Default is False.
4190
4204
  reverse : bool , optional
4191
- If set to True, the spiral will increase in height from the center to the circumference. Otherwise, it will increase in height from the conference to the center. The default is False.
4205
+ If set to True, the spiral will increase in height from the center to the circumference. Otherwise, it will increase in height from the conference to the center. Default is False.
4192
4206
  direction : list , optional
4193
- The vector representing the up direction of the spiral. The default is [0, 0, 1].
4207
+ The vector representing the up direction of the spiral. Default is [0, 0, 1].
4194
4208
  placement : str , optional
4195
- The description of the placement of the origin of the spiral. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
4209
+ The description of the placement of the origin of the spiral. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
4196
4210
  tolerance : float , optional
4197
- The desired tolerance. The default is 0.0001.
4211
+ The desired tolerance. Default is 0.0001.
4198
4212
  Returns
4199
4213
  -------
4200
4214
  topologic_core.Wire
@@ -4373,15 +4387,15 @@ class Wire():
4373
4387
  Parameters
4374
4388
  ----------
4375
4389
  origin : topologic_core.Vertex , optional
4376
- The location of the origin of the square. The default is None which results in the square being placed at (0, 0, 0).
4390
+ The location of the origin of the square. Default is None which results in the square being placed at (0, 0, 0).
4377
4391
  size : float , optional
4378
- The size of the square. The default is 1.0.
4392
+ The size of the square. Default is 1.0.
4379
4393
  direction : list , optional
4380
- The vector representing the up direction of the square. The default is [0, 0, 1].
4394
+ The vector representing the up direction of the square. Default is [0, 0, 1].
4381
4395
  placement : str , optional
4382
- The description of the placement of the origin of the square. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
4396
+ The description of the placement of the origin of the square. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
4383
4397
  tolerance : float , optional
4384
- The desired tolerance. The default is 0.0001.
4398
+ The desired tolerance. Default is 0.0001.
4385
4399
 
4386
4400
  Returns
4387
4401
  -------
@@ -4399,25 +4413,25 @@ class Wire():
4399
4413
  Parameters
4400
4414
  ----------
4401
4415
  origin : topologic_core.Vertex , optional
4402
- The location of the origin of the squircle. The default is None which results in the squircle being placed at (0, 0, 0).
4416
+ The location of the origin of the squircle. Default is None which results in the squircle being placed at (0, 0, 0).
4403
4417
  radius : float , optional
4404
- The desired radius of the squircle. The default is 0.5.
4418
+ The desired radius of the squircle. Default is 0.5.
4405
4419
  sides : int , optional
4406
- The desired number of sides of the squircle. The default is 121.
4420
+ The desired number of sides of the squircle. Default is 121.
4407
4421
  a : float , optional
4408
4422
  The "a" factor affects the x position of the points to interpolate between a circle and a square.
4409
- A value of 1 will create a circle. Higher values will create a more square-like shape. The default is 2.0.
4423
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
4410
4424
  b : float , optional
4411
4425
  The "b" factor affects the y position of the points to interpolate between a circle and a square.
4412
- A value of 1 will create a circle. Higher values will create a more square-like shape. The default is 2.0.
4426
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
4413
4427
  direction : list , optional
4414
- The vector representing the up direction of the circle. The default is [0, 0, 1].
4428
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
4415
4429
  placement : str , optional
4416
- The description of the placement of the origin of the circle. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. The default is "center".
4430
+ The description of the placement of the origin of the circle. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. Default is "center".
4417
4431
  angTolerance : float , optional
4418
- The desired angular tolerance. The default is 0.1.
4432
+ The desired angular tolerance. Default is 0.1.
4419
4433
  tolerance : float , optional
4420
- The desired tolerance. The default is 0.0001.
4434
+ The desired tolerance. Default is 0.0001.
4421
4435
 
4422
4436
  Returns
4423
4437
  -------
@@ -4483,19 +4497,19 @@ class Wire():
4483
4497
  Parameters
4484
4498
  ----------
4485
4499
  origin : topologic_core.Vertex , optional
4486
- The location of the origin of the star. The default is None which results in the star being placed at (0, 0, 0).
4500
+ The location of the origin of the star. Default is None which results in the star being placed at (0, 0, 0).
4487
4501
  radiusA : float , optional
4488
- The outer radius of the star. The default is 1.0.
4502
+ The outer radius of the star. Default is 1.0.
4489
4503
  radiusB : float , optional
4490
- The outer radius of the star. The default is 0.4.
4504
+ The outer radius of the star. Default is 0.4.
4491
4505
  rays : int , optional
4492
- The number of star rays. The default is 8.
4506
+ The number of star rays. Default is 8.
4493
4507
  direction : list , optional
4494
- The vector representing the up direction of the star. The default is [0, 0, 1].
4508
+ The vector representing the up direction of the star. Default is [0, 0, 1].
4495
4509
  placement : str , optional
4496
- The description of the placement of the origin of the star. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. The default is "center".
4510
+ The description of the placement of the origin of the star. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. Default is "center".
4497
4511
  tolerance : float , optional
4498
- The desired tolerance. The default is 0.0001.
4512
+ The desired tolerance. Default is 0.0001.
4499
4513
 
4500
4514
  Returns
4501
4515
  -------
@@ -4617,23 +4631,23 @@ class Wire():
4617
4631
  Parameters
4618
4632
  ----------
4619
4633
  origin : topologic_core.Vertex , optional
4620
- The location of the origin of the trapezoid. The default is None which results in the trapezoid being placed at (0, 0, 0).
4634
+ The location of the origin of the trapezoid. Default is None which results in the trapezoid being placed at (0, 0, 0).
4621
4635
  widthA : float , optional
4622
- The width of the bottom edge of the trapezoid. The default is 1.0.
4636
+ The width of the bottom edge of the trapezoid. Default is 1.0.
4623
4637
  widthB : float , optional
4624
- The width of the top edge of the trapezoid. The default is 0.75.
4638
+ The width of the top edge of the trapezoid. Default is 0.75.
4625
4639
  offsetA : float , optional
4626
- The offset of the bottom edge of the trapezoid. The default is 0.0.
4640
+ The offset of the bottom edge of the trapezoid. Default is 0.0.
4627
4641
  offsetB : float , optional
4628
- The offset of the top edge of the trapezoid. The default is 0.0.
4642
+ The offset of the top edge of the trapezoid. Default is 0.0.
4629
4643
  length : float , optional
4630
- The length of the trapezoid. The default is 1.0.
4644
+ The length of the trapezoid. Default is 1.0.
4631
4645
  direction : list , optional
4632
- The vector representing the up direction of the trapezoid. The default is [0, 0, 1].
4646
+ The vector representing the up direction of the trapezoid. Default is [0, 0, 1].
4633
4647
  placement : str , optional
4634
- The description of the placement of the origin of the trapezoid. This can be "center", or "lowerleft". It is case insensitive. The default is "center".
4648
+ The description of the placement of the origin of the trapezoid. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
4635
4649
  tolerance : float , optional
4636
- The desired tolerance. The default is 0.0001.
4650
+ The desired tolerance. Default is 0.0001.
4637
4651
 
4638
4652
  Returns
4639
4653
  -------
@@ -4701,23 +4715,23 @@ class Wire():
4701
4715
  Parameters
4702
4716
  ----------
4703
4717
  origin : topologic_core.Vertex , optional
4704
- 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).
4718
+ The location of the origin of the T-shape. Default is None which results in the T-shape being placed at (0, 0, 0).
4705
4719
  width : float , optional
4706
- The overall width of the T-shape. The default is 1.0.
4720
+ The overall width of the T-shape. Default is 1.0.
4707
4721
  length : float , optional
4708
- The overall length of the T-shape. The default is 1.0.
4722
+ The overall length of the T-shape. Default is 1.0.
4709
4723
  a : float , optional
4710
- The hortizontal thickness of the vertical arm of the T-shape. The default is 0.25.
4724
+ The hortizontal thickness of the vertical arm of the T-shape. Default is 0.25.
4711
4725
  b : float , optional
4712
- The vertical thickness of the horizontal arm of the T-shape. The default is 0.25.
4726
+ The vertical thickness of the horizontal arm of the T-shape. Default is 0.25.
4713
4727
  direction : list , optional
4714
- The vector representing the up direction of the T-shape. The default is [0, 0, 1].
4728
+ The vector representing the up direction of the T-shape. Default is [0, 0, 1].
4715
4729
  placement : str , optional
4716
- 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".
4730
+ 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".
4717
4731
  tolerance : float , optional
4718
- The desired tolerance. The default is 0.0001.
4732
+ The desired tolerance. Default is 0.0001.
4719
4733
  silent : bool , optional
4720
- If set to True, error and warning messages are suppressed. The default is False.
4734
+ If set to True, error and warning messages are suppressed. Default is False.
4721
4735
 
4722
4736
  Returns
4723
4737
  -------
@@ -4837,11 +4851,11 @@ class Wire():
4837
4851
  vertex : topologic_core.Vertex
4838
4852
  The input vertex
4839
4853
  origin : topologic_core.Vertex , optional
4840
- The origin of the offset distance. If set to None, the origin will be set to the start vertex of the input wire. The default is None.
4854
+ The origin of the offset distance. If set to None, the origin will be set to the start vertex of the input wire. Default is None.
4841
4855
  mantissa : int , optional
4842
- The desired length of the mantissa. The default is 6.
4856
+ The number of decimal places to round the result to. Default is 6.
4843
4857
  tolerance : float , optional
4844
- The desired tolerance. The default is 0.0001.
4858
+ The desired tolerance. Default is 0.0001.
4845
4859
 
4846
4860
  Returns
4847
4861
  -------
@@ -4906,11 +4920,11 @@ class Wire():
4906
4920
  wire : topologic_core.Wire
4907
4921
  The input wire.
4908
4922
  distance : float , optional
4909
- The offset distance. The default is 0.
4923
+ The offset distance. Default is 0.
4910
4924
  origin : topologic_core.Vertex , optional
4911
- The origin of the offset distance. If set to None, the origin will be set to the start vertex of the input edge. The default is None.
4925
+ The origin of the offset distance. If set to None, the origin will be set to the start vertex of the input edge. Default is None.
4912
4926
  tolerance : float , optional
4913
- The desired tolerance. The default is 0.0001.
4927
+ The desired tolerance. Default is 0.0001.
4914
4928
 
4915
4929
  Returns
4916
4930
  -------
@@ -4978,7 +4992,7 @@ class Wire():
4978
4992
  wire : topologic_core.Wire
4979
4993
  The input wire.
4980
4994
  u : float , optional
4981
- The *u* parameter along the input topologic Wire. A parameter of 0 returns the start vertex. A parameter of 1 returns the end vertex. The default is 0.
4995
+ The *u* parameter along the input topologic Wire. A parameter of 0 returns the start vertex. A parameter of 1 returns the end vertex. Default is 0.
4982
4996
 
4983
4997
  Returns
4984
4998
  -------