src/GeomAPI/GeomAPI_WireExplorer.h

   1 // Copyright (C) 2014-2020  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAPI_WireExplorer_H_
  21 #define GeomAPI_WireExplorer_H_
  22
  23 #include <GeomAPI.h>
  24 #include <GeomAPI_Interface.h>
  25
  26 class GeomAPI_Shape;
  27 class GeomAPI_Wire;
  28
  29 /** \class GeomAPI_WireExplorer
  30  *  \ingroup DataModel
  31  *  \brief This class is used to explore edges of wire in the order of connectivity.
  32  */
  33 class GeomAPI_WireExplorer : public GeomAPI_Interface
  34 {
  35 public:
  36   /// Default constructor. Creates an empty explorer, becomes usefull after Init.
  37   GEOMAPI_EXPORT GeomAPI_WireExplorer();
  38
  39   /** \brief Constructs an iterator on a wire.
  40    *  \param[in] theWire a wire to explore.
  41    */
  42   GEOMAPI_EXPORT GeomAPI_WireExplorer(const std::shared_ptr<GeomAPI_Wire>& theWire);
  43
  44   /** \brief Resets this explorer.
  45    *  \param[in] theWire a wire to explore.
  46    */
  47   GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Wire>& theWire);
  48
  49   /// \return true if there are more shapes in the exploration.
  50   GEOMAPI_EXPORT bool more() const;
  51
  52   /// Moves to the next Shape in the exploration or do nothing
  53   /// if there are no more shapes to explore.
  54   GEOMAPI_EXPORT void next();
  55
  56   /// \return the current shape in the exploration or empty pointer
  57   /// if this explorer has no more shapes to explore.
  58   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> current();
  59
  60   /// Clears the content of the explorer. It will return False on more().
  61   GEOMAPI_EXPORT void clear();
  62 };
  63
  64 #endif