Open CASCADE Technology  7.4.1.dev
Public Types
BOPTools_BoxSelector< Dimension > Class Template Reference

Template Selector for elements selection from BVH tree. More...

#include <BOPTools_BoxSelector.hxx>

Inheritance diagram for BOPTools_BoxSelector< Dimension >:
Inheritance graph
[legend]

Public Types

typedef BVH::VectorType< Standard_Real, Dimension >::Type BVH_VecNd
 
- Public Types inherited from BVH_Traverse< Standard_Real, Dimension, BVH_BoxSet< Standard_Real, Dimension, Standard_Integer >, Standard_Boolean >
typedef BVH_Box< Standard_Real, Dimension >::BVH_VecNt BVH_VecNt
 

Public Member Functions

Constructor
 BOPTools_BoxSelector ()
 Empty constructor. More...
 
public interfaces
void Clear ()
 Clears the indices. More...
 
void SetBox (const BVH_Box< Standard_Real, Dimension > &theBox)
 Sets the box. More...
 
const TColStd_ListOfIntegerIndices () const
 Returns the list of accepted indices. More...
 
Rejection/Acceptance rules
virtual Standard_Boolean RejectNode (const BVH_VecNd &theCMin, const BVH_VecNd &theCMax, Standard_Boolean &theIsInside) const override
 Checks if the box should be rejected. More...
 
Standard_Boolean RejectElement (const Standard_Integer theIndex)
 Checks if the element should be rejected. More...
 
virtual Standard_Boolean AcceptMetric (const Standard_Boolean &theIsInside) const override
 Checks if the metric of the node may be accepted. More...
 
virtual Standard_Boolean Accept (const Standard_Integer theIndex, const Standard_Boolean &theIsInside) override
 Accepts the element with the index <theIndex> in BVH tree. More...
 
- Public Member Functions inherited from BVH_Traverse< Standard_Real, Dimension, BVH_BoxSet< Standard_Real, Dimension, Standard_Integer >, Standard_Boolean >
 BVH_Traverse ()
 Constructor. More...
 
void SetBVHSet (BVH_BoxSet< Standard_Real, Dimension, Standard_Integer > *theBVHSet)
 Sets the BVH Set containing the BVH tree. More...
 
virtual Standard_Boolean RejectNode (const BVH_VecNt &theCornerMin, const BVH_VecNt &theCornerMax, Standard_Boolean &theMetric) const=0
 Rejection of the node by bounding box. Metric is computed to choose the best branch. Returns true if the node should be rejected, false otherwise. More...
 
Standard_Integer Select ()
 Selection of the elements from the BVH tree by the rules defined in Accept/Reject methods. The method requires the BVHSet containing BVH tree to be set. Returns the number of accepted elements. More...
 
Standard_Integer Select (const opencascade::handle< BVH_Tree< Standard_Real, Dimension >> &theBVH)
 Performs selection of the elements from the BVH tree by the rules defined in Accept/Reject methods. Returns the number of accepted elements. More...
 
- Public Member Functions inherited from BVH_BaseTraverse< Standard_Boolean >
virtual Standard_Boolean IsMetricBetter (const Standard_Boolean &, const Standard_Boolean &) const
 Compares the two metrics and chooses the best one. Returns true if the first metric is better than the second, false otherwise. More...
 
virtual Standard_Boolean RejectMetric (const Standard_Boolean &) const
 Rejects the node by the metric. More...
 
virtual Standard_Boolean Stop () const
 Returns the flag controlling the tree descend. Returns true if the tree descend should be stopped. More...
 

Protected Attributes

Fields
BVH_Box< Standard_Real, Dimension > myBox
 Selection box. More...
 
TColStd_ListOfInteger myIndices
 Selected indices. More...
 
- Protected Attributes inherited from BVH_Traverse< Standard_Real, Dimension, BVH_BoxSet< Standard_Real, Dimension, Standard_Integer >, Standard_Boolean >
BVH_BoxSet< Standard_Real, Dimension, Standard_Integer > * myBVHSet
 

Additional Inherited Members

- Protected Member Functions inherited from BVH_BaseTraverse< Standard_Boolean >
 BVH_BaseTraverse ()
 Constructor. More...
 
virtual ~BVH_BaseTraverse ()
 Destructor. More...
 

Detailed Description

template<int Dimension>
class BOPTools_BoxSelector< Dimension >

Template Selector for elements selection from BVH tree.

Member Typedef Documentation

◆ BVH_VecNd

template<int Dimension>
typedef BVH::VectorType<Standard_Real, Dimension>::Type BOPTools_BoxSelector< Dimension >::BVH_VecNd

Constructor & Destructor Documentation

◆ BOPTools_BoxSelector()

template<int Dimension>
BOPTools_BoxSelector< Dimension >::BOPTools_BoxSelector ( )
inline

Empty constructor.

Member Function Documentation

◆ Accept()

template<int Dimension>
virtual Standard_Boolean BOPTools_BoxSelector< Dimension >::Accept ( const Standard_Integer  theIndex,
const Standard_Boolean theIsInside 
)
inlineoverridevirtual

◆ AcceptMetric()

template<int Dimension>
virtual Standard_Boolean BOPTools_BoxSelector< Dimension >::AcceptMetric ( const Standard_Boolean theIsInside) const
inlineoverridevirtual

◆ Clear()

template<int Dimension>
void BOPTools_BoxSelector< Dimension >::Clear ( )
inline

Clears the indices.

◆ Indices()

template<int Dimension>
const TColStd_ListOfInteger& BOPTools_BoxSelector< Dimension >::Indices ( ) const
inline

Returns the list of accepted indices.

◆ RejectElement()

template<int Dimension>
Standard_Boolean BOPTools_BoxSelector< Dimension >::RejectElement ( const Standard_Integer  theIndex)
inline

Checks if the element should be rejected.

◆ RejectNode()

template<int Dimension>
virtual Standard_Boolean BOPTools_BoxSelector< Dimension >::RejectNode ( const BVH_VecNd theCMin,
const BVH_VecNd theCMax,
Standard_Boolean theIsInside 
) const
inlineoverridevirtual

Checks if the box should be rejected.

◆ SetBox()

template<int Dimension>
void BOPTools_BoxSelector< Dimension >::SetBox ( const BVH_Box< Standard_Real, Dimension > &  theBox)
inline

Sets the box.

Field Documentation

◆ myBox

template<int Dimension>
BVH_Box<Standard_Real, Dimension> BOPTools_BoxSelector< Dimension >::myBox
protected

Selection box.

◆ myIndices

template<int Dimension>
TColStd_ListOfInteger BOPTools_BoxSelector< Dimension >::myIndices
protected

Selected indices.


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