OpenCAX/entry/src/main/cpp/include/opencascade/BOPDS_Iterator.hxx
2026-02-19 19:05:41 +08:00

130 lines
5.4 KiB
C++

// Created by: Peter KURNEV
// Copyright (c) 2010-2014 OPEN CASCADE SAS
// Copyright (c) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
// Copyright (c) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT,
// EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _BOPDS_Iterator_HeaderFile
#define _BOPDS_Iterator_HeaderFile
#include "Standard.hxx"
#include "Standard_DefineAlloc.hxx"
#include "Standard_Handle.hxx"
#include "Standard_Integer.hxx"
#include "BOPDS_PDS.hxx"
#include "BOPDS_VectorOfVectorOfPair.hxx"
#include "BOPTools_BoxTree.hxx"
#include "NCollection_BaseAllocator.hxx"
#include "Precision.hxx"
#include "TopAbs_ShapeEnum.hxx"
class IntTools_Context;
//! The class BOPDS_Iterator is
//! 1.to compute intersections between BRep sub-shapes
//! of arguments of an operation (see the class BOPDS_DS)
//! in terms of theirs bounding boxes
//! 2.provides interface to iterate the pairs of
//! intersected sub-shapes of given type
class BOPDS_Iterator
{
public:
DEFINE_STANDARD_ALLOC
//! Empty constructor
Standard_EXPORT BOPDS_Iterator();
Standard_EXPORT virtual ~BOPDS_Iterator();
//! Constructor
//! @param theAllocator the allocator to manage the memory
Standard_EXPORT BOPDS_Iterator(const Handle(NCollection_BaseAllocator)& theAllocator);
//! Modifier
//! Sets the data structure <pDS> to process
Standard_EXPORT void SetDS(const BOPDS_PDS& pDS);
//! Selector
//! Returns the data structure
Standard_EXPORT const BOPDS_DS& DS() const;
//! Initializes the iterator
//! theType1 - the first type of shape
//! theType2 - the second type of shape
Standard_EXPORT void Initialize(const TopAbs_ShapeEnum theType1, const TopAbs_ShapeEnum theType2);
//! Returns true if still there are pairs
//! of intersected shapes
Standard_EXPORT Standard_Boolean More() const;
//! Moves iterations ahead
Standard_EXPORT void Next();
//! Returns indices (DS) of intersected shapes
//! theIndex1 - the index of the first shape
//! theIndex2 - the index of the second shape
Standard_EXPORT void Value(Standard_Integer& theIndex1, Standard_Integer& theIndex2) const;
//! Perform the intersection algorithm and prepare
//! the results to be used
Standard_EXPORT virtual void Prepare(
const Handle(IntTools_Context)& theCtx = Handle(IntTools_Context)(),
const Standard_Boolean theCheckOBB = Standard_False,
const Standard_Real theFuzzyValue = Precision::Confusion());
//! Updates the tree of Bounding Boxes with increased boxes and
//! intersects such elements with the tree.
Standard_EXPORT void IntersectExt(const TColStd_MapOfInteger& theIndicies);
//! Returns the number of intersections founded
Standard_EXPORT Standard_Integer ExpectedLength() const;
//! Returns the block length
Standard_EXPORT Standard_Integer BlockLength() const;
//! Set the flag of parallel processing
//! if <theFlag> is true the parallel processing is switched on
//! if <theFlag> is false the parallel processing is switched off
Standard_EXPORT void SetRunParallel(const Standard_Boolean theFlag);
//! Returns the flag of parallel processing
Standard_EXPORT Standard_Boolean RunParallel() const;
public: //! @name Number of extra interfering types
// Extra lists contain only V/V, V/E, V/F interfering pairs.
// Although E/E is also initialized (but never filled) for code simplicity.
static Standard_Integer NbExtInterfs() { return 4; }
protected: //! @name Protected methods for bounding boxes intersection
//! Intersects the Bounding boxes of sub-shapes of the arguments with the tree
//! and saves the interfering pairs for further geometrical intersection.
Standard_EXPORT virtual void Intersect(
const Handle(IntTools_Context)& theCtx = Handle(IntTools_Context)(),
const Standard_Boolean theCheckOBB = Standard_False,
const Standard_Real theFuzzyValue = Precision::Confusion());
protected: //! @name Fields
Handle(NCollection_BaseAllocator) myAllocator; //!< Allocator
Standard_Integer myLength; //!< Length of the intersection vector of
//! particular intersection type
BOPDS_PDS myDS; //!< Data Structure
BOPDS_VectorOfVectorOfPair myLists; //!< Pairs with interfering bounding boxes
BOPDS_VectorOfPair::Iterator myIterator; //!< Iterator on each interfering type
Standard_Boolean myRunParallel; //!< Flag for parallel processing
BOPDS_VectorOfVectorOfPair myExtLists; //!< Extra pairs of sub-shapes found after
//! intersection of increased sub-shapes
Standard_Boolean myUseExt; //!< Information flag for using the extra lists
};
#endif // _BOPDS_Iterator_HeaderFile