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_SensitiveEntity Class Reference

    The purpose of this class is to mark sensitive entities selectable or not depending on current active selection of parent object for proper BVH traverse. More...

    #include <SelectMgr_SensitiveEntity.hxx>

    Inheritance diagram for SelectMgr_SensitiveEntity:

    Public Member Functions

     SelectMgr_SensitiveEntity (const occ::handle< Select3D_SensitiveEntity > &theEntity)
     Creates new inactive for selection object with base entity theEntity.
     ~SelectMgr_SensitiveEntity () override=default
    void Clear ()
     Clears up all resources and memory.
    const occ::handle< Select3D_SensitiveEntity > & BaseSensitive () const
     Returns related instance of SelectBasics class.
    bool IsActiveForSelection () const
     Returns true if this entity belongs to the active selection mode of parent object.
    void ResetSelectionActiveStatus () const
     Marks entity as inactive for selection.
    void SetActiveForSelection () const
     Marks entity as active for selection.
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    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.

    Detailed Description

    The purpose of this class is to mark sensitive entities selectable or not depending on current active selection of parent object for proper BVH traverse.

    Constructor & Destructor Documentation

    ◆ SelectMgr_SensitiveEntity()

    SelectMgr_SensitiveEntity::SelectMgr_SensitiveEntity ( const occ::handle< Select3D_SensitiveEntity > & theEntity)

    Creates new inactive for selection object with base entity theEntity.

    ◆ ~SelectMgr_SensitiveEntity()

    SelectMgr_SensitiveEntity::~SelectMgr_SensitiveEntity ( )
    overridedefault

    Member Function Documentation

    ◆ BaseSensitive()

    const occ::handle< Select3D_SensitiveEntity > & SelectMgr_SensitiveEntity::BaseSensitive ( ) const
    inline

    Returns related instance of SelectBasics class.

    ◆ Clear()

    void SelectMgr_SensitiveEntity::Clear ( )

    Clears up all resources and memory.

    ◆ DumpJson()

    virtual void SelectMgr_SensitiveEntity::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    virtual

    Dumps the content of me into the stream.

    ◆ IsActiveForSelection()

    bool SelectMgr_SensitiveEntity::IsActiveForSelection ( ) const
    inline

    Returns true if this entity belongs to the active selection mode of parent object.

    ◆ ResetSelectionActiveStatus()

    void SelectMgr_SensitiveEntity::ResetSelectionActiveStatus ( ) const
    inline

    Marks entity as inactive for selection.

    ◆ SetActiveForSelection()

    void SelectMgr_SensitiveEntity::SetActiveForSelection ( ) const
    inline

    Marks entity as active for selection.


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