include/opencascade/TopOpeBRep_ShapeScanner.hxx

0001 // Created on: 1993-07-07
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TopOpeBRep_ShapeScanner_HeaderFile
0018 #define _TopOpeBRep_ShapeScanner_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopOpeBRepTool_BoxSort.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <NCollection_List.hxx>
0027 #include <TopAbs_ShapeEnum.hxx>
0028 #include <Standard_Boolean.hxx>
0029 #include <Standard_OStream.hxx>
0030 class TopoDS_Shape;
0031 class TopOpeBRepTool_ShapeExplorer;
0032
0033 //! Find, among the subshapes SS of a reference shape
0034 //! RS, the ones which 3D box interferes with the box of
0035 //! a shape S (SS and S are of the same type).
0036 class TopOpeBRep_ShapeScanner
0037 {
0038 public:
0039   DEFINE_STANDARD_ALLOC
0040
0041   Standard_EXPORT TopOpeBRep_ShapeScanner();
0042
0043   Standard_EXPORT void Clear();
0044
0045   Standard_EXPORT void AddBoxesMakeCOB(const TopoDS_Shape&    S,
0046                                        const TopAbs_ShapeEnum TS,
0047                                        const TopAbs_ShapeEnum TA = TopAbs_SHAPE);
0048
0049   Standard_EXPORT void Init(const TopoDS_Shape& E);
0050
0051   Standard_EXPORT void Init(TopOpeBRepTool_ShapeExplorer& X);
0052
0053   Standard_EXPORT bool More() const;
0054
0055   Standard_EXPORT void Next();
0056
0057   Standard_EXPORT const TopoDS_Shape& Current() const;
0058
0059   Standard_EXPORT const TopOpeBRepTool_BoxSort& BoxSort() const;
0060
0061   Standard_EXPORT TopOpeBRepTool_BoxSort& ChangeBoxSort();
0062
0063   Standard_EXPORT int Index() const;
0064
0065   Standard_EXPORT Standard_OStream& DumpCurrent(Standard_OStream& OS) const;
0066
0067 private:
0068   TopOpeBRepTool_BoxSort          myBoxSort;
0069   NCollection_List<int>::Iterator myListIterator;
0070 };
0071
0072 #endif // _TopOpeBRep_ShapeScanner_HeaderFile