Open CASCADE Technology
6.5.4
|
A framework to reject or to accept only objects of
given types and/or signatures.
Objects are stored, and the stored objects - along
with the flag settings - are used to define the filter.
Objects to be filtered are compared with the stored
objects added to the filter, and are accepted or
rejected according to the exclusion flag setting.
More...
#include <AIS_ExclusionFilter.hxx>
Public Member Functions | |
AIS_ExclusionFilter (const Standard_Boolean ExclusionFlagOn=Standard_True) | |
Constructs an empty exclusion filter object defined by the flag setting ExclusionFlagOn. By default, the flag is set to true. | |
AIS_ExclusionFilter (const AIS_KindOfInteractive TypeToExclude, const Standard_Boolean ExclusionFlagOn=Standard_True) | |
All the AIS objects of <TypeToExclude> Will be rejected by the IsOk Method. | |
AIS_ExclusionFilter (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType, const Standard_Boolean ExclusionFlagOn=Standard_True) | |
Constructs an exclusion filter object defined by the enumeration value TypeToExclude, the signature SignatureInType, and the flag setting ExclusionFlagOn. By default, the flag is set to true. | |
virtual Standard_Boolean | IsOk (const Handle< SelectMgr_EntityOwner > &anObj) const |
Indicates that the selected Interactive Object passes the filter. The owner, anObj, can be either direct or user. A direct owner is the corresponding construction element, whereas a user is the compound shape of which the entity forms a part. When an object is detected by the mouse - in AIS, this is done through a context selector - its owner is passed to the filter as an argument. If the object returns Standard_True, it is kept; if not, it is rejected. If you are creating a filter class inheriting this framework, and the daughter class is to be used in an AIS local context, you will need to implement the virtual function ActsOn. | |
Standard_Boolean | Add (const AIS_KindOfInteractive TypeToExclude) |
Adds the type TypeToExclude to the list of types. | |
Standard_Boolean | Add (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType) |
Standard_Boolean | Remove (const AIS_KindOfInteractive TypeToExclude) |
Standard_Boolean | Remove (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType) |
void | Clear () |
Standard_Boolean | IsExclusionFlagOn () const |
void | SetExclusionFlag (const Standard_Boolean Status) |
Standard_Boolean | IsStored (const AIS_KindOfInteractive aType) const |
void | ListOfStoredTypes (TColStd_ListOfInteger &TheList) const |
void | ListOfSignature (const AIS_KindOfInteractive aType, TColStd_ListOfInteger &TheStoredList) const |
AIS_ExclusionFilter::AIS_ExclusionFilter | ( | const Standard_Boolean | ExclusionFlagOn = Standard_True | ) |
AIS_ExclusionFilter::AIS_ExclusionFilter | ( | const AIS_KindOfInteractive | TypeToExclude, |
const Standard_Boolean | ExclusionFlagOn = Standard_True |
||
) |
AIS_ExclusionFilter::AIS_ExclusionFilter | ( | const AIS_KindOfInteractive | TypeToExclude, |
const Standard_Integer | SignatureInType, | ||
const Standard_Boolean | ExclusionFlagOn = Standard_True |
||
) |
Standard_Boolean AIS_ExclusionFilter::Add | ( | const AIS_KindOfInteractive | TypeToExclude | ) |
Standard_Boolean AIS_ExclusionFilter::Add | ( | const AIS_KindOfInteractive | TypeToExclude, |
const Standard_Integer | SignatureInType | ||
) |
virtual Standard_Boolean AIS_ExclusionFilter::IsOk | ( | const Handle< SelectMgr_EntityOwner > & | anObj | ) | const [virtual] |
Implements SelectMgr_Filter.
Standard_Boolean AIS_ExclusionFilter::IsStored | ( | const AIS_KindOfInteractive | aType | ) | const |
void AIS_ExclusionFilter::ListOfSignature | ( | const AIS_KindOfInteractive | aType, |
TColStd_ListOfInteger & | TheStoredList | ||
) | const |
void AIS_ExclusionFilter::ListOfStoredTypes | ( | TColStd_ListOfInteger & | TheList | ) | const |
Standard_Boolean AIS_ExclusionFilter::Remove | ( | const AIS_KindOfInteractive | TypeToExclude | ) |
Standard_Boolean AIS_ExclusionFilter::Remove | ( | const AIS_KindOfInteractive | TypeToExclude, |
const Standard_Integer | SignatureInType | ||
) |