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
    Select3D_SensitiveSet::BvhPrimitiveSet Class Reference

    The purpose of this class is to provide a link between BVH_PrimitiveSet and Select3D_SensitiveSet instance to build BVH tree for set of sensitives. More...

    #include <Select3D_SensitiveSet.hxx>

    Inheritance diagram for Select3D_SensitiveSet::BvhPrimitiveSet:

    Public Member Functions

     BvhPrimitiveSet ()
     Empty constructor.
     ~BvhPrimitiveSet () override=default
     Destructor.
    void SetSensitiveSet (Select3D_SensitiveSet *theSensitiveSet)
     Setup sensitivity set.
    int Size () const override
     Returns the length of set of sensitives.
    Select3D_BndBox3d Box (const int theIdx) const override
     Returns bounding box of sensitive with index theIdx.
    double Center (const int theIdx, const int theAxis) const override
     Returns center of sensitive with index theIdx in the set along the given axis theAxis.
    void Swap (const int theIdx1, const int theIdx2) override
     Swaps items with indexes theIdx1 and theIdx2 in the set.
    const opencascade::handle< BVH_Tree< double, 3 > > & GetBVH ()
     Returns the tree built for set of sensitives.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    BVH_Box< double, N > Box () const override
     Make inherited method Box() visible to avoid CLang warning.
    Public Member Functions inherited from BVH_PrimitiveSet< double, 3 >
     BVH_PrimitiveSet ()
     Creates set of abstract primitives.
     BVH_PrimitiveSet (const opencascade::handle< BVH_Builder< double, N > > &theBuilder)
     Creates set of abstract primitives.
     ~BVH_PrimitiveSet () override
     Releases resources of set of abstract primitives.
    virtual const opencascade::handle< BVH_Tree< double, N > > & BVH ()
     Returns BVH tree (and builds it if necessary).
    virtual const opencascade::handle< BVH_Builder< double, N > > & Builder () const
     Returns the method (builder) used to construct BVH.
    virtual void SetBuilder (const opencascade::handle< BVH_Builder< double, N > > &theBuilder)
     Sets the method (builder) used to construct BVH.
    Public Member Functions inherited from BVH_Object< double, N >
     BVH_Object ()=default
     Creates new abstract geometric object.
     ~BVH_Object () override=default
     Releases resources of geometric object.
    Public Member Functions inherited from BVH_ObjectTransient
    virtual const occ::handle< BVH_Properties > & Properties () const
     Returns properties of the geometric object.
    virtual void SetProperties (const occ::handle< BVH_Properties > &theProperties)
     Sets properties of the geometric object.
    virtual bool IsDirty () const
     Returns TRUE if object state should be updated.
    virtual void MarkDirty ()
     Marks object state as outdated (needs BVH rebuilding).
    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.
    Public Member Functions inherited from BVH_Set< double, N >
     BVH_Set ()=default
     Creates new abstract set of objects.
    virtual ~BVH_Set ()=default
     Releases resources of set of objects.

    Protected Attributes

    Select3D_SensitiveSetmySensitiveSet
     Set of sensitive entities.
    Protected Attributes inherited from BVH_PrimitiveSet< double, 3 >
    opencascade::handle< BVH_Tree< double, N > > myBVH
     Constructed bottom-level BVH.
    opencascade::handle< BVH_Builder< double, N > > myBuilder
     Builder for bottom-level BVH.
    BVH_Box< double, N > myBox
     Cached bounding box of geometric primitives.
    Protected Attributes inherited from BVH_ObjectTransient
    bool myIsDirty
     Marks internal object state as outdated.
    occ::handle< BVH_PropertiesmyProperties
     Generic properties assigned to the object.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Public Types inherited from BVH_Set< double, N >
    typedef BVH_Box< double, N > BVH_BoxNt
    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.
    Static Public Attributes inherited from BVH_PrimitiveSet< double, 3 >
    static const int MaxTreeDepth
    Protected Member Functions inherited from BVH_PrimitiveSet< double, 3 >
    virtual void Update ()
     Updates BVH of primitive set.
    Protected Member Functions inherited from BVH_ObjectTransient
     BVH_ObjectTransient ()
     Creates new abstract geometric object.

    Detailed Description

    The purpose of this class is to provide a link between BVH_PrimitiveSet and Select3D_SensitiveSet instance to build BVH tree for set of sensitives.

    Constructor & Destructor Documentation

    ◆ BvhPrimitiveSet()

    Select3D_SensitiveSet::BvhPrimitiveSet::BvhPrimitiveSet ( )
    inline

    Empty constructor.

    ◆ ~BvhPrimitiveSet()

    Select3D_SensitiveSet::BvhPrimitiveSet::~BvhPrimitiveSet ( )
    overridedefault

    Destructor.

    Member Function Documentation

    ◆ Box() [1/2]

    BVH_Box< double, N > BVH_PrimitiveSet< double, N >::Box ( ) const
    inlineoverridevirtual

    Make inherited method Box() visible to avoid CLang warning.

    Reimplemented from BVH_PrimitiveSet< double, 3 >.

    ◆ Box() [2/2]

    Select3D_BndBox3d Select3D_SensitiveSet::BvhPrimitiveSet::Box ( const int theIdx) const
    inlineoverride

    Returns bounding box of sensitive with index theIdx.

    ◆ Center()

    double Select3D_SensitiveSet::BvhPrimitiveSet::Center ( const int theIdx,
    const int theAxis ) const
    inlineoverridevirtual

    Returns center of sensitive with index theIdx in the set along the given axis theAxis.

    Implements BVH_Set< double, N >.

    ◆ DumpJson()

    void Select3D_SensitiveSet::BvhPrimitiveSet::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    inline

    Dumps the content of me into the stream.

    ◆ GetBVH()

    const opencascade::handle< BVH_Tree< double, 3 > > & Select3D_SensitiveSet::BvhPrimitiveSet::GetBVH ( )
    inline

    Returns the tree built for set of sensitives.

    ◆ SetSensitiveSet()

    void Select3D_SensitiveSet::BvhPrimitiveSet::SetSensitiveSet ( Select3D_SensitiveSet * theSensitiveSet)
    inline

    Setup sensitivity set.

    ◆ Size()

    int Select3D_SensitiveSet::BvhPrimitiveSet::Size ( ) const
    inlineoverridevirtual

    Returns the length of set of sensitives.

    Implements BVH_Set< double, N >.

    ◆ Swap()

    void Select3D_SensitiveSet::BvhPrimitiveSet::Swap ( const int theIdx1,
    const int theIdx2 )
    inlineoverridevirtual

    Swaps items with indexes theIdx1 and theIdx2 in the set.

    Implements BVH_Set< double, N >.

    Field Documentation

    ◆ mySensitiveSet

    Select3D_SensitiveSet* Select3D_SensitiveSet::BvhPrimitiveSet::mySensitiveSet
    protected

    Set of sensitive entities.


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