Open CASCADE Technology 7.8.0
BOPTools_BoxSet< NumType, Dimension, DataType > Class Template Reference

Redefines BoxSet to use the Linear builder by default. More...

#include <BOPTools_BoxTree.hxx>

Inheritance diagram for BOPTools_BoxSet< NumType, Dimension, DataType >:
Inheritance graph
[legend]

Public Member Functions

Constructors

Empty constructor for use the default BVH_Builder

 BOPTools_BoxSet (const opencascade::handle< BVH_Builder< NumType, Dimension > > &theBuilder=NULL)
 
- Public Member Functions inherited from BVH_BoxSet< NumType, Dimension, DataType >
 BVH_BoxSet ()
 Empty constructor for use the default BVH_Builder.
 
 BVH_BoxSet (const opencascade::handle< BVH_Builder< NumType, Dimension > > &theBuilder)
 Constructor for usage the custom BVH builder.
 
virtual void SetSize (const Standard_Size theSize)
 Sets the expected size of BVH tree.
 
virtual void Add (const DataType &theElement, const BVH_Box< NumType, Dimension > &theBox)
 Adds the element into BVH.
 
void Build ()
 BVH construction.
 
virtual void Clear ()
 Clears the vectors of elements and boxes.
 
virtual BVH_Box< NumType, Dimension > Box (const Standard_Integer theIndex) const override
 Returns the bounding box with the given index.
 
virtual Standard_Real Center (const Standard_Integer theIndex, const Standard_Integer theAxis) const override
 Returns centroid position along specified axis.
 
virtual Standard_Integer Size () const override
 Returns the number of boxes.
 
virtual void Swap (const Standard_Integer theIndex1, const Standard_Integer theIndex2) override
 Swaps indices of two specified boxes.
 
virtual DataType Element (const Standard_Integer theIndex) const
 Returns the Element with the index theIndex.
 
- Public Member Functions inherited from BVH_PrimitiveSet< NumType, Dimension >
 BVH_PrimitiveSet ()
 Creates set of abstract primitives.
 
 BVH_PrimitiveSet (const opencascade::handle< BVH_Builder< NumType, N > > &theBuilder)
 Creates set of abstract primitives.
 
virtual ~BVH_PrimitiveSet ()
 Releases resources of set of abstract primitives.
 
virtual BVH_Box< NumType, N > Box () const override
 Returns AABB of primitive set.
 
virtual const opencascade::handle< BVH_Tree< NumType, N > > & BVH ()
 Returns BVH tree (and builds it if necessary).
 
virtual const opencascade::handle< BVH_Builder< NumType, N > > & Builder () const
 Returns the method (builder) used to construct BVH.
 
virtual void SetBuilder (const opencascade::handle< BVH_Builder< NumType, N > > &theBuilder)
 Sets the method (builder) used to construct BVH.
 
- Public Member Functions inherited from BVH_Object< T, N >
 BVH_Object ()
 Creates new abstract geometric object.
 
virtual ~BVH_Object ()
 Releases resources of geometric object.
 
- Public Member Functions inherited from BVH_ObjectTransient
virtual const Handle< BVH_Properties > & Properties () const
 Returns properties of the geometric object.
 
virtual void SetProperties (const Handle< BVH_Properties > &theProperties)
 Sets properties of the geometric object.
 
virtual Standard_Boolean 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 ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean 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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 
- Public Member Functions inherited from BVH_Set< T, N >
 BVH_Set ()
 Creates new abstract set of objects.
 
virtual ~BVH_Set ()
 Releases resources of set of objects.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Public Types inherited from BVH_Set< T, N >
typedef BVH_Box< T, N > BVH_BoxNt
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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< NumType, Dimension >
static const Standard_Integer MaxTreeDepth
 
- Protected Member Functions inherited from BVH_PrimitiveSet< NumType, Dimension >
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_BoxSet< NumType, Dimension, DataType >
std::vector< DataType > myElements
 Elements.
 
std::vector< BVH_Box< NumType, Dimension > > myBoxes
 Boxes for the elements.
 
- Protected Attributes inherited from BVH_PrimitiveSet< NumType, Dimension >
opencascade::handle< BVH_Tree< NumType, N > > myBVH
 Constructed bottom-level BVH.
 
opencascade::handle< BVH_Builder< NumType, N > > myBuilder
 Builder for bottom-level BVH.
 
BVH_Box< NumType, N > myBox
 Cached bounding box of geometric primitives.
 
- Protected Attributes inherited from BVH_ObjectTransient
Standard_Boolean myIsDirty
 Marks internal object state as outdated.
 
Handle< BVH_PropertiesmyProperties
 Generic properties assigned to the object.
 

Detailed Description

template<class NumType, int Dimension, class DataType>
class BOPTools_BoxSet< NumType, Dimension, DataType >

Redefines BoxSet to use the Linear builder by default.

Constructor & Destructor Documentation

◆ BOPTools_BoxSet()

template<class NumType , int Dimension, class DataType >
BOPTools_BoxSet< NumType, Dimension, DataType >::BOPTools_BoxSet ( const opencascade::handle< BVH_Builder< NumType, Dimension > > &  theBuilder = NULL)
inline

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