src/GeomAPI/GeomAPI_ShapeIterator.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef GeomAPI_ShapeIterator_H_
  22 #define GeomAPI_ShapeIterator_H_
  23
  24 #include "GeomAPI.h"
  25 #include "GeomAPI_Shape.h"
  26
  27 /// \class GeomAPI_ShapeIterator
  28 /// \ingroup DataModel
  29 /// \brief Iterates on the underlying shape underlying a given GeomAPI_Shape object,
  30 ///        providing access
  31 ///        to its component sub-shapes. Each component shape is returned as a GeomAPI_Shape with
  32 ///        an orientation, and a compound of the original values and the relative values.
  33 class GeomAPI_ShapeIterator : public GeomAPI_Interface
  34 {
  35 public:
  36   /// Default constructor. Creates an empty iterator, becomes usefull after Init.
  37   GEOMAPI_EXPORT GeomAPI_ShapeIterator();
  38
  39   /// \brief Creates an iterator on theShape sub-shapes.
  40   /// \param[in] theShape shape to iterate.
  41   GEOMAPI_EXPORT GeomAPI_ShapeIterator(const std::shared_ptr<GeomAPI_Shape> theShape);
  42
  43   /// \brief Initializes this iterator with theShape.
  44   /// \param[in] theShape shape to iterate.
  45   GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Shape> theShape);
  46
  47   /// \return  true if there is another sub-shape in the shape which this iterator is scanning.
  48   GEOMAPI_EXPORT bool more() const;
  49
  50   /// Moves on to the next sub-shape in the shape which this iterator is scanning.
  51   GEOMAPI_EXPORT void next();
  52
  53   /// \return the current sub-shape in the shape which this iterator is scanning.
  54   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> current();
  55 };
  56
  57 #endif