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/ANN.py +19 -19
- topologicpy/BVH.py +5 -5
- topologicpy/CSG.py +17 -17
- topologicpy/Cell.py +295 -295
- topologicpy/CellComplex.py +67 -67
- topologicpy/Cluster.py +35 -35
- topologicpy/Color.py +8 -8
- topologicpy/DGL.py +52 -52
- topologicpy/Dictionary.py +22 -22
- topologicpy/Edge.py +77 -77
- topologicpy/EnergyModel.py +25 -25
- topologicpy/Face.py +270 -270
- topologicpy/Graph.py +1052 -675
- topologicpy/Grid.py +24 -24
- topologicpy/Helper.py +8 -8
- topologicpy/Honeybee.py +13 -13
- topologicpy/Matrix.py +11 -11
- topologicpy/Neo4j.py +21 -21
- topologicpy/Plotly.py +213 -213
- topologicpy/PyG.py +41 -41
- topologicpy/ShapeGrammar.py +7 -7
- topologicpy/Shell.py +104 -104
- topologicpy/Sun.py +46 -46
- topologicpy/Topology.py +392 -392
- topologicpy/Vector.py +25 -25
- topologicpy/Vertex.py +64 -64
- topologicpy/Wire.py +250 -250
- topologicpy/version.py +1 -1
- {topologicpy-0.8.46.dist-info → topologicpy-0.8.47.dist-info}/METADATA +1 -1
- topologicpy-0.8.47.dist-info/RECORD +38 -0
- topologicpy-0.8.46.dist-info/RECORD +0 -38
- {topologicpy-0.8.46.dist-info → topologicpy-0.8.47.dist-info}/WHEEL +0 -0
- {topologicpy-0.8.46.dist-info → topologicpy-0.8.47.dist-info}/licenses/LICENSE +0 -0
- {topologicpy-0.8.46.dist-info → topologicpy-0.8.47.dist-info}/top_level.txt +0 -0
topologicpy/Topology.py
CHANGED
@@ -212,11 +212,11 @@ class Topology():
|
|
212
212
|
apertures : list
|
213
213
|
The input list of apertures.
|
214
214
|
exclusive : bool , optional
|
215
|
-
If set to True, one (sub)topology will accept only one aperture. Otherwise, one (sub)topology can accept multiple apertures.
|
215
|
+
If set to True, one (sub)topology will accept only one aperture. Otherwise, one (sub)topology can accept multiple apertures. Default is False.
|
216
216
|
subTopologyType : string , optional
|
217
|
-
The subtopology type to which to add the apertures. This can be "cell", "face", "edge", or "vertex". It is case insensitive. If set to None, the apertures will be added to the input topology.
|
217
|
+
The subtopology type to which to add the apertures. This can be "cell", "face", "edge", or "vertex". It is case insensitive. If set to None, the apertures will be added to the input topology. Default is None.
|
218
218
|
tolerance : float , optional
|
219
|
-
The desired tolerance.
|
219
|
+
The desired tolerance. Default is 0.001. This is larger than the usual 0.0001 as it seems to work better.
|
220
220
|
|
221
221
|
Returns
|
222
222
|
-------
|
@@ -263,9 +263,9 @@ class Topology():
|
|
263
263
|
contents : list or topologic_core.Topology
|
264
264
|
The input list of contents (of type topologic_core.Topology). A single topology is also accepted as input.
|
265
265
|
subTopologyType : string , optional
|
266
|
-
The subtopology type to which to add the contents. This can be "cellcomplex", "cell", "shell", "face", "wire", "edge", or "vertex". It is case insensitive. If set to None, the contents will be added to the input topology.
|
266
|
+
The subtopology type to which to add the contents. This can be "cellcomplex", "cell", "shell", "face", "wire", "edge", or "vertex". It is case insensitive. If set to None, the contents will be added to the input topology. Default is None.
|
267
267
|
tolerance : float , optional
|
268
|
-
The desired tolerance.
|
268
|
+
The desired tolerance. Default is 0.0001.
|
269
269
|
|
270
270
|
Returns
|
271
271
|
-------
|
@@ -344,7 +344,7 @@ class Topology():
|
|
344
344
|
hostTopology : topologic_core.Topology
|
345
345
|
The host topology in which to search.
|
346
346
|
topologyType : str
|
347
|
-
The type of topology for which to search. This can be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex". It is case-insensitive. If it is set to None, the type will be set to the same type as the input topology.
|
347
|
+
The type of topology for which to search. This can be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex". It is case-insensitive. If it is set to None, the type will be set to the same type as the input topology. Default is None.
|
348
348
|
|
349
349
|
Returns
|
350
350
|
-------
|
@@ -768,7 +768,7 @@ class Topology():
|
|
768
768
|
topology : topologic_core.Topology
|
769
769
|
The input topology.
|
770
770
|
subTopologyType : string , optional
|
771
|
-
The subtopology type from which to retrieve the apertures. This can be "cell", "face", "edge", or "vertex" or "all". It is case insensitive. If set to "all", then all apertures will be returned. If set to None, the apertures will be retrieved only from the input topology.
|
771
|
+
The subtopology type from which to retrieve the apertures. This can be "cell", "face", "edge", or "vertex" or "all". It is case insensitive. If set to "all", then all apertures will be returned. If set to None, the apertures will be retrieved only from the input topology. Default is None.
|
772
772
|
|
773
773
|
Returns
|
774
774
|
-------
|
@@ -827,7 +827,7 @@ class Topology():
|
|
827
827
|
topology : topologic_core.Topology
|
828
828
|
The input topology.
|
829
829
|
subTopologyType : string , optional
|
830
|
-
The subtopology type from which to retrieve the apertures. This can be "cell", "face", "edge", or "vertex" or "all". It is case insensitive. If set to "all", then all apertures will be returned. If set to None, the apertures will be retrieved only from the input topology.
|
830
|
+
The subtopology type from which to retrieve the apertures. This can be "cell", "face", "edge", or "vertex" or "all". It is case insensitive. If set to "all", then all apertures will be returned. If set to None, the apertures will be retrieved only from the input topology. Default is None.
|
831
831
|
|
832
832
|
Returns
|
833
833
|
-------
|
@@ -955,11 +955,11 @@ class Topology():
|
|
955
955
|
sources : list of topologic_core. Topology
|
956
956
|
The list of source topologies from which to inherit dictionary information.
|
957
957
|
exclusive : bool , optional
|
958
|
-
If set to True, a target will inherit information only from the first eligible source.
|
958
|
+
If set to True, a target will inherit information only from the first eligible source. Default is True.
|
959
959
|
tolerance : float , optional
|
960
|
-
The desired tolerance.
|
960
|
+
The desired tolerance. Default is 0.0001.
|
961
961
|
silent : bool , optional
|
962
|
-
If set to True, error and warning messages are suppressed.
|
962
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
963
963
|
|
964
964
|
Returns
|
965
965
|
-------
|
@@ -1134,13 +1134,13 @@ class Topology():
|
|
1134
1134
|
topologyB : topologic_core.Topology
|
1135
1135
|
The second input topology.
|
1136
1136
|
operation : str , optional
|
1137
|
-
The boolean operation. This can be one of "union", "difference", "intersect", "symdif", "merge", "slice", "impose", "imprint". It is case insensitive.
|
1137
|
+
The boolean operation. This can be one of "union", "difference", "intersect", "symdif", "merge", "slice", "impose", "imprint". It is case insensitive. Default is "union".
|
1138
1138
|
tranDict : bool , optional
|
1139
|
-
If set to True the dictionaries of the operands are merged and transferred to the result.
|
1139
|
+
If set to True the dictionaries of the operands are merged and transferred to the result. Default is False.
|
1140
1140
|
tolerance : float , optional
|
1141
|
-
The desired tolerance.
|
1141
|
+
The desired tolerance. Default is 0.0001.
|
1142
1142
|
silent : bool , optional
|
1143
|
-
If set to True, error and warning messages are suppressed.
|
1143
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
1144
1144
|
|
1145
1145
|
Returns
|
1146
1146
|
-------
|
@@ -1279,15 +1279,15 @@ class Topology():
|
|
1279
1279
|
topology : topologic_core.Topology
|
1280
1280
|
The input topology.
|
1281
1281
|
optimize : int , optional
|
1282
|
-
If set to an integer from 1 (low optimization) to 10 (high optimization), the method will attempt to optimize the bounding box so that it reduces its surface area.
|
1282
|
+
If set to an integer from 1 (low optimization) to 10 (high optimization), the method will attempt to optimize the bounding box so that it reduces its surface area. Default is 0 which will result in an axis-aligned bounding box. Default is 0.
|
1283
1283
|
axes : str , optional
|
1284
|
-
Sets what axes are to be used for rotating the bounding box. This can be any permutation or substring of "xyz". It is not case sensitive.
|
1284
|
+
Sets what axes are to be used for rotating the bounding box. This can be any permutation or substring of "xyz". It is not case sensitive. Default is "xyz".
|
1285
1285
|
mantissa : int , optional
|
1286
|
-
The
|
1286
|
+
The number of decimal places to round the result to. Default is 6.
|
1287
1287
|
tolerance : float , optional
|
1288
|
-
The desired tolerance.
|
1288
|
+
The desired tolerance. Default is 0.0001.
|
1289
1289
|
silent : bool , optional
|
1290
|
-
If set to True, error and warning messages are suppressed.
|
1290
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
1291
1291
|
|
1292
1292
|
Returns
|
1293
1293
|
-------
|
@@ -1462,7 +1462,7 @@ class Topology():
|
|
1462
1462
|
topology : topologic_core.Topology
|
1463
1463
|
The input topology.
|
1464
1464
|
version : int , optional
|
1465
|
-
The desired BRep version number.
|
1465
|
+
The desired BRep version number. Default is 3.
|
1466
1466
|
|
1467
1467
|
Returns
|
1468
1468
|
-------
|
@@ -1499,11 +1499,11 @@ class Topology():
|
|
1499
1499
|
topologyType : str , optional
|
1500
1500
|
The desired highest topology type. The options are: "Vertex", "Edge", "Wire", "Face", "Shell", "Cell", "CellComplex".
|
1501
1501
|
It is case insensitive. If any of these options are selected, the returned topology will only contain this type either a single topology
|
1502
|
-
or as a Cluster of these types of topologies. If set to None, a "Cluster" will be returned of vertices, edges, and/or faces.
|
1502
|
+
or as a Cluster of these types of topologies. If set to None, a "Cluster" will be returned of vertices, edges, and/or faces. Default is None.
|
1503
1503
|
tolerance : float , optional
|
1504
|
-
The desired tolerance.
|
1504
|
+
The desired tolerance. Default is 0.0001.
|
1505
1505
|
silent : bool , optional
|
1506
|
-
If set to True, error and warning messages are suppressed.
|
1506
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
1507
1507
|
|
1508
1508
|
Returns
|
1509
1509
|
-------
|
@@ -1636,25 +1636,25 @@ class Topology():
|
|
1636
1636
|
path :str
|
1637
1637
|
The path to the .bim file.
|
1638
1638
|
guidKey : str , optional
|
1639
|
-
The key to use to store the the guid of the topology.
|
1639
|
+
The key to use to store the the guid of the topology. Default is "guid".
|
1640
1640
|
colorKey : str , optional
|
1641
|
-
The key to use to find the the color of the topology.
|
1641
|
+
The key to use to find the the color of the topology. Default is "color". If no color is found, the defaultColor parameter is used.
|
1642
1642
|
typeKey : str , optional
|
1643
|
-
The key to use to find the the type of the topology.
|
1643
|
+
The key to use to find the the type of the topology. Default is "type". If no type is found, the defaultType parameter is used.
|
1644
1644
|
defaultColor : list , optional
|
1645
|
-
The default color to use for the topology.
|
1645
|
+
The default color to use for the topology. Default is [255,255,255,1] which is opaque white.
|
1646
1646
|
defaultType : str , optional
|
1647
|
-
The default type to use for the topology.
|
1647
|
+
The default type to use for the topology. Default is "Structure".
|
1648
1648
|
authorKey : str , optional
|
1649
|
-
The key to use to store the author of the topology.
|
1649
|
+
The key to use to store the author of the topology. Default is "author".
|
1650
1650
|
dateKey : str , optional
|
1651
1651
|
The key to use to store the creation date of the topology. This should be in the formate "DD.MM.YYYY". If no date is found the date of import is used.
|
1652
1652
|
mantissa : int , optional
|
1653
|
-
The
|
1653
|
+
The number of decimal places to round the result to. Default is 6.
|
1654
1654
|
angTolerance : float , optional
|
1655
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
1655
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
1656
1656
|
tolerance : float , optional
|
1657
|
-
The desired tolerance.
|
1657
|
+
The desired tolerance. Default is 0.0001.
|
1658
1658
|
|
1659
1659
|
Returns
|
1660
1660
|
-------
|
@@ -1694,25 +1694,25 @@ class Topology():
|
|
1694
1694
|
string :str
|
1695
1695
|
The input dotbim str (in JSON format).
|
1696
1696
|
guidKey : str , optional
|
1697
|
-
The key to use to store the the guid of the topology.
|
1697
|
+
The key to use to store the the guid of the topology. Default is "guid".
|
1698
1698
|
colorKey : str , optional
|
1699
|
-
The key to use to find the the color of the topology.
|
1699
|
+
The key to use to find the the color of the topology. Default is "color". If no color is found, the defaultColor parameter is used.
|
1700
1700
|
typeKey : str , optional
|
1701
|
-
The key to use to find the the type of the topology.
|
1701
|
+
The key to use to find the the type of the topology. Default is "type". If no type is found, the defaultType parameter is used.
|
1702
1702
|
defaultColor : list , optional
|
1703
|
-
The default color to use for the topology.
|
1703
|
+
The default color to use for the topology. Default is [255,255,255,1] which is opaque white.
|
1704
1704
|
defaultType : str , optional
|
1705
|
-
The default type to use for the topology.
|
1705
|
+
The default type to use for the topology. Default is "Structure".
|
1706
1706
|
authorKey : str , optional
|
1707
|
-
The key to use to store the author of the topology.
|
1707
|
+
The key to use to store the author of the topology. Default is "author".
|
1708
1708
|
dateKey : str , optional
|
1709
1709
|
The key to use to store the creation date of the topology. This should be in the formate "DD.MM.YYYY". If no date is found the date of import is used.
|
1710
1710
|
mantissa : int , optional
|
1711
|
-
The
|
1711
|
+
The number of decimal places to round the result to. Default is 6.
|
1712
1712
|
angTolerance : float , optional
|
1713
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
1713
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
1714
1714
|
tolerance : float , optional
|
1715
|
-
The desired tolerance.
|
1715
|
+
The desired tolerance. Default is 0.0001.
|
1716
1716
|
|
1717
1717
|
Returns
|
1718
1718
|
-------
|
@@ -1784,25 +1784,25 @@ class Topology():
|
|
1784
1784
|
file : dotbimpy.file.File
|
1785
1785
|
The input dotbim file.
|
1786
1786
|
guidKey : str , optional
|
1787
|
-
The key to use to store the the guid of the topology.
|
1787
|
+
The key to use to store the the guid of the topology. Default is "guid".
|
1788
1788
|
colorKey : str , optional
|
1789
|
-
The key to use to find the the color of the topology.
|
1789
|
+
The key to use to find the the color of the topology. Default is "color". If no color is found, the defaultColor parameter is used.
|
1790
1790
|
typeKey : str , optional
|
1791
|
-
The key to use to find the the type of the topology.
|
1791
|
+
The key to use to find the the type of the topology. Default is "type". If no type is found, the defaultType parameter is used.
|
1792
1792
|
defaultColor : list , optional
|
1793
|
-
The default color to use for the topology.
|
1793
|
+
The default color to use for the topology. Default is [255,255,255,1] which is opaque white.
|
1794
1794
|
defaultType : str , optional
|
1795
|
-
The default type to use for the topology.
|
1795
|
+
The default type to use for the topology. Default is "Structure".
|
1796
1796
|
authorKey : str , optional
|
1797
|
-
The key to use to store the author of the topology.
|
1797
|
+
The key to use to store the author of the topology. Default is "author".
|
1798
1798
|
dateKey : str , optional
|
1799
1799
|
The key to use to store the creation date of the topology. This should be in the formate "DD.MM.YYYY". If no date is found the date of import is used.
|
1800
1800
|
mantissa : int , optional
|
1801
|
-
The
|
1801
|
+
The number of decimal places to round the result to. Default is 6.
|
1802
1802
|
angTolerance : float , optional
|
1803
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
1803
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
1804
1804
|
tolerance : float , optional
|
1805
|
-
The desired tolerance.
|
1805
|
+
The desired tolerance. Default is 0.0001.
|
1806
1806
|
|
1807
1807
|
Returns
|
1808
1808
|
-------
|
@@ -1926,11 +1926,11 @@ class Topology():
|
|
1926
1926
|
file : a DXF file object
|
1927
1927
|
The DXF file object.
|
1928
1928
|
sides : int , optional
|
1929
|
-
The desired number of sides of splines.
|
1929
|
+
The desired number of sides of splines. Default is 16.
|
1930
1930
|
tolerance : float , optional
|
1931
|
-
The desired tolerance.
|
1931
|
+
The desired tolerance. Default is 0.0001.
|
1932
1932
|
silent : bool , optional
|
1933
|
-
If set to True, error and warning messages are suppressed.
|
1933
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
1934
1934
|
|
1935
1935
|
Returns
|
1936
1936
|
-------
|
@@ -2150,11 +2150,11 @@ class Topology():
|
|
2150
2150
|
path : str
|
2151
2151
|
The path to the DXF file.
|
2152
2152
|
sides : int , optional
|
2153
|
-
The desired number of sides of splines.
|
2153
|
+
The desired number of sides of splines. Default is 16.
|
2154
2154
|
tolerance : float , optional
|
2155
|
-
The desired tolerance.
|
2155
|
+
The desired tolerance. Default is 0.0001.
|
2156
2156
|
silent : bool , optional
|
2157
|
-
If set to True, error and warning messages are suppressed.
|
2157
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
2158
2158
|
|
2159
2159
|
Returns
|
2160
2160
|
-------
|
@@ -2202,19 +2202,19 @@ class Topology():
|
|
2202
2202
|
ifc_file : file object
|
2203
2203
|
The input IFC file.
|
2204
2204
|
includeTypes : list , optional
|
2205
|
-
The list of IFC object types to include. It is case insensitive. If set to an empty list, all types are included.
|
2205
|
+
The list of IFC object types to include. It is case insensitive. If set to an empty list, all types are included. Default is [].
|
2206
2206
|
excludeTypes : list , optional
|
2207
|
-
The list of IFC object types to exclude. It is case insensitive. If set to an empty list, no types are excluded.
|
2207
|
+
The list of IFC object types to exclude. It is case insensitive. If set to an empty list, no types are excluded. Default is [].
|
2208
2208
|
transferDictionaries : bool , optional
|
2209
|
-
If set to True, the dictionaries from the IFC file will be transferred to the topology. Otherwise, they won't.
|
2209
|
+
If set to True, the dictionaries from the IFC file will be transferred to the topology. Otherwise, they won't. Default is False.
|
2210
2210
|
removeCoplanarFaces : bool , optional
|
2211
|
-
If set to True, coplanar faces are removed. Otherwise they are not.
|
2211
|
+
If set to True, coplanar faces are removed. Otherwise they are not. Default is False.
|
2212
2212
|
epsilon : float , optional
|
2213
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
2213
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
2214
2214
|
tolerance : float , optional
|
2215
|
-
The desired tolerance.
|
2215
|
+
The desired tolerance. Default is 0.0001.
|
2216
2216
|
silent : bool , optional
|
2217
|
-
If set to True, error and warning messages are suppressed.
|
2217
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
2218
2218
|
Returns
|
2219
2219
|
-------
|
2220
2220
|
list
|
@@ -2315,17 +2315,17 @@ class Topology():
|
|
2315
2315
|
path : str
|
2316
2316
|
The path to the IFC file.
|
2317
2317
|
includeTypes : list , optional
|
2318
|
-
The list of IFC object types to include. It is case insensitive. If set to an empty list, all types are included.
|
2318
|
+
The list of IFC object types to include. It is case insensitive. If set to an empty list, all types are included. Default is [].
|
2319
2319
|
excludeTypes : list , optional
|
2320
|
-
The list of IFC object types to exclude. It is case insensitive. If set to an empty list, no types are excluded.
|
2320
|
+
The list of IFC object types to exclude. It is case insensitive. If set to an empty list, no types are excluded. Default is [].
|
2321
2321
|
transferDictionaries : bool , optional
|
2322
|
-
If set to True, the dictionaries from the IFC file will be transferred to the topology. Otherwise, they won't.
|
2322
|
+
If set to True, the dictionaries from the IFC file will be transferred to the topology. Otherwise, they won't. Default is False.
|
2323
2323
|
removeCoplanarFaces : bool , optional
|
2324
|
-
If set to True, coplanar faces are removed. Otherwise they are not.
|
2324
|
+
If set to True, coplanar faces are removed. Otherwise they are not. Default is False.
|
2325
2325
|
epsilon : float , optional
|
2326
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
2326
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.0001.
|
2327
2327
|
tolerance : float , optional
|
2328
|
-
The desired tolerance.
|
2328
|
+
The desired tolerance. Default is 0.0001.
|
2329
2329
|
Returns
|
2330
2330
|
-------
|
2331
2331
|
list
|
@@ -2385,7 +2385,7 @@ class Topology():
|
|
2385
2385
|
file : file object
|
2386
2386
|
The input JSON file.
|
2387
2387
|
tolerance : float , optional
|
2388
|
-
The desired tolerance.
|
2388
|
+
The desired tolerance. Default is 0.0001.
|
2389
2389
|
|
2390
2390
|
Returns
|
2391
2391
|
-------
|
@@ -2409,7 +2409,7 @@ class Topology():
|
|
2409
2409
|
path : str
|
2410
2410
|
The file path to the json file.
|
2411
2411
|
tolerance : float , optional
|
2412
|
-
The desired tolerance.
|
2412
|
+
The desired tolerance. Default is 0.0001.
|
2413
2413
|
|
2414
2414
|
Returns
|
2415
2415
|
-------
|
@@ -2436,7 +2436,7 @@ class Topology():
|
|
2436
2436
|
jsonDictionary : dict
|
2437
2437
|
The input JSON dictionary.
|
2438
2438
|
tolerance : float , optional
|
2439
|
-
The desired tolerance.
|
2439
|
+
The desired tolerance. Default is 0.0001.
|
2440
2440
|
|
2441
2441
|
Returns
|
2442
2442
|
-------
|
@@ -2644,7 +2644,7 @@ class Topology():
|
|
2644
2644
|
string : str
|
2645
2645
|
The input JSON string.
|
2646
2646
|
tolerance : float , optional
|
2647
|
-
The desired tolerance.
|
2647
|
+
The desired tolerance. Default is 0.0001.
|
2648
2648
|
|
2649
2649
|
Returns
|
2650
2650
|
-------
|
@@ -2678,13 +2678,13 @@ class Topology():
|
|
2678
2678
|
'cell_dicts', list of dicts
|
2679
2679
|
}
|
2680
2680
|
transferDictionaries : bool , optional
|
2681
|
-
If set to True, the python dictionaries will be transferred to the coorespoding topologies.
|
2681
|
+
If set to True, the python dictionaries will be transferred to the coorespoding topologies. Default is False.
|
2682
2682
|
mantissa : int , optional
|
2683
|
-
The
|
2683
|
+
The number of decimal places to round the result to. Default is 6.
|
2684
2684
|
tolerance : float , optional
|
2685
|
-
The desired tolerance.
|
2685
|
+
The desired tolerance. Default is 0.0001.
|
2686
2686
|
silent : bool , optional
|
2687
|
-
If set to True, error and warning messages are suppressed.
|
2687
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
2688
2688
|
|
2689
2689
|
Returns
|
2690
2690
|
-------
|
@@ -2796,21 +2796,21 @@ class Topology():
|
|
2796
2796
|
objFile : file object
|
2797
2797
|
The OBJ file.
|
2798
2798
|
mtlFile : file object , optional
|
2799
|
-
The MTL file.
|
2799
|
+
The MTL file. Default is None.
|
2800
2800
|
defaultColor : list , optional
|
2801
|
-
The default color to use if none is specified in the file.
|
2801
|
+
The default color to use if none is specified in the file. Default is [255, 255, 255] (white).
|
2802
2802
|
defaultOpacity : float , optional
|
2803
|
-
The default opacity to use if none is specified in the file.
|
2803
|
+
The default opacity to use if none is specified in the file. Default is 1.0 (fully opaque).
|
2804
2804
|
transposeAxes : bool , optional
|
2805
|
-
If set to True the Z and Y axes are transposed. Otherwise, they are not.
|
2805
|
+
If set to True the Z and Y axes are transposed. Otherwise, they are not. Default is True.
|
2806
2806
|
removeCoplanarFaces : bool , optional
|
2807
|
-
If set to True, coplanar faces are merged.
|
2807
|
+
If set to True, coplanar faces are merged. Default is True.
|
2808
2808
|
selfMerge : bool , optional
|
2809
|
-
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces.
|
2809
|
+
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces. Default is False.
|
2810
2810
|
mantissa : int , optional
|
2811
|
-
The
|
2811
|
+
The number of decimal places to round the result to. Default is 6.
|
2812
2812
|
tolerance : float , optional
|
2813
|
-
The desired tolerance.
|
2813
|
+
The desired tolerance. Default is 0.0001
|
2814
2814
|
|
2815
2815
|
Returns
|
2816
2816
|
-------
|
@@ -2854,19 +2854,19 @@ class Topology():
|
|
2854
2854
|
objPath : str
|
2855
2855
|
The path to the OBJ file.
|
2856
2856
|
defaultColor : list , optional
|
2857
|
-
The default color to use if none is specified in the file.
|
2857
|
+
The default color to use if none is specified in the file. Default is [255, 255, 255] (white).
|
2858
2858
|
defaultOpacity : float , optional
|
2859
|
-
The default opacity to use if none is specified in the file.
|
2859
|
+
The default opacity to use if none is specified in the file. Default is 1.0 (fully opaque).
|
2860
2860
|
transposeAxes : bool , optional
|
2861
|
-
If set to True the Z and Y axes are transposed. Otherwise, they are not.
|
2861
|
+
If set to True the Z and Y axes are transposed. Otherwise, they are not. Default is True.
|
2862
2862
|
removeCoplanarFaces : bool , optional
|
2863
|
-
If set to True, coplanar faces are merged.
|
2863
|
+
If set to True, coplanar faces are merged. Default is True.
|
2864
2864
|
selfMerge : bool , optional
|
2865
|
-
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces.
|
2865
|
+
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces. Default is False.
|
2866
2866
|
mantissa : int , optional
|
2867
|
-
The
|
2867
|
+
The number of decimal places to round the result to. Default is 6.
|
2868
2868
|
tolerance : float , optional
|
2869
|
-
The desired tolerance.
|
2869
|
+
The desired tolerance. Default is 0.0001
|
2870
2870
|
|
2871
2871
|
Returns
|
2872
2872
|
-------
|
@@ -2920,21 +2920,21 @@ class Topology():
|
|
2920
2920
|
objString : str
|
2921
2921
|
The string of the OBJ file.
|
2922
2922
|
mtlString : str , optional
|
2923
|
-
The string of the MTL file.
|
2923
|
+
The string of the MTL file. Default is None.
|
2924
2924
|
defaultColor : list , optional
|
2925
|
-
The default color to use if none is specified in the string.
|
2925
|
+
The default color to use if none is specified in the string. Default is [255, 255, 255] (white).
|
2926
2926
|
defaultOpacity : float , optional
|
2927
|
-
The default opacity to use if none is specified in the string.
|
2927
|
+
The default opacity to use if none is specified in the string. Default is 1.0 (fully opaque).
|
2928
2928
|
transposeAxes : bool , optional
|
2929
|
-
If set to True the Z and Y axes are transposed. Otherwise, they are not.
|
2929
|
+
If set to True the Z and Y axes are transposed. Otherwise, they are not. Default is True.
|
2930
2930
|
removeCoplanarFaces : bool , optional
|
2931
|
-
If set to True, coplanar faces are merged.
|
2931
|
+
If set to True, coplanar faces are merged. Default is True.
|
2932
2932
|
selfMerge : bool , optional
|
2933
|
-
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces.
|
2933
|
+
If set to True, the faces of the imported topologies will each be self-merged to create higher-dimensional objects. Otherwise, they remain a cluster of faces. Default is False.
|
2934
2934
|
mantissa : int , optional
|
2935
|
-
The
|
2935
|
+
The number of decimal places to round the result to. Default is 6.
|
2936
2936
|
tolerance : float , optional
|
2937
|
-
The desired tolerance.
|
2937
|
+
The desired tolerance. Default is 0.0001
|
2938
2938
|
|
2939
2939
|
Returns
|
2940
2940
|
-------
|
@@ -3120,27 +3120,27 @@ class Topology():
|
|
3120
3120
|
file : file
|
3121
3121
|
The input PDF file
|
3122
3122
|
wires : bool , optional
|
3123
|
-
If set to True, wires will be constructed when possible.
|
3123
|
+
If set to True, wires will be constructed when possible. Default is True.
|
3124
3124
|
faces : bool , optional
|
3125
|
-
If set to True, faces will be constructed when possible.
|
3125
|
+
If set to True, faces will be constructed when possible. Default is True.
|
3126
3126
|
includeTypes : list , optional
|
3127
|
-
A list of PDF object types to include in the returned result.
|
3127
|
+
A list of PDF object types to include in the returned result. Default is [] which means all PDF objects will be included.
|
3128
3128
|
The possible strings to include in this list are: ["line", "curve", "rectangle", "quadrilateral"]
|
3129
3129
|
excludeTypes : list , optional
|
3130
|
-
A list of PDF object types to exclude from the returned result.
|
3130
|
+
A list of PDF object types to exclude from the returned result. Default is [] which mean no PDF object type will be excluded.
|
3131
3131
|
The possible strings to include in this list are: ["line", "curve", "rectangle", "quadrilateral"]
|
3132
3132
|
edgeColorKey : str , optional
|
3133
|
-
The dictionary key under which to store the edge color.
|
3133
|
+
The dictionary key under which to store the edge color. Default is None.
|
3134
3134
|
edgeWidthKey : str , optional
|
3135
|
-
The dictionary key under which to store the edge width.
|
3135
|
+
The dictionary key under which to store the edge width. Default is None.
|
3136
3136
|
faceColorKey : str , optional
|
3137
|
-
The dictionary key under which to store the face color.
|
3137
|
+
The dictionary key under which to store the face color. Default is None.
|
3138
3138
|
faceOpacityKey : str , optional
|
3139
|
-
The dictionary key under which to store the face opacity.
|
3139
|
+
The dictionary key under which to store the face opacity. Default is None.
|
3140
3140
|
tolerance : float , optional
|
3141
|
-
The desired tolerance.
|
3141
|
+
The desired tolerance. Default is 0.0001.
|
3142
3142
|
silent : bool , optional
|
3143
|
-
If set to True, error and warning messages are suppressed.
|
3143
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
3144
3144
|
|
3145
3145
|
Returns
|
3146
3146
|
-------
|
@@ -3354,27 +3354,27 @@ class Topology():
|
|
3354
3354
|
path : path
|
3355
3355
|
The input path to the PDF file
|
3356
3356
|
wires : bool , optional
|
3357
|
-
If set to True, wires will be constructed when possible.
|
3357
|
+
If set to True, wires will be constructed when possible. Default is True.
|
3358
3358
|
faces : bool , optional
|
3359
|
-
If set to True, faces will be constructed when possible.
|
3359
|
+
If set to True, faces will be constructed when possible. Default is True.
|
3360
3360
|
includeTypes : list , optional
|
3361
|
-
A list of PDF object types to include in the returned result.
|
3361
|
+
A list of PDF object types to include in the returned result. Default is [] which means all PDF objects will be included.
|
3362
3362
|
The possible strings to include in this list are: ["line", "curve", "rectangle", "quadrilateral"]
|
3363
3363
|
excludeTypes : list , optional
|
3364
|
-
A list of PDF object types to exclude from the returned result.
|
3364
|
+
A list of PDF object types to exclude from the returned result. Default is [] which mean no PDF object type will be excluded.
|
3365
3365
|
The possible strings to include in this list are: ["line", "curve", "rectangle", "quadrilateral"]
|
3366
3366
|
edgeColorKey : str , optional
|
3367
|
-
The dictionary key under which to store the edge color.
|
3367
|
+
The dictionary key under which to store the edge color. Default is None.
|
3368
3368
|
edgeWidthKey : str , optional
|
3369
|
-
The dictionary key under which to store the edge width.
|
3369
|
+
The dictionary key under which to store the edge width. Default is None.
|
3370
3370
|
faceColorKey : str , optional
|
3371
|
-
The dictionary key under which to store the face color.
|
3371
|
+
The dictionary key under which to store the face color. Default is None.
|
3372
3372
|
faceOpacityKey : str , optional
|
3373
|
-
The dictionary key under which to store the face opacity.
|
3373
|
+
The dictionary key under which to store the face opacity. Default is None.
|
3374
3374
|
tolerance : float , optional
|
3375
|
-
The desired tolerance.
|
3375
|
+
The desired tolerance. Default is 0.0001.
|
3376
3376
|
silent : bool , optional
|
3377
|
-
If set to True, error and warning messages are suppressed.
|
3377
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
3378
3378
|
|
3379
3379
|
Returns
|
3380
3380
|
-------
|
@@ -3488,9 +3488,9 @@ class Topology():
|
|
3488
3488
|
file : file object
|
3489
3489
|
The input XYZ file.
|
3490
3490
|
frameIdKey : str , optional
|
3491
|
-
The desired id key to use to store the ID of each frame in its dictionary.
|
3491
|
+
The desired id key to use to store the ID of each frame in its dictionary. Default is "id".
|
3492
3492
|
vertexIdKey : str , optional
|
3493
|
-
The desired id key to use to store the ID of each point in its dictionary.
|
3493
|
+
The desired id key to use to store the ID of each point in its dictionary. Default is "id".
|
3494
3494
|
|
3495
3495
|
Returns
|
3496
3496
|
-------
|
@@ -3570,9 +3570,9 @@ class Topology():
|
|
3570
3570
|
path : str
|
3571
3571
|
The input XYZ file path.
|
3572
3572
|
frameIdKey : str , optional
|
3573
|
-
The desired id key to use to store the ID of each frame in its dictionary.
|
3573
|
+
The desired id key to use to store the ID of each frame in its dictionary. Default is "id".
|
3574
3574
|
vertexIdKey : str , optional
|
3575
|
-
The desired id key to use to store the ID of each point in its dictionary.
|
3575
|
+
The desired id key to use to store the ID of each point in its dictionary. Default is "id".
|
3576
3576
|
|
3577
3577
|
Returns
|
3578
3578
|
-------
|
@@ -3606,13 +3606,13 @@ class Topology():
|
|
3606
3606
|
topology : topologic_core.Topology
|
3607
3607
|
The input topology.
|
3608
3608
|
n : int , optional
|
3609
|
-
The number of segments to use to increase the number of points on each face.
|
3609
|
+
The number of segments to use to increase the number of points on each face. Default is 10.
|
3610
3610
|
normalize : bool , optional
|
3611
|
-
If set to True, the longest edge in the input topology is scaled to become of length 1.
|
3611
|
+
If set to True, the longest edge in the input topology is scaled to become of length 1. Default is False.
|
3612
3612
|
mantissa : int , optional
|
3613
|
-
The
|
3613
|
+
The number of decimal places to round the result to. Default is 6.
|
3614
3614
|
silent : bool , optional
|
3615
|
-
If set to True, error and warning messages are suppressed.
|
3615
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
3616
3616
|
|
3617
3617
|
Returns
|
3618
3618
|
-------
|
@@ -3779,7 +3779,7 @@ class Topology():
|
|
3779
3779
|
keys : str or list or comma-separated str input parameters
|
3780
3780
|
The key or keys in the topology's dictionary to use for clustering.
|
3781
3781
|
silent : bool , optional
|
3782
|
-
If set to True, error and warning messages are suppressed.
|
3782
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
3783
3783
|
|
3784
3784
|
|
3785
3785
|
Returns
|
@@ -3886,9 +3886,9 @@ class Topology():
|
|
3886
3886
|
topology : topologic_core.Topology
|
3887
3887
|
The input topology.
|
3888
3888
|
angTolerance : float , optional
|
3889
|
-
The desired angular tolerance.
|
3889
|
+
The desired angular tolerance. Default is 0.1.
|
3890
3890
|
tolerance : float, optional
|
3891
|
-
The desired tolerance.
|
3891
|
+
The desired tolerance. Default is 0.0001.
|
3892
3892
|
|
3893
3893
|
Returns
|
3894
3894
|
-------
|
@@ -3998,7 +3998,7 @@ class Topology():
|
|
3998
3998
|
tolerance : float, optional
|
3999
3999
|
Tolerance value for geometric operations. Default is 0.0001.
|
4000
4000
|
silent : bool, optional
|
4001
|
-
If True,
|
4001
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4002
4002
|
|
4003
4003
|
Returns
|
4004
4004
|
-------
|
@@ -4126,7 +4126,7 @@ class Topology():
|
|
4126
4126
|
topology : topologic_core.Topology
|
4127
4127
|
The input topology.
|
4128
4128
|
deep : bool , optional
|
4129
|
-
If set to True, a deep copy will be performed (this is slow). Othwerwise, it will not.
|
4129
|
+
If set to True, a deep copy will be performed (this is slow). Othwerwise, it will not. Default is False
|
4130
4130
|
|
4131
4131
|
Returns
|
4132
4132
|
-------
|
@@ -4158,11 +4158,11 @@ class Topology():
|
|
4158
4158
|
topology : topologic_core.Topology
|
4159
4159
|
The input topology
|
4160
4160
|
mantissa : int , optional
|
4161
|
-
The
|
4161
|
+
The number of decimal places to round the result to. Default is 6.
|
4162
4162
|
tolerance : float , optional
|
4163
|
-
The desired tolerance.
|
4163
|
+
The desired tolerance. Default is 0.0001.
|
4164
4164
|
silent : bool , optional
|
4165
|
-
If set to True, error and warning messages are suppressed.
|
4165
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4166
4166
|
|
4167
4167
|
Returns
|
4168
4168
|
-------
|
@@ -4214,7 +4214,7 @@ class Topology():
|
|
4214
4214
|
topology : topologic_core.Topology
|
4215
4215
|
The input topology.
|
4216
4216
|
silent : bool , optional
|
4217
|
-
If set to True, error and warning messages are suppressed.
|
4217
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4218
4218
|
|
4219
4219
|
Returns
|
4220
4220
|
-------
|
@@ -4238,7 +4238,7 @@ class Topology():
|
|
4238
4238
|
topology : topologic_core.Topology
|
4239
4239
|
The input topology.
|
4240
4240
|
silent : bool , optional
|
4241
|
-
If set to True, error and warning messages are suppressed.
|
4241
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4242
4242
|
|
4243
4243
|
Returns
|
4244
4244
|
-------
|
@@ -4268,7 +4268,7 @@ class Topology():
|
|
4268
4268
|
addNestingDepth : bool , optional
|
4269
4269
|
If set to True the nesting depth of the division is added to the dictionaries of the divided topologies.
|
4270
4270
|
silent : bool , optional
|
4271
|
-
If set to True, error and warning messages are suppressed.
|
4271
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4272
4272
|
|
4273
4273
|
Returns
|
4274
4274
|
-------
|
@@ -4355,21 +4355,21 @@ class Topology():
|
|
4355
4355
|
topology : topologic_core.Topology
|
4356
4356
|
The input topology.
|
4357
4357
|
origin : topologic_core.Vertex , optional
|
4358
|
-
The origin of the explosion. If set to None, the centroid of the input topology will be used.
|
4358
|
+
The origin of the explosion. If set to None, the centroid of the input topology will be used. Default is None.
|
4359
4359
|
scale : float , optional
|
4360
|
-
The scale factor of the explosion.
|
4360
|
+
The scale factor of the explosion. Default is 1.25.
|
4361
4361
|
typeFilter : str , optional
|
4362
|
-
The type of the subtopologies to explode. This can be any of "vertex", "edge", "face", or "cell". If set to None, a subtopology one level below the type of the input topology will be used.
|
4362
|
+
The type of the subtopologies to explode. This can be any of "vertex", "edge", "face", or "cell". If set to None, a subtopology one level below the type of the input topology will be used. Default is None.
|
4363
4363
|
axes : str , optional
|
4364
|
-
Sets what axes are to be used for exploding the topology. This can be any permutation or substring of "xyz". It is not case sensitive.
|
4364
|
+
Sets what axes are to be used for exploding the topology. This can be any permutation or substring of "xyz". It is not case sensitive. Default is "xyz".
|
4365
4365
|
transferDictionaries : bool , optional
|
4366
|
-
If set to True, the dictionaries of the original subTopologies are transferred to the exploded topologies. Otherwise, they are not.
|
4366
|
+
If set to True, the dictionaries of the original subTopologies are transferred to the exploded topologies. Otherwise, they are not. Default is False.
|
4367
4367
|
mantissa : int , optional
|
4368
|
-
The
|
4368
|
+
The number of decimal places to round the result to. Default is 6.
|
4369
4369
|
tolerance : float , optional
|
4370
|
-
The desired tolerance.
|
4370
|
+
The desired tolerance. Default is 0.0001.
|
4371
4371
|
silent : bool , optional
|
4372
|
-
If set to True, error and warning messages are suppressed.
|
4372
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
4373
4373
|
|
4374
4374
|
Returns
|
4375
4375
|
-------
|
@@ -4499,27 +4499,27 @@ class Topology():
|
|
4499
4499
|
path : str
|
4500
4500
|
The input file path.
|
4501
4501
|
overwrite : bool , optional
|
4502
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
4502
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
4503
4503
|
version : str , optional
|
4504
|
-
The desired version number for the BIM file.
|
4504
|
+
The desired version number for the BIM file. Default is "1.0.0".
|
4505
4505
|
guidKey : str , optional
|
4506
|
-
The key to use to find the the guid of the topology. It is case insensitive.
|
4506
|
+
The key to use to find the the guid of the topology. It is case insensitive. Default is "guid". If no guid is found, one is generated automatically.
|
4507
4507
|
colorKey : str , optional
|
4508
|
-
The key to use to find the the color of the topology. It is case insensitive.
|
4508
|
+
The key to use to find the the color of the topology. It is case insensitive. Default is "color". If no color is found, the defaultColor parameter is used.
|
4509
4509
|
typeKey : str , optional
|
4510
|
-
The key to use to find the the type of the topology. It is case insensitive.
|
4510
|
+
The key to use to find the the type of the topology. It is case insensitive. Default is "type". If no type is found, the defaultType parameter is used.
|
4511
4511
|
defaultColor : list , optional
|
4512
|
-
The default color to use for the topology.
|
4512
|
+
The default color to use for the topology. Default is [255,255,255,1] which is opaque white.
|
4513
4513
|
defaultType : str , optional
|
4514
|
-
The default type to use for the topology.
|
4514
|
+
The default type to use for the topology. Default is "Structure".
|
4515
4515
|
author : str , optional
|
4516
|
-
The author of the topology.
|
4516
|
+
The author of the topology. Default is "topologicpy".
|
4517
4517
|
date : str , optional
|
4518
|
-
The creation date of the topology. This should be in the formate "DD.MM.YYYY".
|
4518
|
+
The creation date of the topology. This should be in the formate "DD.MM.YYYY". Default is None which uses the date of export.
|
4519
4519
|
mantissa : int , optional
|
4520
|
-
The
|
4520
|
+
The number of decimal places to round the result to. Default is 6.
|
4521
4521
|
tolerance : float , optional
|
4522
|
-
The desired tolerance.
|
4522
|
+
The desired tolerance. Default is 0.0001.
|
4523
4523
|
|
4524
4524
|
Returns
|
4525
4525
|
-------
|
@@ -4643,9 +4643,9 @@ class Topology():
|
|
4643
4643
|
path : str
|
4644
4644
|
The input file path.
|
4645
4645
|
overwrite : bool , optional
|
4646
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
4646
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
4647
4647
|
version : int , optional
|
4648
|
-
The desired version number for the BREP file.
|
4648
|
+
The desired version number for the BREP file. Default is 3.
|
4649
4649
|
|
4650
4650
|
Returns
|
4651
4651
|
-------
|
@@ -4695,9 +4695,9 @@ class Topology():
|
|
4695
4695
|
path : str
|
4696
4696
|
The input file path.
|
4697
4697
|
overwrite : bool , optional
|
4698
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
4698
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
4699
4699
|
mantissa : int , optional
|
4700
|
-
The
|
4700
|
+
The number of decimal places to round the result to. Default is 6.
|
4701
4701
|
|
4702
4702
|
Returns
|
4703
4703
|
-------
|
@@ -4892,7 +4892,7 @@ class Topology():
|
|
4892
4892
|
path : str
|
4893
4893
|
The path to the JSON file.
|
4894
4894
|
overwrite : bool , optional
|
4895
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
4895
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
4896
4896
|
|
4897
4897
|
Returns
|
4898
4898
|
-------
|
@@ -4937,9 +4937,9 @@ class Topology():
|
|
4937
4937
|
topology : topologic_core.Topology
|
4938
4938
|
The input topology
|
4939
4939
|
topologyType : str , optional
|
4940
|
-
The desired output topology type. This must be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive.
|
4940
|
+
The desired output topology type. This must be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive. Default is "CellComplex"
|
4941
4941
|
tolerance : float , optional
|
4942
|
-
The desired tolerance.
|
4942
|
+
The desired tolerance. Default is 0.0001.
|
4943
4943
|
|
4944
4944
|
Returns
|
4945
4945
|
-------
|
@@ -5097,7 +5097,7 @@ class Topology():
|
|
5097
5097
|
topologies : list or topologic_core.Topology
|
5098
5098
|
The input list of topologies or a single topology.
|
5099
5099
|
mantissa : int , optional
|
5100
|
-
The
|
5100
|
+
The number of decimal places to round the result to. Default is 6.
|
5101
5101
|
|
5102
5102
|
Returns
|
5103
5103
|
-------
|
@@ -5364,9 +5364,9 @@ class Topology():
|
|
5364
5364
|
The desired size of the mesh when using the "mesh" option. If set to None, it will be
|
5365
5365
|
calculated automatically and set to 10% of the overall size of the face.
|
5366
5366
|
mantissa : int , optional
|
5367
|
-
The
|
5367
|
+
The number of decimal places to round the result to. Default is 6.
|
5368
5368
|
tolerance : float , optional
|
5369
|
-
The desired tolerance.
|
5369
|
+
The desired tolerance. Default is 0.0001.
|
5370
5370
|
|
5371
5371
|
Returns
|
5372
5372
|
-------
|
@@ -5418,15 +5418,15 @@ class Topology():
|
|
5418
5418
|
path : str
|
5419
5419
|
The input file path.
|
5420
5420
|
nameKey : str , optional
|
5421
|
-
The topology dictionary key under which to find the name of the topology.
|
5421
|
+
The topology dictionary key under which to find the name of the topology. Default is "name".
|
5422
5422
|
colorKey : str, optional
|
5423
|
-
The topology dictionary key under which to find the color of the topology.
|
5423
|
+
The topology dictionary key under which to find the color of the topology. Default is "color".
|
5424
5424
|
opacityKey : str , optional
|
5425
|
-
The topology dictionary key under which to find the opacity of the topology.
|
5425
|
+
The topology dictionary key under which to find the opacity of the topology. Default is "opacity".
|
5426
5426
|
defaultColor : list , optional
|
5427
|
-
The default color to use if no color is stored in the topology dictionary.
|
5427
|
+
The default color to use if no color is stored in the topology dictionary. Default is [255,255, 255] (white).
|
5428
5428
|
defaultOpacity : float , optional
|
5429
|
-
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1.
|
5429
|
+
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1. Default is 1 (fully opaque).
|
5430
5430
|
transposeAxes : bool , optional
|
5431
5431
|
If set to True the Z and Y coordinates are transposed so that Y points "up"
|
5432
5432
|
mode : int , optional
|
@@ -5445,11 +5445,11 @@ class Topology():
|
|
5445
5445
|
The desired size of the mesh when using the "mesh" option. If set to None, it will be
|
5446
5446
|
calculated automatically and set to 10% of the overall size of the face.
|
5447
5447
|
mantissa : int , optional
|
5448
|
-
The
|
5448
|
+
The number of decimal places to round the result to. Default is 6.
|
5449
5449
|
tolerance : float , optional
|
5450
|
-
The desired tolerance.
|
5450
|
+
The desired tolerance. Default is 0.0001.
|
5451
5451
|
overwrite : bool , optional
|
5452
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
5452
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
5453
5453
|
|
5454
5454
|
Returns
|
5455
5455
|
-------
|
@@ -5512,15 +5512,15 @@ class Topology():
|
|
5512
5512
|
topologies : list or comma separated topologies
|
5513
5513
|
The input list of topologies.
|
5514
5514
|
nameKey : str , optional
|
5515
|
-
The topology dictionary key under which to find the name of the topology.
|
5515
|
+
The topology dictionary key under which to find the name of the topology. Default is "name".
|
5516
5516
|
colorKey : str, optional
|
5517
|
-
The topology dictionary key under which to find the color of the topology.
|
5517
|
+
The topology dictionary key under which to find the color of the topology. Default is "color".
|
5518
5518
|
opacityKey : str , optional
|
5519
|
-
The topology dictionary key under which to find the opacity of the topology.
|
5519
|
+
The topology dictionary key under which to find the opacity of the topology. Default is "opacity".
|
5520
5520
|
defaultColor : list , optional
|
5521
|
-
The default color to use if no color is stored in the topology dictionary.
|
5521
|
+
The default color to use if no color is stored in the topology dictionary. Default is [255,255, 255] (white).
|
5522
5522
|
defaultOpacity : float , optional
|
5523
|
-
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1.
|
5523
|
+
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1. Default is 1 (fully opaque).
|
5524
5524
|
transposeAxes : bool , optional
|
5525
5525
|
If set to True the Z and Y coordinates are transposed so that Y points "up"
|
5526
5526
|
mode : int , optional
|
@@ -5539,9 +5539,9 @@ class Topology():
|
|
5539
5539
|
The desired size of the mesh when using the "mesh" option. If set to None, it will be
|
5540
5540
|
calculated automatically and set to 10% of the overall size of the face.
|
5541
5541
|
mantissa : int , optional
|
5542
|
-
The
|
5542
|
+
The number of decimal places to round the result to. Default is 6.
|
5543
5543
|
tolerance : float , optional
|
5544
|
-
The desired tolerance.
|
5544
|
+
The desired tolerance. Default is 0.0001.
|
5545
5545
|
|
5546
5546
|
Returns
|
5547
5547
|
-------
|
@@ -5609,13 +5609,13 @@ class Topology():
|
|
5609
5609
|
topologies : list
|
5610
5610
|
The input list of topologies.
|
5611
5611
|
topologyType : str , optional
|
5612
|
-
The type of topology to filter by. This can be one of "any", "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", or "cluster". It is case insensitive.
|
5612
|
+
The type of topology to filter by. This can be one of "any", "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", or "cluster". It is case insensitive. Default is "any".
|
5613
5613
|
searchType : str , optional
|
5614
|
-
The type of search query to conduct in the topology's dictionary. This can be one of "any", "equal to", "contains", "starts with", "ends with", "not equal to", "does not contain".
|
5614
|
+
The type of search query to conduct in the topology's dictionary. This can be one of "any", "equal to", "contains", "starts with", "ends with", "not equal to", "does not contain". Default is "any".
|
5615
5615
|
key : str , optional
|
5616
|
-
The dictionary key to search within.
|
5616
|
+
The dictionary key to search within. Default is None which means it will filter by topology type only.
|
5617
5617
|
value : str , optional
|
5618
|
-
The value to search for at the specified key.
|
5618
|
+
The value to search for at the specified key. Default is None which means it will filter by topology type only.
|
5619
5619
|
|
5620
5620
|
Returns
|
5621
5621
|
-------
|
@@ -5690,11 +5690,11 @@ class Topology():
|
|
5690
5690
|
topology : topologic_core.Topology
|
5691
5691
|
The input topology.
|
5692
5692
|
origin : topologic_core.Vertex , optional
|
5693
|
-
The input origin. If set to None, The object's centroid will be used to place the world origin.
|
5693
|
+
The input origin. If set to None, The object's centroid will be used to place the world origin. Default is None.
|
5694
5694
|
direction : list , optional
|
5695
5695
|
The input direction vector. The input topology will be rotated such that this vector is pointed in the positive Z axis.
|
5696
5696
|
mantissa : int , optional
|
5697
|
-
The
|
5697
|
+
The number of decimal places to round the result to. Default is 6.
|
5698
5698
|
|
5699
5699
|
Returns
|
5700
5700
|
-------
|
@@ -5740,11 +5740,11 @@ class Topology():
|
|
5740
5740
|
topology : topologic_core.Topology
|
5741
5741
|
The input topology.
|
5742
5742
|
transferDictionaries : bool , optional
|
5743
|
-
If set to True, vertex, edge, and face dictionaries will be included in the output. Otherwise, they are not.
|
5743
|
+
If set to True, vertex, edge, and face dictionaries will be included in the output. Otherwise, they are not. Default is False.
|
5744
5744
|
mantissa : int , optional
|
5745
|
-
The
|
5745
|
+
The number of decimal places to round the result to. Default is 6.
|
5746
5746
|
silent : bool , optional
|
5747
|
-
If set to True, error and warning messages are suppressed.
|
5747
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
5748
5748
|
|
5749
5749
|
Returns
|
5750
5750
|
-------
|
@@ -5886,9 +5886,9 @@ class Topology():
|
|
5886
5886
|
topology : topologic_core.Topology
|
5887
5887
|
The input topology.
|
5888
5888
|
tolerance : float , ptional
|
5889
|
-
The desired tolerance.
|
5889
|
+
The desired tolerance. Default is 0.0001.
|
5890
5890
|
silent : bool , optional
|
5891
|
-
If set to True, error and warning messages are suppressed.
|
5891
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
5892
5892
|
|
5893
5893
|
Returns
|
5894
5894
|
-------
|
@@ -5951,11 +5951,11 @@ class Topology():
|
|
5951
5951
|
topology : topologic_core.Topology
|
5952
5952
|
The input topology.
|
5953
5953
|
timeout : int , optional
|
5954
|
-
The amount of seconds to wait before timing out.
|
5954
|
+
The amount of seconds to wait before timing out. Default is 30 seconds.
|
5955
5955
|
tolerance : float , ptional
|
5956
|
-
The desired tolerance.
|
5956
|
+
The desired tolerance. Default is 0.0001.
|
5957
5957
|
silent : bool , optional
|
5958
|
-
If set to True, error and warning messages are suppressed.
|
5958
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
5959
5959
|
|
5960
5960
|
Returns
|
5961
5961
|
-------
|
@@ -6054,9 +6054,9 @@ class Topology():
|
|
6054
6054
|
topology : topologic_core.Topology
|
6055
6055
|
The input topology.
|
6056
6056
|
mantissa : int , optional
|
6057
|
-
The desired length of the mantissa.
|
6057
|
+
The desired length of the mantissa. Default is 6
|
6058
6058
|
tolerance : float , optional
|
6059
|
-
The desired tolerance.
|
6059
|
+
The desired tolerance. Default is 0.0001.
|
6060
6060
|
|
6061
6061
|
Returns
|
6062
6062
|
-------
|
@@ -6140,15 +6140,15 @@ class Topology():
|
|
6140
6140
|
topologyB : topologic_core.Topology
|
6141
6141
|
The second input topology.
|
6142
6142
|
removeCoplanarFaces : bool , optional
|
6143
|
-
If set to True, coplanar faces are removed. Otherwise they are not.
|
6143
|
+
If set to True, coplanar faces are removed. Otherwise they are not. Default is False.
|
6144
6144
|
mantissa : int , optional
|
6145
|
-
The
|
6145
|
+
The number of decimal places to round the result to. Default is 6.
|
6146
6146
|
epsilon : float , optional
|
6147
|
-
The desired epsilon (another form of percentage tolerance) for finding if two objects are similar. Should be in the range 0 to 1.
|
6147
|
+
The desired epsilon (another form of percentage tolerance) for finding if two objects are similar. Should be in the range 0 to 1. Default is 0.1 (10%).
|
6148
6148
|
tolerance : float , optional
|
6149
|
-
The desired tolerance.
|
6149
|
+
The desired tolerance. Default is 0.0001.
|
6150
6150
|
silent : bool , optional
|
6151
|
-
If set to True, error and warning messages are suppressed.
|
6151
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6152
6152
|
|
6153
6153
|
Returns
|
6154
6154
|
-------
|
@@ -6329,14 +6329,14 @@ class Topology():
|
|
6329
6329
|
topologyB : topologic_core.Topology
|
6330
6330
|
The second input topology.
|
6331
6331
|
mantissa : int , optional
|
6332
|
-
The
|
6332
|
+
The number of decimal places to round the result to. Default is 6.
|
6333
6333
|
epsilon : float , optional
|
6334
6334
|
The desired accepted tolerance for the number of matched number of vertices. For example, an epsilon of 0.1 indicates that
|
6335
|
-
the algorithm will return True even if 10% of the vertices do not match.
|
6335
|
+
the algorithm will return True even if 10% of the vertices do not match. Default is 0.1.
|
6336
6336
|
tolerance : float , optional
|
6337
|
-
The desired tolerance.
|
6337
|
+
The desired tolerance. Default is 0.0001.
|
6338
6338
|
silent : bool , optional
|
6339
|
-
If set to True, error and warning messages are suppressed.
|
6339
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6340
6340
|
|
6341
6341
|
Returns
|
6342
6342
|
-------
|
@@ -6411,13 +6411,13 @@ class Topology():
|
|
6411
6411
|
topology : topologic_core.Topology
|
6412
6412
|
The input topology.
|
6413
6413
|
removeCoplanarFaces : bool , optional
|
6414
|
-
If set to True, coplanar faces are removed to find the true largest faces. Otherwise they are not.
|
6414
|
+
If set to True, coplanar faces are removed to find the true largest faces. Otherwise they are not. Default is False.
|
6415
6415
|
epsilon : float , optional
|
6416
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
6416
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
6417
6417
|
tolerance : float , optional
|
6418
|
-
The desired tolerance.
|
6418
|
+
The desired tolerance. Default is 0.0001.
|
6419
6419
|
silent : bool , optional
|
6420
|
-
If set to True, error and warning messages are suppressed.
|
6420
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6421
6421
|
Returns
|
6422
6422
|
-------
|
6423
6423
|
list
|
@@ -6460,13 +6460,13 @@ class Topology():
|
|
6460
6460
|
topology : topologic_core.Topology
|
6461
6461
|
The input topology.
|
6462
6462
|
removeCoplanarFaces : bool , optional
|
6463
|
-
If set to True, coplanar faces are removed to find the true longest straight edges. Otherwise they are not.
|
6463
|
+
If set to True, coplanar faces are removed to find the true longest straight edges. Otherwise they are not. Default is False.
|
6464
6464
|
epsilon : float , optional
|
6465
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
6465
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
6466
6466
|
tolerance : float , optional
|
6467
|
-
The desired tolerance.
|
6467
|
+
The desired tolerance. Default is 0.0001.
|
6468
6468
|
silent : bool , optional
|
6469
|
-
If set to True, error and warning messages are suppressed.
|
6469
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6470
6470
|
Returns
|
6471
6471
|
-------
|
6472
6472
|
list
|
@@ -6510,7 +6510,7 @@ class Topology():
|
|
6510
6510
|
topologies : list
|
6511
6511
|
The list of input topologies.
|
6512
6512
|
tolerance : float , optional
|
6513
|
-
The desired tolerance.
|
6513
|
+
The desired tolerance. Default is 0.0001.
|
6514
6514
|
|
6515
6515
|
Returns
|
6516
6516
|
-------
|
@@ -6545,13 +6545,13 @@ class Topology():
|
|
6545
6545
|
1: The faces list indexes into the edges list.
|
6546
6546
|
The default is 1.
|
6547
6547
|
transferDictionaries : bool , optional
|
6548
|
-
If set to True, the python dictionaries will be transferred to the coorespoding topologies.
|
6548
|
+
If set to True, the python dictionaries will be transferred to the coorespoding topologies. Default is False.
|
6549
6549
|
mantissa : int , optional
|
6550
|
-
The
|
6550
|
+
The number of decimal places to round the result to. Default is 6.
|
6551
6551
|
tolerance : float , optional
|
6552
|
-
The desired tolerance.
|
6552
|
+
The desired tolerance. Default is 0.0001.
|
6553
6553
|
silent : bool , optional
|
6554
|
-
If set to True, error and warning messages are suppressed.
|
6554
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6555
6555
|
|
6556
6556
|
Returns
|
6557
6557
|
-------
|
@@ -6695,11 +6695,11 @@ class Topology():
|
|
6695
6695
|
topology : topologic_core.topology
|
6696
6696
|
The input topology.
|
6697
6697
|
x : float , optional
|
6698
|
-
The x distance value.
|
6698
|
+
The x distance value. Default is 0.
|
6699
6699
|
y : float , optional
|
6700
|
-
The y distance value.
|
6700
|
+
The y distance value. Default is 0.
|
6701
6701
|
z : float , optional
|
6702
|
-
The z distance value.
|
6702
|
+
The z distance value. Default is 0.
|
6703
6703
|
|
6704
6704
|
Returns
|
6705
6705
|
-------
|
@@ -6781,7 +6781,7 @@ class Topology():
|
|
6781
6781
|
topology : topologic_core.Topology
|
6782
6782
|
The input topology.
|
6783
6783
|
tolerance : float , optional
|
6784
|
-
The desired tolerance.
|
6784
|
+
The desired tolerance. Default is 0.0001.
|
6785
6785
|
|
6786
6786
|
Returns
|
6787
6787
|
-------
|
@@ -6874,13 +6874,13 @@ class Topology():
|
|
6874
6874
|
topology : topologic_core.Topology
|
6875
6875
|
The input topology.
|
6876
6876
|
origin : topologic_core.Vertex , optional
|
6877
|
-
The input origin. If set to None, The object's centroid will be used to locate the input topology.
|
6877
|
+
The input origin. If set to None, The object's centroid will be used to locate the input topology. Default is None.
|
6878
6878
|
dirA : list , optional
|
6879
|
-
The first input direction vector. The input topology will be rotated such that this vector is parallel to the input dirB vector.
|
6879
|
+
The first input direction vector. The input topology will be rotated such that this vector is parallel to the input dirB vector. Default is [0, 0, 1].
|
6880
6880
|
dirB : list , optional
|
6881
|
-
The target direction vector. The input topology will be rotated such that the input dirA vector is parallel to this vector.
|
6881
|
+
The target direction vector. The input topology will be rotated such that the input dirA vector is parallel to this vector. Default is [0, 0, 1].
|
6882
6882
|
tolerance : float , optional
|
6883
|
-
The desired tolerance.
|
6883
|
+
The desired tolerance. Default is 0.0001
|
6884
6884
|
|
6885
6885
|
Returns
|
6886
6886
|
-------
|
@@ -6911,11 +6911,11 @@ class Topology():
|
|
6911
6911
|
topology : topologic_core.Topology
|
6912
6912
|
The input topology.
|
6913
6913
|
originA : topologic_core.Vertex , optional
|
6914
|
-
The old location to use as the origin of the movement. If set to None, the centroid of the input topology is used.
|
6914
|
+
The old location to use as the origin of the movement. If set to None, the centroid of the input topology is used. Default is None.
|
6915
6915
|
originB : topologic_core.Vertex , optional
|
6916
|
-
The new location at which to place the topology. If set to None, the world origin (0, 0, 0) is used.
|
6916
|
+
The new location at which to place the topology. If set to None, the world origin (0, 0, 0) is used. Default is None.
|
6917
6917
|
mantissa : int , optional
|
6918
|
-
The
|
6918
|
+
The number of decimal places to round the result to. Default is 6.
|
6919
6919
|
|
6920
6920
|
Returns
|
6921
6921
|
-------
|
@@ -6954,11 +6954,11 @@ class Topology():
|
|
6954
6954
|
topology : topologic_core.Topology
|
6955
6955
|
The input topology.
|
6956
6956
|
n : int , optional
|
6957
|
-
The number of segments to use to increase the number of points on each face.
|
6957
|
+
The number of segments to use to increase the number of points on each face. Default is 10.
|
6958
6958
|
mantissa : int , optional
|
6959
|
-
The
|
6959
|
+
The number of decimal places to round the result to. Default is 6.
|
6960
6960
|
silent : bool , optional
|
6961
|
-
If set to True, error and warning messages are suppressed.
|
6961
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
6962
6962
|
|
6963
6963
|
Returns
|
6964
6964
|
-------
|
@@ -7036,11 +7036,11 @@ class Topology():
|
|
7036
7036
|
topology : topologic_core.Topology
|
7037
7037
|
The input topology.
|
7038
7038
|
angTolerance : float , optional
|
7039
|
-
The desired angular tolerance.
|
7039
|
+
The desired angular tolerance. Default is 0.1.
|
7040
7040
|
tolerance : float , optional
|
7041
|
-
The desired tolerance.
|
7041
|
+
The desired tolerance. Default is 0.0001.
|
7042
7042
|
silent : bool , optional
|
7043
|
-
If set to True, error and warning messages are suppressed.
|
7043
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
7044
7044
|
|
7045
7045
|
Returns
|
7046
7046
|
-------
|
@@ -7122,11 +7122,11 @@ class Topology():
|
|
7122
7122
|
topology : topologic_core.Topology
|
7123
7123
|
The input topology.
|
7124
7124
|
epsilon : float , optional
|
7125
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
7125
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
7126
7126
|
tolerance : float , optional
|
7127
|
-
The desired tolerance.
|
7127
|
+
The desired tolerance. Default is 0.0001.
|
7128
7128
|
silent : bool , optional
|
7129
|
-
If set to True, error and warning messages are suppressed.
|
7129
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
7130
7130
|
|
7131
7131
|
Returns
|
7132
7132
|
-------
|
@@ -7236,7 +7236,7 @@ class Topology():
|
|
7236
7236
|
edges : list
|
7237
7237
|
The input list of edges.
|
7238
7238
|
tolerance : float , optional
|
7239
|
-
The desired tolerance.
|
7239
|
+
The desired tolerance. Default is 0.0001.
|
7240
7240
|
|
7241
7241
|
Returns
|
7242
7242
|
-------
|
@@ -7296,7 +7296,7 @@ class Topology():
|
|
7296
7296
|
faces : list
|
7297
7297
|
The input list of faces.
|
7298
7298
|
tolerance : float , optional
|
7299
|
-
The desired tolerance.
|
7299
|
+
The desired tolerance. Default is 0.0001.
|
7300
7300
|
|
7301
7301
|
Returns
|
7302
7302
|
-------
|
@@ -7342,7 +7342,7 @@ class Topology():
|
|
7342
7342
|
selectors : list
|
7343
7343
|
The input list of selectors (vertices).
|
7344
7344
|
tolerance : float , optional
|
7345
|
-
The desired tolerance.
|
7345
|
+
The desired tolerance. Default is 0.0001.
|
7346
7346
|
|
7347
7347
|
Returns
|
7348
7348
|
-------
|
@@ -7384,7 +7384,7 @@ class Topology():
|
|
7384
7384
|
vertices : list
|
7385
7385
|
The input list of vertices.
|
7386
7386
|
tolerance : float , optional
|
7387
|
-
The desired tolerance.
|
7387
|
+
The desired tolerance. Default is 0.0001.
|
7388
7388
|
|
7389
7389
|
Returns
|
7390
7390
|
-------
|
@@ -7469,9 +7469,9 @@ class Topology():
|
|
7469
7469
|
verticesB : list
|
7470
7470
|
The second input list of vertices.
|
7471
7471
|
mantissa : int , optional
|
7472
|
-
The
|
7472
|
+
The number of decimal places to round the result to. Default is 6.
|
7473
7473
|
tolerance : float , optional
|
7474
|
-
The desired tolerance.
|
7474
|
+
The desired tolerance. Default is 0.0001.
|
7475
7475
|
|
7476
7476
|
Returns
|
7477
7477
|
-------
|
@@ -7507,15 +7507,15 @@ class Topology():
|
|
7507
7507
|
topology : topologic_core.Topology
|
7508
7508
|
The input topology.
|
7509
7509
|
origin : topologic_core.Vertex , optional
|
7510
|
-
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used.
|
7510
|
+
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used. Default is None.
|
7511
7511
|
axis : list , optional
|
7512
|
-
The vector representing the axis of rotation.
|
7512
|
+
The vector representing the axis of rotation. Default is [0, 0, 1] which equates to the Z axis.
|
7513
7513
|
angle : float , optional
|
7514
|
-
The angle of rotation in degrees.
|
7514
|
+
The angle of rotation in degrees. Default is 0.
|
7515
7515
|
angTolerance : float , optional
|
7516
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
7516
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
7517
7517
|
tolerance : float , optional
|
7518
|
-
The desired tolerance.
|
7518
|
+
The desired tolerance. Default is 0.0001.
|
7519
7519
|
|
7520
7520
|
Returns
|
7521
7521
|
-------
|
@@ -7620,17 +7620,17 @@ class Topology():
|
|
7620
7620
|
topology : topologic_core.Topology
|
7621
7621
|
The input topology.
|
7622
7622
|
origin : topologic_core.Vertex , optional
|
7623
|
-
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used.
|
7623
|
+
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used. Default is None.
|
7624
7624
|
roll : float , optional
|
7625
|
-
The rotation angle in degrees around the X-axis.
|
7625
|
+
The rotation angle in degrees around the X-axis. Default is 0.
|
7626
7626
|
pitch = float , optional
|
7627
|
-
The rotation angle in degrees around the Y-axis.
|
7627
|
+
The rotation angle in degrees around the Y-axis. Default is 0.
|
7628
7628
|
yaw = float , optional
|
7629
|
-
The rotation angle in degrees around the Z-axis.
|
7629
|
+
The rotation angle in degrees around the Z-axis. Default is 0.
|
7630
7630
|
angTolerance : float , optional
|
7631
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
7631
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
7632
7632
|
tolerance : float , optional
|
7633
|
-
The desired tolerance.
|
7633
|
+
The desired tolerance. Default is 0.0001.
|
7634
7634
|
|
7635
7635
|
Returns
|
7636
7636
|
-------
|
@@ -7668,13 +7668,13 @@ class Topology():
|
|
7668
7668
|
topology : topologic_core.Topology
|
7669
7669
|
The input topology.
|
7670
7670
|
origin : topologic_core.Vertex , optional
|
7671
|
-
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used.
|
7671
|
+
The origin (center) of the rotation. If set to None, the world origin (0, 0, 0) is used. Default is None.
|
7672
7672
|
quaternion : list or numpy array of size 4
|
7673
7673
|
The input Quaternion list. It should be in the form [x, y, z, w].
|
7674
7674
|
angTolerance : float , optional
|
7675
|
-
The angle tolerance in degrees under which no rotation is carried out.
|
7675
|
+
The angle tolerance in degrees under which no rotation is carried out. Default is 0.001 degrees.
|
7676
7676
|
tolerance : float , optional
|
7677
|
-
The desired tolerance.
|
7677
|
+
The desired tolerance. Default is 0.0001.
|
7678
7678
|
|
7679
7679
|
Returns
|
7680
7680
|
-------
|
@@ -7748,13 +7748,13 @@ class Topology():
|
|
7748
7748
|
topology : topologic_core.Topology
|
7749
7749
|
The input topology.
|
7750
7750
|
origin : topologic_core.Vertex , optional
|
7751
|
-
The origin (center) of the scaling. If set to None, the world origin (0, 0, 0) is used.
|
7751
|
+
The origin (center) of the scaling. If set to None, the world origin (0, 0, 0) is used. Default is None.
|
7752
7752
|
x : float , optional
|
7753
|
-
The 'x' component of the scaling factor.
|
7753
|
+
The 'x' component of the scaling factor. Default is 1.
|
7754
7754
|
y : float , optional
|
7755
|
-
The 'y' component of the scaling factor.
|
7755
|
+
The 'y' component of the scaling factor. Default is 1.
|
7756
7756
|
z : float , optional
|
7757
|
-
The 'z' component of the scaling factor.
|
7757
|
+
The 'z' component of the scaling factor. Default is 1..
|
7758
7758
|
|
7759
7759
|
Returns
|
7760
7760
|
-------
|
@@ -7823,7 +7823,7 @@ class Topology():
|
|
7823
7823
|
selector : topologic_core.Vertex
|
7824
7824
|
A vertex located on the desired subtopology.
|
7825
7825
|
subTopologyType : str , optional.
|
7826
|
-
The desired subtopology type. This can be of "vertex", "edge", "wire", "face", "shell", "cell", or "cellcomplex". It is case insensitive.
|
7826
|
+
The desired subtopology type. This can be of "vertex", "edge", "wire", "face", "shell", "cell", or "cellcomplex". It is case insensitive. Default is "vertex".
|
7827
7827
|
|
7828
7828
|
Returns
|
7829
7829
|
-------
|
@@ -7863,7 +7863,7 @@ class Topology():
|
|
7863
7863
|
topology : topologic_core.Topology
|
7864
7864
|
The input topology.
|
7865
7865
|
tolerance : float , optional
|
7866
|
-
The desired tolerance.
|
7866
|
+
The desired tolerance. Default is 0.0001
|
7867
7867
|
|
7868
7868
|
Returns
|
7869
7869
|
-------
|
@@ -7947,7 +7947,7 @@ class Topology():
|
|
7947
7947
|
dictionary : topologic_core.Dictionary
|
7948
7948
|
The input dictionary.
|
7949
7949
|
silent : bool , optional
|
7950
|
-
If set to True, error and warning messages are suppressed.
|
7950
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
7951
7951
|
|
7952
7952
|
Returns
|
7953
7953
|
-------
|
@@ -8179,13 +8179,13 @@ class Topology():
|
|
8179
8179
|
topology : topologic_core.Topology
|
8180
8180
|
The input topology.
|
8181
8181
|
removeCoplanarFaces : bool , optional
|
8182
|
-
If set to True, coplanar faces are removed to find the true shortest straight edges. Otherwise they are not.
|
8182
|
+
If set to True, coplanar faces are removed to find the true shortest straight edges. Otherwise they are not. Default is False.
|
8183
8183
|
epsilon : float , optional
|
8184
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
8184
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
8185
8185
|
tolerance : float , optional
|
8186
|
-
The desired tolerance.
|
8186
|
+
The desired tolerance. Default is 0.0001.
|
8187
8187
|
silent : bool , optional
|
8188
|
-
If set to True, error and warning messages are suppressed.
|
8188
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
8189
8189
|
Returns
|
8190
8190
|
-------
|
8191
8191
|
list
|
@@ -8318,13 +8318,13 @@ class Topology():
|
|
8318
8318
|
topologies : topologic_core.Topology or list
|
8319
8319
|
The input topology. This must contain faces and or edges. If the input is a list, a cluster is first created
|
8320
8320
|
opacityKey : str , optional
|
8321
|
-
The key under which to find the opacity of the topology.
|
8321
|
+
The key under which to find the opacity of the topology. Default is "opacity".
|
8322
8322
|
showVertices : bool , optional
|
8323
|
-
If set to True the vertices will be drawn. Otherwise, they will not be drawn.
|
8323
|
+
If set to True the vertices will be drawn. Otherwise, they will not be drawn. Default is True.
|
8324
8324
|
vertexSize : float , optional
|
8325
|
-
The desired size of the vertices.
|
8325
|
+
The desired size of the vertices. Default is 1.1.
|
8326
8326
|
vertexSizeKey : str , optional
|
8327
|
-
The key under which to find the size of the vertex.
|
8327
|
+
The key under which to find the size of the vertex. Default is None.
|
8328
8328
|
vertexColor : str , optional
|
8329
8329
|
The desired color of the output vertices. This can be any plotly color string and may be specified as:
|
8330
8330
|
- A hex string (e.g. '#ff0000')
|
@@ -8334,9 +8334,9 @@ class Topology():
|
|
8334
8334
|
- A named CSS color.
|
8335
8335
|
The default is "black".
|
8336
8336
|
vertexColorKey : str , optional
|
8337
|
-
The key under which to find the color of the vertex.
|
8337
|
+
The key under which to find the color of the vertex. Default is None.
|
8338
8338
|
vertexBorderWidth : float , optional
|
8339
|
-
The desired width of the borders of the output vertices.
|
8339
|
+
The desired width of the borders of the output vertices. Default is 0.
|
8340
8340
|
vertexBorderColor : str , optional
|
8341
8341
|
The desired color of the borders of the output vertices. This can be any plotly color string and may be specified as:
|
8342
8342
|
- A hex string (e.g. '#ff0000')
|
@@ -8346,31 +8346,31 @@ class Topology():
|
|
8346
8346
|
- A named CSS color.
|
8347
8347
|
The default is "black".
|
8348
8348
|
vertexLabelKey : str , optional
|
8349
|
-
The dictionary key to use to display the vertex label.
|
8349
|
+
The dictionary key to use to display the vertex label. Default is None.
|
8350
8350
|
showVertexLabels : bool , optional
|
8351
|
-
If set to True, the vertex labels are shown permenantely on screen. Otherwise, they are not.
|
8351
|
+
If set to True, the vertex labels are shown permenantely on screen. Otherwise, they are not. Default is False.
|
8352
8352
|
vertexGroupKey : str , optional
|
8353
|
-
The dictionary key to use to display the vertex group.
|
8353
|
+
The dictionary key to use to display the vertex group. Default is None.
|
8354
8354
|
vertexGroups : list , optional
|
8355
|
-
The list of vertex groups against which to index the color of the vertex.
|
8355
|
+
The list of vertex groups against which to index the color of the vertex. Default is [].
|
8356
8356
|
vertexMinGroup : int or float , optional
|
8357
|
-
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups.
|
8357
|
+
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups. Default is None.
|
8358
8358
|
vertexMaxGroup : int or float , optional
|
8359
|
-
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups.
|
8359
|
+
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups. Default is None.
|
8360
8360
|
showVertexLegend : bool, optional
|
8361
|
-
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't.
|
8361
|
+
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't. Default is False.
|
8362
8362
|
vertexLegendLabel : str , optional
|
8363
|
-
The legend label string used to identify vertices.
|
8363
|
+
The legend label string used to identify vertices. Default is "Topology Vertices".
|
8364
8364
|
directed : bool , optional
|
8365
|
-
If set to True, arrowheads are drawn to show direction.
|
8365
|
+
If set to True, arrowheads are drawn to show direction. Default is False.
|
8366
8366
|
arrowSize : int, optional
|
8367
|
-
The desired size of arrowheads for directed graphs.
|
8367
|
+
The desired size of arrowheads for directed graphs. Default is 0.1.
|
8368
8368
|
arrowSizeKey: str , optional
|
8369
|
-
The edge dictionary key under which to find the arrowhead size.
|
8369
|
+
The edge dictionary key under which to find the arrowhead size. Default is None.
|
8370
8370
|
showEdges : bool , optional
|
8371
|
-
If set to True the edges will be drawn. Otherwise, they will not be drawn.
|
8371
|
+
If set to True the edges will be drawn. Otherwise, they will not be drawn. Default is True.
|
8372
8372
|
edgeWidth : float , optional
|
8373
|
-
The desired thickness of the output edges.
|
8373
|
+
The desired thickness of the output edges. Default is 1.
|
8374
8374
|
edgeColor : str , optional
|
8375
8375
|
The desired color of the output edges. This can be any plotly color string and may be specified as:
|
8376
8376
|
- A hex string (e.g. '#ff0000')
|
@@ -8380,36 +8380,36 @@ class Topology():
|
|
8380
8380
|
- A named CSS color.
|
8381
8381
|
The default is "black".
|
8382
8382
|
edgeColorKey : str , optional
|
8383
|
-
The key under which to find the color of the edge.
|
8383
|
+
The key under which to find the color of the edge. Default is None.
|
8384
8384
|
edgeDash : bool , optional
|
8385
|
-
If set to True, the edges are drawn as dashed lines.
|
8385
|
+
If set to True, the edges are drawn as dashed lines. Default is False.
|
8386
8386
|
edgeDashKey : str , optional
|
8387
|
-
The key under which to find the boolean flag to draw edges as dashed lines.
|
8387
|
+
The key under which to find the boolean flag to draw edges as dashed lines. Default is None.
|
8388
8388
|
edgeWidthKey : str , optional
|
8389
|
-
The key under which to find the width of the edge.
|
8389
|
+
The key under which to find the width of the edge. Default is None.
|
8390
8390
|
edgeLabelKey : str , optional
|
8391
|
-
The dictionary key to use to display the edge label.
|
8391
|
+
The dictionary key to use to display the edge label. Default is None.
|
8392
8392
|
showEdgeLabels : bool , optional
|
8393
|
-
If set to True, the edge labels are shown permenantely on screen. Otherwise, they are not.
|
8393
|
+
If set to True, the edge labels are shown permenantely on screen. Otherwise, they are not. Default is False.
|
8394
8394
|
edgeGroupKey : str , optional
|
8395
|
-
The dictionary key to use to display the edge group.
|
8395
|
+
The dictionary key to use to display the edge group. Default is None.
|
8396
8396
|
edgeGroups : list , optional
|
8397
|
-
The list of edge groups against which to index the color of the edge.
|
8397
|
+
The list of edge groups against which to index the color of the edge. Default is [].
|
8398
8398
|
edgeMinGroup : int or float , optional
|
8399
|
-
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups.
|
8399
|
+
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups. Default is None.
|
8400
8400
|
edgeMaxGroup : int or float , optional
|
8401
|
-
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups.
|
8401
|
+
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups. Default is None.
|
8402
8402
|
showEdgeLegend : bool, optional
|
8403
|
-
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't.
|
8403
|
+
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't. Default is False.
|
8404
8404
|
edgeLegendLabel : str , optional
|
8405
|
-
The legend label string used to identify edges.
|
8405
|
+
The legend label string used to identify edges. Default is "Topology Edges".
|
8406
8406
|
|
8407
8407
|
showFaces : bool , optional
|
8408
|
-
If set to True the faces will be drawn. Otherwise, they will not be drawn.
|
8408
|
+
If set to True the faces will be drawn. Otherwise, they will not be drawn. Default is True.
|
8409
8409
|
faceOpacity : float , optional
|
8410
|
-
The desired opacity of the output faces (0=transparent, 1=opaque).
|
8410
|
+
The desired opacity of the output faces (0=transparent, 1=opaque). Default is 0.5.
|
8411
8411
|
faceOpacityKey : str , optional
|
8412
|
-
The key under which to find the opacity of the face.
|
8412
|
+
The key under which to find the opacity of the face. Default is None.
|
8413
8413
|
faceColor : str , optional
|
8414
8414
|
The desired color of the output faces. This can be any plotly color string and may be specified as:
|
8415
8415
|
- A hex string (e.g. '#ff0000')
|
@@ -8419,31 +8419,31 @@ class Topology():
|
|
8419
8419
|
- A named CSS color.
|
8420
8420
|
The default is "#FAFAFA".
|
8421
8421
|
faceColorKey : str , optional
|
8422
|
-
The key under which to find the color of the face.
|
8422
|
+
The key under which to find the color of the face. Default is None.
|
8423
8423
|
faceLabelKey : str , optional
|
8424
|
-
The dictionary key to use to display the face label.
|
8424
|
+
The dictionary key to use to display the face label. Default is None.
|
8425
8425
|
faceGroupKey : str , optional
|
8426
|
-
The dictionary key to use to display the face group.
|
8426
|
+
The dictionary key to use to display the face group. Default is None.
|
8427
8427
|
faceGroups : list , optional
|
8428
|
-
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey.
|
8428
|
+
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey. Default is [].
|
8429
8429
|
faceMinGroup : int or float , optional
|
8430
|
-
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups.
|
8430
|
+
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups. Default is None.
|
8431
8431
|
faceMaxGroup : int or float , optional
|
8432
|
-
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups.
|
8432
|
+
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups. Default is None.
|
8433
8433
|
showFaceLegend : bool, optional
|
8434
|
-
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't.
|
8434
|
+
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't. Default is False.
|
8435
8435
|
faceLegendLabel : str , optional
|
8436
|
-
The legend label string used to idenitfy edges.
|
8436
|
+
The legend label string used to idenitfy edges. Default is "Topology Faces".
|
8437
8437
|
width : int , optional
|
8438
8438
|
The width in pixels of the figure. The default value is 950.
|
8439
8439
|
height : int , optional
|
8440
8440
|
The height in pixels of the figure. The default value is 950.
|
8441
8441
|
xAxis : bool , optional
|
8442
|
-
If set to True the x axis is drawn. Otherwise it is not drawn.
|
8442
|
+
If set to True the x axis is drawn. Otherwise it is not drawn. Default is False.
|
8443
8443
|
yAxis : bool , optional
|
8444
|
-
If set to True the y axis is drawn. Otherwise it is not drawn.
|
8444
|
+
If set to True the y axis is drawn. Otherwise it is not drawn. Default is False.
|
8445
8445
|
zAxis : bool , optional
|
8446
|
-
If set to True the z axis is drawn. Otherwise it is not drawn.
|
8446
|
+
If set to True the z axis is drawn. Otherwise it is not drawn. Default is False.
|
8447
8447
|
backgroundColor : str , optional
|
8448
8448
|
The desired color of the background. This can be any plotly color string and may be specified as:
|
8449
8449
|
- A hex string (e.g. '#ff0000')
|
@@ -8461,45 +8461,45 @@ class Topology():
|
|
8461
8461
|
marginBottom : int , optional
|
8462
8462
|
The size in pixels of the bottom margin. The default value is 0.
|
8463
8463
|
camera : list , optional
|
8464
|
-
The desired location of the camera).
|
8464
|
+
The desired location of the camera). Default is [-1.25, -1.25, 1.25].
|
8465
8465
|
center : list , optional
|
8466
|
-
The desired center (camera target).
|
8466
|
+
The desired center (camera target). Default is [0, 0, 0].
|
8467
8467
|
up : list , optional
|
8468
|
-
The desired up vector.
|
8468
|
+
The desired up vector. Default is [0, 0, 1].
|
8469
8469
|
projection : str , optional
|
8470
|
-
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive.
|
8470
|
+
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive. Default is "perspective"
|
8471
8471
|
renderer : str , optional
|
8472
|
-
The desired renderer. See Plotly.Renderers(). If set to None, the code will attempt to discover the most suitable renderer.
|
8472
|
+
The desired renderer. See Plotly.Renderers(). If set to None, the code will attempt to discover the most suitable renderer. Default is None.
|
8473
8473
|
intensityKey : str , optional
|
8474
|
-
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale.
|
8474
|
+
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale. Default is None.
|
8475
8475
|
intensities : list , optional
|
8476
|
-
The list of intensities against which to index the intensity of the vertex.
|
8476
|
+
The list of intensities against which to index the intensity of the vertex. Default is [].
|
8477
8477
|
showScale : bool , optional
|
8478
|
-
If set to True, the colorbar is shown.
|
8478
|
+
If set to True, the colorbar is shown. Default is False.
|
8479
8479
|
cbValues : list , optional
|
8480
|
-
The input list of values to use for the colorbar.
|
8480
|
+
The input list of values to use for the colorbar. Default is [].
|
8481
8481
|
cbTicks : int , optional
|
8482
|
-
The number of ticks to use on the colorbar.
|
8482
|
+
The number of ticks to use on the colorbar. Default is 5.
|
8483
8483
|
cbX : float , optional
|
8484
|
-
The x location of the colorbar.
|
8484
|
+
The x location of the colorbar. Default is -0.15.
|
8485
8485
|
cbWidth : int , optional
|
8486
|
-
The width in pixels of the colorbar.
|
8486
|
+
The width in pixels of the colorbar. Default is 15
|
8487
8487
|
cbOutlineWidth : int , optional
|
8488
|
-
The width in pixels of the outline of the colorbar.
|
8488
|
+
The width in pixels of the outline of the colorbar. Default is 0.
|
8489
8489
|
cbTitle : str , optional
|
8490
|
-
The title of the colorbar.
|
8490
|
+
The title of the colorbar. Default is "".
|
8491
8491
|
cbSubTitle : str , optional
|
8492
|
-
The subtitle of the colorbar.
|
8492
|
+
The subtitle of the colorbar. Default is "".
|
8493
8493
|
cbUnits: str , optional
|
8494
|
-
The units used in the colorbar.
|
8494
|
+
The units used in the colorbar. Default is ""
|
8495
8495
|
colorScale : str , optional
|
8496
|
-
The desired type of plotly color scales to use (e.g. "viridis", "plasma").
|
8496
|
+
The desired type of plotly color scales to use (e.g. "viridis", "plasma"). Default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
8497
8497
|
mantissa : int , optional
|
8498
|
-
The desired length of the mantissa for the values listed on the colorbar.
|
8498
|
+
The desired length of the mantissa for the values listed on the colorbar. Default is 6.
|
8499
8499
|
tolerance : float , optional
|
8500
|
-
The desired tolerance.
|
8500
|
+
The desired tolerance. Default is 0.0001.
|
8501
8501
|
silent : bool , optional
|
8502
|
-
If set to True, error and warning messages are suppressed.
|
8502
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
8503
8503
|
|
8504
8504
|
Returns
|
8505
8505
|
-------
|
@@ -8690,13 +8690,13 @@ class Topology():
|
|
8690
8690
|
topology : topologic_core.Topology
|
8691
8691
|
The input topology.
|
8692
8692
|
removeCoplanarFaces : bool , optional
|
8693
|
-
If set to True, coplanar faces are removed to find the true smallest faces. Otherwise they are not.
|
8693
|
+
If set to True, coplanar faces are removed to find the true smallest faces. Otherwise they are not. Default is False.
|
8694
8694
|
epsilon : float , optional
|
8695
|
-
The desired epsilon (another form of tolerance) for finding if two faces are coplanar.
|
8695
|
+
The desired epsilon (another form of tolerance) for finding if two faces are coplanar. Default is 0.01.
|
8696
8696
|
tolerance : float , optional
|
8697
|
-
The desired tolerance.
|
8697
|
+
The desired tolerance. Default is 0.0001.
|
8698
8698
|
silent : bool , optional
|
8699
|
-
If set to True, error and warning messages are suppressed.
|
8699
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
8700
8700
|
Returns
|
8701
8701
|
-------
|
8702
8702
|
list
|
@@ -8741,9 +8741,9 @@ class Topology():
|
|
8741
8741
|
selectors : list
|
8742
8742
|
The input list of selectors (vertices).
|
8743
8743
|
exclusive : bool , optional
|
8744
|
-
If set to True only one selector can be used to select on topology.
|
8744
|
+
If set to True only one selector can be used to select on topology. Default is False.
|
8745
8745
|
tolerance : float , optional
|
8746
|
-
The desired tolerance.
|
8746
|
+
The desired tolerance. Default is 0.0001.
|
8747
8747
|
|
8748
8748
|
Returns
|
8749
8749
|
-------
|
@@ -8841,17 +8841,17 @@ class Topology():
|
|
8841
8841
|
origin : topologic_core.Vertex
|
8842
8842
|
The origin (center) of the spin.
|
8843
8843
|
triangulate : bool , optional
|
8844
|
-
If set to True, the result will be triangulated.
|
8844
|
+
If set to True, the result will be triangulated. Default is True.
|
8845
8845
|
direction : list , optional
|
8846
|
-
The vector representing the direction of the spin axis.
|
8846
|
+
The vector representing the direction of the spin axis. Default is [0, 0, 1].
|
8847
8847
|
angle : float , optional
|
8848
|
-
The angle in degrees for the spin.
|
8848
|
+
The angle in degrees for the spin. Default is 360.
|
8849
8849
|
sides : int , optional
|
8850
|
-
The desired number of sides.
|
8850
|
+
The desired number of sides. Default is 16.
|
8851
8851
|
tolerance : float , optional
|
8852
|
-
The desired tolerance.
|
8852
|
+
The desired tolerance. Default is 0.0001.
|
8853
8853
|
silent : bool , optional
|
8854
|
-
If set to True, error and warning messages are suppressed.
|
8854
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
8855
8855
|
|
8856
8856
|
|
8857
8857
|
Returns
|
@@ -8988,21 +8988,21 @@ class Topology():
|
|
8988
8988
|
- "Vertex" -> None
|
8989
8989
|
- "Graph" -> "Graphs"
|
8990
8990
|
minSize : int , optional
|
8991
|
-
The minimum number of subtopologies to include in a combination. This number cannot be less than 2.
|
8991
|
+
The minimum number of subtopologies to include in a combination. This number cannot be less than 2. Default is 2.
|
8992
8992
|
maxSize : int , optional
|
8993
|
-
The maximum number of faces to include in a combinations. This number cannot be less than the number of subtopologies minus 1.
|
8993
|
+
The maximum number of faces to include in a combinations. This number cannot be less than the number of subtopologies minus 1. Default is None which means the maximum will be set to the number of subtopologies minus 1.
|
8994
8994
|
maxCombinations : int , optional
|
8995
|
-
The maximum number of combinations to create.
|
8995
|
+
The maximum number of combinations to create. Default is 100.
|
8996
8996
|
timeLimit : int , optional
|
8997
|
-
The time limit in seconds.
|
8997
|
+
The time limit in seconds. Default is 10 seconds. Note that this time limit only applies to creating the combination indices and not the actual Shells.
|
8998
8998
|
removeCoplanarFaces : bool , optional
|
8999
|
-
If set to True, coplanar faces are removed. Otherwise they are not.
|
8999
|
+
If set to True, coplanar faces are removed. Otherwise they are not. Default is False.
|
9000
9000
|
removeCollinearEdges : bool , optional
|
9001
|
-
If set to True, collinear edges are removed. Otherwise they are not.
|
9001
|
+
If set to True, collinear edges are removed. Otherwise they are not. Default is False.
|
9002
9002
|
tolerance : float , optional
|
9003
|
-
The desired tolerance.
|
9003
|
+
The desired tolerance. Default is 0.0001.
|
9004
9004
|
silent : bool , optional
|
9005
|
-
If set to True, error and warning messages are suppressed.
|
9005
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
9006
9006
|
|
9007
9007
|
Returns
|
9008
9008
|
-------
|
@@ -9133,13 +9133,13 @@ class Topology():
|
|
9133
9133
|
topology : topologic_core.Topology
|
9134
9134
|
The input topology.
|
9135
9135
|
origin : topologic_core.Vertex , optional
|
9136
|
-
The desired origin for tapering. If not specified, the centroid of the input topology is used. The tapering will use the X, Y coordinates of the specified origin, but will use the Z of the point being tapered.
|
9136
|
+
The desired origin for tapering. If not specified, the centroid of the input topology is used. The tapering will use the X, Y coordinates of the specified origin, but will use the Z of the point being tapered. Default is None.
|
9137
9137
|
ratioRange : list , optional
|
9138
9138
|
The desired ratio range. This will specify a linear range from bottom to top for tapering the vertices. 0 means no tapering, and 1 means maximum (inward) tapering. Negative numbers mean that tapering will be outwards.
|
9139
9139
|
triangulate : bool , optional
|
9140
|
-
If set to true, the input topology is triangulated before tapering. Otherwise, it will not be traingulated.
|
9140
|
+
If set to true, the input topology is triangulated before tapering. Otherwise, it will not be traingulated. Default is False.
|
9141
9141
|
mantissa : int , optional
|
9142
|
-
The
|
9142
|
+
The number of decimal places to round the result to. Default is 6.
|
9143
9143
|
tolerance : float , optional
|
9144
9144
|
The desired tolerance. Vertices will not be moved if the calculated distance is at or less than this tolerance.
|
9145
9145
|
|
@@ -9192,13 +9192,13 @@ class Topology():
|
|
9192
9192
|
topology : topologic_core.Topology
|
9193
9193
|
The input topology.
|
9194
9194
|
origin : topologic_core.Vertex , optional
|
9195
|
-
The desired origin for tapering. If not specified, the centroid of the input topology is used. The tapering will use the X, Y coordinates of the specified origin, but will use the Z of the point being tapered.
|
9195
|
+
The desired origin for tapering. If not specified, the centroid of the input topology is used. The tapering will use the X, Y coordinates of the specified origin, but will use the Z of the point being tapered. Default is None.
|
9196
9196
|
angleRange : list , optional
|
9197
9197
|
The desired angle range in degrees. This will specify a linear range from bottom to top for twisting the vertices. positive numbers mean a clockwise rotation.
|
9198
9198
|
triangulate : bool , optional
|
9199
|
-
If set to true, the input topology is triangulated before tapering. Otherwise, it will not be traingulated.
|
9199
|
+
If set to true, the input topology is triangulated before tapering. Otherwise, it will not be traingulated. Default is False.
|
9200
9200
|
mantissa : int , optional
|
9201
|
-
The
|
9201
|
+
The number of decimal places to round the result to. Default is 6.
|
9202
9202
|
|
9203
9203
|
Returns
|
9204
9204
|
-------
|
@@ -9240,7 +9240,7 @@ class Topology():
|
|
9240
9240
|
topology : topologic_core.Topology
|
9241
9241
|
The input topology.
|
9242
9242
|
origin : topologic_core.Vertex , optional
|
9243
|
-
The input origin. If set to None, The object's centroid will be used to translate the world origin.
|
9243
|
+
The input origin. If set to None, The object's centroid will be used to translate the world origin. Default is None.
|
9244
9244
|
vector : list , optional
|
9245
9245
|
The input direction vector. The input topology will be rotated such that this vector is pointed in the positive Z axis.
|
9246
9246
|
|
@@ -9459,9 +9459,9 @@ class Topology():
|
|
9459
9459
|
topology : topologic_core.Topology
|
9460
9460
|
The input topology.
|
9461
9461
|
subTopologyType : str , optional
|
9462
|
-
The requested subtopology type. This can be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive.
|
9462
|
+
The requested subtopology type. This can be one of "vertex", "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive. Default is "vertex".
|
9463
9463
|
silent : bool , optional
|
9464
|
-
If set to True,
|
9464
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
9465
9465
|
Returns
|
9466
9466
|
-------
|
9467
9467
|
list
|
@@ -9532,7 +9532,7 @@ class Topology():
|
|
9532
9532
|
hostTopology : topologic_core.Topology
|
9533
9533
|
The host to topology in which to search for ther supertopologies.
|
9534
9534
|
topologyType : str , optional
|
9535
|
-
The topology type to search for. This can be any of "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive. If set to None, the immediate supertopology type is searched for.
|
9535
|
+
The topology type to search for. This can be any of "edge", "wire", "face", "shell", "cell", "cellcomplex", "cluster". It is case insensitive. If set to None, the immediate supertopology type is searched for. Default is None.
|
9536
9536
|
|
9537
9537
|
Returns
|
9538
9538
|
-------
|
@@ -9589,9 +9589,9 @@ class Topology():
|
|
9589
9589
|
sinks : list
|
9590
9590
|
The list of topologies to which to transfer the dictionaries.
|
9591
9591
|
tolerance : float , optional
|
9592
|
-
The desired tolerance.
|
9592
|
+
The desired tolerance. Default is 0.0001.
|
9593
9593
|
numWorkers : int, optional
|
9594
|
-
Number of workers run in parallel to process.
|
9594
|
+
Number of workers run in parallel to process. Default is None which sets the number to twice the number of CPU cores.
|
9595
9595
|
|
9596
9596
|
Returns
|
9597
9597
|
-------
|
@@ -9660,7 +9660,7 @@ class Topology():
|
|
9660
9660
|
tranCells : bool , optional
|
9661
9661
|
If True transfer dictionaries to the cells of the input topology.
|
9662
9662
|
tolerance : float , optional
|
9663
|
-
The desired tolerance.
|
9663
|
+
The desired tolerance. Default is 0.0001.
|
9664
9664
|
numWorkers : int , optional
|
9665
9665
|
Number of workers run in parallel to process. If you set it to 1, no parallel processing will take place.
|
9666
9666
|
The default is None which causes the algorithm to use twice the number of cpu cores in the host computer.
|
@@ -9774,7 +9774,7 @@ class Topology():
|
|
9774
9774
|
matrix : list
|
9775
9775
|
The input 4x4 transformation matrix.
|
9776
9776
|
silent : bool , optional
|
9777
|
-
If set to True,
|
9777
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
9778
9778
|
|
9779
9779
|
Returns
|
9780
9780
|
-------
|
@@ -9902,13 +9902,13 @@ class Topology():
|
|
9902
9902
|
topology : topologic_core.topology
|
9903
9903
|
The input topology.
|
9904
9904
|
x : float , optional
|
9905
|
-
The x translation value.
|
9905
|
+
The x translation value. Default is 0.
|
9906
9906
|
y : float , optional
|
9907
|
-
The y translation value.
|
9907
|
+
The y translation value. Default is 0.
|
9908
9908
|
z : float , optional
|
9909
|
-
The z translation value.
|
9909
|
+
The z translation value. Default is 0.
|
9910
9910
|
silent : bool , optional
|
9911
|
-
If set to True,
|
9911
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
9912
9912
|
|
9913
9913
|
Returns
|
9914
9914
|
-------
|
@@ -9979,9 +9979,9 @@ class Topology():
|
|
9979
9979
|
topology : topologic_core.topology
|
9980
9980
|
The input topology.
|
9981
9981
|
direction : list , optional
|
9982
|
-
The direction vector in which the topology should be moved.
|
9982
|
+
The direction vector in which the topology should be moved. Default is [0, 0, 0]
|
9983
9983
|
distance : float , optional
|
9984
|
-
The distance by which the toplogy should be moved.
|
9984
|
+
The distance by which the toplogy should be moved. Default is 0.
|
9985
9985
|
|
9986
9986
|
Returns
|
9987
9987
|
-------
|
@@ -10007,7 +10007,7 @@ class Topology():
|
|
10007
10007
|
topology : topologic_core.Topology
|
10008
10008
|
The input topologgy.
|
10009
10009
|
transferDictionaries : bool , optional
|
10010
|
-
If set to True, the dictionaries of the faces in the input topology will be transferred to the created triangular faces.
|
10010
|
+
If set to True, the dictionaries of the faces in the input topology will be transferred to the created triangular faces. Default is False.
|
10011
10011
|
mode : int , optional
|
10012
10012
|
The desired mode of meshing algorithm. Several options are available:
|
10013
10013
|
0: Classic
|
@@ -10024,9 +10024,9 @@ class Topology():
|
|
10024
10024
|
The desired size of the mesh when using the "mesh" option. If set to None, it will be
|
10025
10025
|
calculated automatically and set to 10% of the overall size of the face.
|
10026
10026
|
tolerance : float , optional
|
10027
|
-
The desired tolerance.
|
10027
|
+
The desired tolerance. Default is 0.0001.
|
10028
10028
|
silent : bool , optional
|
10029
|
-
If set to True,
|
10029
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
10030
10030
|
|
10031
10031
|
Returns
|
10032
10032
|
-------
|
@@ -10132,7 +10132,7 @@ class Topology():
|
|
10132
10132
|
topology : topologic_core.Topology
|
10133
10133
|
The input topology.
|
10134
10134
|
silent : bool , optional
|
10135
|
-
If set to True,
|
10135
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
10136
10136
|
|
10137
10137
|
Returns
|
10138
10138
|
-------
|
@@ -10171,7 +10171,7 @@ class Topology():
|
|
10171
10171
|
"graph",
|
10172
10172
|
"topology"
|
10173
10173
|
|
10174
|
-
It is case insensitive.
|
10174
|
+
It is case insensitive. Default is None.
|
10175
10175
|
|
10176
10176
|
Returns
|
10177
10177
|
-------
|
@@ -10281,17 +10281,17 @@ class Topology():
|
|
10281
10281
|
topologies : list or comma separated topologies
|
10282
10282
|
The input list of topologies.
|
10283
10283
|
uuid : UUID , optional
|
10284
|
-
The UUID v5 to use to identify these topologies.
|
10284
|
+
The UUID v5 to use to identify these topologies. Default is a UUID based on the topologies themselves.
|
10285
10285
|
nameKey : str , optional
|
10286
|
-
The topology dictionary key under which to find the name of the topology.
|
10286
|
+
The topology dictionary key under which to find the name of the topology. Default is "name".
|
10287
10287
|
colorKey : str, optional
|
10288
|
-
The topology dictionary key under which to find the color of the topology.
|
10288
|
+
The topology dictionary key under which to find the color of the topology. Default is "color".
|
10289
10289
|
opacityKey : str , optional
|
10290
|
-
The topology dictionary key under which to find the opacity of the topology.
|
10290
|
+
The topology dictionary key under which to find the opacity of the topology. Default is "opacity".
|
10291
10291
|
defaultColor : list , optional
|
10292
|
-
The default color to use if no color is stored in the topology dictionary.
|
10292
|
+
The default color to use if no color is stored in the topology dictionary. Default is [255,255, 255] (white).
|
10293
10293
|
defaultOpacity : float , optional
|
10294
|
-
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1.
|
10294
|
+
The default opacity to use of no opacity is stored in the topology dictionary. This must be between 0 and 1. Default is 1 (fully opaque).
|
10295
10295
|
transposeAxes : bool , optional
|
10296
10296
|
If set to True the Z and Y coordinates are transposed so that Y points "up"
|
10297
10297
|
mode : int , optional
|
@@ -10310,11 +10310,11 @@ class Topology():
|
|
10310
10310
|
The desired size of the mesh when using the "mesh" option. If set to None, it will be
|
10311
10311
|
calculated automatically and set to 10% of the overall size of the face.
|
10312
10312
|
mantissa : int , optional
|
10313
|
-
The
|
10313
|
+
The number of decimal places to round the result to. Default is 6.
|
10314
10314
|
tolerance : float , optional
|
10315
|
-
The desired tolerance.
|
10315
|
+
The desired tolerance. Default is 0.0001.
|
10316
10316
|
overwrite : bool , optional
|
10317
|
-
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
10317
|
+
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't. Default is False.
|
10318
10318
|
|
10319
10319
|
Returns
|
10320
10320
|
-------
|