1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
|
import OCP.BRepAlgoAPI
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.TopTools
import OCP.Message
import OCP.BRepTools
import OCP.NCollection
import OCP.Geom
import OCP.BOPAlgo
import OCP.Standard
import OCP.gp
import OCP.BRepBuilderAPI
import OCP.TopoDS
import io
__all__ = [
"BRepAlgoAPI_Algo",
"BRepAlgoAPI_BuilderAlgo",
"BRepAlgoAPI_BooleanOperation",
"BRepAlgoAPI_Check",
"BRepAlgoAPI_Common",
"BRepAlgoAPI_Cut",
"BRepAlgoAPI_Defeaturing",
"BRepAlgoAPI_Fuse",
"BRepAlgoAPI_Section",
"BRepAlgoAPI_Splitter"
]
class BRepAlgoAPI_Algo(OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
Provides the root interface for the API algorithms
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
This is called by Shape(). It does nothing but may be redefined.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,S : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <S>.
"""
def IsDeleted(self,S : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Returns true if the shape S has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,S : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes modified from the shape <S>.
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
pass
class BRepAlgoAPI_BuilderAlgo(BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The class contains API level of the General Fuse algorithm.
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the algorithm
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,thePF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_BooleanOperation(BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The root API class for performing Boolean Operations on arbitrary shapes.
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the Boolean operation.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def Operation(self) -> OCP.BOPAlgo.BOPAlgo_Operation:
"""
Returns the type of Boolean Operation
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetOperation(self,theBOP : OCP.BOPAlgo.BOPAlgo_Operation) -> None:
"""
Sets the type of Boolean operation
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def Shape1(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the first argument involved in this Boolean operation. Obsolete
"""
def Shape2(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the second argument involved in this Boolean operation. Obsolete
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tools arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,thePF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_Check(OCP.BOPAlgo.BOPAlgo_Options):
"""
The class Check provides a diagnostic tool for checking the validity of the single shape or couple of shapes. The shapes are checked on: - Topological validity; - Small edges; - Self-interference; - Validity for Boolean operation of certain type (for couple of shapes only).
"""
def AddError(self,theAlert : OCP.Message.Message_Alert) -> None:
"""
Adds the alert as error (fail)
"""
def AddWarning(self,theAlert : OCP.Message.Message_Alert) -> None:
"""
Adds the alert as warning
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns allocator
"""
def Clear(self) -> None:
"""
Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.
"""
def ClearWarnings(self) -> None:
"""
Clears the warnings of the algorithm
"""
def DumpErrors(self,theOS : io.BytesIO) -> None:
"""
Dumps the error status into the given stream
"""
def DumpWarnings(self,theOS : io.BytesIO) -> None:
"""
Dumps the warning statuses into the given stream
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance
"""
@staticmethod
def GetParallelMode_s() -> bool:
"""
Gets the global parallel mode
"""
def GetReport(self) -> OCP.Message.Message_Report:
"""
Returns report collecting all errors and warnings
"""
def HasError(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns true if algorithm has generated error of specified type
"""
def HasErrors(self) -> bool:
"""
Returns true if algorithm has failed
"""
def HasWarning(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns true if algorithm has generated warning of specified type
"""
def HasWarnings(self) -> bool:
"""
Returns true if algorithm has generated some warning alerts
"""
def IsValid(self) -> bool:
"""
Shows whether shape(s) valid or not.
"""
def Perform(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the check.
"""
def Result(self) -> OCP.BOPAlgo.BOPAlgo_ListOfCheckResult:
"""
Returns faulty shapes.
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing
"""
@overload
def SetData(self,theS : OCP.TopoDS.TopoDS_Shape,bTestSE : bool=True,bTestSI : bool=True) -> None:
"""
Initializes the algorithm with single shape.
Initializes the algorithm with couple of shapes. Additionally to the validity checks of each given shape, the types of the given shapes will be checked on validity for Boolean operation of given type.
"""
@overload
def SetData(self,theS1 : OCP.TopoDS.TopoDS_Shape,theS2 : OCP.TopoDS.TopoDS_Shape,theOp : OCP.BOPAlgo.BOPAlgo_Operation=BOPAlgo_Operation.BOPAlgo_UNKNOWN,bTestSE : bool=True,bTestSI : bool=True) -> None: ...
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance
"""
@staticmethod
def SetParallelMode_s(theNewMode : bool) -> None:
"""
Sets the global parallel mode
"""
def SetRunParallel(self,theFlag : bool) -> None:
"""
Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off
"""
def SetUseOBB(self,theUseOBB : bool) -> None:
"""
Enables/Disables the usage of OBB
"""
def UseOBB(self) -> bool:
"""
Returns the flag defining usage of OBB
"""
@overload
def __init__(self,theS1 : OCP.TopoDS.TopoDS_Shape,theS2 : OCP.TopoDS.TopoDS_Shape,theOp : OCP.BOPAlgo.BOPAlgo_Operation=BOPAlgo_Operation.BOPAlgo_UNKNOWN,bTestSE : bool=True,bTestSI : bool=True,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self,theS : OCP.TopoDS.TopoDS_Shape,bTestSE : bool=True,bTestSI : bool=True,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_Common(BRepAlgoAPI_BooleanOperation, BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The class provides Boolean common operation between arguments and tools (Boolean Intersection).
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the Boolean operation.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def Operation(self) -> OCP.BOPAlgo.BOPAlgo_Operation:
"""
Returns the type of Boolean Operation
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetOperation(self,theBOP : OCP.BOPAlgo.BOPAlgo_Operation) -> None:
"""
Sets the type of Boolean operation
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def Shape1(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the first argument involved in this Boolean operation. Obsolete
"""
def Shape2(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the second argument involved in this Boolean operation. Obsolete
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tools arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,PF : OCP.BOPAlgo.BOPAlgo_PaveFiller,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self,PF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_Cut(BRepAlgoAPI_BooleanOperation, BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The class Cut provides Boolean cut operation between arguments and tools (Boolean Subtraction).
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the Boolean operation.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def Operation(self) -> OCP.BOPAlgo.BOPAlgo_Operation:
"""
Returns the type of Boolean Operation
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetOperation(self,theBOP : OCP.BOPAlgo.BOPAlgo_Operation) -> None:
"""
Sets the type of Boolean operation
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def Shape1(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the first argument involved in this Boolean operation. Obsolete
"""
def Shape2(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the second argument involved in this Boolean operation. Obsolete
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tools arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,aDSF : OCP.BOPAlgo.BOPAlgo_PaveFiller,bFWD : bool=True,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,PF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
pass
class BRepAlgoAPI_Defeaturing(BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The BRepAlgoAPI_Defeaturing algorithm is the API algorithm intended for removal of the unwanted parts from the shape. The unwanted parts (or features) can be holes, protrusions, gaps, chamfers, fillets etc. The shape itself is not modified, the new shape is built as the result.
"""
def AddFaceToRemove(self,theFace : OCP.TopoDS.TopoDS_Shape) -> None:
"""
Adds the features to remove from the input shape.
"""
def AddFacesToRemove(self,theFaces : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Adds the faces to remove from the input shape.
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the operation
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def FacesToRemove(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of faces which have been requested for removal from the input shape.
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS> during the operation.
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns whether the history was requested or not.
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
Returns the History of shapes modifications
"""
def InputShape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the input shape
"""
def IsDeleted(self,theS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Returns true if the shape <theS> has been deleted during the operation. It means that the shape has no any trace in the result. Otherwise it returns false.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes modified from the shape <theS> during the operation.
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetShape(self,theShape : OCP.TopoDS.TopoDS_Shape) -> None:
"""
Sets the shape for processing.
"""
def SetToFillHistory(self,theFlag : bool) -> None:
"""
Defines whether to track the modification of the shapes or not.
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_Fuse(BRepAlgoAPI_BooleanOperation, BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The class provides Boolean fusion operation between arguments and tools (Boolean Union).
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the Boolean operation.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def Operation(self) -> OCP.BOPAlgo.BOPAlgo_Operation:
"""
Returns the type of Boolean Operation
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetOperation(self,theBOP : OCP.BOPAlgo.BOPAlgo_Operation) -> None:
"""
Sets the type of Boolean operation
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def Shape1(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the first argument involved in this Boolean operation. Obsolete
"""
def Shape2(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the second argument involved in this Boolean operation. Obsolete
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tools arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,aDSF : OCP.BOPAlgo.BOPAlgo_PaveFiller,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None: ...
@overload
def __init__(self,PF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class BRepAlgoAPI_Section(BRepAlgoAPI_BooleanOperation, BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The algorithm is to build a Section operation between arguments and tools. The result of Section operation consists of vertices and edges. The result of Section operation contains: 1. new vertices that are subjects of V/V, E/E, E/F, F/F interferences 2. vertices that are subjects of V/E, V/F interferences 3. new edges that are subjects of F/F interferences 4. edges that are Common Blocks
"""
def Approximation(self,B : bool) -> None:
"""
None
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the algorithm Filling interference Data Structure (if it is necessary) Building the result of the operation.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def ComputePCurveOn1(self,B : bool) -> None:
"""
Indicates whether the P-Curve should be (or not) performed on the argument. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the argument to the constructed edges. Obsolete
"""
def ComputePCurveOn2(self,B : bool) -> None:
"""
Indicates whether the P-Curve should be (or not) performed on the tool. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the tool to the constructed edges. Obsolete
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasAncestorFaceOn1(self,E : OCP.TopoDS.TopoDS_Shape,F : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
get the face of the first part giving section edge <E>. Returns True on the 3 following conditions : 1/ <E> is an edge returned by the Shape() metwod. 2/ First part of section performed is a shape. 3/ <E> is built on a intersection curve (i.e <E> is not the result of common edges) When False, F remains untouched. Obsolete
"""
def HasAncestorFaceOn2(self,E : OCP.TopoDS.TopoDS_Shape,F : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Identifies the ancestor faces of the intersection edge E resulting from the last computation performed in this framework, that is, the faces of the two original shapes on which the edge E lies: - HasAncestorFaceOn1 gives the ancestor face in the first shape, and - HasAncestorFaceOn2 gives the ancestor face in the second shape. These functions return true if an ancestor face F is found, or false if not. An ancestor face is identifiable for the edge E if the following conditions are satisfied: - the first part on which this algorithm performed its last computation is a shape, that is, it was not given as a surface or a plane at the time of construction of this algorithm or at a later time by the Init1 function, - E is one of the elementary edges built by the last computation of this section algorithm. To use these functions properly, you have to test the returned Boolean value before using the ancestor face: F is significant only if the returned Boolean value equals true. Obsolete
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
@overload
def Init1(self,S1 : OCP.TopoDS.TopoDS_Shape) -> None:
"""
initialize the argument <S1> - argument Obsolete
initialize the argument <Pl> - argument Obsolete
initialize the argument <Sf> - argument Obsolete
"""
@overload
def Init1(self,Sf : OCP.Geom.Geom_Surface) -> None: ...
@overload
def Init1(self,Pl : OCP.gp.gp_Pln) -> None: ...
@overload
def Init2(self,S2 : OCP.TopoDS.TopoDS_Shape) -> None:
"""
initialize the tool <S2> - tool Obsolete
initialize the tool <Pl> - tool Obsolete
initialize the tool <Sf> - tool Obsolete
"""
@overload
def Init2(self,Pl : OCP.gp.gp_Pln) -> None: ...
@overload
def Init2(self,Sf : OCP.Geom.Geom_Surface) -> None: ...
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def Operation(self) -> OCP.BOPAlgo.BOPAlgo_Operation:
"""
Returns the type of Boolean Operation
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetOperation(self,theBOP : OCP.BOPAlgo.BOPAlgo_Operation) -> None:
"""
Sets the type of Boolean operation
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def Shape1(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the first argument involved in this Boolean operation. Obsolete
"""
def Shape2(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns the second argument involved in this Boolean operation. Obsolete
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tools arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,Sf : OCP.Geom.Geom_Surface,PerformNow : bool=True) -> None: ...
@overload
def __init__(self,Sf1 : OCP.Geom.Geom_Surface,Sf2 : OCP.Geom.Geom_Surface,PerformNow : bool=True) -> None: ...
@overload
def __init__(self,Sf : OCP.Geom.Geom_Surface,S2 : OCP.TopoDS.TopoDS_Shape,PerformNow : bool=True) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,PerformNow : bool=True) -> None: ...
@overload
def __init__(self,PF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,S2 : OCP.TopoDS.TopoDS_Shape,aDSF : OCP.BOPAlgo.BOPAlgo_PaveFiller,PerformNow : bool=True) -> None: ...
@overload
def __init__(self,S1 : OCP.TopoDS.TopoDS_Shape,Pl : OCP.gp.gp_Pln,PerformNow : bool=True) -> None: ...
pass
class BRepAlgoAPI_Splitter(BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Algo, OCP.BRepBuilderAPI.BRepBuilderAPI_MakeShape, OCP.BRepBuilderAPI.BRepBuilderAPI_Command):
"""
The class contains API level of the **Splitter** algorithm, which allows splitting a group of arbitrary shapes by the other group of arbitrary shapes. The arguments of the operation are divided on two groups: *Objects* - shapes that will be split; *Tools* - shapes by which the *Objects* will be split. The result of the operation contains only the split parts of the shapes from the group of *Objects*. The split parts of the shapes from the group of *Tools* are excluded from the result. The shapes can be split by the other shapes from the same group (in case these shapes are interfering).
"""
def Arguments(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Gets the arguments
"""
def Build(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
Performs the Split operation. Performs the intersection of the argument shapes (both objects and tools) and splits objects by the tools.
"""
def Check(self) -> None:
"""
Raises NotDone if done is false.
"""
def CheckInverted(self) -> bool:
"""
Returns the flag defining whether the check for input solids on inverted status should be performed or not.
"""
def DSFiller(self) -> OCP.BOPAlgo.BOPAlgo_PaveFiller:
"""
Returns the Intersection tool
"""
def FuzzyValue(self) -> float:
"""
Returns the additional tolerance.
"""
def Generated(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the list of shapes generated from the shape <theS>. In frames of Boolean Operations algorithms only Edges and Faces could have Generated elements, as only they produce new elements during intersection: - Edges can generate new vertices; - Faces can generate new edges and vertices.
"""
def Glue(self) -> OCP.BOPAlgo.BOPAlgo_GlueEnum:
"""
Returns the glue option of the algorithm
"""
def HasDeleted(self) -> bool:
"""
Returns true if any of the input shapes has been deleted during operation. Normally, General Fuse operation should not have Deleted elements, but all derived operation can have.
"""
def HasGenerated(self) -> bool:
"""
Returns true if any of the input shapes has generated shapes during operation.
"""
def HasHistory(self) -> bool:
"""
Returns flag of history availability
"""
def HasModified(self) -> bool:
"""
Returns true if any of the input shapes has been modified during operation.
"""
def History(self) -> OCP.BRepTools.BRepTools_History:
"""
History tool
"""
def IsDeleted(self,aS : OCP.TopoDS.TopoDS_Shape) -> bool:
"""
Checks if the shape <theS> has been completely removed from the result, i.e. the result does not contain the shape itself and any of its splits. Returns TRUE if the shape has been deleted.
"""
def IsDone(self) -> bool:
"""
None
"""
def Modified(self,theS : OCP.TopoDS.TopoDS_Shape) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the shapes modified from the shape <theS>. If any, the list will contain only those splits of the given shape, contained in the result.
"""
def NonDestructive(self) -> bool:
"""
Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def RunParallel(self) -> bool:
"""
Returns the flag of parallel processing.
"""
def SectionEdges(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns a list of section edges. The edges represent the result of intersection between arguments of operation.
"""
def SetArguments(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the arguments
"""
def SetCheckInverted(self,theCheck : bool) -> None:
"""
Enables/Disables the check of the input solids for inverted status
"""
def SetFuzzyValue(self,theFuzz : float) -> None:
"""
Sets the additional tolerance.
"""
def SetGlue(self,theGlue : OCP.BOPAlgo.BOPAlgo_GlueEnum) -> None:
"""
Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes.
"""
def SetNonDestructive(self,theFlag : bool) -> None:
"""
Sets the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.
"""
def SetRunParallel(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def SetToFillHistory(self,theHistFlag : bool) -> None:
"""
Allows disabling the history collection
"""
def SetTools(self,theLS : OCP.TopTools.TopTools_ListOfShape) -> None:
"""
Sets the Tool arguments
"""
def SetUseOBB(self,thFlag : bool) -> None:
"""
Set the flag of parallel processing.
"""
def Shape(self) -> OCP.TopoDS.TopoDS_Shape:
"""
Returns a shape built by the shape construction algorithm. Does not check if the shape is built.
"""
def SimplifyResult(self,theUnifyEdges : bool=True,theUnifyFaces : bool=True,theAngularTol : float=1e-12) -> None:
"""
Simplification of the result shape is performed by the means of *ShapeUpgrade_UnifySameDomain* algorithm. The result of the operation will be overwritten with the simplified result.
"""
def Tools(self) -> OCP.TopTools.TopTools_ListOfShape:
"""
Returns the Tool arguments
"""
def __bool__(self) -> bool:
"""
Check if command is done
"""
@overload
def __init__(self,thePF : OCP.BOPAlgo.BOPAlgo_PaveFiller) -> None: ...
@overload
def __init__(self) -> None: ...
pass
|