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