topologicpy 0.8.46__py3-none-any.whl → 0.8.47__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/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
  -------
@@ -908,11 +908,11 @@ class Wire():
908
908
  cluster : topologic_core.cluster
909
909
  the input cluster of vertices.
910
910
  close : bool , optional
911
- If True the last vertex will be connected to the first vertex to close the wire. The default is True.
911
+ If True the last vertex will be connected to the first vertex to close the wire. Default is True.
912
912
  tolerance : float , optional
913
- The desired tolerance. The default is 0.0001
913
+ The desired tolerance. Default is 0.0001
914
914
  silent : bool , optional
915
- If set to True, error and warning messages are suppressed. The default is False.
915
+ If set to True, error and warning messages are suppressed. Default is False.
916
916
 
917
917
  Returns
918
918
  -------
@@ -937,23 +937,23 @@ class Wire():
937
937
  Parameters
938
938
  ----------
939
939
  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).
940
+ The location of the origin of the circle. Default is None which results in the circle being placed at (0, 0, 0).
941
941
  radius : float , optional
942
- The radius of the circle. The default is 0.5.
942
+ The radius of the circle. Default is 0.5.
943
943
  sides : int , optional
944
- The desired number of sides of the circle. The default is 16.
944
+ The desired number of sides of the circle. Default is 16.
945
945
  fromAngle : float , optional
946
- The angle in degrees from which to start creating the arc of the circle. The default is 0.
946
+ The angle in degrees from which to start creating the arc of the circle. Default is 0.
947
947
  toAngle : float , optional
948
- The angle in degrees at which to end creating the arc of the circle. The default is 360.
948
+ The angle in degrees at which to end creating the arc of the circle. Default is 360.
949
949
  close : bool , optional
950
950
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
951
951
  direction : list , optional
952
- The vector representing the up direction of the circle. The default is [0, 0, 1].
952
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
953
953
  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".
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. Default is "center".
955
955
  tolerance : float , optional
956
- The desired tolerance. The default is 0.0001.
956
+ The desired tolerance. Default is 0.0001.
957
957
 
958
958
  Returns
959
959
  -------
@@ -1028,9 +1028,9 @@ class Wire():
1028
1028
  wire : topologic_core.Wire
1029
1029
  The input wire.
1030
1030
  mantissa : int , optional
1031
- The desired length of the mantissa. The default is 6.
1031
+ The number of decimal places to round the result to. Default is 6.
1032
1032
  tolerance : float , optional
1033
- The desired tolerance. The default is 0.0001.
1033
+ The desired tolerance. Default is 0.0001.
1034
1034
 
1035
1035
  Returns
1036
1036
  -------
@@ -1098,11 +1098,11 @@ class Wire():
1098
1098
  k : int, optional
1099
1099
  The number of nearest neighbors to consider for each point when building the hull.
1100
1100
  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.
1101
+ less concave hull, while decreasing `k` may yield a more detailed, concave shape. Default is 3.
1102
1102
  mantissa : int , optional
1103
- The desired length of the mantissa. The default is 6.
1103
+ The number of decimal places to round the result to. Default is 6.
1104
1104
  tolerance : float , optional
1105
- The desired tolerance. The default is 0.0001.
1105
+ The desired tolerance. Default is 0.0001.
1106
1106
 
1107
1107
  Returns
1108
1108
  -------
@@ -1309,9 +1309,9 @@ class Wire():
1309
1309
  topology : topologic_core.Topology
1310
1310
  The input topology.
1311
1311
  mantissa : int , optional
1312
- The desired length of the mantissa. The default is 6.
1312
+ The number of decimal places to round the result to. Default is 6.
1313
1313
  tolerance : float , optional
1314
- The desired tolerance. The default is 0.0001.
1314
+ The desired tolerance. Default is 0.0001.
1315
1315
 
1316
1316
  Returns
1317
1317
  -------
@@ -1453,27 +1453,27 @@ class Wire():
1453
1453
  Parameters
1454
1454
  ----------
1455
1455
  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).
1456
+ 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
1457
  width : float , optional
1458
- The overall width of the Cross-shape. The default is 1.0.
1458
+ The overall width of the Cross-shape. Default is 1.0.
1459
1459
  length : float , optional
1460
- The overall length of the Cross-shape. The default is 1.0.
1460
+ The overall length of the Cross-shape. Default is 1.0.
1461
1461
  a : float , optional
1462
- The hortizontal thickness of the vertical arm of the Cross-shape. The default is 0.25.
1462
+ The hortizontal thickness of the vertical arm of the Cross-shape. Default is 0.25.
1463
1463
  b : float , optional
1464
- The vertical thickness of the horizontal arm of the Cross-shape. The default is 0.25.
1464
+ The vertical thickness of the horizontal arm of the Cross-shape. Default is 0.25.
1465
1465
  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.
1466
+ 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
1467
  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.
1468
+ 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
1469
  direction : list , optional
1470
- The vector representing the up direction of the Cross-shape. The default is [0, 0, 1].
1470
+ The vector representing the up direction of the Cross-shape. Default is [0, 0, 1].
1471
1471
  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".
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. Default is "center".
1473
1473
  tolerance : float , optional
1474
- The desired tolerance. The default is 0.0001.
1474
+ The desired tolerance. Default is 0.0001.
1475
1475
  silent : bool , optional
1476
- If set to True, error and warning messages are suppressed. The default is False.
1476
+ If set to True, error and warning messages are suppressed. Default is False.
1477
1477
 
1478
1478
  Returns
1479
1479
  -------
@@ -1639,25 +1639,25 @@ class Wire():
1639
1639
  Parameters
1640
1640
  ----------
1641
1641
  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).
1642
+ 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
1643
  width : float , optional
1644
- The overall width of the C-shape. The default is 1.0.
1644
+ The overall width of the C-shape. Default is 1.0.
1645
1645
  length : float , optional
1646
- The overall length of the C-shape. The default is 1.0.
1646
+ The overall length of the C-shape. Default is 1.0.
1647
1647
  a : float , optional
1648
- The hortizontal thickness of the vertical arm of the C-shape. The default is 0.25.
1648
+ The hortizontal thickness of the vertical arm of the C-shape. Default is 0.25.
1649
1649
  b : float , optional
1650
- The vertical thickness of the lower horizontal arm of the C-shape. The default is 0.25.
1650
+ The vertical thickness of the lower horizontal arm of the C-shape. Default is 0.25.
1651
1651
  c : float , optional
1652
- The vertical thickness of the upper horizontal arm of the C-shape. The default is 0.25.
1652
+ The vertical thickness of the upper horizontal arm of the C-shape. Default is 0.25.
1653
1653
  direction : list , optional
1654
- The vector representing the up direction of the C-shape. The default is [0, 0, 1].
1654
+ The vector representing the up direction of the C-shape. Default is [0, 0, 1].
1655
1655
  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".
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. Default is "center".
1657
1657
  tolerance : float , optional
1658
- The desired tolerance. The default is 0.0001.
1658
+ The desired tolerance. Default is 0.0001.
1659
1659
  silent : bool , optional
1660
- If set to True, error and warning messages are suppressed. The default is False.
1660
+ If set to True, error and warning messages are suppressed. Default is False.
1661
1661
 
1662
1662
  Returns
1663
1663
  -------
@@ -1779,9 +1779,9 @@ class Wire():
1779
1779
  wire : topologic_core.Wire
1780
1780
  The input wire.
1781
1781
  maxVertices : int , optional
1782
- The maximum number of vertices of the circuits to be searched. The default is 4.
1782
+ The maximum number of vertices of the circuits to be searched. Default is 4.
1783
1783
  tolerance : float , optional
1784
- The desired tolerance. The default is 0.0001.
1784
+ The desired tolerance. Default is 0.0001.
1785
1785
 
1786
1786
  Returns
1787
1787
  -------
@@ -1917,17 +1917,17 @@ class Wire():
1917
1917
  Parameters
1918
1918
  ----------
1919
1919
  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).
1920
+ 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
1921
  radius : float , optional
1922
- The radius of the hexagon determining the size of the tile. The default is 0.5.
1922
+ The radius of the hexagon determining the size of the tile. Default is 0.5.
1923
1923
  direction : list , optional
1924
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
1924
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
1925
1925
  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".
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. Default is "center".
1927
1927
  mantissa : int , optional
1928
- The desired length of the mantissa. The default is 6.
1928
+ The number of decimal places to round the result to. Default is 6.
1929
1929
  tolerance : float , optional
1930
- The desired tolerance. The default is 0.0001.
1930
+ The desired tolerance. Default is 0.0001.
1931
1931
  Returns
1932
1932
  -------
1933
1933
  topologic_core.Wire
@@ -1982,40 +1982,40 @@ class Wire():
1982
1982
  Parameters
1983
1983
  ----------
1984
1984
  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).
1985
+ The location of the origin of the ellipse. Default is None which results in the ellipse being placed at (0, 0, 0).
1986
1986
  inputMode : int , optional
1987
- The method by which the ellipse is defined. The default is 1.
1987
+ The method by which the ellipse is defined. Default is 1.
1988
1988
  Based on the inputMode value, only the following inputs will be considered. The options are:
1989
1989
  1. Width and Length (considered inputs: width, length)
1990
1990
  2. Focal Length and Eccentricity (considered inputs: focalLength, eccentricity)
1991
1991
  3. Focal Length and Minor Axis Length (considered inputs: focalLength, minorAxisLength)
1992
1992
  4. Major Axis Length and Minor Axis Length (considered input: majorAxisLength, minorAxisLength)
1993
1993
  width : float , optional
1994
- The width of the ellipse. The default is 2.0. This is considered if the inputMode is 1.
1994
+ The width of the ellipse. Default is 2.0. This is considered if the inputMode is 1.
1995
1995
  length : float , optional
1996
- The length of the ellipse. The default is 1.0. This is considered if the inputMode is 1.
1996
+ The length of the ellipse. Default is 1.0. This is considered if the inputMode is 1.
1997
1997
  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.
1998
+ The focal length of the ellipse. Default is 0.866025. This is considered if the inputMode is 2 or 3.
1999
1999
  eccentricity : float , optional
2000
- The eccentricity of the ellipse. The default is 0.866025. This is considered if the inputMode is 2.
2000
+ The eccentricity of the ellipse. Default is 0.866025. This is considered if the inputMode is 2.
2001
2001
  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.
2002
+ The length of the major axis of the ellipse. Default is 1.0. This is considered if the inputMode is 4.
2003
2003
  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.
2004
+ The length of the minor axis of the ellipse. Default is 0.5. This is considered if the inputMode is 3 or 4.
2005
2005
  sides : int , optional
2006
- The number of sides of the ellipse. The default is 32.
2006
+ The number of sides of the ellipse. Default is 32.
2007
2007
  fromAngle : float , optional
2008
- The angle in degrees from which to start creating the arc of the ellipse. The default is 0.
2008
+ The angle in degrees from which to start creating the arc of the ellipse. Default is 0.
2009
2009
  toAngle : float , optional
2010
- The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
2010
+ The angle in degrees at which to end creating the arc of the ellipse. Default is 360.
2011
2011
  close : bool , optional
2012
2012
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
2013
2013
  direction : list , optional
2014
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
2014
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
2015
2015
  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".
2016
+ 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
2017
  tolerance : float , optional
2018
- The desired tolerance. The default is 0.0001.
2018
+ The desired tolerance. Default is 0.0001.
2019
2019
 
2020
2020
  Returns
2021
2021
  -------
@@ -2034,40 +2034,40 @@ class Wire():
2034
2034
  Parameters
2035
2035
  ----------
2036
2036
  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).
2037
+ The location of the origin of the ellipse. Default is None which results in the ellipse being placed at (0, 0, 0).
2038
2038
  inputMode : int , optional
2039
- The method by which the ellipse is defined. The default is 1.
2039
+ The method by which the ellipse is defined. Default is 1.
2040
2040
  Based on the inputMode value, only the following inputs will be considered. The options are:
2041
2041
  1. Width and Length (considered inputs: width, length)
2042
2042
  2. Focal Length and Eccentricity (considered inputs: focalLength, eccentricity)
2043
2043
  3. Focal Length and Minor Axis Length (considered inputs: focalLength, minorAxisLength)
2044
2044
  4. Major Axis Length and Minor Axis Length (considered input: majorAxisLength, minorAxisLength)
2045
2045
  width : float , optional
2046
- The width of the ellipse. The default is 2.0. This is considered if the inputMode is 1.
2046
+ The width of the ellipse. Default is 2.0. This is considered if the inputMode is 1.
2047
2047
  length : float , optional
2048
- The length of the ellipse. The default is 1.0. This is considered if the inputMode is 1.
2048
+ The length of the ellipse. Default is 1.0. This is considered if the inputMode is 1.
2049
2049
  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.
2050
+ The focal length of the ellipse. Default is 0.866025. This is considered if the inputMode is 2 or 3.
2051
2051
  eccentricity : float , optional
2052
- The eccentricity of the ellipse. The default is 0.866025. This is considered if the inputMode is 2.
2052
+ The eccentricity of the ellipse. Default is 0.866025. This is considered if the inputMode is 2.
2053
2053
  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.
2054
+ The length of the major axis of the ellipse. Default is 1.0. This is considered if the inputMode is 4.
2055
2055
  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.
2056
+ The length of the minor axis of the ellipse. Default is 0.5. This is considered if the inputMode is 3 or 4.
2057
2057
  sides : int , optional
2058
- The number of sides of the ellipse. The default is 32.
2058
+ The number of sides of the ellipse. Default is 32.
2059
2059
  fromAngle : float , optional
2060
- The angle in degrees from which to start creating the arc of the ellipse. The default is 0.
2060
+ The angle in degrees from which to start creating the arc of the ellipse. Default is 0.
2061
2061
  toAngle : float , optional
2062
- The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
2062
+ The angle in degrees at which to end creating the arc of the ellipse. Default is 360.
2063
2063
  close : bool , optional
2064
2064
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
2065
2065
  direction : list , optional
2066
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
2066
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
2067
2067
  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".
2068
+ 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
2069
  tolerance : float , optional
2070
- The desired tolerance. The default is 0.0001.
2070
+ The desired tolerance. Default is 0.0001.
2071
2071
 
2072
2072
  Returns
2073
2073
  -------
@@ -2203,9 +2203,9 @@ class Wire():
2203
2203
  wire : topologic_core.Wire
2204
2204
  The input wire.
2205
2205
  tolerance : float , optional
2206
- The desired tolerance. The default is 0.0001.
2206
+ The desired tolerance. Default is 0.0001.
2207
2207
  mantissa : int , optional
2208
- The length of the desired mantissa. The default is 6.
2208
+ The length of the desired mantissa. Default is 6.
2209
2209
 
2210
2210
  Returns
2211
2211
  -------
@@ -2264,13 +2264,13 @@ class Wire():
2264
2264
  radius : float
2265
2265
  The desired radius of the fillet.
2266
2266
  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.
2267
+ If specified, the dictionary of the vertices will be queried for this key to specify the desired fillet radius. Default is None.
2268
2268
  sides : int , optional
2269
- The number of sides (segments) of the fillet. The default is 16.
2269
+ The number of sides (segments) of the fillet. Default is 16.
2270
2270
  tolerance : float , optional
2271
- The desired tolerance. The default is 0.0001.
2271
+ The desired tolerance. Default is 0.0001.
2272
2272
  silent : bool , optional
2273
- If set to True, error and warning messages are suppressed. The default is False.
2273
+ If set to True, error and warning messages are suppressed. Default is False.
2274
2274
 
2275
2275
  Returns
2276
2276
  -------
@@ -2384,9 +2384,9 @@ class Wire():
2384
2384
  wire : topologic_core.Wire
2385
2385
  The input wire.
2386
2386
  tolerance : float , optional
2387
- The desired tolerance. The default is 0.0001.
2387
+ The desired tolerance. Default is 0.0001.
2388
2388
  mantissa : int , optional
2389
- The desired length of the mantissa. The default is 6.
2389
+ The number of decimal places to round the result to. Default is 6.
2390
2390
 
2391
2391
  Returns
2392
2392
  -------
@@ -2444,18 +2444,18 @@ class Wire():
2444
2444
  wireB : topologic_core.Wire
2445
2445
  The second input wire.
2446
2446
  n : int , optional
2447
- The number of intermediate wires to create. The default is 5.
2447
+ The number of intermediate wires to create. Default is 5.
2448
2448
  outputType : str , optional
2449
- The desired type of output. The options are case insensitive. The default is "contour". The options are:
2449
+ The desired type of output. The options are case insensitive. Default is "contour". The options are:
2450
2450
  - "Default" or "Contours" (wires are not connected)
2451
2451
  - "Raster or "Zigzag" or "Toolpath" (the wire ends are connected to create a continuous path)
2452
2452
  - "Grid" (the wire ends are connected to create a grid).
2453
2453
  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:
2454
+ The desired type of mapping for wires with different number of vertices. It is case insensitive. Default is "default". The options are:
2455
2455
  - "Default" or "Repeat" which repeats the last vertex of the wire with the least number of vertices
2456
2456
  - "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
2457
  tolerance : float , optional
2458
- The desired tolerance. The default is 0.0001.
2458
+ The desired tolerance. Default is 0.0001.
2459
2459
 
2460
2460
  Returns
2461
2461
  -------
@@ -2563,7 +2563,7 @@ class Wire():
2563
2563
  wire : topologic_core.Wire
2564
2564
  The input wire.
2565
2565
  tolerance : float , optional
2566
- The desired tolerance. The default is 0.0001.
2566
+ The desired tolerance. Default is 0.0001.
2567
2567
 
2568
2568
  Returns
2569
2569
  -------
@@ -2611,7 +2611,7 @@ class Wire():
2611
2611
  wire : topologic_core.Wire
2612
2612
  The input wire.
2613
2613
  silent : bool , optional
2614
- If set to True, error and warning messages are suppressed. The default is False.
2614
+ If set to True, error and warning messages are suppressed. Default is False.
2615
2615
 
2616
2616
  Returns
2617
2617
  -------
@@ -2649,9 +2649,9 @@ class Wire():
2649
2649
  wireB : topologic_core.Wire
2650
2650
  The second input wire.
2651
2651
  angTolerance : float , optional
2652
- The desired angular tolerance. The default is 0.1.
2652
+ The desired angular tolerance. Default is 0.1.
2653
2653
  tolerance : float , optional
2654
- The desired tolerance. The default is 0.0001.
2654
+ The desired tolerance. Default is 0.0001.
2655
2655
 
2656
2656
  Returns
2657
2657
  -------
@@ -2757,29 +2757,29 @@ class Wire():
2757
2757
  Parameters
2758
2758
  ----------
2759
2759
  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).
2760
+ 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
2761
  width : float , optional
2762
- The overall width of the I-shape. The default is 1.0.
2762
+ The overall width of the I-shape. Default is 1.0.
2763
2763
  length : float , optional
2764
- The overall length of the I-shape. The default is 1.0.
2764
+ The overall length of the I-shape. Default is 1.0.
2765
2765
  a : float , optional
2766
- The hortizontal thickness of the central vertical arm of the I-shape. The default is 0.25.
2766
+ The hortizontal thickness of the central vertical arm of the I-shape. Default is 0.25.
2767
2767
  b : float , optional
2768
- The vertical thickness of the lower horizontal arm of the I-shape. The default is 0.25.
2768
+ The vertical thickness of the lower horizontal arm of the I-shape. Default is 0.25.
2769
2769
  c : float , optional
2770
- The vertical thickness of the upper horizontal arm of the I-shape. The default is 0.25.
2770
+ The vertical thickness of the upper horizontal arm of the I-shape. Default is 0.25.
2771
2771
  flipHorizontal : bool , optional
2772
- if set to True, the shape is flipped horizontally. The default is False.
2772
+ if set to True, the shape is flipped horizontally. Default is False.
2773
2773
  flipVertical : bool , optional
2774
- if set to True, the shape is flipped vertically. The default is False.
2774
+ if set to True, the shape is flipped vertically. Default is False.
2775
2775
  direction : list , optional
2776
- The vector representing the up direction of the I-shape. The default is [0, 0, 1].
2776
+ The vector representing the up direction of the I-shape. Default is [0, 0, 1].
2777
2777
  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".
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. Default is "center".
2779
2779
  tolerance : float , optional
2780
- The desired tolerance. The default is 0.0001.
2780
+ The desired tolerance. Default is 0.0001.
2781
2781
  silent : bool , optional
2782
- If set to True, error and warning messages are suppressed. The default is False.
2782
+ If set to True, error and warning messages are suppressed. Default is False.
2783
2783
 
2784
2784
  Returns
2785
2785
  -------
@@ -2905,7 +2905,7 @@ class Wire():
2905
2905
  wire : topologic_core.Wire
2906
2906
  The input wire.
2907
2907
  mantissa : int , optional
2908
- The desired length of the mantissa. The default is 6.
2908
+ The number of decimal places to round the result to. Default is 6.
2909
2909
 
2910
2910
  Returns
2911
2911
  -------
@@ -2939,13 +2939,13 @@ class Wire():
2939
2939
  Parameters
2940
2940
  ----------
2941
2941
  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).
2942
+ The origin location of the box. Default is None which results in the edge being placed at (0, 0, 0).
2943
2943
  length : float , optional
2944
- The desired length of the edge. The default is 1.0.
2944
+ The desired length of the edge. Default is 1.0.
2945
2945
  direction : list , optional
2946
- The desired direction (vector) of the edge. The default is [1, 0, 0] (along the X-axis).
2946
+ The desired direction (vector) of the edge. Default is [1, 0, 0] (along the X-axis).
2947
2947
  sides : int , optional
2948
- The desired number of sides/segments. The minimum number of sides is 2. The default is 2.
2948
+ The desired number of sides/segments. The minimum number of sides is 2. Default is 2.
2949
2949
  placement : str , optional
2950
2950
  The desired placement of the edge. The options are:
2951
2951
  1. "center" which places the center of the edge at the origin.
@@ -2953,7 +2953,7 @@ class Wire():
2953
2953
  3. "end" which places the end of the edge at the origin.
2954
2954
  The default is "center".
2955
2955
  tolerance : float , optional
2956
- The desired tolerance. The default is 0.0001.
2956
+ The desired tolerance. Default is 0.0001.
2957
2957
 
2958
2958
  Returns
2959
2959
  -------
@@ -3009,23 +3009,23 @@ class Wire():
3009
3009
  Parameters
3010
3010
  ----------
3011
3011
  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).
3012
+ 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
3013
  width : float , optional
3014
- The overall width of the L-shape. The default is 1.0.
3014
+ The overall width of the L-shape. Default is 1.0.
3015
3015
  length : float , optional
3016
- The overall length of the L-shape. The default is 1.0.
3016
+ The overall length of the L-shape. Default is 1.0.
3017
3017
  a : float , optional
3018
- The hortizontal thickness of the vertical arm of the L-shape. The default is 0.25.
3018
+ The hortizontal thickness of the vertical arm of the L-shape. Default is 0.25.
3019
3019
  b : float , optional
3020
- The vertical thickness of the horizontal arm of the L-shape. The default is 0.25.
3020
+ The vertical thickness of the horizontal arm of the L-shape. Default is 0.25.
3021
3021
  direction : list , optional
3022
- The vector representing the up direction of the L-shape. The default is [0, 0, 1].
3022
+ The vector representing the up direction of the L-shape. Default is [0, 0, 1].
3023
3023
  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".
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. Default is "center".
3025
3025
  tolerance : float , optional
3026
- The desired tolerance. The default is 0.0001.
3026
+ The desired tolerance. Default is 0.0001.
3027
3027
  silent : bool , optional
3028
- If set to True, error and warning messages are suppressed. The default is False.
3028
+ If set to True, error and warning messages are suppressed. Default is False.
3029
3029
 
3030
3030
  Returns
3031
3031
  -------
@@ -3143,11 +3143,11 @@ class Wire():
3143
3143
  offset : float
3144
3144
  The desired offset length of the miter along each edge.
3145
3145
  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.
3146
+ If specified, the dictionary of the vertices will be queried for this key to specify the desired offset length. Default is None.
3147
3147
  tolerance : float , optional
3148
- The desired tolerance. The default is 0.0001.
3148
+ The desired tolerance. Default is 0.0001.
3149
3149
  silent : bool , optional
3150
- If set to True, error and warning messages are suppressed. The default is False.
3150
+ If set to True, error and warning messages are suppressed. Default is False.
3151
3151
 
3152
3152
  Returns
3153
3153
  -------
@@ -3247,9 +3247,9 @@ class Wire():
3247
3247
  wire : topologic_core.Wire
3248
3248
  The input wire.
3249
3249
  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".
3250
+ The string defining the desired output. This can be any subset or permutation of "xyz". It is case insensitive. Default is "xyz".
3251
3251
  mantissa : int , optional
3252
- The desired length of the mantissa. The default is 6.
3252
+ The number of decimal places to round the result to. Default is 6.
3253
3253
 
3254
3254
  Returns
3255
3255
  -------
@@ -3358,9 +3358,9 @@ class Wire():
3358
3358
  vertexA : topologic_core.Vertex
3359
3359
  The desired start vertex of the wire.
3360
3360
  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.
3361
+ If set to True, the dictionaries of the original wire are transfered to the new wire. Otherwise, they are not. Default is False.
3362
3362
  tolerance : float, optional
3363
- The desired tolerance. The default is 0.0001.
3363
+ The desired tolerance. Default is 0.0001.
3364
3364
 
3365
3365
  Returns
3366
3366
  -------
@@ -3432,11 +3432,11 @@ class Wire():
3432
3432
  wire : topologic_core.Wire
3433
3433
  The input wire.
3434
3434
  tolerance : float, optional
3435
- The desired tolerance. The default is 0.0001.
3435
+ The desired tolerance. Default is 0.0001.
3436
3436
  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.
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. Default is None.
3438
3438
  mantissa : int , optional
3439
- The desired length of the mantissa. The default is 6.
3439
+ The number of decimal places to round the result to. Default is 6.
3440
3440
 
3441
3441
  Returns
3442
3442
  -------
@@ -3492,11 +3492,11 @@ class Wire():
3492
3492
  face : topologic_core.Face
3493
3493
  The face unto which to project the input wire.
3494
3494
  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.
3495
+ 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
3496
  mantissa : int , optional
3497
- The desired length of the mantissa. The default is 6.
3497
+ The number of decimal places to round the result to. Default is 6.
3498
3498
  tolerance : float , optional
3499
- The desired tolerance. The default is 0.0001.
3499
+ The desired tolerance. Default is 0.0001.
3500
3500
 
3501
3501
  Returns
3502
3502
  -------
@@ -3551,21 +3551,21 @@ class Wire():
3551
3551
  Parameters
3552
3552
  ----------
3553
3553
  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).
3554
+ The location of the origin of the rectangle. Default is None which results in the rectangle being placed at (0, 0, 0).
3555
3555
  width : float , optional
3556
- The width of the rectangle. The default is 1.0.
3556
+ The width of the rectangle. Default is 1.0.
3557
3557
  length : float , optional
3558
- The length of the rectangle. The default is 1.0.
3558
+ The length of the rectangle. Default is 1.0.
3559
3559
  direction : list , optional
3560
- The vector representing the up direction of the rectangle. The default is [0, 0, 1].
3560
+ The vector representing the up direction of the rectangle. Default is [0, 0, 1].
3561
3561
  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".
3562
+ 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
3563
  angTolerance : float , optional
3564
- The desired angular tolerance. The default is 0.1.
3564
+ The desired angular tolerance. Default is 0.1.
3565
3565
  tolerance : float , optional
3566
- The desired tolerance. The default is 0.0001.
3566
+ The desired tolerance. Default is 0.0001.
3567
3567
  silent : bool , optional
3568
- If set to True, error and warning messages are suppressed. The default is False.
3568
+ If set to True, error and warning messages are suppressed. Default is False.
3569
3569
 
3570
3570
  Returns
3571
3571
  -------
@@ -3631,11 +3631,11 @@ class Wire():
3631
3631
  wire : topologic_core.Wire
3632
3632
  The input wire.
3633
3633
  angTolerance : float, optional
3634
- The desired angular tolerance. The default is 0.1.
3634
+ The desired angular tolerance. Default is 0.1.
3635
3635
  tolerance : float, optional
3636
- The desired tolerance. The default is 0.0001.
3636
+ The desired tolerance. Default is 0.0001.
3637
3637
  silent : bool, optional
3638
- If set to True, error and warning messages are suppressed. The default is False.
3638
+ If set to True, error and warning messages are suppressed. Default is False.
3639
3639
 
3640
3640
  Returns
3641
3641
  -------
@@ -3724,13 +3724,13 @@ class Wire():
3724
3724
  wire : topologic_core.Wire
3725
3725
  The input wire.
3726
3726
  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.
3727
+ 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
3728
  rotate : bool , optional
3729
3729
  If set to True, the list is rotated such that the shortest edge appears first.
3730
3730
  mantissa : int , optional
3731
- The desired length of the mantissa. The default is 6.
3731
+ The number of decimal places to round the result to. Default is 6.
3732
3732
  tolerance : float , optional
3733
- The desired tolerance. The default is 0.0001.
3733
+ The desired tolerance. Default is 0.0001.
3734
3734
 
3735
3735
  Returns
3736
3736
  -------
@@ -3806,11 +3806,11 @@ class Wire():
3806
3806
  wire : topologic_core.Wire
3807
3807
  The input wire.
3808
3808
  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.
3809
+ If set to True the dictionaries of the input wire are transferred to the new wire. Othwerwise, they are not. Default is False.
3810
3810
  tolerance : float , optional
3811
- The desired tolerance. The default is 0.0001.
3811
+ The desired tolerance. Default is 0.0001.
3812
3812
  silent : bool, optional
3813
- If set to True, error and warning messages are suppressed. The default is False.
3813
+ If set to True, error and warning messages are suppressed. Default is False.
3814
3814
 
3815
3815
  Returns
3816
3816
  -------
@@ -3858,11 +3858,11 @@ class Wire():
3858
3858
  face : topologic_core.Face
3859
3859
  The input face.
3860
3860
  angle : float , optioal
3861
- The desired angle in degrees of the roof. The default is 45.
3861
+ The desired angle in degrees of the roof. Default is 45.
3862
3862
  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.
3863
+ If set to True the original boundary is returned as part of the roof. Otherwise it is not. Default is True.
3864
3864
  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)
3865
+ The desired tolerance. Default is 0.001. (This is set to a larger number as it was found to work better)
3866
3866
 
3867
3867
  Returns
3868
3868
  -------
@@ -3985,7 +3985,7 @@ class Wire():
3985
3985
  between any point and the current line segment; points falling within this distance are discarded.
3986
3986
  The default is 0.0001.
3987
3987
  silent : bool , optional
3988
- If set to True, error and warning messages are suppressed. The default is False.
3988
+ If set to True, error and warning messages are suppressed. Default is False.
3989
3989
 
3990
3990
  Returns
3991
3991
  -------
@@ -4152,9 +4152,9 @@ class Wire():
4152
4152
  face : topologic_core.Face
4153
4153
  The input face.
4154
4154
  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.
4155
+ If set to True the original boundary is returned as part of the roof. Otherwise it is not. Default is True.
4156
4156
  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)
4157
+ The desired tolerance. Default is 0.001. (This is set to a larger number as it was found to work better)
4158
4158
 
4159
4159
  Returns
4160
4160
  -------
@@ -4174,27 +4174,27 @@ class Wire():
4174
4174
  Parameters
4175
4175
  ----------
4176
4176
  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).
4177
+ The location of the origin of the spiral. Default is None which results in the spiral being placed at (0, 0, 0).
4178
4178
  radiusA : float , optional
4179
- The initial radius of the spiral. The default is 0.05.
4179
+ The initial radius of the spiral. Default is 0.05.
4180
4180
  radiusB : float , optional
4181
- The final radius of the spiral. The default is 0.5.
4181
+ The final radius of the spiral. Default is 0.5.
4182
4182
  height : float , optional
4183
- The height of the spiral. The default is 1.
4183
+ The height of the spiral. Default is 1.
4184
4184
  turns : int , optional
4185
- The number of turns of the spiral. The default is 10.
4185
+ The number of turns of the spiral. Default is 10.
4186
4186
  sides : int , optional
4187
- The number of sides of one full turn in the spiral. The default is 36.
4187
+ The number of sides of one full turn in the spiral. Default is 36.
4188
4188
  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.
4189
+ 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
4190
  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.
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. Default is False.
4192
4192
  direction : list , optional
4193
- The vector representing the up direction of the spiral. The default is [0, 0, 1].
4193
+ The vector representing the up direction of the spiral. Default is [0, 0, 1].
4194
4194
  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".
4195
+ 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
4196
  tolerance : float , optional
4197
- The desired tolerance. The default is 0.0001.
4197
+ The desired tolerance. Default is 0.0001.
4198
4198
  Returns
4199
4199
  -------
4200
4200
  topologic_core.Wire
@@ -4373,15 +4373,15 @@ class Wire():
4373
4373
  Parameters
4374
4374
  ----------
4375
4375
  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).
4376
+ The location of the origin of the square. Default is None which results in the square being placed at (0, 0, 0).
4377
4377
  size : float , optional
4378
- The size of the square. The default is 1.0.
4378
+ The size of the square. Default is 1.0.
4379
4379
  direction : list , optional
4380
- The vector representing the up direction of the square. The default is [0, 0, 1].
4380
+ The vector representing the up direction of the square. Default is [0, 0, 1].
4381
4381
  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".
4382
+ 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
4383
  tolerance : float , optional
4384
- The desired tolerance. The default is 0.0001.
4384
+ The desired tolerance. Default is 0.0001.
4385
4385
 
4386
4386
  Returns
4387
4387
  -------
@@ -4399,25 +4399,25 @@ class Wire():
4399
4399
  Parameters
4400
4400
  ----------
4401
4401
  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).
4402
+ The location of the origin of the squircle. Default is None which results in the squircle being placed at (0, 0, 0).
4403
4403
  radius : float , optional
4404
- The desired radius of the squircle. The default is 0.5.
4404
+ The desired radius of the squircle. Default is 0.5.
4405
4405
  sides : int , optional
4406
- The desired number of sides of the squircle. The default is 121.
4406
+ The desired number of sides of the squircle. Default is 121.
4407
4407
  a : float , optional
4408
4408
  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.
4409
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
4410
4410
  b : float , optional
4411
4411
  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.
4412
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
4413
4413
  direction : list , optional
4414
- The vector representing the up direction of the circle. The default is [0, 0, 1].
4414
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
4415
4415
  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".
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. Default is "center".
4417
4417
  angTolerance : float , optional
4418
- The desired angular tolerance. The default is 0.1.
4418
+ The desired angular tolerance. Default is 0.1.
4419
4419
  tolerance : float , optional
4420
- The desired tolerance. The default is 0.0001.
4420
+ The desired tolerance. Default is 0.0001.
4421
4421
 
4422
4422
  Returns
4423
4423
  -------
@@ -4483,19 +4483,19 @@ class Wire():
4483
4483
  Parameters
4484
4484
  ----------
4485
4485
  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).
4486
+ The location of the origin of the star. Default is None which results in the star being placed at (0, 0, 0).
4487
4487
  radiusA : float , optional
4488
- The outer radius of the star. The default is 1.0.
4488
+ The outer radius of the star. Default is 1.0.
4489
4489
  radiusB : float , optional
4490
- The outer radius of the star. The default is 0.4.
4490
+ The outer radius of the star. Default is 0.4.
4491
4491
  rays : int , optional
4492
- The number of star rays. The default is 8.
4492
+ The number of star rays. Default is 8.
4493
4493
  direction : list , optional
4494
- The vector representing the up direction of the star. The default is [0, 0, 1].
4494
+ The vector representing the up direction of the star. Default is [0, 0, 1].
4495
4495
  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".
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. Default is "center".
4497
4497
  tolerance : float , optional
4498
- The desired tolerance. The default is 0.0001.
4498
+ The desired tolerance. Default is 0.0001.
4499
4499
 
4500
4500
  Returns
4501
4501
  -------
@@ -4617,23 +4617,23 @@ class Wire():
4617
4617
  Parameters
4618
4618
  ----------
4619
4619
  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).
4620
+ The location of the origin of the trapezoid. Default is None which results in the trapezoid being placed at (0, 0, 0).
4621
4621
  widthA : float , optional
4622
- The width of the bottom edge of the trapezoid. The default is 1.0.
4622
+ The width of the bottom edge of the trapezoid. Default is 1.0.
4623
4623
  widthB : float , optional
4624
- The width of the top edge of the trapezoid. The default is 0.75.
4624
+ The width of the top edge of the trapezoid. Default is 0.75.
4625
4625
  offsetA : float , optional
4626
- The offset of the bottom edge of the trapezoid. The default is 0.0.
4626
+ The offset of the bottom edge of the trapezoid. Default is 0.0.
4627
4627
  offsetB : float , optional
4628
- The offset of the top edge of the trapezoid. The default is 0.0.
4628
+ The offset of the top edge of the trapezoid. Default is 0.0.
4629
4629
  length : float , optional
4630
- The length of the trapezoid. The default is 1.0.
4630
+ The length of the trapezoid. Default is 1.0.
4631
4631
  direction : list , optional
4632
- The vector representing the up direction of the trapezoid. The default is [0, 0, 1].
4632
+ The vector representing the up direction of the trapezoid. Default is [0, 0, 1].
4633
4633
  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".
4634
+ 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
4635
  tolerance : float , optional
4636
- The desired tolerance. The default is 0.0001.
4636
+ The desired tolerance. Default is 0.0001.
4637
4637
 
4638
4638
  Returns
4639
4639
  -------
@@ -4701,23 +4701,23 @@ class Wire():
4701
4701
  Parameters
4702
4702
  ----------
4703
4703
  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).
4704
+ 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
4705
  width : float , optional
4706
- The overall width of the T-shape. The default is 1.0.
4706
+ The overall width of the T-shape. Default is 1.0.
4707
4707
  length : float , optional
4708
- The overall length of the T-shape. The default is 1.0.
4708
+ The overall length of the T-shape. Default is 1.0.
4709
4709
  a : float , optional
4710
- The hortizontal thickness of the vertical arm of the T-shape. The default is 0.25.
4710
+ The hortizontal thickness of the vertical arm of the T-shape. Default is 0.25.
4711
4711
  b : float , optional
4712
- The vertical thickness of the horizontal arm of the T-shape. The default is 0.25.
4712
+ The vertical thickness of the horizontal arm of the T-shape. Default is 0.25.
4713
4713
  direction : list , optional
4714
- The vector representing the up direction of the T-shape. The default is [0, 0, 1].
4714
+ The vector representing the up direction of the T-shape. Default is [0, 0, 1].
4715
4715
  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".
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. Default is "center".
4717
4717
  tolerance : float , optional
4718
- The desired tolerance. The default is 0.0001.
4718
+ The desired tolerance. Default is 0.0001.
4719
4719
  silent : bool , optional
4720
- If set to True, error and warning messages are suppressed. The default is False.
4720
+ If set to True, error and warning messages are suppressed. Default is False.
4721
4721
 
4722
4722
  Returns
4723
4723
  -------
@@ -4837,11 +4837,11 @@ class Wire():
4837
4837
  vertex : topologic_core.Vertex
4838
4838
  The input vertex
4839
4839
  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.
4840
+ 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
4841
  mantissa : int , optional
4842
- The desired length of the mantissa. The default is 6.
4842
+ The number of decimal places to round the result to. Default is 6.
4843
4843
  tolerance : float , optional
4844
- The desired tolerance. The default is 0.0001.
4844
+ The desired tolerance. Default is 0.0001.
4845
4845
 
4846
4846
  Returns
4847
4847
  -------
@@ -4906,11 +4906,11 @@ class Wire():
4906
4906
  wire : topologic_core.Wire
4907
4907
  The input wire.
4908
4908
  distance : float , optional
4909
- The offset distance. The default is 0.
4909
+ The offset distance. Default is 0.
4910
4910
  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.
4911
+ 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
4912
  tolerance : float , optional
4913
- The desired tolerance. The default is 0.0001.
4913
+ The desired tolerance. Default is 0.0001.
4914
4914
 
4915
4915
  Returns
4916
4916
  -------
@@ -4978,7 +4978,7 @@ class Wire():
4978
4978
  wire : topologic_core.Wire
4979
4979
  The input wire.
4980
4980
  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.
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. Default is 0.
4982
4982
 
4983
4983
  Returns
4984
4984
  -------