Open CASCADE Technology 6.6.0
Public Member Functions
Bnd_BoundSortBox2d Class Reference

A tool to compare a 2D bounding box with a set of 2D
bounding boxes. It sorts the set of bounding boxes to give
the list of boxes which intersect the element being compared.
The boxes being sorted generally bound a set of shapes,
while the box being compared bounds a shape to be
compared. The resulting list of intersecting boxes therefore
gives the list of items which potentially intersect the shape to be compared.

#include <Bnd_BoundSortBox2d.hxx>

Public Member Functions

 Bnd_BoundSortBox2d ()
 Constructs an empty comparison algorithm for 2D bounding boxes.
The bounding boxes are then defined using the Initialize function.

void Initialize (const Bnd_Box2d &CompleteBox, const Handle< Bnd_HArray1OfBox2d > &SetOfBox)
 Initializes this comparison algorithm with

void Initialize (const Handle< Bnd_HArray1OfBox2d > &SetOfBox)
 Initializes this comparison algorithm with

void Initialize (const Bnd_Box2d &CompleteBox, const Standard_Integer nbComponents)
 Initializes this comparison algorithm, giving it only

void Add (const Bnd_Box2d &theBox, const Standard_Integer boxIndex)
 Adds the 2D bounding box theBox at position boxIndex in
the array of boxes to be sorted by this comparison algorithm.
This function is used only in conjunction with the third
syntax described in the synopsis of Initialize.
Exceptions

const TColStd_ListOfIntegerCompare (const Bnd_Box2d &theBox)
 Compares the 2D bounding box theBox with the set of
bounding boxes to be sorted by this comparison algorithm,
and returns the list of intersecting bounding boxes as a list
of indexes on the array of bounding boxes used by this algorithm.

void Dump () const

Constructor & Destructor Documentation

Bnd_BoundSortBox2d::Bnd_BoundSortBox2d ( )

Member Function Documentation

void Bnd_BoundSortBox2d::Add ( const Bnd_Box2d theBox,
const Standard_Integer  boxIndex 
)
  • Standard_OutOfRange if boxIndex is not in the
    range [ 1,nbComponents ] where
    nbComponents is the maximum number of bounding
    boxes declared for this comparison algorithm at
    initialization.
  • Standard_MultiplyDefined if a box still exists at
    position boxIndex in the array of boxes to be sorted by
    this comparison algorithm.
const TColStd_ListOfInteger& Bnd_BoundSortBox2d::Compare ( const Bnd_Box2d theBox)
void Bnd_BoundSortBox2d::Dump ( ) const
void Bnd_BoundSortBox2d::Initialize ( const Handle< Bnd_HArray1OfBox2d > &  SetOfBox)
  • the set of 2D bounding boxes SetOfBox, where
    CompleteBox is given as the global bounding box of SetOfBox.
void Bnd_BoundSortBox2d::Initialize ( const Bnd_Box2d CompleteBox,
const Handle< Bnd_HArray1OfBox2d > &  SetOfBox 
)
  • the set of 2D bounding boxes SetOfBox
void Bnd_BoundSortBox2d::Initialize ( const Bnd_Box2d CompleteBox,
const Standard_Integer  nbComponents 
)
  • the maximum number nbComponents, and
  • the global bounding box CompleteBox,
    of the 2D bounding boxes to be managed. Use the Add
    function to define the array of bounding boxes to be sorted by this algorithm.

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines