Open CASCADE Technology 7.8.0
Public Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

Public Member Functions

 BvhPrimitiveSet ()
 Empty constructor.
 
 ~BvhPrimitiveSet ()
 Destructor.
 
void SetSensitiveSet (Select3D_SensitiveSet *theSensitiveSet)
 Setup sensitivity set.
 
virtual Standard_Integer Size () const override
 Returns the length of set of sensitives.
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const override
 Returns bounding box of sensitive with index theIdx.
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override
 Returns center of sensitive with index theIdx in the set along the given axis theAxis.
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) override
 Swaps items with indexes theIdx1 and theIdx2 in the set.
 
const opencascade::handle< BVH_Tree< Standard_Real, 3 > > & GetBVH ()
 Returns the tree built for set of sensitives.
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream.
 
virtual BVH_Box< T, N > Box () const override
 Make inherited method Box() visible to avoid CLang warning.
 
- Public Member Functions inherited from BVH_PrimitiveSet< T, N >
 BVH_PrimitiveSet ()
 Creates set of abstract primitives.
 
 BVH_PrimitiveSet (const opencascade::handle< BVH_Builder< T, N > > &theBuilder)
 Creates set of abstract primitives.
 
virtual ~BVH_PrimitiveSet ()
 Releases resources of set of abstract primitives.
 
virtual const opencascade::handle< BVH_Tree< T, N > > & BVH ()
 Returns BVH tree (and builds it if necessary).
 
virtual const opencascade::handle< BVH_Builder< T, N > > & Builder () const
 Returns the method (builder) used to construct BVH.
 
virtual void SetBuilder (const opencascade::handle< BVH_Builder< T, 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.
 

Protected Attributes

Select3D_SensitiveSetmySensitiveSet
 Set of sensitive entities.
 
- Protected Attributes inherited from BVH_PrimitiveSet< T, N >
opencascade::handle< BVH_Tree< T, N > > myBVH
 Constructed bottom-level BVH.
 
opencascade::handle< BVH_Builder< T, N > > myBuilder
 Builder for bottom-level BVH.
 
BVH_Box< T, 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.
 

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< T, N >
static const Standard_Integer MaxTreeDepth = BVH_Constants_MaxTreeDepth
 
- Protected Member Functions inherited from BVH_PrimitiveSet< T, N >
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 ( )
inline

Destructor.

Member Function Documentation

◆ Box() [1/2]

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

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

Reimplemented from BVH_PrimitiveSet< T, N >.

◆ Box() [2/2]

virtual Select3D_BndBox3d Select3D_SensitiveSet::BvhPrimitiveSet::Box ( const Standard_Integer  theIdx) const
inlineoverridevirtual

Returns bounding box of sensitive with index theIdx.

Implements BVH_Set< T, N >.

◆ Center()

virtual Standard_Real Select3D_SensitiveSet::BvhPrimitiveSet::Center ( const Standard_Integer  theIdx,
const Standard_Integer  theAxis 
) const
inlineoverridevirtual

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

Implements BVH_Set< T, N >.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ GetBVH()

const opencascade::handle< BVH_Tree< Standard_Real, 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()

virtual Standard_Integer Select3D_SensitiveSet::BvhPrimitiveSet::Size ( ) const
inlineoverridevirtual

Returns the length of set of sensitives.

Implements BVH_Set< T, N >.

◆ Swap()

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

Swaps items with indexes theIdx1 and theIdx2 in the set.

Implements BVH_Set< T, 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: