src/GeomAPI/GeomAPI_Wire.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_Wire_H_
  21 #define GeomAPI_Wire_H_
  22
  23 #include "GeomAPI_Shape.h"
  24
  25 class GeomAPI_Pnt;
  26
  27 /// \class GeomAPI_Wire
  28 /// \ingroup DataModel
  29 /// \brief Interface to the wire object
  30 class GeomAPI_Wire: public GeomAPI_Shape
  31 {
  32 public:
  33   /// Makes an undefined Wire.
  34   GEOMAPI_EXPORT GeomAPI_Wire();
  35
  36   /// Creation of wire by the wire-shape
  37   GEOMAPI_EXPORT GeomAPI_Wire(const std::shared_ptr<GeomAPI_Shape>& theShape);
  38
  39   /// Returns "closed" status of the wire
  40   GEOMAPI_EXPORT bool isClosed() const;
  41
  42   /// Returns \c true if the wire is a polygon
  43   /// \param[out] thePoints  vertices of the polygon
  44   GEOMAPI_EXPORT bool isPolygon(std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints) const;
  45
  46   /// Returns \c true if the wire is a rectangle
  47   /// \param[out] thePoints  corners of the rectangle
  48   GEOMAPI_EXPORT bool isRectangle(std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints) const;
  49
  50   /// Return middle point on the wire
  51   GEOMAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
  52 };
  53
  54 typedef std::shared_ptr<GeomAPI_Wire> GeomWirePtr;
  55
  56 #endif