topologicpy 0.8.45__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/Face.py CHANGED
@@ -112,7 +112,7 @@ class Face():
112
112
  faceB : topologic_core.Face
113
113
  The second input face.
114
114
  mantissa : int , optional
115
- The desired length of the mantissa. The default is 6.
115
+ The number of decimal places to round the result to. Default is 6.
116
116
 
117
117
  Returns
118
118
  -------
@@ -146,7 +146,7 @@ class Face():
146
146
  face : topologic_core.Face
147
147
  The input face.
148
148
  mantissa : int , optional
149
- The desired length of the mantissa. The default is 6.
149
+ The number of decimal places to round the result to. Default is 6.
150
150
 
151
151
  Returns
152
152
  -------
@@ -176,9 +176,9 @@ class Face():
176
176
  topology : topologic_core.Topology
177
177
  The input topology.
178
178
  optimize : int , optional
179
- 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. The default is 0 which will result in an axis-aligned bounding rectangle. The default is 0.
179
+ 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. Default is 0 which will result in an axis-aligned bounding rectangle. Default is 0.
180
180
  tolerance : float , optional
181
- The desired tolerance. The default is 0.0001.
181
+ The desired tolerance. Default is 0.0001.
182
182
 
183
183
  Returns
184
184
  -------
@@ -210,9 +210,9 @@ class Face():
210
210
  edges : list
211
211
  The input list of edges.
212
212
  tolerance : float , optional
213
- The desired tolerance. The default is 0.0001.
213
+ The desired tolerance. Default is 0.0001.
214
214
  silent : bool , optional
215
- If set to True, error and warning messages are suppressed. The default is False.
215
+ If set to True, error and warning messages are suppressed. Default is False.
216
216
 
217
217
  Returns
218
218
  -------
@@ -254,9 +254,9 @@ class Face():
254
254
  cluster : topologic_core.Cluster
255
255
  The input cluster of edges.
256
256
  tolerance : float , optional
257
- The desired tolerance. The default is 0.0001.
257
+ The desired tolerance. Default is 0.0001.
258
258
  silent : bool , optional
259
- If set to True, error and warning messages are suppressed. The default is False.
259
+ If set to True, error and warning messages are suppressed. Default is False.
260
260
 
261
261
  Returns
262
262
  -------
@@ -293,29 +293,29 @@ class Face():
293
293
  face : topologic_core.Face
294
294
  The input face.
295
295
  offset : float , optional
296
- The desired offset distance. The default is 1.0.
296
+ The desired offset distance. Default is 1.0.
297
297
  offsetKey : str , optional
298
- 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".
298
+ 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".
299
299
  stepOffsetA : float , optional
300
- The amount to offset along the previous edge when transitioning between parallel edges with different offsets. The default is 0.
300
+ The amount to offset along the previous edge when transitioning between parallel edges with different offsets. Default is 0.
301
301
  stepOffsetB : float , optional
302
- The amount to offset along the next edge when transitioning between parallel edges with different offsets. The default is 0.
302
+ The amount to offset along the next edge when transitioning between parallel edges with different offsets. Default is 0.
303
303
  stepOffsetKeyA : str , optional
304
- 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".
304
+ 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".
305
305
  stepOffsetKeyB : str , optional
306
- 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".
306
+ 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".
307
307
  bisectors : bool , optional
308
- If set to True, The bisectors (seams) edges will be included in the returned wire. This will result in the returned shape to be a shell rather than a face. The default is False.
308
+ If set to True, The bisectors (seams) edges will be included in the returned wire. This will result in the returned shape to be a shell rather than a face. Default is False.
309
309
  reverse : bool , optional
310
- If set to True, the direction of offsets is reversed. Otherwise, it is not. The default is False.
310
+ If set to True, the direction of offsets is reversed. Otherwise, it is not. Default is False.
311
311
  transferDictionaries : bool , optional
312
- 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.
312
+ 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.
313
313
  epsilon : float , optional
314
- 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)
314
+ 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)
315
315
  tolerance : float , optional
316
- The desired tolerance. The default is 0.0001.
316
+ The desired tolerance. Default is 0.0001.
317
317
  silent : bool , optional
318
- If set to True, error and warning messages are suppressed. The default is False.
318
+ If set to True, error and warning messages are suppressed. Default is False.
319
319
  numWorkers : int , optional
320
320
  Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
321
321
  The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
@@ -430,21 +430,21 @@ class Face():
430
430
  area : float
431
431
  The desired area of the created face.
432
432
  offsetKey : str , optional
433
- The edge dictionary key under which to store the offset value. The default is "offset".
433
+ The edge dictionary key under which to store the offset value. Default is "offset".
434
434
  minOffsetKey : str , optional
435
- 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".
435
+ 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".
436
436
  maxOffsetKey : str , optional
437
- 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".
437
+ 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".
438
438
  defaultMinOffset : float , optional
439
- The desired minimum edge offset distance. The default is 0.
439
+ The desired minimum edge offset distance. Default is 0.
440
440
  defaultMaxOffset : float , optional
441
- The desired maximum edge offset distance. The default is 1.
441
+ The desired maximum edge offset distance. Default is 1.
442
442
  maxIterations: int , optional
443
- The desired maximum number of iterations to attempt to converge on a solution. The default is 1.
443
+ The desired maximum number of iterations to attempt to converge on a solution. Default is 1.
444
444
  tolerance : float , optional
445
- The desired tolerance. The default is 0.0001.
445
+ The desired tolerance. Default is 0.0001.
446
446
  silent : bool , optional
447
- If set to True, error and warning messages are suppressed. The default is False.
447
+ If set to True, error and warning messages are suppressed. Default is False.
448
448
  numWorkers : int , optional
449
449
  Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
450
450
  The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
@@ -568,11 +568,11 @@ class Face():
568
568
  shell : topologic_core.Shell
569
569
  The input shell.
570
570
  angTolerance : float , optional
571
- The desired angular tolerance. The default is 0.1.
571
+ The desired angular tolerance. Default is 0.1.
572
572
  tolerance : float , optional
573
- The desired tolerance. The default is 0.0001.
573
+ The desired tolerance. Default is 0.0001.
574
574
  silent : bool , optional
575
- If set to True, error and warning messages are suppressed. The default is False.
575
+ If set to True, error and warning messages are suppressed. Default is False.
576
576
 
577
577
 
578
578
  Returns
@@ -687,13 +687,13 @@ class Face():
687
687
  wire : topologic_core.Wire
688
688
  The input wire to be thickened.
689
689
  offsetA : float , optional
690
- The desired offset to the exterior of the wire. The default is 1.0.
690
+ The desired offset to the exterior of the wire. Default is 1.0.
691
691
  offsetB : float , optional
692
- The desired offset to the interior of the wire. The default is 0.0.
692
+ The desired offset to the interior of the wire. Default is 0.0.
693
693
  tolerance : float , optional
694
- The desired tolerance. The default is 0.0001.
694
+ The desired tolerance. Default is 0.0001.
695
695
  silent : bool , optional
696
- If set to True, error and warning messages are suppressed. The default is False.
696
+ If set to True, error and warning messages are suppressed. Default is False.
697
697
 
698
698
  Returns
699
699
  -------
@@ -754,9 +754,9 @@ class Face():
754
754
  vertices : list
755
755
  The input list of vertices.
756
756
  tolerance : float , optional
757
- The desired tolerance. The default is 0.0001.
757
+ The desired tolerance. Default is 0.0001.
758
758
  silent : bool , optional
759
- If set to True, error and warning messages are suppressed. The default is False.
759
+ If set to True, error and warning messages are suppressed. Default is False.
760
760
 
761
761
  Returns
762
762
  -------
@@ -803,9 +803,9 @@ class Face():
803
803
  cluster : topologic_core.Cluster
804
804
  The input cluster of vertices.
805
805
  tolerance : float , optional
806
- The desired tolerance. The default is 0.0001.
806
+ The desired tolerance. Default is 0.0001.
807
807
  silent : bool , optional
808
- If set to True, error and warning messages are suppressed. The default is False.
808
+ If set to True, error and warning messages are suppressed. Default is False.
809
809
 
810
810
  Returns
811
811
  -------
@@ -836,9 +836,9 @@ class Face():
836
836
  wire : topologic_core.Wire
837
837
  The input wire.
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
  -------
@@ -928,11 +928,11 @@ class Face():
928
928
  externalBoundary : topologic_core.Wire
929
929
  The input external boundary.
930
930
  internalBoundaries : list , optional
931
- The input list of internal boundaries (closed wires). The default is an empty list.
931
+ The input list of internal boundaries (closed wires). Default is an empty list.
932
932
  tolerance : float , optional
933
- The desired tolerance. The default is 0.0001.
933
+ The desired tolerance. Default is 0.0001.
934
934
  silent : bool , optional
935
- If set to True, error and warning messages are suppressed. The default is False.
935
+ If set to True, error and warning messages are suppressed. Default is False.
936
936
 
937
937
  Returns
938
938
  -------
@@ -981,11 +981,11 @@ class Face():
981
981
  externalBoundary topologic_core.Wire
982
982
  The input external boundary (closed wire).
983
983
  internalBoundariesCluster : topologic_core.Cluster
984
- The input cluster of internal boundaries (closed wires). The default is None.
984
+ The input cluster of internal boundaries (closed wires). Default is None.
985
985
  tolerance : float , optional
986
- The desired tolerance. The default is 0.0001.
986
+ The desired tolerance. Default is 0.0001.
987
987
  silent : bool , optional
988
- If set to True, error and warning messages are suppressed. The default is False.
988
+ If set to True, error and warning messages are suppressed. Default is False.
989
989
 
990
990
  Returns
991
991
  -------
@@ -1023,19 +1023,19 @@ class Face():
1023
1023
  Parameters
1024
1024
  ----------
1025
1025
  origin : topologic_core.Vertex, optional
1026
- The location of the origin of the CHS. The default is None which results in the CHS being placed at (0, 0, 0).
1026
+ The location of the origin of the CHS. Default is None which results in the CHS being placed at (0, 0, 0).
1027
1027
  radius : float , optional
1028
- The outer radius of the CHS. The default is 0.5.
1028
+ The outer radius of the CHS. Default is 0.5.
1029
1029
  thickness : float , optional
1030
- The thickness of the CHS. The default is 0.25.
1030
+ The thickness of the CHS. Default is 0.25.
1031
1031
  direction : list , optional
1032
- The vector representing the up direction of the CHS. The default is [0, 0, 1].
1032
+ The vector representing the up direction of the CHS. Default is [0, 0, 1].
1033
1033
  placement : str , optional
1034
- The description of the placement of the origin of the CHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
1034
+ The description of the placement of the origin of the CHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
1035
1035
  tolerance : float , optional
1036
- The desired tolerance. The default is 0.0001.
1036
+ The desired tolerance. Default is 0.0001.
1037
1037
  silent : bool , optional
1038
- If set to True, error and warning messages are suppressed. The default is False.
1038
+ If set to True, error and warning messages are suppressed. Default is False.
1039
1039
 
1040
1040
  Returns
1041
1041
  -------
@@ -1092,21 +1092,21 @@ class Face():
1092
1092
  Parameters
1093
1093
  ----------
1094
1094
  origin : topologic_core.Vertex, optional
1095
- The location of the origin of the circle. The default is None which results in the circle being placed at (0, 0, 0).
1095
+ The location of the origin of the circle. Default is None which results in the circle being placed at (0, 0, 0).
1096
1096
  radius : float , optional
1097
- The radius of the circle. The default is 1.
1097
+ The radius of the circle. Default is 1.
1098
1098
  sides : int , optional
1099
- The number of sides of the circle. The default is 16.
1099
+ The number of sides of the circle. Default is 16.
1100
1100
  fromAngle : float , optional
1101
- The angle in degrees from which to start creating the arc of the circle. The default is 0.
1101
+ The angle in degrees from which to start creating the arc of the circle. Default is 0.
1102
1102
  toAngle : float , optional
1103
- The angle in degrees at which to end creating the arc of the circle. The default is 360.
1103
+ The angle in degrees at which to end creating the arc of the circle. Default is 360.
1104
1104
  direction : list , optional
1105
- The vector representing the up direction of the circle. The default is [0, 0, 1].
1105
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
1106
1106
  placement : str , optional
1107
- 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".
1107
+ 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".
1108
1108
  tolerance : float , optional
1109
- The desired tolerance. The default is 0.0001.
1109
+ The desired tolerance. Default is 0.0001.
1110
1110
 
1111
1111
  Returns
1112
1112
  -------
@@ -1132,7 +1132,7 @@ class Face():
1132
1132
  face : topologic_core.Face
1133
1133
  The input face.
1134
1134
  mantissa : int , optional
1135
- The desired length of the mantissa. The default is 6.
1135
+ The number of decimal places to round the result to. Default is 6.
1136
1136
 
1137
1137
  Returns
1138
1138
  -------
@@ -1169,11 +1169,11 @@ class Face():
1169
1169
  face : topologic_core.Face
1170
1170
  The input face.
1171
1171
  north : list , optional
1172
- The second vector representing the north direction. The default is the positive YAxis ([0,1,0]).
1172
+ The second vector representing the north direction. Default is the positive YAxis ([0,1,0]).
1173
1173
  mantissa : int, optional
1174
- The length of the desired mantissa. The default is 6.
1174
+ The length of the desired mantissa. Default is 6.
1175
1175
  tolerance : float , optional
1176
- The desired tolerance. The default is 0.0001.
1176
+ The desired tolerance. Default is 0.0001.
1177
1177
 
1178
1178
  Returns
1179
1179
  -------
@@ -1211,27 +1211,27 @@ class Face():
1211
1211
  Parameters
1212
1212
  ----------
1213
1213
  origin : topologic_core.Vertex , optional
1214
- 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).
1214
+ The location of the origin of the T-shape. Default is None which results in the Cross-shape being placed at (0, 0, 0).
1215
1215
  width : float , optional
1216
- The overall width of the Cross-shape. The default is 1.0.
1216
+ The overall width of the Cross-shape. Default is 1.0.
1217
1217
  length : float , optional
1218
- The overall length of the Cross-shape. The default is 1.0.
1218
+ The overall length of the Cross-shape. Default is 1.0.
1219
1219
  a : float , optional
1220
- The hortizontal thickness of the vertical arm of the Cross-shape. The default is 0.25.
1220
+ The hortizontal thickness of the vertical arm of the Cross-shape. Default is 0.25.
1221
1221
  b : float , optional
1222
- The vertical thickness of the horizontal arm of the Cross-shape. The default is 0.25.
1222
+ The vertical thickness of the horizontal arm of the Cross-shape. Default is 0.25.
1223
1223
  c : float , optional
1224
- 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.
1224
+ 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.
1225
1225
  d : float , optional
1226
- 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.
1226
+ 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.
1227
1227
  direction : list , optional
1228
- The vector representing the up direction of the Cross-shape. The default is [0, 0, 1].
1228
+ The vector representing the up direction of the Cross-shape. Default is [0, 0, 1].
1229
1229
  placement : str , optional
1230
- 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".
1230
+ 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".
1231
1231
  tolerance : float , optional
1232
- The desired tolerance. The default is 0.0001.
1232
+ The desired tolerance. Default is 0.0001.
1233
1233
  silent : bool , optional
1234
- If set to True, error and warning messages are suppressed. The default is False.
1234
+ If set to True, error and warning messages are suppressed. Default is False.
1235
1235
 
1236
1236
  Returns
1237
1237
  -------
@@ -1366,25 +1366,25 @@ class Face():
1366
1366
  Parameters
1367
1367
  ----------
1368
1368
  origin : topologic_core.Vertex , optional
1369
- 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).
1369
+ The location of the origin of the C-shape. Default is None which results in the C-shape being placed at (0, 0, 0).
1370
1370
  width : float , optional
1371
- The overall width of the C-shape. The default is 1.0.
1371
+ The overall width of the C-shape. Default is 1.0.
1372
1372
  length : float , optional
1373
- The overall length of the C-shape. The default is 1.0.
1373
+ The overall length of the C-shape. Default is 1.0.
1374
1374
  a : float , optional
1375
- The hortizontal thickness of the vertical arm of the C-shape. The default is 0.25.
1375
+ The hortizontal thickness of the vertical arm of the C-shape. Default is 0.25.
1376
1376
  b : float , optional
1377
- The vertical thickness of the bottom horizontal arm of the C-shape. The default is 0.25.
1377
+ The vertical thickness of the bottom horizontal arm of the C-shape. Default is 0.25.
1378
1378
  c : float , optional
1379
- The vertical thickness of the top horizontal arm of the C-shape. The default is 0.25.
1379
+ The vertical thickness of the top horizontal arm of the C-shape. Default is 0.25.
1380
1380
  direction : list , optional
1381
- The vector representing the up direction of the C-shape. The default is [0, 0, 1].
1381
+ The vector representing the up direction of the C-shape. Default is [0, 0, 1].
1382
1382
  placement : str , optional
1383
- 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".
1383
+ 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".
1384
1384
  tolerance : float , optional
1385
- The desired tolerance. The default is 0.0001.
1385
+ The desired tolerance. Default is 0.0001.
1386
1386
  silent : bool , optional
1387
- If set to True, error and warning messages are suppressed. The default is False.
1387
+ If set to True, error and warning messages are suppressed. Default is False.
1388
1388
 
1389
1389
  Returns
1390
1390
  -------
@@ -1497,15 +1497,15 @@ class Face():
1497
1497
  Parameters
1498
1498
  ----------
1499
1499
  origin : topologic_core.Vertex , optional
1500
- 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).
1500
+ The location of the origin of the tile. Default is None which results in the tiles first vertex being placed at (0, 0, 0).
1501
1501
  radius : float , optional
1502
- The radius of the hexagon determining the size of the tile. The default is 0.5.
1502
+ The radius of the hexagon determining the size of the tile. Default is 0.5.
1503
1503
  direction : list , optional
1504
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
1504
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
1505
1505
  placement : str , optional
1506
- 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".
1506
+ 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".
1507
1507
  tolerance : float , optional
1508
- The desired tolerance. The default is 0.0001.
1508
+ The desired tolerance. Default is 0.0001.
1509
1509
 
1510
1510
  Returns
1511
1511
  -------
@@ -1532,40 +1532,40 @@ class Face():
1532
1532
  Parameters
1533
1533
  ----------
1534
1534
  origin : topologic_core.Vertex , optional
1535
- The location of the origin of the ellipse. The default is None which results in the ellipse being placed at (0, 0, 0).
1535
+ The location of the origin of the ellipse. Default is None which results in the ellipse being placed at (0, 0, 0).
1536
1536
  inputMode : int , optional
1537
- The method by which the ellipse is defined. The default is 1.
1537
+ The method by which the ellipse is defined. Default is 1.
1538
1538
  Based on the inputMode value, only the following inputs will be considered. The options are:
1539
1539
  1. Width and Length (considered inputs: width, length)
1540
1540
  2. Focal Length and Eccentricity (considered inputs: focalLength, eccentricity)
1541
1541
  3. Focal Length and Minor Axis Length (considered inputs: focalLength, minorAxisLength)
1542
1542
  4. Major Axis Length and Minor Axis Length (considered input: majorAxisLength, minorAxisLength)
1543
1543
  width : float , optional
1544
- The width of the ellipse. The default is 2.0. This is considered if the inputMode is 1.
1544
+ The width of the ellipse. Default is 2.0. This is considered if the inputMode is 1.
1545
1545
  length : float , optional
1546
- The length of the ellipse. The default is 1.0. This is considered if the inputMode is 1.
1546
+ The length of the ellipse. Default is 1.0. This is considered if the inputMode is 1.
1547
1547
  focalLength : float , optional
1548
- The focal length of the ellipse. The default is 0.866025. This is considered if the inputMode is 2 or 3.
1548
+ The focal length of the ellipse. Default is 0.866025. This is considered if the inputMode is 2 or 3.
1549
1549
  eccentricity : float , optional
1550
- The eccentricity of the ellipse. The default is 0.866025. This is considered if the inputMode is 2.
1550
+ The eccentricity of the ellipse. Default is 0.866025. This is considered if the inputMode is 2.
1551
1551
  majorAxisLength : float , optional
1552
- The length of the major axis of the ellipse. The default is 1.0. This is considered if the inputMode is 4.
1552
+ The length of the major axis of the ellipse. Default is 1.0. This is considered if the inputMode is 4.
1553
1553
  minorAxisLength : float , optional
1554
- The length of the minor axis of the ellipse. The default is 0.5. This is considered if the inputMode is 3 or 4.
1554
+ The length of the minor axis of the ellipse. Default is 0.5. This is considered if the inputMode is 3 or 4.
1555
1555
  sides : int , optional
1556
- The number of sides of the ellipse. The default is 32.
1556
+ The number of sides of the ellipse. Default is 32.
1557
1557
  fromAngle : float , optional
1558
- The angle in degrees from which to start creating the arc of the ellipse. The default is 0.
1558
+ The angle in degrees from which to start creating the arc of the ellipse. Default is 0.
1559
1559
  toAngle : float , optional
1560
- The angle in degrees at which to end creating the arc of the ellipse. The default is 360.
1560
+ The angle in degrees at which to end creating the arc of the ellipse. Default is 360.
1561
1561
  close : bool , optional
1562
1562
  If set to True, arcs will be closed by connecting the last vertex to the first vertex. Otherwise, they will be left open.
1563
1563
  direction : list , optional
1564
- The vector representing the up direction of the ellipse. The default is [0, 0, 1].
1564
+ The vector representing the up direction of the ellipse. Default is [0, 0, 1].
1565
1565
  placement : str , optional
1566
- 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".
1566
+ The description of the placement of the origin of the ellipse. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
1567
1567
  tolerance : float , optional
1568
- The desired tolerance. The default is 0.0001.
1568
+ The desired tolerance. Default is 0.0001.
1569
1569
 
1570
1570
  Returns
1571
1571
  -------
@@ -1598,7 +1598,7 @@ class Face():
1598
1598
  a simple list of interior angles of the external boundary. For example: [270,270,270,270]. Please note that that the interior angles of the
1599
1599
  internal boundaries are considered to be those interior to the original face. Thus, they are exterior to the internal boundary.
1600
1600
  mantissa : int , optional
1601
- The desired length of the mantissa. The default is 6.
1601
+ The number of decimal places to round the result to. Default is 6.
1602
1602
  Returns
1603
1603
  -------
1604
1604
  list
@@ -1634,7 +1634,7 @@ class Face():
1634
1634
  face : topologic_core.Face
1635
1635
  The input face.
1636
1636
  silent : bool , optional
1637
- If set to True, error and warning messages are suppressed. The default is False.
1637
+ If set to True, error and warning messages are suppressed. Default is False.
1638
1638
 
1639
1639
  Returns
1640
1640
  -------
@@ -1663,13 +1663,13 @@ class Face():
1663
1663
  face : topologic_core.Face
1664
1664
  The input face.
1665
1665
  direction : list , optional
1666
- The input direction. The default is [0,0,-1].
1666
+ The input direction. Default is [0,0,-1].
1667
1667
  asVertex : bool , optional
1668
- If set to True, the direction is treated as an actual vertex in 3D space. The default is False.
1668
+ If set to True, the direction is treated as an actual vertex in 3D space. Default is False.
1669
1669
  mantissa : int , optional
1670
- The desired length of the mantissa. The default is 6.
1670
+ The number of decimal places to round the result to. Default is 6.
1671
1671
  tolerance : float , optional
1672
- The desired tolerance. The default is 0.0001.
1672
+ The desired tolerance. Default is 0.0001.
1673
1673
 
1674
1674
  Returns
1675
1675
  -------
@@ -1703,15 +1703,15 @@ class Face():
1703
1703
  face : topologic_core.Face
1704
1704
  The input face.
1705
1705
  radius : float , optional
1706
- The desired radius of the fillet. The default is 0.
1706
+ The desired radius of the fillet. Default is 0.
1707
1707
  sides : int , optional
1708
- The number of sides (segments) of the fillet. The default is 16.
1708
+ The number of sides (segments) of the fillet. Default is 16.
1709
1709
  radiusKey : str , optional
1710
- If specified, the dictionary of the vertices will be queried for this key to specify the desired fillet radius. The default is None.
1710
+ If specified, the dictionary of the vertices will be queried for this key to specify the desired fillet radius. Default is None.
1711
1711
  tolerance : float , optional
1712
- The desired tolerance. The default is 0.0001.
1712
+ The desired tolerance. Default is 0.0001.
1713
1713
  silent : bool , optional
1714
- If set to True, error and warning messages are suppressed. The default is False.
1714
+ If set to True, error and warning messages are suppressed. Default is False.
1715
1715
 
1716
1716
  Returns
1717
1717
  -------
@@ -1763,9 +1763,9 @@ class Face():
1763
1763
  face : topologic_core.Face
1764
1764
  The input face.
1765
1765
  tolerance : float , optional
1766
- The desired tolerance. The default is 0.0001.
1766
+ The desired tolerance. Default is 0.0001.
1767
1767
  silent : bool , optional
1768
- If set to True, error and warning messages are suppressed. The default is False.
1768
+ If set to True, error and warning messages are suppressed. Default is False.
1769
1769
 
1770
1770
  Returns
1771
1771
  -------
@@ -1813,7 +1813,7 @@ class Face():
1813
1813
  a simple list of interior angles of the external boundary. For example: [90,90,90,90]. Please note that that the interior angles of the
1814
1814
  internal boundaries are considered to be those interior to the original face. Thus, they are exterior to the internal boundary.
1815
1815
  mantissa : int , optional
1816
- The desired length of the mantissa. The default is 6.
1816
+ The number of decimal places to round the result to. Default is 6.
1817
1817
  Returns
1818
1818
  -------
1819
1819
  list
@@ -1872,9 +1872,9 @@ class Face():
1872
1872
  face : topologic_core.Face
1873
1873
  The input face.
1874
1874
  tolerance : float , optional
1875
- The desired tolerance. The default is 0.0001.
1875
+ The desired tolerance. Default is 0.0001.
1876
1876
  silent : bool , optional
1877
- If set to True, error and warning messages are suppressed. The default is False.
1877
+ If set to True, error and warning messages are suppressed. Default is False.
1878
1878
 
1879
1879
  Returns
1880
1880
  -------
@@ -1940,9 +1940,9 @@ class Face():
1940
1940
  face : topologic_core.Face
1941
1941
  The input face.
1942
1942
  tolerance : float , optional
1943
- The desired tolerance. The default is 0.0001.
1943
+ The desired tolerance. Default is 0.0001.
1944
1944
  silent : bool , optional
1945
- If set to True, error and warning messages are suppressed. The default is False.
1945
+ If set to True, error and warning messages are suppressed. Default is False.
1946
1946
 
1947
1947
  Returns
1948
1948
  -------
@@ -1975,9 +1975,9 @@ class Face():
1975
1975
  face : topologic_core.Face
1976
1976
  The input face.
1977
1977
  mantissa : int , optional
1978
- The length of the desired mantissa. The default is 6.
1978
+ The length of the desired mantissa. Default is 6.
1979
1979
  silent : bool , optional
1980
- If set to True no warnings or errors are printed. The default is False.
1980
+ If set to True, error and warning messages are suppressed. Default is False.
1981
1981
  Returns
1982
1982
  -------
1983
1983
  bool
@@ -2006,9 +2006,9 @@ class Face():
2006
2006
  faceB : topologic_core.Face
2007
2007
  The second input face
2008
2008
  mantissa : int , optional
2009
- The length of the desired mantissa. The default is 6.
2009
+ The length of the desired mantissa. Default is 6.
2010
2010
  tolerance : float , optional
2011
- The desired tolerance. The default is 0.0001.
2011
+ The desired tolerance. Default is 0.0001.
2012
2012
 
2013
2013
  Returns
2014
2014
  -------
@@ -2079,29 +2079,29 @@ class Face():
2079
2079
  Parameters
2080
2080
  ----------
2081
2081
  origin : topologic_core.Vertex , optional
2082
- 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).
2082
+ The location of the origin of the I-shape. Default is None which results in the I-shape being placed at (0, 0, 0).
2083
2083
  width : float , optional
2084
- The overall width of the I-shape. The default is 1.0.
2084
+ The overall width of the I-shape. Default is 1.0.
2085
2085
  length : float , optional
2086
- The overall length of the I-shape. The default is 1.0.
2086
+ The overall length of the I-shape. Default is 1.0.
2087
2087
  a : float , optional
2088
- The hortizontal thickness of the central vertical arm of the I-shape. The default is 0.25.
2088
+ The hortizontal thickness of the central vertical arm of the I-shape. Default is 0.25.
2089
2089
  b : float , optional
2090
- The vertical thickness of the bottom horizontal arm of the I-shape. The default is 0.25.
2090
+ The vertical thickness of the bottom horizontal arm of the I-shape. Default is 0.25.
2091
2091
  c : float , optional
2092
- The vertical thickness of the top horizontal arm of the I-shape. The default is 0.25.
2092
+ The vertical thickness of the top horizontal arm of the I-shape. Default is 0.25.
2093
2093
  flipHorizontal : bool , optional
2094
- if set to True, the shape is flipped horizontally. The default is False.
2094
+ if set to True, the shape is flipped horizontally. Default is False.
2095
2095
  flipVertical : bool , optional
2096
- if set to True, the shape is flipped vertically. The default is False.
2096
+ if set to True, the shape is flipped vertically. Default is False.
2097
2097
  direction : list , optional
2098
- The vector representing the up direction of the I-shape. The default is [0, 0, 1].
2098
+ The vector representing the up direction of the I-shape. Default is [0, 0, 1].
2099
2099
  placement : str , optional
2100
- 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".
2100
+ 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".
2101
2101
  tolerance : float , optional
2102
- The desired tolerance. The default is 0.0001.
2102
+ The desired tolerance. Default is 0.0001.
2103
2103
  silent : bool , optional
2104
- If set to True, error and warning messages are suppressed. The default is False.
2104
+ If set to True, error and warning messages are suppressed. Default is False.
2105
2105
 
2106
2106
  Returns
2107
2107
  -------
@@ -2197,17 +2197,17 @@ class Face():
2197
2197
  The vertex representing the location of the viewpoint of the isovist.
2198
2198
  obstacles : list , optional
2199
2199
  A list of wires representing the obstacles within the face. All obstacles are assumed to be within the
2200
- boundary of the face. The default is [].
2200
+ boundary of the face. Default is [].
2201
2201
  direction : list, optional
2202
2202
  The vector representing the direction (in the XY plane) in which the observer is facing. The Z component is ignored.
2203
2203
  The direction follows the Vector.CompassAngle convention where [0,1,0] (North) is considered to be
2204
2204
  in the positive Y direction, [1,0,0] (East) is considered to be in the positive X-direction.
2205
- Angles are measured in a clockwise fashion. The default is [0,1,0] (North).
2205
+ Angles are measured in a clockwise fashion. Default is [0,1,0] (North).
2206
2206
  fov : float , optional
2207
2207
  The horizontal field of view (fov) angle in degrees. See https://en.wikipedia.org/wiki/Field_of_view.
2208
- The acceptable range is 1 to 360. The default is 360.
2208
+ The acceptable range is 1 to 360. Default is 360.
2209
2209
  transferDictionaries : bool , optional
2210
- If set to True, the dictionaries of the encountered edges will be transfered to the isovist edges. The default is False.
2210
+ If set to True, the dictionaries of the encountered edges will be transfered to the isovist edges. Default is False.
2211
2211
  metrics : bool , optional
2212
2212
  If set to True, the following metrics are calculated and stored in the dictionary of the returned isovist. The keys of the values are:
2213
2213
  - viewpoint : list , the x , y , z coordinates of the location of the viewpoint.
@@ -2236,13 +2236,13 @@ class Face():
2236
2236
  - variance: float, "the mean of the square of deviation between all radial lengths and average radial length of an isovist (Benedikt, 1979)." (from isovists.org)
2237
2237
  - skewness: float, "the mean of the cube of deviation between all radial lengths and average radial length of an isovist (Benediky, 1979)." (from isovists.org)
2238
2238
  triangles : bool , optional
2239
- If set to True, the subtended triangles of the isovist are created and stored as contents of the returned isovist face. The default is False.
2239
+ If set to True, the subtended triangles of the isovist are created and stored as contents of the returned isovist face. Default is False.
2240
2240
  mantissa : int , optional
2241
- The desired length of the mantissa. The default is 6.
2241
+ The number of decimal places to round the result to. Default is 6.
2242
2242
  tolerance : float , optional:
2243
- The desired tolerance. The default is 0.0001.
2243
+ The desired tolerance. Default is 0.0001.
2244
2244
  silent : bool , optional
2245
- If set to True, error and warning messages are suppressed. The default is False.
2245
+ If set to True, error and warning messages are suppressed. Default is False.
2246
2246
 
2247
2247
  Returns
2248
2248
  -------
@@ -2813,23 +2813,23 @@ class Face():
2813
2813
  Parameters
2814
2814
  ----------
2815
2815
  origin : topologic_core.Vertex , optional
2816
- 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).
2816
+ The location of the origin of the L-shape. Default is None which results in the L-shape being placed at (0, 0, 0).
2817
2817
  width : float , optional
2818
- The overall width of the L-shape. The default is 1.0.
2818
+ The overall width of the L-shape. Default is 1.0.
2819
2819
  length : float , optional
2820
- The overall length of the L-shape. The default is 1.0.
2820
+ The overall length of the L-shape. Default is 1.0.
2821
2821
  a : float , optional
2822
- The hortizontal thickness of the vertical arm of the L-shape. The default is 0.25.
2822
+ The hortizontal thickness of the vertical arm of the L-shape. Default is 0.25.
2823
2823
  b : float , optional
2824
- The vertical thickness of the horizontal arm of the L-shape. The default is 0.25.
2824
+ The vertical thickness of the horizontal arm of the L-shape. Default is 0.25.
2825
2825
  direction : list , optional
2826
- The vector representing the up direction of the L-shape. The default is [0, 0, 1].
2826
+ The vector representing the up direction of the L-shape. Default is [0, 0, 1].
2827
2827
  placement : str , optional
2828
- 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".
2828
+ 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".
2829
2829
  tolerance : float , optional
2830
- The desired tolerance. The default is 0.0001.
2830
+ The desired tolerance. Default is 0.0001.
2831
2831
  silent : bool , optional
2832
- If set to True, error and warning messages are suppressed. The default is False.
2832
+ If set to True, error and warning messages are suppressed. Default is False.
2833
2833
 
2834
2834
  Returns
2835
2835
  -------
@@ -2918,19 +2918,19 @@ class Face():
2918
2918
  face : topologic_core.Face
2919
2919
  The input face.
2920
2920
  resolution : int , optional
2921
- The desired resolution of the solution (range is 0: standard resolution to 10: high resolution). This determines the density of the sampling along each edge. The default is 0.
2921
+ The desired resolution of the solution (range is 0: standard resolution to 10: high resolution). This determines the density of the sampling along each edge. Default is 0.
2922
2922
  externalVertices : bool , optional
2923
- If set to True, the external vertices of the face will be connected to the nearest vertex on the medial axis. The default is False.
2923
+ If set to True, the external vertices of the face will be connected to the nearest vertex on the medial axis. Default is False.
2924
2924
  internalVertices : bool , optional
2925
- If set to True, the internal vertices of the face will be connected to the nearest vertex on the medial axis. The default is False.
2925
+ If set to True, the internal vertices of the face will be connected to the nearest vertex on the medial axis. Default is False.
2926
2926
  toLeavesOnly : bool , optional
2927
- If set to True, the vertices of the face will be connected to the nearest vertex on the medial axis only if this vertex is a leaf (end point). Otherwise, it will connect to any nearest vertex. The default is False.
2927
+ If set to True, the vertices of the face will be connected to the nearest vertex on the medial axis only if this vertex is a leaf (end point). Otherwise, it will connect to any nearest vertex. Default is False.
2928
2928
  angTolerance : float , optional
2929
- The desired angular tolerance in degrees for removing collinear edges. The default is 0.1.
2929
+ The desired angular tolerance in degrees for removing collinear edges. Default is 0.1.
2930
2930
  tolerance : float , optional
2931
- The desired tolerance. The default is 0.0001.
2931
+ The desired tolerance. Default is 0.0001.
2932
2932
  silent : bool , optional
2933
- If set to True, error and warning messages are suppressed. The default is False.
2933
+ If set to True, error and warning messages are suppressed. Default is False.
2934
2934
 
2935
2935
  Returns
2936
2936
  -------
@@ -3029,9 +3029,9 @@ class Face():
3029
3029
  face : topologic_core.Face
3030
3030
  The input face.
3031
3031
  outputType : string , optional
3032
- The string defining the desired output. This can be any subset or permutation of "xyz". It is case insensitive. The default is "xyz".
3032
+ The string defining the desired output. This can be any subset or permutation of "xyz". It is case insensitive. Default is "xyz".
3033
3033
  mantissa : int , optional
3034
- The desired length of the mantissa. The default is 6.
3034
+ The number of decimal places to round the result to. Default is 6.
3035
3035
 
3036
3036
  Returns
3037
3037
  -------
@@ -3133,11 +3133,11 @@ class Face():
3133
3133
  face : topologic_core.Face
3134
3134
  The input face.
3135
3135
  length : float , optional
3136
- The desired length of the normal edge. The default is 1.
3136
+ The desired length of the normal edge. Default is 1.
3137
3137
  tolerance : float , optional
3138
- The desired tolerance. The default is 0.0001.
3138
+ The desired tolerance. Default is 0.0001.
3139
3139
  silent : bool , optional
3140
- If set to True, error and warning messages are suppressed. The default is False.
3140
+ If set to True, error and warning messages are suppressed. Default is False.
3141
3141
 
3142
3142
  Returns
3143
3143
  -------
@@ -3171,19 +3171,19 @@ class Face():
3171
3171
  Parameters
3172
3172
  ----------
3173
3173
  origin : topologic_core.Vertex, optional
3174
- The location of the origin of the circle. The default is None which results in the circle being placed at (0, 0, 0).
3174
+ The location of the origin of the circle. Default is None which results in the circle being placed at (0, 0, 0).
3175
3175
  radius : float , optional
3176
- The radius of the circle. The default is 1.
3176
+ The radius of the circle. Default is 1.
3177
3177
  sides : int , optional
3178
- The number of sides of the circle. The default is 16.
3178
+ The number of sides of the circle. Default is 16.
3179
3179
  direction : list , optional
3180
- The vector representing the up direction of the circle. The default is [0, 0, 1].
3180
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
3181
3181
  northAngle : float , optional
3182
3182
  The angular offset in degrees from the positive Y axis direction. The angle is measured in a counter-clockwise fashion where 0 is positive Y, 90 is negative X, 180 is negative Y, and 270 is positive X.
3183
3183
  placement : str , optional
3184
- 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".
3184
+ 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".
3185
3185
  tolerance : float , optional
3186
- The desired tolerance. The default is 0.0001.
3186
+ The desired tolerance. Default is 0.0001.
3187
3187
 
3188
3188
  Returns
3189
3189
  -------
@@ -3254,9 +3254,9 @@ class Face():
3254
3254
  face : topologic_core.Face
3255
3255
  The input face.
3256
3256
  origin : topologic_core.Vertex , optional
3257
- The desired vertex to use as the origin of the plane to project the face unto. If set to None, the centroidof the input face is used. The default is None.
3257
+ The desired vertex to use as the origin of the plane to project the face unto. If set to None, the centroidof the input face is used. Default is None.
3258
3258
  tolerance : float , optional
3259
- The desired tolerance. The default is 0.0001.
3259
+ The desired tolerance. Default is 0.0001.
3260
3260
 
3261
3261
  Returns
3262
3262
  -------
@@ -3294,11 +3294,11 @@ class Face():
3294
3294
  faceB : topologic_core.Face
3295
3295
  The face unto which the first input face will be projected.
3296
3296
  direction : list, optional
3297
- The vector direction of the projection. If None, the reverse vector of the receiving face normal will be used. The default is None.
3297
+ The vector direction of the projection. If None, the reverse vector of the receiving face normal will be used. Default is None.
3298
3298
  mantissa : int , optional
3299
- The desired length of the mantissa. The default is 6.
3299
+ The number of decimal places to round the result to. Default is 6.
3300
3300
  tolerance : float , optional
3301
- The desired tolerance. The default is 0.0001.
3301
+ The desired tolerance. Default is 0.0001.
3302
3302
 
3303
3303
  Returns
3304
3304
  -------
@@ -3352,17 +3352,17 @@ class Face():
3352
3352
  Parameters
3353
3353
  ----------
3354
3354
  origin : topologic_core.Vertex, optional
3355
- The location of the origin of the rectangle. The default is None which results in the rectangle being placed at (0, 0, 0).
3355
+ The location of the origin of the rectangle. Default is None which results in the rectangle being placed at (0, 0, 0).
3356
3356
  width : float , optional
3357
- The width of the rectangle. The default is 1.0.
3357
+ The width of the rectangle. Default is 1.0.
3358
3358
  length : float , optional
3359
- The length of the rectangle. The default is 1.0.
3359
+ The length of the rectangle. Default is 1.0.
3360
3360
  direction : list , optional
3361
- The vector representing the up direction of the rectangle. The default is [0, 0, 1].
3361
+ The vector representing the up direction of the rectangle. Default is [0, 0, 1].
3362
3362
  placement : str , optional
3363
- 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".
3363
+ 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".
3364
3364
  tolerance : float , optional
3365
- The desired tolerance. The default is 0.0001.
3365
+ The desired tolerance. Default is 0.0001.
3366
3366
 
3367
3367
  Returns
3368
3368
  -------
@@ -3389,11 +3389,11 @@ class Face():
3389
3389
  face : topologic_core.Face
3390
3390
  The input face.
3391
3391
  angTolerance : float , optional
3392
- The desired angular tolerance. The default is 0.1.
3392
+ The desired angular tolerance. Default is 0.1.
3393
3393
  tolerance : float , optional
3394
- The desired tolerance. The default is 0.0001.
3394
+ The desired tolerance. Default is 0.0001.
3395
3395
  silent : bool , optional
3396
- If set to True, error and warning messages are suppressed. The default is False.
3396
+ If set to True, error and warning messages are suppressed. Default is False.
3397
3397
 
3398
3398
  Returns
3399
3399
  -------
@@ -3424,27 +3424,27 @@ class Face():
3424
3424
  Parameters
3425
3425
  ----------
3426
3426
  origin : topologic_core.Vertex, optional
3427
- The location of the origin of the RHS. The default is None which results in the RHS being placed at (0, 0, 0).
3427
+ The location of the origin of the RHS. Default is None which results in the RHS being placed at (0, 0, 0).
3428
3428
  width : float , optional
3429
- The width of the RHS. The default is 1.0.
3429
+ The width of the RHS. Default is 1.0.
3430
3430
  length : float , optional
3431
- The length of the RHS. The default is 1.0.
3431
+ The length of the RHS. Default is 1.0.
3432
3432
  thickness : float , optional
3433
- The thickness of the RHS. The default is 0.25.
3433
+ The thickness of the RHS. Default is 0.25.
3434
3434
  outerFillet : float , optional
3435
- The outer fillet multiplication factor based on the thickness (e.g. 1t). The default is 0.
3435
+ The outer fillet multiplication factor based on the thickness (e.g. 1t). Default is 0.
3436
3436
  innerFillet : float , optional
3437
- The inner fillet multiplication factor based on the thickness (e.g. 1.5t). The default is 0.
3437
+ The inner fillet multiplication factor based on the thickness (e.g. 1.5t). Default is 0.
3438
3438
  sides : int , optional
3439
- The desired number of sides of the fillets. The default is 16.
3439
+ The desired number of sides of the fillets. Default is 16.
3440
3440
  direction : list , optional
3441
- The vector representing the up direction of the RHS. The default is [0, 0, 1].
3441
+ The vector representing the up direction of the RHS. Default is [0, 0, 1].
3442
3442
  placement : str , optional
3443
- The description of the placement of the origin of the RHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3443
+ The description of the placement of the origin of the RHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3444
3444
  tolerance : float , optional
3445
- The desired tolerance. The default is 0.0001.
3445
+ The desired tolerance. Default is 0.0001.
3446
3446
  silent : bool , optional
3447
- If set to True, error and warning messages are suppressed. The default is False.
3447
+ If set to True, error and warning messages are suppressed. Default is False.
3448
3448
 
3449
3449
  Returns
3450
3450
  -------
@@ -3520,19 +3520,19 @@ class Face():
3520
3520
  Parameters
3521
3521
  ----------
3522
3522
  origin : topologic_core.Vertex, optional
3523
- The location of the origin of the ring. The default is None which results in the ring being placed at (0, 0, 0).
3523
+ The location of the origin of the ring. Default is None which results in the ring being placed at (0, 0, 0).
3524
3524
  radius : float , optional
3525
- The outer radius of the ring. The default is 0.5.
3525
+ The outer radius of the ring. Default is 0.5.
3526
3526
  thickness : float , optional
3527
- The thickness of the ring. The default is 0.25.
3527
+ The thickness of the ring. Default is 0.25.
3528
3528
  direction : list , optional
3529
- The vector representing the up direction of the ring. The default is [0, 0, 1].
3529
+ The vector representing the up direction of the ring. Default is [0, 0, 1].
3530
3530
  placement : str , optional
3531
- The description of the placement of the origin of the ring. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3531
+ The description of the placement of the origin of the ring. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3532
3532
  tolerance : float , optional
3533
- The desired tolerance. The default is 0.0001.
3533
+ The desired tolerance. Default is 0.0001.
3534
3534
  silent : bool , optional
3535
- If set to True, error and warning messages are suppressed. The default is False.
3535
+ If set to True, error and warning messages are suppressed. Default is False.
3536
3536
 
3537
3537
  Returns
3538
3538
  -------
@@ -3561,25 +3561,25 @@ class Face():
3561
3561
  Parameters
3562
3562
  ----------
3563
3563
  origin : topologic_core.Vertex, optional
3564
- The location of the origin of the SHS. The default is None which results in the SHS being placed at (0, 0, 0).
3564
+ The location of the origin of the SHS. Default is None which results in the SHS being placed at (0, 0, 0).
3565
3565
  size : float , optional
3566
- The outer size of the SHS. The default is 1.0.
3566
+ The outer size of the SHS. Default is 1.0.
3567
3567
  thickness : float , optional
3568
- The thickness of the SHS. The default is 0.25.
3568
+ The thickness of the SHS. Default is 0.25.
3569
3569
  outerFillet : float , optional
3570
- The outer fillet multiplication factor based on the thickness (e.g. 1t). The default is 0.
3570
+ The outer fillet multiplication factor based on the thickness (e.g. 1t). Default is 0.
3571
3571
  innerFillet : float , optional
3572
- The inner fillet multiplication factor based on the thickness (e.g. 1.5t). The default is 0.
3572
+ The inner fillet multiplication factor based on the thickness (e.g. 1.5t). Default is 0.
3573
3573
  sides : int , optional
3574
- The desired number of sides of the fillets. The default is 16.
3574
+ The desired number of sides of the fillets. Default is 16.
3575
3575
  direction : list , optional
3576
- The vector representing the up direction of the SHS. The default is [0, 0, 1].
3576
+ The vector representing the up direction of the SHS. Default is [0, 0, 1].
3577
3577
  placement : str , optional
3578
- The description of the placement of the origin of the SHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. The default is "center".
3578
+ The description of the placement of the origin of the SHS. This can be "center", "lowerleft", "upperleft", "lowerright", "upperright". It is case insensitive. Default is "center".
3579
3579
  tolerance : float , optional
3580
- The desired tolerance. The default is 0.0001.
3580
+ The desired tolerance. Default is 0.0001.
3581
3581
  silent : bool , optional
3582
- 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.
3583
3583
 
3584
3584
  Returns
3585
3585
  -------
@@ -3631,7 +3631,7 @@ class Face():
3631
3631
  between any point and the current line segment; points falling within this distance are discarded.
3632
3632
  The default is 0.0001.
3633
3633
  silent : bool , optional
3634
- If set to True, error and warning messages are suppressed. The default is False.
3634
+ If set to True, error and warning messages are suppressed. Default is False.
3635
3635
 
3636
3636
  Returns
3637
3637
  -------
@@ -3669,9 +3669,9 @@ class Face():
3669
3669
  face : topologic_core.Face
3670
3670
  The input face.
3671
3671
  boundary : bool , optional
3672
- If set to True the original boundary is returned as part of the roof. Otherwise it is not. The default is True.
3672
+ If set to True the original boundary is returned as part of the roof. Otherwise it is not. Default is True.
3673
3673
  tolerance : float , optional
3674
- The desired tolerance. The default is 0.001. (This is set to a larger number than the usual 0.0001 as it was found to work better)
3674
+ The desired tolerance. Default is 0.001. (This is set to a larger number than the usual 0.0001 as it was found to work better)
3675
3675
 
3676
3676
  Returns
3677
3677
  -------
@@ -3695,15 +3695,15 @@ class Face():
3695
3695
  Parameters
3696
3696
  ----------
3697
3697
  origin : topologic_core.Vertex , optional
3698
- The location of the origin of the square. The default is None which results in the square being placed at (0, 0, 0).
3698
+ The location of the origin of the square. Default is None which results in the square being placed at (0, 0, 0).
3699
3699
  size : float , optional
3700
- The size of the square. The default is 1.0.
3700
+ The size of the square. Default is 1.0.
3701
3701
  direction : list , optional
3702
- The vector representing the up direction of the square. The default is [0, 0, 1].
3702
+ The vector representing the up direction of the square. Default is [0, 0, 1].
3703
3703
  placement : str , optional
3704
- The description of the placement of the origin of the square. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. The default is "center".
3704
+ The description of the placement of the origin of the square. This can be "center", "lowerleft", "upperleft", "lowerright", or "upperright". It is case insensitive. Default is "center".
3705
3705
  tolerance : float , optional
3706
- The desired tolerance. The default is 0.0001.
3706
+ The desired tolerance. Default is 0.0001.
3707
3707
 
3708
3708
  Returns
3709
3709
  -------
@@ -3722,25 +3722,25 @@ class Face():
3722
3722
  Parameters
3723
3723
  ----------
3724
3724
  origin : topologic_core.Vertex , optional
3725
- The location of the origin of the squircle. The default is None which results in the squircle being placed at (0, 0, 0).
3725
+ The location of the origin of the squircle. Default is None which results in the squircle being placed at (0, 0, 0).
3726
3726
  radius : float , optional
3727
- The desired radius of the squircle. The default is 0.5.
3727
+ The desired radius of the squircle. Default is 0.5.
3728
3728
  sides : int , optional
3729
- The desired number of sides of the squircle. The default is 121.
3729
+ The desired number of sides of the squircle. Default is 121.
3730
3730
  a : float , optional
3731
3731
  The "a" factor affects the x position of the points to interpolate between a circle and a square.
3732
- A value of 1 will create a circle. Higher values will create a more square-like shape. The default is 2.0.
3732
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
3733
3733
  b : float , optional
3734
3734
  The "b" factor affects the y position of the points to interpolate between a circle and a square.
3735
- A value of 1 will create a circle. Higher values will create a more square-like shape. The default is 2.0.
3735
+ A value of 1 will create a circle. Higher values will create a more square-like shape. Default is 2.0.
3736
3736
  direction : list , optional
3737
- The vector representing the up direction of the circle. The default is [0, 0, 1].
3737
+ The vector representing the up direction of the circle. Default is [0, 0, 1].
3738
3738
  placement : str , optional
3739
- 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".
3739
+ 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".
3740
3740
  angTolerance : float , optional
3741
- The desired angular tolerance. The default is 0.1.
3741
+ The desired angular tolerance. Default is 0.1.
3742
3742
  tolerance : float , optional
3743
- The desired tolerance. The default is 0.0001.
3743
+ The desired tolerance. Default is 0.0001.
3744
3744
 
3745
3745
  Returns
3746
3746
  -------
@@ -3759,19 +3759,19 @@ class Face():
3759
3759
  Parameters
3760
3760
  ----------
3761
3761
  origin : topologic_core.Vertex, optional
3762
- The location of the origin of the star. The default is None which results in the star being placed at (0, 0, 0).
3762
+ The location of the origin of the star. Default is None which results in the star being placed at (0, 0, 0).
3763
3763
  radiusA : float , optional
3764
- The outer radius of the star. The default is 1.0.
3764
+ The outer radius of the star. Default is 1.0.
3765
3765
  radiusB : float , optional
3766
- The outer radius of the star. The default is 0.4.
3766
+ The outer radius of the star. Default is 0.4.
3767
3767
  rays : int , optional
3768
- The number of star rays. The default is 5.
3768
+ The number of star rays. Default is 5.
3769
3769
  direction : list , optional
3770
- The vector representing the up direction of the star. The default is [0, 0, 1].
3770
+ The vector representing the up direction of the star. Default is [0, 0, 1].
3771
3771
  placement : str , optional
3772
- 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".
3772
+ 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".
3773
3773
  tolerance : float , optional
3774
- The desired tolerance. The default is 0.0001.
3774
+ The desired tolerance. Default is 0.0001.
3775
3775
 
3776
3776
  Returns
3777
3777
  -------
@@ -3799,9 +3799,9 @@ class Face():
3799
3799
  face : topologic_core.Face
3800
3800
  The input face.
3801
3801
  tolerance : float , optional
3802
- The desired tolerance. The default is 0.0001.
3802
+ The desired tolerance. Default is 0.0001.
3803
3803
  silent : bool , optional
3804
- If set to True, error and warning messages are suppressed. The default is False.
3804
+ If set to True, error and warning messages are suppressed. Default is False.
3805
3805
 
3806
3806
  Returns
3807
3807
  -------
@@ -3851,23 +3851,23 @@ class Face():
3851
3851
  Parameters
3852
3852
  ----------
3853
3853
  origin : topologic_core.Vertex, optional
3854
- The location of the origin of the trapezoid. The default is None which results in the trapezoid being placed at (0, 0, 0).
3854
+ The location of the origin of the trapezoid. Default is None which results in the trapezoid being placed at (0, 0, 0).
3855
3855
  widthA : float , optional
3856
- The width of the bottom edge of the trapezoid. The default is 1.0.
3856
+ The width of the bottom edge of the trapezoid. Default is 1.0.
3857
3857
  widthB : float , optional
3858
- The width of the top edge of the trapezoid. The default is 0.75.
3858
+ The width of the top edge of the trapezoid. Default is 0.75.
3859
3859
  offsetA : float , optional
3860
- The offset of the bottom edge of the trapezoid. The default is 0.0.
3860
+ The offset of the bottom edge of the trapezoid. Default is 0.0.
3861
3861
  offsetB : float , optional
3862
- The offset of the top edge of the trapezoid. The default is 0.0.
3862
+ The offset of the top edge of the trapezoid. Default is 0.0.
3863
3863
  length : float , optional
3864
- The length of the trapezoid. The default is 1.0.
3864
+ The length of the trapezoid. Default is 1.0.
3865
3865
  direction : list , optional
3866
- The vector representing the up direction of the trapezoid. The default is [0, 0, 1].
3866
+ The vector representing the up direction of the trapezoid. Default is [0, 0, 1].
3867
3867
  placement : str , optional
3868
- 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".
3868
+ The description of the placement of the origin of the trapezoid. This can be "center", or "lowerleft". It is case insensitive. Default is "center".
3869
3869
  tolerance : float , optional
3870
- The desired tolerance. The default is 0.0001.
3870
+ The desired tolerance. Default is 0.0001.
3871
3871
 
3872
3872
  Returns
3873
3873
  -------
@@ -3909,11 +3909,11 @@ class Face():
3909
3909
  The desired size of the mesh when using the "mesh" option. If set to None, it will be
3910
3910
  calculated automatically and set to 10% of the overall size of the face.
3911
3911
  mantissa : int , optional
3912
- The desired length of the mantissa. The default is 6.
3912
+ The number of decimal places to round the result to. Default is 6.
3913
3913
  tolerance : float , optional
3914
- The desired tolerance. The default is 0.0001.
3914
+ The desired tolerance. Default is 0.0001.
3915
3915
  silent : bool , optional
3916
- If set to True, error and warning messages are suppressed. The default is False.
3916
+ If set to True, error and warning messages are suppressed. Default is False.
3917
3917
 
3918
3918
  Returns
3919
3919
  -------
@@ -3937,7 +3937,7 @@ class Face():
3937
3937
  meshSize : float , optional
3938
3938
  The desired mesh size.
3939
3939
  tolerance : float , optional
3940
- The desired tolerance. The default is 0.0001.
3940
+ The desired tolerance. Default is 0.0001.
3941
3941
 
3942
3942
  Returns
3943
3943
  -------
@@ -4114,7 +4114,7 @@ class Face():
4114
4114
  wire : topologic_core.Wire
4115
4115
  The input wire.
4116
4116
  reverse : bool , optional
4117
- If set to True, the effect of the trim will be reversed. The default is False.
4117
+ If set to True, the effect of the trim will be reversed. Default is False.
4118
4118
 
4119
4119
  Returns
4120
4120
  -------
@@ -4151,23 +4151,23 @@ class Face():
4151
4151
  Parameters
4152
4152
  ----------
4153
4153
  origin : topologic_core.Vertex , optional
4154
- 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).
4154
+ The location of the origin of the T-shape. Default is None which results in the T-shape being placed at (0, 0, 0).
4155
4155
  width : float , optional
4156
- The overall width of the T-shape. The default is 1.0.
4156
+ The overall width of the T-shape. Default is 1.0.
4157
4157
  length : float , optional
4158
- The overall length of the T-shape. The default is 1.0.
4158
+ The overall length of the T-shape. Default is 1.0.
4159
4159
  a : float , optional
4160
- The hortizontal thickness of the vertical arm of the T-shape. The default is 0.25.
4160
+ The hortizontal thickness of the vertical arm of the T-shape. Default is 0.25.
4161
4161
  b : float , optional
4162
- The vertical thickness of the horizontal arm of the T-shape. The default is 0.25.
4162
+ The vertical thickness of the horizontal arm of the T-shape. Default is 0.25.
4163
4163
  direction : list , optional
4164
- The vector representing the up direction of the T-shape. The default is [0, 0, 1].
4164
+ The vector representing the up direction of the T-shape. Default is [0, 0, 1].
4165
4165
  placement : str , optional
4166
- 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".
4166
+ 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".
4167
4167
  tolerance : float , optional
4168
- The desired tolerance. The default is 0.0001.
4168
+ The desired tolerance. Default is 0.0001.
4169
4169
  silent : bool , optional
4170
- If set to True, error and warning messages are suppressed. The default is False.
4170
+ If set to True, error and warning messages are suppressed. Default is False.
4171
4171
 
4172
4172
  Returns
4173
4173
  -------
@@ -4256,9 +4256,9 @@ class Face():
4256
4256
  face : topologic_core.Face
4257
4257
  The input face.
4258
4258
  u : float , optional
4259
- The *u* parameter of the input face. The default is 0.5.
4259
+ The *u* parameter of the input face. Default is 0.5.
4260
4260
  v : float , optional
4261
- The *v* parameter of the input face. The default is 0.5.
4261
+ The *v* parameter of the input face. Default is 0.5.
4262
4262
 
4263
4263
  Returns
4264
4264
  -------
@@ -4284,9 +4284,9 @@ class Face():
4284
4284
  vertex : topologic_core.Vertex
4285
4285
  The input vertex.
4286
4286
  outputType : string , optional
4287
- The string defining the desired output. This can be any subset or permutation of "uv". It is case insensitive. The default is "uv".
4287
+ The string defining the desired output. This can be any subset or permutation of "uv". It is case insensitive. Default is "uv".
4288
4288
  mantissa : int , optional
4289
- The desired length of the mantissa. The default is 6.
4289
+ The number of decimal places to round the result to. Default is 6.
4290
4290
 
4291
4291
  Returns
4292
4292
  -------