Open CASCADE Technology  6.9.0
Public Member Functions

NIS_SelectFilter Class Referenceabstract

#include <NIS_SelectFilter.hxx>

Inheritance diagram for NIS_SelectFilter:
Inheritance graph
[legend]

Public Member Functions

 NIS_SelectFilter ()
 
virtual Standard_Boolean IsOk (const NIS_InteractiveObject *theObject) const =0
 
virtual Standard_Boolean ActsOn (const Handle< Standard_Type > &theType) const
 
- 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 void Delete () const
 Memory deallocator for transient classes. 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...
 

Detailed Description

Interface for selection filters. It can be used in NIS_InteractiveContext by methods SetFilter and GetFilter. Unlike in AIS, only one filter can be installed in InteractiveContext. If you need more than one filter instance to work together, create a composite NIS_SelectFilter specialization that would hold a list of simpler Filter instances.

Constructor & Destructor Documentation

NIS_SelectFilter::NIS_SelectFilter ( )
inline

Empty constructor.

Member Function Documentation

virtual Standard_Boolean NIS_SelectFilter::ActsOn ( const Handle< Standard_Type > &  theType) const
virtual

Check if the type of InteractiveObject is allowed for selection. Default implementation returns always True.

Returns
True if objects of the given Type should be checked, False if such objects are excluded from Selection before any checking.
virtual Standard_Boolean NIS_SelectFilter::IsOk ( const NIS_InteractiveObject theObject) const
pure virtual

Indicate that the given NIS_InteractiveObject passes the Filter.

Returns
True - theObject is kept in the Selection, False - excluded from it.

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