src/GeomAlgoAPI/GeomAlgoAPI_WireBuilder.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAlgoAPI_WireBuilder.h
   4 // Created:     14 April 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef GeomAlgoAPI_WireBuilder_H_
   8 #define GeomAlgoAPI_WireBuilder_H_
   9
  10 #include "GeomAlgoAPI.h"
  11
  12 #include <GeomAPI_Shape.h>
  13
  14 /// \class GeomAlgoAPI_WireBuilder
  15 /// \ingroup DataAlgo
  16 /// \brief Allows to create wire-shapes by different parameters.
  17 class GeomAlgoAPI_WireBuilder
  18 {
  19  public:
  20    /// \brief Creates a wire from edges and wires.
  21    /// \param[in] theShapes list of shapes. Only edges and wires allowed.
  22    /// The edges are not to be consecutive. But they are to be all connected geometrically or topologically.
  23    /// \return wire created from theShapes. Empty in case of error or bad input.
  24    GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> wire(const ListOfShape& theShapes);
  25 };
  26
  27 #endif