summaryrefslogtreecommitdiff
path: root/inc/AIS_ExclusionFilter.hxx
blob: 79d078b32a5ccbfe66af94c53094e654a58b43fb (plain)
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
// 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_ExclusionFilter_HeaderFile
#define _AIS_ExclusionFilter_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_AIS_ExclusionFilter_HeaderFile
#include <Handle_AIS_ExclusionFilter.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TColStd_DataMapOfIntegerListOfInteger_HeaderFile
#include <TColStd_DataMapOfIntegerListOfInteger.hxx>
#endif
#ifndef _SelectMgr_Filter_HeaderFile
#include <SelectMgr_Filter.hxx>
#endif
#ifndef _AIS_KindOfInteractive_HeaderFile
#include <AIS_KindOfInteractive.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_SelectMgr_EntityOwner_HeaderFile
#include <Handle_SelectMgr_EntityOwner.hxx>
#endif
class SelectMgr_EntityOwner;
class TColStd_ListOfInteger;


//!  A framework to reject or to accept only objects of <br>
//! given types and/or signatures. <br>
//! Objects are stored, and the stored objects - along <br>
//! with the flag settings - are used to define the filter. <br>
//! Objects to be filtered are compared with the stored <br>
//! objects added to the filter, and are accepted or <br>
//! rejected according to the exclusion flag setting. <br>
//! -   Exclusion flag on <br>
//!   -   the function IsOk answers true for all objects, <br>
//!    except those of the types and signatures stored <br>
//!    in the filter framework <br>
//! -   Exclusion flag off <br>
//!   -   the funciton IsOk answers true for all objects <br>
//!    which have the same type and signature as the stored ones. <br>
class AIS_ExclusionFilter : public SelectMgr_Filter {

public:

  //! Constructs an empty exclusion filter object defined by <br>
//! the flag setting ExclusionFlagOn. <br>
//! By default, the flag is set to true. <br>
  Standard_EXPORT   AIS_ExclusionFilter(const Standard_Boolean ExclusionFlagOn = Standard_True);
  //! All the AIS objects of <TypeToExclude> <br>
//!          Will be rejected by the IsOk Method. <br>
  Standard_EXPORT   AIS_ExclusionFilter(const AIS_KindOfInteractive TypeToExclude,const Standard_Boolean ExclusionFlagOn = Standard_True);
  //! Constructs an exclusion filter object defined by the <br>
//! enumeration value TypeToExclude, the signature <br>
//! SignatureInType, and the flag setting ExclusionFlagOn. <br>
//! By default, the flag is set to true. <br>
  Standard_EXPORT   AIS_ExclusionFilter(const AIS_KindOfInteractive TypeToExclude,const Standard_Integer SignatureInType,const Standard_Boolean ExclusionFlagOn = Standard_True);
  
  Standard_EXPORT   virtual  Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& anObj) const;
  //! Adds the type TypeToExclude to the list of types. <br>
  Standard_EXPORT     Standard_Boolean Add(const AIS_KindOfInteractive TypeToExclude) ;
  
  Standard_EXPORT     Standard_Boolean Add(const AIS_KindOfInteractive TypeToExclude,const Standard_Integer SignatureInType) ;
  
  Standard_EXPORT     Standard_Boolean Remove(const AIS_KindOfInteractive TypeToExclude) ;
  
  Standard_EXPORT     Standard_Boolean Remove(const AIS_KindOfInteractive TypeToExclude,const Standard_Integer SignatureInType) ;
  
  Standard_EXPORT     void Clear() ;
  
        Standard_Boolean IsExclusionFlagOn() const;
  
        void SetExclusionFlag(const Standard_Boolean Status) ;
  
  Standard_EXPORT     Standard_Boolean IsStored(const AIS_KindOfInteractive aType) const;
  
  Standard_EXPORT     void ListOfStoredTypes(TColStd_ListOfInteger& TheList) const;
  
  Standard_EXPORT     void ListOfSignature(const AIS_KindOfInteractive aType,TColStd_ListOfInteger& TheStoredList) const;




  DEFINE_STANDARD_RTTI(AIS_ExclusionFilter)

protected:




private: 

  
  Standard_EXPORT     Standard_Boolean IsSignatureIn(const AIS_KindOfInteractive aType,const Standard_Integer aSignature) const;

Standard_Boolean myIsExclusionFlagOn;
TColStd_DataMapOfIntegerListOfInteger myStoredTypes;


};


#include <AIS_ExclusionFilter.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif