include/opencascade/BRepSweep_Iterator.hxx

0001 // Created on: 1993-06-08
0002 // Created by: Laurent BOURESCHE
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 _BRepSweep_Iterator_HeaderFile
0018 #define _BRepSweep_Iterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopoDS_Iterator.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <TopAbs_Orientation.hxx>
0027 class TopoDS_Shape;
0028
0029 //! This class provides iteration services required by
0030 //! the Generating Line (TopoDS Shape) of a BRepSweep.
0031 //! This   tool is  used  to   iterate  on the  direct
0032 //! sub-shapes of a Shape.
0033 class BRepSweep_Iterator
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   Standard_EXPORT BRepSweep_Iterator();
0039
0040   //! Reset the Iterator on sub-shapes of <aShape>.
0041   Standard_EXPORT void Init(const TopoDS_Shape& aShape);
0042
0043   //! Returns True if there is a current sub-shape.
0044   Standard_Boolean More() const;
0045
0046   //! Moves to the next sub-shape.
0047   Standard_EXPORT void Next();
0048
0049   //! Returns the current sub-shape.
0050   const TopoDS_Shape& Value() const;
0051
0052   //! Returns the orientation of the current sub-shape.
0053   TopAbs_Orientation Orientation() const;
0054
0055 protected:
0056 private:
0057   TopoDS_Iterator myIterator;
0058 };
0059
0060 #include <BRepSweep_Iterator.lxx>
0061
0062 #endif // _BRepSweep_Iterator_HeaderFile