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...
|
| | 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 override |
| | 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 theStatus) |
| |
| Standard_Boolean | IsStored (const AIS_KindOfInteractive aType) const |
| |
| void | ListOfStoredTypes (TColStd_ListOfInteger &TheList) const |
| |
| void | ListOfSignature (const AIS_KindOfInteractive aType, TColStd_ListOfInteger &TheStoredList) const |
| |
| virtual Standard_Boolean | ActsOn (const TopAbs_ShapeEnum aStandardMode) const |
| | Returns true in an AIS local context, if this filter operates on a type of subshape defined in a filter class inheriting this framework. This function completes IsOk in an AIS local context.
|
| |
 Public Member Functions inherited from Standard_Transient |
| | Standard_Transient () |
| | Empty constructor.
|
| |
| | Standard_Transient (const Standard_Transient &) |
| | Copy constructor – does nothing.
|
| |
| Standard_Transient & | operator= (const Standard_Transient &) |
| | Assignment operator, needed to avoid copying reference counter.
|
| |
| virtual | ~Standard_Transient () |
| | Destructor must be virtual.
|
| |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| | Returns a type descriptor about this object.
|
| |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| | Returns a true value if this is an instance of Type.
|
| |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| | Returns a true value if this is an instance of TypeName.
|
| |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| | Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| | Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| |
| Standard_Transient * | This () const |
| | Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
|
| |
| Standard_Integer | GetRefCount () const noexcept |
| | Get the reference counter of this object.
|
| |
| void | IncrementRefCounter () noexcept |
| | Increments the reference counter of this object.
|
| |
| Standard_Integer | DecrementRefCounter () noexcept |
| | Decrements the reference counter of this object; returns the decremented value.
|
| |
| virtual void | Delete () const |
| | Memory deallocator for transient classes.
|
| |
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.
- Exclusion flag on
- the function IsOk answers true for all objects, except those of the types and signatures stored in the filter framework
- Exclusion flag off
- the funciton IsOk answers true for all objects which have the same type and signature as the stored ones.
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.
Implements SelectMgr_Filter.
