src/GeomAPI/GeomAPI_WireExplorer.h

   1 // Copyright (C) 2014-2021  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_Edge;
  27 class GeomAPI_Shape;
  28 class GeomAPI_Vertex;
  29 class GeomAPI_Wire;
  30
  31 /** \class GeomAPI_WireExplorer
  32  *  \ingroup DataModel
  33  *  \brief This class is used to explore edges of wire in the order of connectivity.
  34  */
  35 class GeomAPI_WireExplorer : public GeomAPI_Interface
  36 {
  37 public:
  38   /// Default constructor. Creates an empty explorer, becomes usefull after Init.
  39   GEOMAPI_EXPORT GeomAPI_WireExplorer();
  40
  41   /** \brief Constructs an iterator on a wire.
  42    *  \param[in] theWire a wire to explore.
  43    */
  44   GEOMAPI_EXPORT GeomAPI_WireExplorer(const std::shared_ptr<GeomAPI_Wire>& theWire);
  45
  46   /** \brief Resets this explorer.
  47    *  \param[in] theWire a wire to explore.
  48    */
  49   GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Wire>& theWire);
  50
  51   /// \return true if there are more shapes in the exploration.
  52   GEOMAPI_EXPORT bool more() const;
  53
  54   /// Moves to the next Shape in the exploration or do nothing
  55   /// if there are no more shapes to explore.
  56   GEOMAPI_EXPORT void next();
  57
  58   /// \return the current edge in the exploration or empty pointer
  59   /// if this explorer has no more shapes to explore.
  60   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Edge> current();
  61
  62   /// \return the current vertex in the exploration or empty pointer
  63   /// if this explorer has no more shapes to explore.
  64   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Vertex> currentVertex();
  65
  66   /// Clears the content of the explorer. It will return False on more().
  67   GEOMAPI_EXPORT void clear();
  68 };
  69
  70 #endif