/usr/include/opencascade/AIS_InteractiveContext.hxx is in libopencascade-visualization-dev 6.5.0.dfsg-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 | // This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _AIS_InteractiveContext_HeaderFile
#define _AIS_InteractiveContext_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_AIS_InteractiveContext_HeaderFile
#include <Handle_AIS_InteractiveContext.hxx>
#endif
#ifndef _AIS_DataMapOfIOStatus_HeaderFile
#include <AIS_DataMapOfIOStatus.hxx>
#endif
#ifndef _Handle_SelectMgr_SelectionManager_HeaderFile
#include <Handle_SelectMgr_SelectionManager.hxx>
#endif
#ifndef _Handle_PrsMgr_PresentationManager3d_HeaderFile
#include <Handle_PrsMgr_PresentationManager3d.hxx>
#endif
#ifndef _Handle_V3d_Viewer_HeaderFile
#include <Handle_V3d_Viewer.hxx>
#endif
#ifndef _Handle_StdSelect_ViewerSelector3d_HeaderFile
#include <Handle_StdSelect_ViewerSelector3d.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Handle_AIS_InteractiveObject_HeaderFile
#include <Handle_AIS_InteractiveObject.hxx>
#endif
#ifndef _Handle_SelectMgr_OrFilter_HeaderFile
#include <Handle_SelectMgr_OrFilter.hxx>
#endif
#ifndef _Handle_Prs3d_Drawer_HeaderFile
#include <Handle_Prs3d_Drawer.hxx>
#endif
#ifndef _Quantity_NameOfColor_HeaderFile
#include <Quantity_NameOfColor.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _AIS_DataMapOfILC_HeaderFile
#include <AIS_DataMapOfILC.hxx>
#endif
#ifndef _Handle_V3d_View_HeaderFile
#include <Handle_V3d_View.hxx>
#endif
#ifndef _AIS_SequenceOfInteractive_HeaderFile
#include <AIS_SequenceOfInteractive.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _AIS_KindOfInteractive_HeaderFile
#include <AIS_KindOfInteractive.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Aspect_TypeOfFacingModel_HeaderFile
#include <Aspect_TypeOfFacingModel.hxx>
#endif
#ifndef _Graphic3d_NameOfMaterial_HeaderFile
#include <Graphic3d_NameOfMaterial.hxx>
#endif
#ifndef _Aspect_TypeOfDegenerateModel_HeaderFile
#include <Aspect_TypeOfDegenerateModel.hxx>
#endif
#ifndef _Quantity_Ratio_HeaderFile
#include <Quantity_Ratio.hxx>
#endif
#ifndef _Handle_AIS_Drawer_HeaderFile
#include <Handle_AIS_Drawer.hxx>
#endif
#ifndef _AIS_DisplayStatus_HeaderFile
#include <AIS_DisplayStatus.hxx>
#endif
#ifndef _AIS_DisplayMode_HeaderFile
#include <AIS_DisplayMode.hxx>
#endif
#ifndef _Handle_Prs3d_LineAspect_HeaderFile
#include <Handle_Prs3d_LineAspect.hxx>
#endif
#ifndef _AIS_TypeOfIso_HeaderFile
#include <AIS_TypeOfIso.hxx>
#endif
#ifndef _Handle_Prs3d_BasicAspect_HeaderFile
#include <Handle_Prs3d_BasicAspect.hxx>
#endif
#ifndef _AIS_StatusOfDetection_HeaderFile
#include <AIS_StatusOfDetection.hxx>
#endif
#ifndef _AIS_StatusOfPick_HeaderFile
#include <AIS_StatusOfPick.hxx>
#endif
#ifndef _Handle_SelectMgr_EntityOwner_HeaderFile
#include <Handle_SelectMgr_EntityOwner.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _AIS_ClearMode_HeaderFile
#include <AIS_ClearMode.hxx>
#endif
#ifndef _Handle_Geom_Transformation_HeaderFile
#include <Handle_Geom_Transformation.hxx>
#endif
#ifndef _Handle_SelectMgr_Filter_HeaderFile
#include <Handle_SelectMgr_Filter.hxx>
#endif
#ifndef _TopAbs_ShapeEnum_HeaderFile
#include <TopAbs_ShapeEnum.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
class SelectMgr_SelectionManager;
class PrsMgr_PresentationManager3d;
class V3d_Viewer;
class StdSelect_ViewerSelector3d;
class AIS_InteractiveObject;
class SelectMgr_OrFilter;
class Prs3d_Drawer;
class V3d_View;
class AIS_LocalContext;
class TopLoc_Location;
class Quantity_Color;
class AIS_Drawer;
class TColStd_ListOfInteger;
class TCollection_ExtendedString;
class Prs3d_LineAspect;
class Prs3d_BasicAspect;
class TColgp_Array1OfPnt2d;
class TopoDS_Shape;
class SelectMgr_EntityOwner;
class SelectMgr_IndexedMapOfOwner;
class Standard_Transient;
class Geom_Transformation;
class SelectMgr_Filter;
class SelectMgr_ListOfFilter;
class AIS_ListOfInteractive;
class TCollection_AsciiString;
//! The Interactive Context allows you to manage <br>
//! graphic behavior and selection of Interactive Objects <br>
//! in one or more viewers. Class methods make this <br>
//! highly transparent. <br>
//! It is essential to remember that an Interactive Object <br>
//! which is already known by the Interactive Context <br>
//! must be modified using Context methods. You can <br>
//! only directly call the methods available for an <br>
//! Interactive Object if it has not been loaded into an <br>
//! Interactive Context. <br>
//! You must distinguish two states in the Interactive Context: <br>
//! - No Open Local Context, also known as the Neutral Point. <br>
//! - One or several open local contexts, each <br>
//! representing a temporary state of selection and presentation. <br>
//! Some methods can only be used in open Local <br>
//! Context; others in closed Local Context; others do <br>
//! not have the same behavior in one state as in the other. <br>
//! The possiblities of use for local contexts are <br>
//! numerous depending on the type of operation that <br>
//! you want to perform, for example: <br>
//! - working on all visualized interactive objects, <br>
//! - working on only a few objects, <br>
//! - working on a single object. <br>
//! 1. When you want ot work on one type of entity, you <br>
//! should open a local context with the option <br>
//! UseDisplayedObjects set to false. DisplayedObjects <br>
//! allows you to recover the visualized Interactive <br>
//! Objects which have a given Type and <br>
//! Signature from Neutral Point. <br>
//! 2. You must keep in mind the fact that when you open <br>
//! a Local Context with default options: <br>
//! - The Interactive Objects visualized at Neutral Point <br>
//! are activated with their default selection mode. You <br>
//! must deactivate those which you do not want ot use. <br>
//! - The Shape type Interactive Objects are <br>
//! automatically decomposed into sub-shapes when <br>
//! standard activation modes are launched. <br>
//! - The "temporary" Interactive Objects present in the <br>
//! Local Contexts are not automatically taken into <br>
//! account. You have to load them manually if you <br>
//! want to use them. <br>
//! - The stages could be the following: <br>
//! - Open a Local Context with the right options; <br>
//! - Load/Visualize the required complementary <br>
//! objects with the desired activation modes. <br>
//! - Activate Standard modes if necessary <br>
//! - Create its filters and add them to the Local Context <br>
//! - Detect/Select/recover the desired entities <br>
//! - Close the Local Context with the adequate index. <br>
//! - It is useful to create an interactive editor, to which <br>
//! you pass the Interactive Context. This will take care <br>
//! of setting up the different contexts of <br>
//! selection/presentation according to the operation <br>
//! which you want to perform. <br>
class AIS_InteractiveContext : public MMgt_TShared {
public:
//! Constructs the interactive context object defined by <br>
//! the principal viewer MainViewer. <br>
Standard_EXPORT AIS_InteractiveContext(const Handle(V3d_Viewer)& MainViewer);
//! Constructs the interactive context object defined by <br>
//! the principal viewer MainViewer and the collector <br>
//! (or trash) viewer. <br>
Standard_EXPORT AIS_InteractiveContext(const Handle(V3d_Viewer)& MainViewer,const Handle(V3d_Viewer)& Collector);
Standard_EXPORT virtual void Delete() const;
Standard_Boolean IsCollectorClosed() const;
void CloseCollector() ;
Standard_EXPORT void OpenCollector() ;
Standard_EXPORT void SetAutoActivateSelection(const Standard_Boolean Auto) ;
Standard_EXPORT Standard_Boolean GetAutoActivateSelection() const;
//! Controls the choice between the using the display <br>
//! and selection modes of open local context which you <br>
//! have defined and activating those available by default. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the Interactive Object anIobj is <br>
//! displayed in the default active mode. This will be the <br>
//! object's default display mode, if there is one. <br>
//! Otherwise, it will be the context mode. The Interactive <br>
//! Object's default selection mode is activated. In <br>
//! general, this is 0. <br>
//! This syntax has the same behavior as local context, <br>
//! open or closed. If you want to view the object in open <br>
//! local context without selection, use the syntax below, <br>
//! setting aSelectionMode to -1. <br>
Standard_EXPORT void Display(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Controls the choice between the using the display <br>
//! and selection modes of open local context which you <br>
//! have defined and activating those available by default. <br>
//! If no Local Context is opened. and the Interactive <br>
//! Object aniobj has no display mode of its own, the <br>
//! default display mode, 0, is used. Likewise, if aniobj <br>
//! has no selection mode of its own, the default one, 0, is used. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
//! If aSelectionMode equals -1, anIobj will not be <br>
//! activated: it will be displayed but will not be selectable. <br>
//! Use this if you want to view the object in open local <br>
//! context without selection. Note: This option is only <br>
//! available in Local Context. <br>
//! If allowDecomposition equals true, anIObj can have <br>
//! subshapes detected by selection mechanisms. anIObj <br>
//! must be able to give a shape selection modes which <br>
//! fit the AIS_Shape selection modes: <br>
//! - vertices: 1 <br>
//! - edges: 2 <br>
//! - wires: 3. <br>
Standard_EXPORT void Display(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Integer amode,const Standard_Integer aSelectionMode,const Standard_Boolean updateviewer = Standard_True,const Standard_Boolean allowdecomposition = Standard_True) ;
//! Allows you to load the Interactive Object aniobj <br>
//! with a given selection mode SelectionMode, and/or <br>
//! with the desired decomposition option, whether the <br>
//! object is visualized or not. If AllowDecomp = <br>
//! Standard_True and, if the interactive object is of <br>
//! the "Shape" type, these "standard" selection <br>
//! modes will be automatically activated as a function <br>
//! of the modes present in the Local Context. <br>
//! The loaded objects will be selectable but <br>
//! displayable in highlighting only when detected by the Selector. <br>
//! This method is available only when Local Contexts are open. <br>
Standard_EXPORT void Load(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer SelectionMode = -1,const Standard_Boolean AllowDecomp = Standard_False) ;
//! To erase presentations in current local context, or <br>
//! failing that, in other local contexts which allow erasing. <br>
Standard_EXPORT void Erase(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True,const Standard_Boolean PutInCollector = Standard_False) ;
//! Updates viewer contents and returns the display <br>
//! mode of each aniobj object. Use only if more than <br>
//! one display mode is active in the main viewer. <br>
//! This method works only on presentation modes other <br>
//! than the default mode. Nothing is done if aMode is <br>
//! the default presentation mode. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void EraseMode(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer aMode,const Standard_Boolean updateviewer = Standard_True) ;
//! Every erased object goes into the Collector viewer, <br>
//! depending on PutInCollector value. <br>
Standard_EXPORT void EraseAll(const Standard_Boolean PutInCollector = Standard_False,const Standard_Boolean updateviewer = Standard_True) ;
//! Displays all erased objects or display all objects from collector <br>
Standard_EXPORT void DisplayAll(const Standard_Boolean OnlyFromCollector = Standard_False,const Standard_Boolean updateviewer = Standard_True) ;
//! display anIObj from the collector. <br>
Standard_EXPORT void DisplayFromCollector(const Handle(AIS_InteractiveObject)& anIObj,const Standard_Boolean updateviewer = Standard_True) ;
//! Erases selected objects if there is no open active local context. <br>
//! If there is no local context activated and if <br>
//! updateviewer equals Standard_False, the <br>
//! presentation of the Interactive Object activates the <br>
//! selection mode; the object is displayed but no viewer <br>
//! will be updated. <br>
//! If a local context is open, this method is neutral. <br>
Standard_EXPORT void EraseSelected(const Standard_Boolean PutInCollector = Standard_False,const Standard_Boolean updateviewer = Standard_True) ;
//! Displays selected objects if a local context is open. <br>
//! Displays current objects if there is no active local context. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void DisplaySelected(const Standard_Boolean updateviewer = Standard_True) ;
//! Changes the status of a temporary object. It will be <br>
//! kept at the neutral point, i.e. put in the list of <br>
//! displayed objects along withwith its temporary <br>
//! attributes. These include display mode and <br>
//! selection mode, for example. <br>
//! Returns true if done. <br>
//! inWhichLocal gives the local context in which anIObj <br>
//! is displayed. By default, the index -1 refers to the last <br>
//! Local Context opened. <br>
Standard_EXPORT Standard_Boolean KeepTemporary(const Handle(AIS_InteractiveObject)& anIObj,const Standard_Integer InWhichLocal = -1) ;
//! Removes the interactive object aniobj from all viewers. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void Clear(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Empties the graphic presentation of the mode <br>
//! indexed by aMode. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
//! Warning <br>
//! Removes anIobj. anIobj is still active if it was <br>
//! previously activated. <br>
Standard_EXPORT void ClearPrs(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer aMode = 0,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes aniobj from every viewer. aniobj is no <br>
//! longer referenced in the Context. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void Remove(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes all the objects from all opened Local Contexts <br>
//! and from the Neutral Point <br>
Standard_EXPORT void RemoveAll(const Standard_Boolean updateviewer = Standard_True) ;
//! Updates the display in the viewer to take dynamic <br>
//! detection into account. On dynamic detection by the <br>
//! mouse cursor, sensitive primitives are highlighted. <br>
//! The highlight color of entities detected by mouse <br>
//! movement is white by default. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void Hilight(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Changes the color of all the lines of the object in view, <br>
//! aniobj. It paints these lines the color passed as the <br>
//! argument, aCol. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void HilightWithColor(const Handle(AIS_InteractiveObject)& aniobj,const Quantity_NameOfColor aCol,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes hilighting from the entity aniobj. Updates the viewer. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void Unhilight(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the display priority aPriority of the seen parts <br>
//! presentation of the entity anIobj. <br>
Standard_EXPORT void SetDisplayPriority(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Integer aPriority) ;
//! Recomputes the seen parts presentation of the entity <br>
//! aniobj. If allmodes equals true, all presentations are <br>
//! present in the object even if unseen. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void Redisplay(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True,const Standard_Boolean allmodes = Standard_False) ;
//! Recomputes the Prs/Selection of displayed objects of <br>
//! a given type and a given signature. <br>
//! if signature = -1 doesnt take signature criterion. <br>
Standard_EXPORT void Redisplay(const AIS_KindOfInteractive aTypeOfObject,const Standard_Integer Signature = -1,const Standard_Boolean updateviewer = Standard_True) ;
//! Recomputes the displayed presentations, flags the others <br>
//! Doesn't update presentations <br>
Standard_EXPORT void RecomputePrsOnly(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Boolean updateviewer = Standard_True,const Standard_Boolean allmodes = Standard_False) ;
//! Recomputes the active selections, flags the others <br>
//! Doesn't update presentations <br>
Standard_EXPORT void RecomputeSelectionOnly(const Handle(AIS_InteractiveObject)& anIObj) ;
//! Checks which presentations are flagged "to be recomputed" <br>
//! and recomputes them if they are displayed. <br>
//! This method doesn't force any Computation. <br>
//! Recomputes Flagged selections if they are activated. <br>
Standard_EXPORT void Update(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the display mode of seen Interactive Objects. <br>
//! aMode provides the display mode index of the entity aniobj. <br>
//! If updateviewer equals Standard_True, the <br>
//! predominant mode aMode will overule the context mode. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object returns to the default selection mode; the <br>
//! object is displayed but no viewer will be updated. <br>
//! Note that display mode 3 is only used if you have an <br>
//! AIS_Textured Shape. <br>
Standard_EXPORT void SetDisplayMode(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer aMode,const Standard_Boolean updateviewer = Standard_True) ;
//! Unsets the display mode of seen Interactive Objects. <br>
//! aMode provides the display mode index of the entity aniobj. <br>
//! If updateviewer equals Standard_True, the <br>
//! predominant mode aMode will overule the context mode. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object returns to the default selection mode; the <br>
//! object is displayed but no viewer will be updated. <br>
Standard_EXPORT void UnsetDisplayMode(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the selection mode of Interactive Objects. <br>
//! aMode provides the selection mode index of the entity aniobj. <br>
Standard_EXPORT void SetSelectionMode(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer aMode) ;
//! Removes selection mode from Interactive Objects. <br>
//! aMode provides the selection mode index of the entity aniobj. <br>
Standard_EXPORT void UnsetSelectionMode(const Handle(AIS_InteractiveObject)& aniobj) ;
//! Sets the sensitivity aPrecision <br>
//! according to the view size for the current context or local <br>
//! context if any is activated. <br>
//! Sets the sensitivity aPrecision in pixels for the current context <br>
//! or local context if any is activated. By default, this <br>
//! sensitivity is equal to 4 pixels. <br>
//! When a local context is open, the defined sensitivity applies to <br>
//! this local context instead of the main context. <br>
Standard_EXPORT void SetSensitivity(const Standard_Real aPrecision) ;
//! Define the current selection pixel sensitivity <br>
//! for this context or local context if any one is activated. <br>
//! Warning: When a local context is open the sensitivity is apply on it <br>
//! instead on the main context. <br>
Standard_EXPORT void SetSensitivity(const Standard_Integer aPrecision = 4) ;
//! Puts the location aLocation on the initial graphic <br>
//! representation and the selection for the entity aniobj. <br>
//! In other words, aniobj is visible and selectable at a <br>
//! position other than initial position. <br>
//! Graphic and selection primitives are not recomputed. <br>
//! To clean the view correctly, you must reset the previous location. <br>
Standard_EXPORT void SetLocation(const Handle(AIS_InteractiveObject)& aniobj,const TopLoc_Location& aLocation) ;
//! Puts the entity aniobj back into its initial position. <br>
Standard_EXPORT void ResetLocation(const Handle(AIS_InteractiveObject)& aniobj) ;
//! Returns true if the entity aniobj has a location. <br>
Standard_EXPORT Standard_Boolean HasLocation(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Returns the location of the entity aniobj. <br>
Standard_EXPORT const TopLoc_Location& Location(const Handle(AIS_InteractiveObject)& aniobj) const;
//! change the current facing model apply on polygons for <br>
//! SetColor(), SetTransparency(), SetMaterial() methods <br>
//! default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is <br>
//! applying both on the front and back face. <br>
Standard_EXPORT void SetCurrentFacingModel(const Handle(AIS_InteractiveObject)& aniobj,const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE) ;
Standard_EXPORT void SetColor(const Handle(AIS_InteractiveObject)& aniobj,const Quantity_NameOfColor aColor,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the color of the selected entity. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetColor(const Handle(AIS_InteractiveObject)& aniobj,const Quantity_Color& aColor,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the color selection for the selected entity. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnsetColor(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the width of the entity aniobj. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT virtual void SetWidth(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real aValue,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the width setting of the entity aniobj. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT virtual void UnsetWidth(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Provides the type of material setting for the view of <br>
//! the entity aniobj. <br>
//! The range of settings includes: BRASS, BRONZE, <br>
//! GOLD, PEWTER, SILVER, STONE. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetMaterial(const Handle(AIS_InteractiveObject)& aniobj,const Graphic3d_NameOfMaterial aName,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the type of material setting for viewing the <br>
//! entity aniobj. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnsetMaterial(const Handle(AIS_InteractiveObject)& anObj,const Standard_Boolean updateviewer = Standard_True) ;
//! Provides the transparency settings for viewing the <br>
//! entity aniobj. The transparency value aValue may be <br>
//! between 0.0, opaque, and 1.0, fully transparent. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetTransparency(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real aValue = 0.6,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the transparency settings for viewing the <br>
//! entity aniobj. The transparency value aValue may be <br>
//! between 0.0, opaque, and 1.0, fully transparent. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnsetTransparency(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the model of degeneration for the shaded representation <br>
//! of the object <aniobj> <br>
//! according to the degenerate ratio >= 0. & <= 1. where : <br>
//! <aRatio> = 0. indicate that all polygons of the object <br>
//! will be displayed. <br>
//! <aRatio> = 1. indicate that no polygons will be displayed !! <br>
//! When <ARatio> is > 0 & < 1. the corresponding amount <br>
//! of object polygons will be displayed with a random method. <br>
//! Warning: the degenerate structure is shown only when <br>
//! the animation and degenerate flags are set to TRUE <br>
//! in V3d_View::SetAnimationMode(..) <br>
Standard_EXPORT void SetDegenerateModel(const Handle(AIS_InteractiveObject)& aniobj,const Aspect_TypeOfDegenerateModel aModel = Aspect_TDM_WIREFRAME,const Quantity_Ratio aRatio = 0.0) ;
//! Defines the degenerate method to apply on the shaded <br>
//! representation of all objects. <br>
Standard_EXPORT void SetDegenerateModel(const Aspect_TypeOfDegenerateModel aModel,const Quantity_Ratio aSkipRatio = 0.0) ;
//! Sets the attributes of the interactive object aniobj by <br>
//! plugging the attribute manager aDrawer into the local <br>
//! context. The graphic attributes of aDrawer such as <br>
//! visualization mode, color, and material, are then used <br>
//! to display aniobj. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetLocalAttributes(const Handle(AIS_InteractiveObject)& aniobj,const Handle(AIS_Drawer)& aDrawer,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the settings for local attributes of the entity <br>
//! anObj and returns to the Neutral Point attributes or <br>
//! those of the previous local context. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnsetLocalAttributes(const Handle(AIS_InteractiveObject)& anObj,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets up polygon offsets for the given AIS_InteractiveObject. <br>
//! It simply calls anObj->SetPolygonOffsets() <br>
Standard_EXPORT void SetPolygonOffsets(const Handle(AIS_InteractiveObject)& anObj,const Standard_Integer aMode,const Standard_Real aFactor = 1.0,const Standard_Real aUnits = 0.0,const Standard_Boolean updateviewer = Standard_True) ;
//! simply calls anObj->HasPolygonOffsets() <br>
Standard_EXPORT Standard_Boolean HasPolygonOffsets(const Handle(AIS_InteractiveObject)& anObj) const;
//! Retrieves current polygon offsets settings for <anObj>. <br>
Standard_EXPORT void PolygonOffsets(const Handle(AIS_InteractiveObject)& anObj,Standard_Integer& aMode,Standard_Real& aFactor,Standard_Real& aUnits) const;
//! Sets the size aSize of the trihedron. <br>
//! Is used to change the default value 100 mm for <br>
//! display of trihedra. <br>
//! Use of this function in one of your own interactive <br>
//! objects requires a call to the Compute function of the <br>
//! new class. This will recalculate the presentation for <br>
//! every trihedron displayed. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetTrihedronSize(const Standard_Real aSize,const Standard_Boolean updateviewer = Standard_True) ;
//! returns the current value of trihedron size. <br>
Standard_EXPORT Standard_Real TrihedronSize() const;
//! Sets the plane size defined by the length in the X <br>
//! direction XSize and that in the Y direction YSize. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetPlaneSize(const Standard_Real aSizeX,const Standard_Real aSizeY,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the plane size aSize. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
//! May be used if PlaneSize returns true. <br>
Standard_EXPORT void SetPlaneSize(const Standard_Real aSize,const Standard_Boolean updateviewer = Standard_True) ;
//! Returns true if the length in the X direction XSize is <br>
//! the same as that in the Y direction YSize. <br>
Standard_EXPORT Standard_Boolean PlaneSize(Standard_Real& XSize,Standard_Real& YSize) const;
//! Returns the display status of the entity anIobj. <br>
//! This will be one of the following: <br>
//! - DS_Displayed displayed in main viewer <br>
//! - DS_Erased erased in the Collector <br>
//! - DS_FullErased erased everywhere but in the Collector <br>
//! - DS_Temporary temporarily displayed <br>
//! - DS_None nowhere displayed. <br>
Standard_EXPORT AIS_DisplayStatus DisplayStatus(const Handle(AIS_InteractiveObject)& anIobj) const;
//! Returns the list of active display modes for the entity aniobj. <br>
Standard_EXPORT const TColStd_ListOfInteger& DisplayedModes(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Returns true if anIobj is displayed in the interactive context. <br>
Standard_EXPORT Standard_Boolean IsDisplayed(const Handle(AIS_InteractiveObject)& anIobj) const;
Standard_EXPORT Standard_Boolean IsDisplayed(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Integer aMode) const;
Standard_EXPORT Standard_Boolean IsHilighted(const Handle(AIS_InteractiveObject)& aniobj) const;
//! if <anIObj> is hilighted with a specific color <br>
//! <WithColor> will be returned TRUE <br>
//! <theHiCol> gives the name of the hilightcolor <br>
Standard_EXPORT Standard_Boolean IsHilighted(const Handle(AIS_InteractiveObject)& anIobj,Standard_Boolean& WithColor,Quantity_NameOfColor& theHiCol) const;
//! Returns true if the entity anIobj is in the Collector viewer. <br>
Standard_EXPORT Standard_Boolean IsInCollector(const Handle(AIS_InteractiveObject)& anIObj) const;
//! Returns the display priority of the entity anIobj. This <br>
//! will be display mode of anIobj if it is in the main <br>
//! viewer, and the highlight mode if it is in the Collector viewer. <br>
Standard_EXPORT Standard_Integer DisplayPriority(const Handle(AIS_InteractiveObject)& anIobj) const;
//! Returns true if a view of the Interactive Object aniobj has color. <br>
Standard_EXPORT Standard_Boolean HasColor(const Handle(AIS_InteractiveObject)& aniobj) const;
Standard_EXPORT Quantity_NameOfColor Color(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Returns the color Color of the entity aniobj in the interactive context. <br>
Standard_EXPORT void Color(const Handle(AIS_InteractiveObject)& aniobj,Quantity_Color& acolor) const;
//! Returns the width of the Interactive Object aniobj in <br>
//! the interactive context. <br>
Standard_EXPORT virtual Standard_Real Width(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Returns the status astatus of the Interactive Context <br>
//! for the view of the Interactive Object anObj. <br>
Standard_EXPORT void Status(const Handle(AIS_InteractiveObject)& anObj,TCollection_ExtendedString& astatus) const;
//! Updates the current viewer, the viewer in Neutral Point. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT void UpdateCurrentViewer() ;
//! Updates the Collector viewer. <br>
Standard_EXPORT void UpdateCollector() ;
//! Returns the display mode setting. <br>
//! Note that mode 3 is only used. <br>
Standard_Integer DisplayMode() const;
//! Returns the name of the color used to show <br>
//! highlighted entities, that is, entities picked out by the mouse. <br>
Quantity_NameOfColor HilightColor() const;
//! Returns the name of the color used to show selected entities. <br>
//! By default, this is Quantity_NOC_GRAY80. <br>
Quantity_NameOfColor SelectionColor() const;
//! Returns the name of the color used to show preselection. <br>
//! By default, this is Quantity_NOC_GREEN. <br>
Quantity_NameOfColor PreSelectionColor() const;
//! Returns the name of the color used by default. <br>
//! By default, this is Quantity_NOC_GOLDENROD. <br>
Quantity_NameOfColor DefaultColor() const;
//! Returns the name of the color used to show that an <br>
//! object is not currently selected. <br>
//! By default, this is Quantity_NOC_GRAY40. <br>
Quantity_NameOfColor SubIntensityColor() const;
//! Sets the color used to show highlighted entities, that <br>
//! is, entities picked by the mouse. <br>
//! By default, this is Quantity_NOC_CYAN1. <br>
void SetHilightColor(const Quantity_NameOfColor aHiCol) ;
//! Sets the color used to show selected entities. <br>
//! By default, this is Quantity_NOC_GRAY80. <br>
void SelectionColor(const Quantity_NameOfColor aCol) ;
//! Allows you to set the color used to show preselection. <br>
//! By default, this is Quantity_NOC_GREEN. <br>
//! A preselected entity is one which has been selected <br>
//! as the domain of application of a function such as a fillet. <br>
void SetPreselectionColor(const Quantity_NameOfColor aCol) ;
//! Sets the color used to show that an object is not currently selected. <br>
//! By default, this is Quantity_NOC_GRAY40. <br>
void SetSubIntensityColor(const Quantity_NameOfColor aCol) ;
//! Sets the display mode of seen Interactive Objects. <br>
//! aMode provides the display mode index of the entity aniobj. <br>
//! If updateviewer equals Standard_True, the <br>
//! predominant mode aMode will overule the context mode. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object returns to the default selection mode; the <br>
//! object is displayed but no viewer will be updated. <br>
//! Note that display mode 3 is only used if you have an <br>
//! AIS_Textured Shape. <br>
Standard_EXPORT void SetDisplayMode(const AIS_DisplayMode AMode,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the deviation coefficient aCoefficient. <br>
//! Drawings of curves or patches are made with respect <br>
//! to a maximal chordal deviation. A Deviation coefficient <br>
//! is used in the shading display mode. The shape is <br>
//! seen decomposed into triangles. These are used to <br>
//! calculate reflection of light from the surface of the <br>
//! object. The triangles are formed from chords of the <br>
//! curves in the shape. The deviation coefficient <br>
//! aCoefficient gives the highest value of the angle with <br>
//! which a chord can deviate from a tangent to a curve. <br>
//! If this limit is reached, a new triangle is begun. <br>
//! This deviation is absolute and is set through the <br>
//! method: SetMaximalChordialDeviation. The default <br>
//! value is 0.001. <br>
//! In drawing shapes, however, you are allowed to ask <br>
//! for a relative deviation. This deviation will be: <br>
//! SizeOfObject * DeviationCoefficient. <br>
//! default 0.001 <br>
Standard_EXPORT void SetDeviationCoefficient(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real aCoefficient,const Standard_Boolean updateviewer = Standard_True) ;
Standard_EXPORT void SetDeviationAngle(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real anAngle,const Standard_Boolean updateviewer = Standard_True) ;
//! Calls the AIS_Shape SetAngleAndDeviation to set <br>
//! both Angle and Deviation coefficients <br>
Standard_EXPORT void SetAngleAndDeviation(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real anAngle,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the deviation coefficient aCoefficient for <br>
//! removal of hidden lines created by different <br>
//! viewpoints in different presentations. The Default value is 0.02. <br>
Standard_EXPORT void SetHLRDeviationCoefficient(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real aCoefficient,const Standard_Boolean updateviewer = Standard_True) ;
Standard_EXPORT void SetHLRDeviationAngle(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real anAngle,const Standard_Boolean updateviewer = Standard_True) ;
//! Computes a HLRAngle and a <br>
//! HLRDeviationCoefficient by means of the angle <br>
//! anAngle and sets the corresponding methods in the <br>
//! default drawing tool with these values. <br>
//! <br>
Standard_EXPORT void SetHLRAngleAndDeviation(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Real anAngle,const Standard_Boolean updateviewer = Standard_True) ;
//! Sets the deviation coefficient aCoefficient. <br>
//! Drawings of curves or patches are made with respect <br>
//! to a maximal chordal deviation. A Deviation coefficient <br>
//! is used in the shading display mode. The shape is <br>
//! seen decomposed into triangles. These are used to <br>
//! calculate reflection of light from the surface of the <br>
//! object. The triangles are formed from chords of the <br>
//! curves in the shape. The deviation coefficient <br>
//! aCoefficient gives the highest value of the angle with <br>
//! which a chord can deviate from a tangent to a curve. <br>
//! If this limit is reached, a new triangle is begun. <br>
//! This deviation is absolute and is set through the <br>
//! method: SetMaximalChordialDeviation. The default <br>
//! value is 0.001. <br>
//! In drawing shapes, however, you are allowed to ask <br>
//! for a relative deviation. This deviation will be: <br>
//! SizeOfObject * DeviationCoefficient. <br>
//! default 0.001 <br>
Standard_EXPORT void SetDeviationCoefficient(const Standard_Real aCoefficient) ;
//! Returns the deviation coefficient. <br>
//! Drawings of curves or patches are made with respect <br>
//! to a maximal chordal deviation. A Deviation coefficient <br>
//! is used in the shading display mode. The shape is <br>
//! seen decomposed into triangles. These are used to <br>
//! calculate reflection of light from the surface of the <br>
//! object. The triangles are formed from chords of the <br>
//! curves in the shape. The deviation coefficient gives <br>
//! the highest value of the angle with which a chord can <br>
//! deviate from a tangent to a curve. If this limit is <br>
//! reached, a new triangle is begun. <br>
//! This deviation is absolute and is set through <br>
//! AIS_Drawer::SetMaximalChordialDeviation. The <br>
//! default value is 0.001. <br>
//! In drawing shapes, however, you are allowed to ask <br>
//! for a relative deviation. This deviation will be: <br>
//! SizeOfObject * DeviationCoefficient. <br>
Standard_EXPORT Standard_Real DeviationCoefficient() const;
//! default 6degrees <br>
Standard_EXPORT void SetDeviationAngle(const Standard_Real anAngle) ;
Standard_EXPORT Standard_Real DeviationAngle() const;
//! Sets the deviation coefficient aCoefficient for <br>
//! removal of hidden lines created by different <br>
//! viewpoints in different presentations. The Default value is 0.02. <br>
Standard_EXPORT void SetHLRDeviationCoefficient(const Standard_Real aCoefficient) ;
//! Returns the real number value of the hidden line <br>
//! removal deviation coefficient. <br>
//! A Deviation coefficient is used in the shading display <br>
//! mode. The shape is seen decomposed into triangles. <br>
//! These are used to calculate reflection of light from the <br>
//! surface of the object. <br>
//! The triangles are formed from chords of the curves in <br>
//! the shape. The deviation coefficient give the highest <br>
//! value of the angle with which a chord can deviate <br>
//! from a tangent to a curve. If this limit is reached, a <br>
//! new triangle is begun. <br>
//! To find the hidden lines, hidden line display mode <br>
//! entails recalculation of the view at each different <br>
//! projector perspective. <br>
//! Because hidden lines entail calculations of more than <br>
//! usual complexity to decompose them into these <br>
//! triangles, a deviation coefficient allowing greater <br>
//! tolerance is used. This increases efficiency in calculation. <br>
//! The Default value is 0.02. <br>
Standard_EXPORT Standard_Real HLRDeviationCoefficient() const;
//! Sets the HLR angle anAngle. <br>
Standard_EXPORT void SetHLRAngle(const Standard_Real anAngle) ;
//! Returns the real number value of the deviation angle <br>
//! in hidden line removal views in this interactive context. <br>
//! The default value is 20*PI/180. <br>
Standard_EXPORT Standard_Real HLRAngle() const;
//! compute with anangle a HLRAngle and a HLRDeviationCoefficient <br>
//! and set them in myHLRAngle and in myHLRDeviationCoefficient <br>
//! of myDefaultDrawer ; <br>
//! anAngle is in radian ; ( 1 deg < angle in deg < 20 deg) <br>
Standard_EXPORT void SetHLRAngleAndDeviation(const Standard_Real anAngle) ;
//! Initializes hidden line aspect in the default drawing tool, or Drawer. <br>
//! The default values are: <br>
//! Color: Quantity_NOC_YELLOW <br>
//! Type of line: Aspect_TOL_DASH <br>
//! Width: 1. <br>
Standard_EXPORT Handle_Prs3d_LineAspect HiddenLineAspect() const;
//! Sets the hidden line aspect anAspect. <br>
//! anAspect defines display attributes for hidden lines in <br>
//! HLR projections. <br>
Standard_EXPORT void SetHiddenLineAspect(const Handle(Prs3d_LineAspect)& anAspect) const;
//! returns Standard_True if the hidden lines are to be drawn. <br>
//! By default the hidden lines are not drawn. <br>
Standard_EXPORT Standard_Boolean DrawHiddenLine() const;
Standard_EXPORT void EnableDrawHiddenLine() const;
Standard_EXPORT void DisableDrawHiddenLine() const;
//! Sets the number of U and V isoparameters displayed. <br>
Standard_EXPORT void SetIsoNumber(const Standard_Integer NbIsos,const AIS_TypeOfIso WhichIsos = AIS_TOI_Both) ;
//! Returns the number of U and V isoparameters displayed. <br>
Standard_EXPORT Standard_Integer IsoNumber(const AIS_TypeOfIso WhichIsos = AIS_TOI_Both) ;
//! Returns True if drawing isoparameters on planes is enabled. <br>
Standard_EXPORT void IsoOnPlane(const Standard_Boolean SwitchOn) ;
//! Returns True if drawing isoparameters on planes is enabled. <br>//! if <forUIsos> = False, <br>
Standard_EXPORT Standard_Boolean IsoOnPlane() const;
//! Sets the graphic basic aspect to the current presentation of <br>
//! ALL selected objects. <br>
//! When <globalChange> is TRUE , the full object presentation <br>
//! is changed. <br>
//! When <globalChange> is FALSE , only the current group <br>
//! of the object presentation is changed. <br>
//! Updates the viewer or collector when <updateViewer> is TRUE <br>
Standard_EXPORT void SetSelectedAspect(const Handle(Prs3d_BasicAspect)& anAspect,const Standard_Boolean globalChange = Standard_True,const Standard_Boolean updateViewer = Standard_True) ;
//! Relays mouse position in pixels XPix and YPix to the <br>
//! interactive context selectors. This is done by the view <br>
//! aView passing this position to the main viewer and updating it. <br>
//! Functions in both Neutral Point and local contexts. <br>
Standard_EXPORT AIS_StatusOfDetection MoveTo(const Standard_Integer XPix,const Standard_Integer YPix,const Handle(V3d_View)& aView) ;
//! returns True if other entities were detected in the <br>
//! last mouse detection <br>
Standard_EXPORT Standard_Boolean HasNextDetected() const;
//! if more than 1 object is detected by the selector, <br>
//! only the "best" owner is hilighted at the mouse position. <br>
//! This Method allows the user to hilight one after another <br>
//! the other detected entities. <br>
//! if The method select is called, the selected entity <br>
//! will be the hilighted one! <br>
//! returns the Rank of hilighted entity <br>
//! WARNING : Loop Method. When all the detected entities <br>
//! have been hilighted , the next call will hilight <br>
//! the first one again <br>
Standard_EXPORT Standard_Integer HilightNextDetected(const Handle(V3d_View)& aView) ;
//! Same as previous methods in reverse direction... <br>
Standard_EXPORT Standard_Integer HilightPreviousDetected(const Handle(V3d_View)& aView) ;
//! Selects everything found in the bounding rectangle <br>
//! defined by the pixel minima and maxima, XPMin, <br>
//! YPMin, XPMax, and YPMax in the view, aView <br>
//! The objects detected are passed to the main viewer, <br>
//! which is then updated. <br>
Standard_EXPORT AIS_StatusOfPick Select(const Standard_Integer XPMin,const Standard_Integer YPMin,const Standard_Integer XPMax,const Standard_Integer YPMax,const Handle(V3d_View)& aView,const Standard_Boolean updateviewer = Standard_True) ;
//! polyline selection; clears the previous picked list <br>
Standard_EXPORT AIS_StatusOfPick Select(const TColgp_Array1OfPnt2d& Polyline,const Handle(V3d_View)& aView,const Standard_Boolean updateviewer = Standard_True) ;
//! Stores and hilights the previous detected; Unhilights <br>
//! the previous picked. <br>
Standard_EXPORT AIS_StatusOfPick Select(const Standard_Boolean updateviewer = Standard_True) ;
//! adds the last detected to the list of previous picked. <br>
//! if the last detected was already declared as picked, <br>
//! removes it from the Picked List. <br>
Standard_EXPORT AIS_StatusOfPick ShiftSelect(const Standard_Boolean updateviewer = Standard_True) ;
//! adds the last detected to the list of previous picked. <br>
//! if the last detected was already declared as picked, <br>
//! removes it from the Picked List. <br>
Standard_EXPORT AIS_StatusOfPick ShiftSelect(const TColgp_Array1OfPnt2d& Polyline,const Handle(V3d_View)& aView,const Standard_Boolean updateviewer = Standard_True) ;
//! rectangle of selection ; adds new detected entities into the <br>
//! picked list, removes the detected entities that were already stored... <br>
Standard_EXPORT AIS_StatusOfPick ShiftSelect(const Standard_Integer XPMin,const Standard_Integer YPMin,const Standard_Integer XPMax,const Standard_Integer YPMax,const Handle(V3d_View)& aView,const Standard_Boolean updateviewer = Standard_True) ;
//! Specify whether selected object must be hilighted when mouse cursor <br>
//! is moved above it (in MoveTo method). By default this value is false and <br>
//! selected object is not hilighted in this case. <br>
void SetToHilightSelected(const Standard_Boolean toHilight) ;
//! Return value specified whether selected object must be hilighted <br>
//! when mouse cursor is moved above it <br>
Standard_Boolean ToHilightSelected() const;
//! Updates the view of the current object in open context. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetCurrentObject(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Allows you to add a current object to the list of current <br>
//! objects or remove it from that list. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void AddOrRemoveCurrentObject(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Updates the list of current objects, i.e. hilights new <br>
//! current objects, removes hilighting from former current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! <br>
Standard_EXPORT void UpdateCurrent() ;
//! Returns the current selection touched by the cursor. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_Boolean WasCurrentTouched() const;
void SetOkCurrent() ;
//! Returns true if there is a non-null interactive object in Neutral Point. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Standard_Boolean IsCurrent(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Initializes a scan of the current selected objects in <br>
//! Neutral Point. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT void InitCurrent() ;
//! Returns true if there is another object found by the <br>
//! scan of the list of current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Standard_Boolean MoreCurrent() const;
//! Continues the scan to the next object in the list of <br>
//! current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT void NextCurrent() ;
//! Returns the current interactive object. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Handle_AIS_InteractiveObject Current() const;
Standard_EXPORT Standard_Integer NbCurrents() ;
//! Returns the first current object in the list of current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Handle_AIS_InteractiveObject FirstCurrentObject() ;
//! Highlights current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void HilightCurrents(const Standard_Boolean updateviewer = Standard_True) ;
//! Removes highlighting from current objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnhilightCurrents(const Standard_Boolean updateviewer = Standard_True) ;
//! Empties previous current objects in order to get the <br>
//! current objects detected by the selector using <br>
//! UpdateCurrent. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void ClearCurrents(const Standard_Boolean updateviewer = Standard_True) ;
//! Puts the interactive object aniObj in the list of <br>
//! selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetSelected(const Handle(AIS_InteractiveObject)& aniObj,const Standard_Boolean updateviewer = Standard_True) ;
//! puts the selected list in the current objects List. <br>
Standard_EXPORT void SetSelectedCurrent() ;
//! updates the list of selected objects <br>
//! i.e. hilights the new selected <br>
//! unhilights old selected objects <br>
Standard_EXPORT void UpdateSelected(const Standard_Boolean updateviewer = Standard_True) ;
//!Allows you to add a selected object to the list of <br>
//! selected objects or remove it from that list. This entity <br>
//! can be an Interactive Object aniobj or its owner <br>
//! aShape as can be seen in the two syntaxes above. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void AddOrRemoveSelected(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Highlights selected objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void HilightSelected(const Standard_Boolean updateviewer = Standard_True) ;
//! Removes highlighting from selected objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void UnhilightSelected(const Standard_Boolean updateviewer = Standard_True) ;
//! Empties previous selected objects in order to get the <br>
//! selected objects detected by the selector using <br>
//! UpdateSelected. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void ClearSelected(const Standard_Boolean updateviewer = Standard_True) ;
//! No right to Add a selected Shape (Internal Management <br>
//! of shape Selection). <br>
//! A Previous selected shape may only be removed. <br>
Standard_EXPORT void AddOrRemoveSelected(const TopoDS_Shape& aShape,const Standard_Boolean updateviewer = Standard_True) ;
//! allows to add/remove in the selected list the entities <br>
//! represented by <anOwner> in the selection process. <br>
Standard_EXPORT void AddOrRemoveSelected(const Handle(SelectMgr_EntityOwner)& anOwner,const Standard_Boolean updateviewer = Standard_True) ;
//! Finds the selected object aniobj in local context and <br>
//! returns its name. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Standard_Boolean IsSelected(const Handle(AIS_InteractiveObject)& aniobj) const;
//! Initializes a scan of the selected objects in local context. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT void InitSelected() ;
//! Returns true if there is another object found by the <br>
//! scan of the list of selected objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT Standard_Boolean MoreSelected() const;
//! Continues the scan to the next object in the list of <br>
//! selected objects. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT void NextSelected() ;
Standard_EXPORT Standard_Integer NbSelected() ;
//! Returns true if the interactive context has a shape <br>
//! selected in it which results from the decomposition of <br>
//! another entity in local context. <br>
//! If HasSelectedShape returns true, SelectedShape <br>
//! returns the shape which has been shown to be <br>
//! selected. Interactive returns the Interactive Object <br>
//! from which the shape has been selected. <br>
//! If HasSelectedShape returns false, Interactive <br>
//! returns the interactive entity selected by the click of the mouse. <br>
Standard_EXPORT Standard_Boolean HasSelectedShape() const;
//! Returns the selected shape in the open local context. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT TopoDS_Shape SelectedShape() const;
//! Returns the owner of the selected entity resulting <br>
//! from the decomposition of another entity in local context. <br>
Standard_EXPORT Handle_SelectMgr_EntityOwner SelectedOwner() const;
//! Returns a collection containing all entity owners <br>
//! created for the interactive object <theIObj> in <br>
//! the selection mode theMode (in all active modes <br>
//! if the Mode == -1) <br>
Standard_EXPORT void EntityOwners(SelectMgr_IndexedMapOfOwner& theOwners,const Handle(AIS_InteractiveObject)& theIObj,const Standard_Integer theMode = -1) const;
//! Returns the location of the selected Interactive Object. <br>
Standard_EXPORT Handle_AIS_InteractiveObject Interactive() const;
Standard_EXPORT Handle_AIS_InteractiveObject SelectedInteractive() const;
//! Returns true if the applicative object has an owner <br>
//! from Interactive attributed to it. <br>
Standard_EXPORT Standard_Boolean HasApplicative() const;
//! Returns the owner of the applicative entity detected <br>
//! in interactive context. The owner can be a shape for <br>
//! a set of sub-shapes or a sub-shape for sub-shapes <br>
//! which it is composed of. <br>
Standard_EXPORT Handle_Standard_Transient Applicative() const;
//! Returns true if there is a mouse-detected entity in local context. <br>
//! If there is no open local context, the objects selected <br>
//! are called current objects; selected objects if there is <br>
//! one. Iterators allow entities to be recovered in either <br>
//! case. This method is one of a set which allows you to <br>
//! manipulate the objects which have been placed in these two lists. <br>
Standard_EXPORT Standard_Boolean HasDetected() const;
//! Returns true if there is a detected shape in local context. <br>
//! If there is no open local context, the objects selected <br>
//! are called current objects; selected objects if there is <br>
//! one. Iterators allow entities to be recovered in either <br>
//! case. This method is one of a set which allows you to <br>
//! manipulate the objects which have been placed in these two lists. <br>
Standard_EXPORT Standard_Boolean HasDetectedShape() const;
//! Returns the shape detected in local context. <br>
//! If there is no open local context, the objects selected <br>
//! are called current objects; selected objects if there is <br>
//! one. Iterators allow entities to be recovered in either <br>
//! case. This method is one of a set which allows you to <br>
//! manipulate the objects which have been placed in these two lists. <br>
Standard_EXPORT const TopoDS_Shape& DetectedShape() const;
//! Returns the interactive objects last detected in open context. <br>
//! If there is no open local context, the objects selected <br>
//! are called current objects; selected objects if there is <br>
//! one. Iterators allow entities to be recovered in either <br>
//! case. This method is one of a set which allows you to <br>
//! manipulate the objects which have been placed in these two lists. <br>
Standard_EXPORT Handle_AIS_InteractiveObject DetectedInteractive() const;
//! returns the owner of the detected sensitive primitive. <br>
Standard_EXPORT Handle_SelectMgr_EntityOwner DetectedOwner() const;
Standard_EXPORT void InitDetected() ;
Standard_EXPORT Standard_Boolean MoreDetected() const;
Standard_EXPORT void NextDetected() ;
Standard_EXPORT const TopoDS_Shape& DetectedCurrentShape() const;
Standard_EXPORT Handle_AIS_InteractiveObject DetectedCurrentObject() const;
//! Opens local contexts and specifies how this is to be <br>
//! done. The options listed above function in the following manner: <br>
//! - UseDisplayedObjects -allows you to load or not <br>
//! load the interactive objects visualized at Neutral <br>
//! Point in the local context which you open. If false, <br>
//! the local context is empty after being opened. If <br>
//! true, the objects at Neutral Point are loaded by their <br>
//! default selection mode. <br>
//! - AllowShapeDecomposition -AIS_Shape allows or <br>
//! prevents decomposition in standard shape location <br>
//! mode of objects at Neutral Point which are <br>
//! type-"privileged". This Flag is only taken into <br>
//! account when UseDisplayedObjects is true. <br>
//! - AcceptEraseOfObjects -authorises other local <br>
//! contexts to erase the interactive objects present in <br>
//! this context. This option is rarely used. <br>
//! - BothViewers - Has no use currently defined. <br>
//! This method returns the index of the created local <br>
//! context. It should be kept and used to close the context. <br>
//! Opening a local context allows you to prepare an <br>
//! environment for temporary presentations and <br>
//! selections which will disappear once the local context is closed. <br>
//! You can open several local contexts, but only the last <br>
//! one will be active. <br>
Standard_EXPORT Standard_Integer OpenLocalContext(const Standard_Boolean UseDisplayedObjects = Standard_True,const Standard_Boolean AllowShapeDecomposition = Standard_True,const Standard_Boolean AcceptEraseOfObjects = Standard_False,const Standard_Boolean BothViewers = Standard_False) ;
//! Allows you to close local contexts. For greater <br>
//! security, you should close the context with the <br>
//! index Index given on opening. <br>
//! When you close a local context, the one before, <br>
//! which is still on the stack, reactivates. If none is <br>
//! left, you return to Neutral Point. <br>
//! If a local context is open and if updateviewer <br>
//! equals Standard_False, the presentation of the <br>
//! Interactive Object activates the selection mode; the <br>
//! object is displayed but no viewer will be updated. <br>
//! Warning <br>
//! When the index isn't specified, the current context <br>
//! is closed. This option can be dangerous, as other <br>
//! Interactive Functions can open local contexts <br>
//! without necessarily warning the user. <br>
Standard_EXPORT void CloseLocalContext(const Standard_Integer Index = -1,const Standard_Boolean updateviewer = Standard_True) ;
//! returns -1 if no opened local context. <br>
Standard_EXPORT Standard_Integer IndexOfCurrentLocal() const;
//! Allows you to close all local contexts at one go and <br>
//! return to Neutral Point. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void CloseAllContexts(const Standard_Boolean updateviewer = Standard_True) ;
//! to be used only with no opened <br>
//! local context.. displays and activates objects in their <br>
//! original state before local contexts were opened... <br>
Standard_EXPORT void ResetOriginalState(const Standard_Boolean updateviewer = Standard_True) ;
//! clears Objects/Filters/Activated Modes list in the current opened <br>
//! local context. <br>
Standard_EXPORT void ClearLocalContext(const AIS_ClearMode TheMode = AIS_CM_All) ;
Standard_EXPORT void UseDisplayedObjects() ;
//! when a local Context is opened, one is able to <br>
//! use/not use the displayed objects at neutral point <br>
//! at anytime. <br>
Standard_EXPORT void NotUseDisplayedObjects() ;
//! initializes the list of presentations to be displayed <br>
//! returns False if No Local COnte <br>
Standard_EXPORT Standard_Boolean BeginImmediateDraw() ;
//! returns True if <anIObj> has been stored in the list. <br>
Standard_EXPORT Standard_Boolean ImmediateAdd(const Handle(AIS_InteractiveObject)& anIObj,const Standard_Integer aMode = 0) ;
//! returns True if <anIObj> has been removed from the list. <br>
Standard_EXPORT Standard_Boolean ImmediateRemove(const Handle(AIS_InteractiveObject)& anIObj,const Standard_Integer aMode = 0) ;
//! returns True if the immediate display has been done. <br>
Standard_EXPORT Standard_Boolean EndImmediateDraw(const Handle(V3d_View)& aView,const Standard_Boolean DoubleBuf = Standard_False) ;
//! Uses the First Active View of Main Viewer!!! <br>
//! returns True if the immediate display has been done. <br>
Standard_EXPORT Standard_Boolean EndImmediateDraw(const Standard_Boolean DoubleBuf = Standard_False) ;
Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
//! Transforms the current presentation of the object <anObject> <br>
//! using the transient graphic space of the view <aView> in <br>
//! immediat mode graphics. <br>
Standard_EXPORT void Drag(const Handle(V3d_View)& aView,const Handle(AIS_InteractiveObject)& anObject,const Handle(Geom_Transformation)& aTranformation,const Standard_Boolean postConcatenate = Standard_False,const Standard_Boolean update = Standard_False,const Standard_Boolean zBuffer = Standard_False) ;
//! Sets the highlighting status aStatus of detected and <br>
//! selected entities. <br>
//! Whether you are in Neutral Point or local context, this <br>
//! is automatically managed by the Interactive Context. <br>
//! This function allows you to disconnect the automatic mode. <br>
Standard_EXPORT void SetAutomaticHilight(const Standard_Boolean aStatus) ;
//! Returns true if the automatic highlight mode is active <br>
//! in an open context. <br>
Standard_EXPORT Standard_Boolean AutomaticHilight() const;
//! Enables/Disables the Z detection. <br>
//! If TRUE the detection echo can be partially hidden by the <br>
//! detected object. <br>
Standard_EXPORT void SetZDetection(const Standard_Boolean aStatus = Standard_False) ;
//! Retrieves the Z detection state. <br>
Standard_EXPORT Standard_Boolean ZDetection() const;
//! Activates the selection mode aMode whose index is <br>
//! given, for the given interactive entity anIobj. <br>
Standard_EXPORT void Activate(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Integer aMode = 0) ;
//! Deactivates all the activated selection modes <br>
//! of an object. <br>
Standard_EXPORT void Deactivate(const Handle(AIS_InteractiveObject)& anIObj) ;
//! Deactivates all the activated selection modes of the <br>
//! interactive object anIobj with a given selection mode aMode. <br>
Standard_EXPORT void Deactivate(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Integer aMode) ;
//! Returns the list of activated selection modes in an open context. <br>
Standard_EXPORT void ActivatedModes(const Handle(AIS_InteractiveObject)& anIobj,TColStd_ListOfInteger& theList) const;
//! to be Used only with opened local context and <br>
//! if <anIobj> is of type shape... <br>
//! if <aStatus> = True <anIobj> will be sensitive to <br>
//! shape selection modes activation. <br>
//! = False, <anIobj> will not be senstive <br>
//! any more. <br>
//! <br>
Standard_EXPORT void SetShapeDecomposition(const Handle(AIS_InteractiveObject)& anIobj,const Standard_Boolean aStatus) ;
//! Sets the temporary graphic attributes of the entity <br>
//! anObj. These are provided by the attribute manager <br>
//! aDrawer and are valid for a particular local context only. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SetTemporaryAttributes(const Handle(AIS_InteractiveObject)& anObj,const Handle(Prs3d_Drawer)& aDrawer,const Standard_Boolean updateviewer = Standard_True) ;
//! Highlights, and removes highlights from, the displayed <br>
//! object aniobj which is displayed at Neutral Point with <br>
//! subintensity color; available only for active local <br>
//! context. There is no effect if there is no local context. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SubIntensityOn(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! Removes the subintensity option for the entity aniobj. <br>
//! If a local context is open and if updateviewer equals <br>
//! Standard_False, the presentation of the Interactive <br>
//! Object activates the selection mode; the object is <br>
//! displayed but no viewer will be updated. <br>
Standard_EXPORT void SubIntensityOff(const Handle(AIS_InteractiveObject)& aniobj,const Standard_Boolean updateviewer = Standard_True) ;
//! hilights/unhilights displayed objects which are displayed at <br>
//! neutral state with subintensity color; <br>
//! available only for active local context. <br>
//! No effect if no local context. <br>
Standard_EXPORT void SubIntensityOn(const Standard_Boolean updateviewer = Standard_True) ;
//! removes subintensity option for all objects. <br>
Standard_EXPORT void SubIntensityOff(const Standard_Boolean updateviewer = Standard_True) ;
//! Allows you to add the filter aFilter to Neutral Point or <br>
//! to a local context if one or more selection modes have been activated. <br>
//! Only type filters may be active in Neutral Point. <br>
Standard_EXPORT void AddFilter(const Handle(SelectMgr_Filter)& aFilter) ;
//! Removes a filter from Neutral Point or a local context <br>
//! if one or more selection modes have been activated. <br>
//! Only type filters are activated in Neutral Point. <br>
Standard_EXPORT void RemoveFilter(const Handle(SelectMgr_Filter)& aFilter) ;
//! Remove a filter to Neutral Point or a local context if <br>
//! one or more selection modes have been activated. <br>
//! Only type filters are active in Neutral Point. <br>
Standard_EXPORT void RemoveFilters() ;
//! Provides an alternative to the Display methods when <br>
//! activating specific selection modes. This has the <br>
//! effect of activating the corresponding selection mode <br>
//! aStandardActivation for all objects in Local Context <br>
//! which accept decomposition into sub-shapes. <br>
//! Every new Object which has been loaded into the <br>
//! interactive context and which answers these <br>
//! decomposition criteria is automatically activated <br>
//! according to these modes. <br>
//! Warning <br>
//! If you have opened a local context by loading an <br>
//! object with the default options <br>
//! (<AllowShapeDecomposition >= Standard_True), all <br>
//! objects of the "Shape" type are also activated with <br>
//! the same modes. You can act on the state of these <br>
//! "Standard" objects by using SetShapeDecomposition(Status). <br>
Standard_EXPORT void ActivateStandardMode(const TopAbs_ShapeEnum aStandardActivation) ;
//! Provides an alternative to the Display methods when <br>
//! deactivating specific selection modes. This has the <br>
//! effect of deactivating the corresponding selection <br>
//! mode aStandardActivation for all objects in Local <br>
//! Context which accept decomposition into sub-shapes. <br>
Standard_EXPORT void DeactivateStandardMode(const TopAbs_ShapeEnum aStandardActivation) ;
//! Returns the list of activated standard selection modes <br>
//! available in a local context. <br>
Standard_EXPORT const TColStd_ListOfInteger& ActivatedStandardModes() const;
//! Returns the list of filters active in a local context. <br>
Standard_EXPORT const SelectMgr_ListOfFilter& Filters() const;
//! Returns the default attribute manager. <br>
//! This contains all the color and line attributes which <br>
//! can be used by interactive objects which do not have <br>
//! their own attributes. <br>
const Handle_Prs3d_Drawer& DefaultDrawer() const;
//! Returns the current viewer. <br>
const Handle_V3d_Viewer& CurrentViewer() const;
//! Returns the list of displayed objects of a particular <br>
//! Type WhichKind and Signature WhichSignature. By <br>
//! Default, WhichSignature equals -1. This means that <br>
//! there is a check on type only. <br>
Standard_EXPORT void DisplayedObjects(AIS_ListOfInteractive& aListOfIO,const Standard_Boolean OnlyFromNeutral = Standard_False) const;
//! gives the list of displayed objects of a particular <br>
//! Type and signature. <br>
//! by Default, <WhichSignature> = -1 means <br>
//! control only on <WhichKind>. <br>
Standard_EXPORT void DisplayedObjects(const AIS_KindOfInteractive WhichKind,const Standard_Integer WhichSignature,AIS_ListOfInteractive& aListOfIO,const Standard_Boolean OnlyFromNeutral = Standard_False) const;
const Handle_V3d_Viewer& Collector() const;
//! Returns the list aListOfIO of erased objects of a <br>
//! particular Type WhichKind and Signature WhichSignature. <br>
//! By Default, WhichSignature equals 1. This means <br>
//! that there is a check on type only. <br>
Standard_EXPORT void ObjectsInCollector(AIS_ListOfInteractive& aListOfIO) const;
//! gives the list of erased objects of a particular <br>
//! Type and signature <br>
//! by Default, <WhichSignature> = -1 means <br>
//! control only on <WhichKind>. <br>
Standard_EXPORT void ObjectsInCollector(const AIS_KindOfInteractive WhichKind,const Standard_Integer WhichSignature,AIS_ListOfInteractive& aListOfIO) const;
//! Returns the list theListOfIO of erased objects (but not placed into collecter) <br>
//! particular Type WhichKind and Signature WhichSignature. <br>
//! By Default, WhichSignature equals 1. This means <br>
//! that there is a check on type only. <br>
Standard_EXPORT void ErasedObjects(AIS_ListOfInteractive& theListOfIO) const;
//! gives the list of erased objects (but not placed into collecter) <br>
//! Type and signature <br>
//! by Default, <WhichSignature> = -1 means <br>
//! control only on <WhichKind>. <br>
Standard_EXPORT void ErasedObjects(const AIS_KindOfInteractive WhichKind,const Standard_Integer WhichSignature,AIS_ListOfInteractive& theListOfIO) const;
//! Returns the list theListOfIO of objects with indicated display status <br>
//! particular Type WhichKind and Signature WhichSignature. <br>
//! By Default, WhichSignature equals 1. This means <br>
//! that there is a check on type only. <br>
Standard_EXPORT void ObjectsByDisplayStatus(const AIS_DisplayStatus theStatus,AIS_ListOfInteractive& theListOfIO) const;
//! gives the list of objects with indicated display status <br>
//! Type and signature <br>
//! by Default, <WhichSignature> = -1 means <br>
//! control only on <WhichKind>. <br>
Standard_EXPORT void ObjectsByDisplayStatus(const AIS_KindOfInteractive WhichKind,const Standard_Integer WhichSignature,const AIS_DisplayStatus theStatus,AIS_ListOfInteractive& theListOfIO) const;
//! fills <aListOfIO> with objects of a particular <br>
//! Type and Signature with no consideration of display status. <br>
//! by Default, <WhichSignature> = -1 means <br>
//! control only on <WhichKind>. <br>
//! if <WhichKind> = AIS_KOI_None and <WhichSignature> = -1, <br>
//! all the objects are put into the list. <br>
Standard_EXPORT void ObjectsInside(AIS_ListOfInteractive& aListOfIO,const AIS_KindOfInteractive WhichKind = AIS_KOI_None,const Standard_Integer WhichSignature = -1) const;
//! Returns true if there is an open context. <br>
Standard_Boolean HasOpenedContext() const;
//! Returns the name of the current selected entity in Neutral Point. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
const TCollection_AsciiString& CurrentName() const;
//! Returns the name of the current selected entity in <br>
//! open local context. <br>
//! Objects selected when there is no open local context <br>
//! are called current objects; those selected in open <br>
//! local context, selected objects. <br>
Standard_EXPORT const TCollection_AsciiString& SelectionName() const;
//! Returns the domain name of the main viewer. <br>
Standard_EXPORT Standard_CString DomainOfMainViewer() const;
//! Returns the domain name of the Collector viewer. <br>
Standard_EXPORT Standard_CString DomainOfCollector() const;
const Handle_SelectMgr_SelectionManager& SelectionManager() const;
const Handle_PrsMgr_PresentationManager3d& MainPrsMgr() const;
const Handle_PrsMgr_PresentationManager3d& CollectorPrsMgr() const;
const Handle_StdSelect_ViewerSelector3d& MainSelector() const;
Standard_EXPORT Handle_StdSelect_ViewerSelector3d LocalSelector() const;
const Handle_StdSelect_ViewerSelector3d& CollectorSelector() const;
//! Clears all the structures which don't <br>
//! belong to objects displayed at neutral point <br>
//! only effective when no Local Context is opened... <br>
//! returns the number of removed structures from the viewers. <br>
Standard_EXPORT Standard_Integer PurgeDisplay(const Standard_Boolean CollectorToo = Standard_False) ;
Standard_EXPORT Standard_Integer HighestIndex() const;
Standard_EXPORT void DisplayActiveAreas(const Handle(V3d_View)& aView) ;
Standard_EXPORT void ClearActiveAreas(const Handle(V3d_View)& aView) ;
Standard_EXPORT void DisplayActiveSensitive(const Handle(V3d_View)& aView) ;
Standard_EXPORT void ClearActiveSensitive(const Handle(V3d_View)& aView) ;
Standard_EXPORT void DisplayActiveSensitive(const Handle(AIS_InteractiveObject)& anObject,const Handle(V3d_View)& aView) ;
Standard_EXPORT void DisplayActiveAreas(const Handle(AIS_InteractiveObject)& anObject,const Handle(V3d_View)& aView) ;
//! returns if possible, <br>
//! the first local context where the object is seen <br>
Standard_EXPORT Standard_Boolean IsInLocal(const Handle(AIS_InteractiveObject)& anObject,Standard_Integer& TheIndex) const;
friend class AIS_LocalContext;
DEFINE_STANDARD_RTTI(AIS_InteractiveContext)
protected:
private:
Standard_EXPORT void GetDefModes(const Handle(AIS_InteractiveObject)& anIobj,Standard_Integer& Dmode,Standard_Integer& HiMod,Standard_Integer& SelMode) const;
Standard_EXPORT void EraseGlobal(const Handle(AIS_InteractiveObject)& anObj,const Standard_Boolean updateviewer = Standard_True,const Standard_Boolean PutInCollector = Standard_False) ;
Standard_EXPORT void ClearGlobal(const Handle(AIS_InteractiveObject)& anObj,const Standard_Boolean updateviewer = Standard_True) ;
Standard_EXPORT void ClearGlobalPrs(const Handle(AIS_InteractiveObject)& anObj,const Standard_Integer aMode,const Standard_Boolean updateviewer = Standard_True) ;
Standard_EXPORT void InitAttributes() ;
Standard_EXPORT Standard_Integer PurgeViewer(const Handle(V3d_Viewer)& Vwr) ;
AIS_DataMapOfIOStatus myObjects;
Handle_SelectMgr_SelectionManager mgrSelector;
Handle_PrsMgr_PresentationManager3d myMainPM;
Handle_V3d_Viewer myMainVwr;
Handle_StdSelect_ViewerSelector3d myMainSel;
Handle_PrsMgr_PresentationManager3d myCollectorPM;
Handle_V3d_Viewer myCollectorVwr;
Handle_StdSelect_ViewerSelector3d myCollectorSel;
Standard_Boolean myIsCollClosed;
TCollection_AsciiString mySelectionName;
TCollection_AsciiString myCurrentName;
Handle_AIS_InteractiveObject myLastPicked;
Handle_AIS_InteractiveObject myLastinMain;
Handle_AIS_InteractiveObject myLastinColl;
Standard_Boolean myWasLastMain;
Standard_Boolean myCurrentTouched;
Standard_Boolean mySelectedTouched;
Standard_Boolean myToHilightSelected;
Handle_SelectMgr_OrFilter myFilters;
Handle_Prs3d_Drawer myDefaultDrawer;
Quantity_NameOfColor myDefaultColor;
Quantity_NameOfColor myHilightColor;
Quantity_NameOfColor mySelectionColor;
Quantity_NameOfColor myPreselectionColor;
Quantity_NameOfColor mySubIntensity;
Standard_Integer myDisplayMode;
AIS_DataMapOfILC myLocalContexts;
Standard_Integer myCurLocalIndex;
Handle_V3d_View mylastmoveview;
AIS_SequenceOfInteractive myAISDetectedSeq;
Standard_Integer myAISCurDetected;
Standard_Boolean myZDetectionFlag;
Standard_Boolean myIsAutoActivateSelMode;
};
#include <AIS_InteractiveContext.lxx>
// other Inline functions and methods (like "C++: function call" methods)
#endif
|