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

    List of shapes and their IDs for collision detection. More...

    #include <BRepExtrema_TriangleSet.hxx>

    Inheritance diagram for BRepExtrema_TriangleSet:

    Public Member Functions

     BRepExtrema_TriangleSet ()
     Creates empty triangle set.
     BRepExtrema_TriangleSet (const NCollection_DynamicArray< TopoDS_Shape > &theFaces)
     Creates triangle set from the given face.
     ~BRepExtrema_TriangleSet () override
     Releases resources of triangle set.
    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.
    BVH_Box< double, N > Box () const override
     Returns AABB of primitive set.
    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.

    methods implementing BVH set interface

    Returns total number of triangles.

    BVH_Array4i myTriangles
     Array of vertex indices.
    BVH_Array3d myVertexArray
     Array of vertex coordinates.
    NCollection_DynamicArray< int > myShapeIdxOfVtxVec
     Vector of shapes' indices where index of item corresponds to index of vertex, belonging to this shape.
    NCollection_DynamicArray< int > myNumVtxInShapeVec
     Vector of vertexes' number belonging to shape which index corresponds item's index.
    NCollection_DynamicArray< int > myNumTrgInShapeVec
     Vector of triangles' number belonging to shape which index corresponds item's index.
    NCollection_DataMap< int, int > myTrgIdxMap
     Map of triangles' indices after (key) and before (value) swapping.
    int Size () const override
     Array of vertex indices.
    BVH_Box< double, 3 > Box (const int theIndex) const override
     Returns AABB of the given triangle.
    double Center (const int theIndex, const int theAxis) const override
     Returns centroid position along specified axis.
    void Swap (const int theIndex1, const int theIndex2) override
     Swaps indices of two specified triangles.
    void Clear ()
     Clears triangle set data.
    bool Init (const NCollection_DynamicArray< TopoDS_Shape > &theShapes)
     Initializes triangle set.
    const BVH_Array3dGetVertices () const
     Returns all vertices.
    void GetVertices (const int theIndex, BVH_Vec3d &theVertex1, BVH_Vec3d &theVertex2, BVH_Vec3d &theVertex3) const
     Returns vertices of the given triangle.
    void GetVtxIndices (const int theIndex, NCollection_Array1< int > &theVtxIndices) const
     Returns vertex indices of the given triangle.
    int GetFaceID (const int theIndex) const
     Returns face ID of the given triangle.
    int GetShapeIDOfVtx (const int theIndex) const
     Returns shape ID of the given vertex index.
    int GetVtxIdxInShape (const int theIndex) const
     Returns vertex index in tringulation of the shape, which vertex belongs, with the given vtx ID in whole set.
    int GetTrgIdxInShape (const int theIndex) const
     Returns triangle index (before swapping) in tringulation of the shape, which triangle belongs, with the given trg ID in whole set (after swapping).
    BVH_Box< double, N > Box () const override
     Make inherited method Box() visible to avoid CLang warning.

    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.
    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.

    Detailed Description

    List of shapes and their IDs for collision detection.

    Triangle set corresponding to specific face.

    Constructor & Destructor Documentation

    ◆ BRepExtrema_TriangleSet() [1/2]

    BRepExtrema_TriangleSet::BRepExtrema_TriangleSet ( )

    Creates empty triangle set.

    ◆ BRepExtrema_TriangleSet() [2/2]

    BRepExtrema_TriangleSet::BRepExtrema_TriangleSet ( const NCollection_DynamicArray< TopoDS_Shape > & theFaces)

    Creates triangle set from the given face.

    ◆ ~BRepExtrema_TriangleSet()

    BRepExtrema_TriangleSet::~BRepExtrema_TriangleSet ( )
    override

    Releases resources of triangle set.

    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.

    Implements BVH_Object< double, N >.

    ◆ Box() [2/2]

    BVH_Box< double, 3 > BRepExtrema_TriangleSet::Box ( const int theIndex) const
    override

    Returns AABB of the given triangle.

    ◆ Center()

    double BRepExtrema_TriangleSet::Center ( const int theIndex,
    const int theAxis ) const
    overridevirtual

    Returns centroid position along specified axis.

    Implements BVH_Set< double, N >.

    ◆ Clear()

    void BRepExtrema_TriangleSet::Clear ( )

    Clears triangle set data.

    ◆ GetFaceID()

    int BRepExtrema_TriangleSet::GetFaceID ( const int theIndex) const

    Returns face ID of the given triangle.

    ◆ GetShapeIDOfVtx()

    int BRepExtrema_TriangleSet::GetShapeIDOfVtx ( const int theIndex) const

    Returns shape ID of the given vertex index.

    ◆ GetTrgIdxInShape()

    int BRepExtrema_TriangleSet::GetTrgIdxInShape ( const int theIndex) const

    Returns triangle index (before swapping) in tringulation of the shape, which triangle belongs, with the given trg ID in whole set (after swapping).

    ◆ GetVertices() [1/2]

    const BVH_Array3d & BRepExtrema_TriangleSet::GetVertices ( ) const
    inline

    Returns all vertices.

    ◆ GetVertices() [2/2]

    void BRepExtrema_TriangleSet::GetVertices ( const int theIndex,
    BVH_Vec3d & theVertex1,
    BVH_Vec3d & theVertex2,
    BVH_Vec3d & theVertex3 ) const

    Returns vertices of the given triangle.

    ◆ GetVtxIdxInShape()

    int BRepExtrema_TriangleSet::GetVtxIdxInShape ( const int theIndex) const

    Returns vertex index in tringulation of the shape, which vertex belongs, with the given vtx ID in whole set.

    ◆ GetVtxIndices()

    void BRepExtrema_TriangleSet::GetVtxIndices ( const int theIndex,
    NCollection_Array1< int > & theVtxIndices ) const

    Returns vertex indices of the given triangle.

    ◆ Init()

    bool BRepExtrema_TriangleSet::Init ( const NCollection_DynamicArray< TopoDS_Shape > & theShapes)

    Initializes triangle set.

    ◆ Size()

    int BRepExtrema_TriangleSet::Size ( ) const
    overridevirtual

    Array of vertex indices.

    Implements BVH_Set< double, N >.

    ◆ Swap()

    void BRepExtrema_TriangleSet::Swap ( const int theIndex1,
    const int theIndex2 )
    overridevirtual

    Swaps indices of two specified triangles.

    Implements BVH_Set< double, N >.

    Field Documentation

    ◆ myNumTrgInShapeVec

    NCollection_DynamicArray<int> BRepExtrema_TriangleSet::myNumTrgInShapeVec
    protected

    Vector of triangles' number belonging to shape which index corresponds item's index.

    ◆ myNumVtxInShapeVec

    NCollection_DynamicArray<int> BRepExtrema_TriangleSet::myNumVtxInShapeVec
    protected

    Vector of vertexes' number belonging to shape which index corresponds item's index.

    ◆ myShapeIdxOfVtxVec

    NCollection_DynamicArray<int> BRepExtrema_TriangleSet::myShapeIdxOfVtxVec
    protected

    Vector of shapes' indices where index of item corresponds to index of vertex, belonging to this shape.

    ◆ myTrgIdxMap

    NCollection_DataMap<int, int> BRepExtrema_TriangleSet::myTrgIdxMap
    protected

    Map of triangles' indices after (key) and before (value) swapping.

    ◆ myTriangles

    BVH_Array4i BRepExtrema_TriangleSet::myTriangles
    protected

    Array of vertex indices.

    ◆ myVertexArray

    BVH_Array3d BRepExtrema_TriangleSet::myVertexArray
    protected

    Array of vertex coordinates.


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