OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    SelectMgr_AndOrFilter Class Reference

    A framework to define an OR or AND selection filter. To use an AND selection filter call SetUseOrFilter with False parameter. By default the OR selection filter is used. More...

    #include <SelectMgr_AndOrFilter.hxx>

    Inheritance diagram for SelectMgr_AndOrFilter:

    Public Member Functions

     SelectMgr_AndOrFilter (const SelectMgr_FilterType theFilterType)
     Constructs an empty selection filter.
    bool IsOk (const occ::handle< SelectMgr_EntityOwner > &theObj) const override
     Indicates that the selected Interactive Object passes the filter.
    void SetDisabledObjects (const occ::handle< NCollection_Shared< NCollection_Map< const Standard_Transient * > > > &theObjects)
     Disable selection of specified objects.
    SelectMgr_FilterType FilterType () const
    void SetFilterType (const SelectMgr_FilterType theFilterType)
     Sets a selection filter type. SelectMgr_FilterType_OR selection filter is used be default.
    Public Member Functions inherited from SelectMgr_CompositionFilter
    void Add (const occ::handle< SelectMgr_Filter > &afilter)
     Adds the filter afilter to a filter object created by a filter class inheriting this framework.
    void Remove (const occ::handle< SelectMgr_Filter > &aFilter)
     Removes the filter aFilter from this framework.
    bool IsEmpty () const
     Returns true if this framework is empty.
    bool IsIn (const occ::handle< SelectMgr_Filter > &aFilter) const
     Returns true if the filter aFilter is in this framework.
    const NCollection_List< occ::handle< SelectMgr_Filter > > & StoredFilters () const
     Returns the list of stored filters from this framework.
    void Clear ()
     Clears the filters used in this framework.
    bool ActsOn (const TopAbs_ShapeEnum aStandardMode) const override
     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_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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_TransientThis () 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.
    Protected Attributes inherited from SelectMgr_CompositionFilter
    NCollection_List< occ::handle< SelectMgr_Filter > > myFilters

    Detailed Description

    A framework to define an OR or AND selection filter. To use an AND selection filter call SetUseOrFilter with False parameter. By default the OR selection filter is used.

    Constructor & Destructor Documentation

    ◆ SelectMgr_AndOrFilter()

    SelectMgr_AndOrFilter::SelectMgr_AndOrFilter ( const SelectMgr_FilterType theFilterType)

    Constructs an empty selection filter.

    Member Function Documentation

    ◆ FilterType()

    SelectMgr_FilterType SelectMgr_AndOrFilter::FilterType ( ) const
    inline
    Returns
    a selection filter type (
    See also
    SelectMgr_FilterType).

    ◆ IsOk()

    bool SelectMgr_AndOrFilter::IsOk ( const occ::handle< SelectMgr_EntityOwner > & theObj) const
    overridevirtual

    Indicates that the selected Interactive Object passes the filter.

    Implements SelectMgr_Filter.

    ◆ SetDisabledObjects()

    void SelectMgr_AndOrFilter::SetDisabledObjects ( const occ::handle< NCollection_Shared< NCollection_Map< const Standard_Transient * > > > & theObjects)

    Disable selection of specified objects.

    ◆ SetFilterType()

    void SelectMgr_AndOrFilter::SetFilterType ( const SelectMgr_FilterType theFilterType)
    inline

    Sets a selection filter type. SelectMgr_FilterType_OR selection filter is used be default.

    Parameters
    theFilterTypethe filter type.

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