Open CASCADE Technology  6.9.0
Public Member Functions | Protected Attributes

AIS_TypeFilter Class Reference

Selects Interactive Objects through their types. The filter questions each Interactive Object in local context to determine whether it has an non-null owner, and if so, whether it is of the desired type. If the object returns true in each case, it is kept. If not, it is rejected. By default, the interactive object has a None type and a signature of 0. A filter for type specifies a choice of type out of a range at any level enumerated for type or kind. The choice could be for kind of interactive object, of dimension, of unit, or type of axis, plane or attribute. If you want to give a particular type and signature to your Interactive Object, you must redefine two virtual methods: Type and Signature. This filter is used in both Neutral Point and open local contexts. In the Collector viewer, you can only locate Interactive Objects which answer positively to the positioned filters when a local context is open. Warning When you close a local context, all temporary interactive objects are deleted, all selection modes concerning the context are cancelled, and all content filters are emptied. More...

#include <AIS_TypeFilter.hxx>

Inheritance diagram for AIS_TypeFilter:
Inheritance graph
[legend]

Public Member Functions

 AIS_TypeFilter (const AIS_KindOfInteractive aGivenKind)
 Initializes filter for type, aGivenKind. More...
 
virtual Standard_Boolean IsOk (const Handle< SelectMgr_EntityOwner > &anobj) const
 Returns False if the transient is not an Interactive Object, or if the type of the Interactive Object is not the same as that stored in the filter. More...
 
- Public Member Functions inherited from SelectMgr_Filter
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. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const 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. More...
 
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. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Attributes

AIS_KindOfInteractive myKind
 

Detailed Description

Selects Interactive Objects through their types. The filter questions each Interactive Object in local context to determine whether it has an non-null owner, and if so, whether it is of the desired type. If the object returns true in each case, it is kept. If not, it is rejected. By default, the interactive object has a None type and a signature of 0. A filter for type specifies a choice of type out of a range at any level enumerated for type or kind. The choice could be for kind of interactive object, of dimension, of unit, or type of axis, plane or attribute. If you want to give a particular type and signature to your Interactive Object, you must redefine two virtual methods: Type and Signature. This filter is used in both Neutral Point and open local contexts. In the Collector viewer, you can only locate Interactive Objects which answer positively to the positioned filters when a local context is open. Warning When you close a local context, all temporary interactive objects are deleted, all selection modes concerning the context are cancelled, and all content filters are emptied.

Constructor & Destructor Documentation

AIS_TypeFilter::AIS_TypeFilter ( const AIS_KindOfInteractive  aGivenKind)

Initializes filter for type, aGivenKind.

Member Function Documentation

virtual Standard_Boolean AIS_TypeFilter::IsOk ( const Handle< SelectMgr_EntityOwner > &  anobj) const
virtual

Returns False if the transient is not an Interactive Object, or if the type of the Interactive Object is not the same as that stored in the filter.

Implements SelectMgr_Filter.

Reimplemented in AIS_SignatureFilter.

Field Documentation

AIS_KindOfInteractive AIS_TypeFilter::myKind
protected

The documentation for this class was generated from the following file: