Salome HOME
Updated copyright comment
[modules/shaper.git] / src / GeomAPI / GeomAPI_Wire.h
index de849ef9391376b870c22321976f9c6d7e783d1c..e0f2651bcbc09db6cb41a2ab285ea95b70498f02 100644 (file)
@@ -1,43 +1,56 @@
-// File:        GeomAPI_Wire.hxx
-// Created:     24 Jul 2014
-// Author:      Artem ZHIDKOV
-
-#ifndef GEOMAPI_WIRE_H_
-#define GEOMAPI_WIRE_H_
-
-#include <GeomAPI.h>
-#include <GeomAPI_Edge.h>
-
-#include <boost/smart_ptr/shared_ptr.hpp>
-
-#include <list>
-
-/**\class GeomAPI_Wire
- * \ingroup DataModel
- * \brief Interface to the edge object
- */
-
-class GEOMAPI_EXPORT GeomAPI_Wire : public GeomAPI_Shape
+// Copyright (C) 2014-2024  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+#ifndef GeomAPI_Wire_H_
+#define GeomAPI_Wire_H_
+
+#include "GeomAPI_Shape.h"
+
+class GeomAPI_Pnt;
+
+/// \class GeomAPI_Wire
+/// \ingroup DataModel
+/// \brief Interface to the wire object
+class GeomAPI_Wire: public GeomAPI_Shape
 {
- public:
-  /// Creation of empty (null) shape
-  GeomAPI_Wire();
+public:
+  /// Makes an undefined Wire.
+  GEOMAPI_EXPORT GeomAPI_Wire();
+
+  /// Creation of wire by the wire-shape
+  GEOMAPI_EXPORT GeomAPI_Wire(const std::shared_ptr<GeomAPI_Shape>& theShape);
 
-  virtual bool isVertex() const
-  {
-    return false;
-  }
+  /// Returns "closed" status of the wire
+  GEOMAPI_EXPORT bool isClosed() const;
 
-  /// Returns whether the shape is an edge
-  virtual bool isEdge() const
-  {
-    return false;
-  }
+  /// Returns \c true if the wire is a polygon
+  /// \param[out] thePoints  vertices of the polygon
+  GEOMAPI_EXPORT bool isPolygon(std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints) const;
 
-  void addEdge(boost::shared_ptr<GeomAPI_Shape> theEdge);
-  std::list<boost::shared_ptr<GeomAPI_Shape> > getEdges();
+  /// Returns \c true if the wire is a rectangle
+  /// \param[out] thePoints  corners of the rectangle
+  GEOMAPI_EXPORT bool isRectangle(std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints) const;
 
+  /// Return middle point on the wire
+  GEOMAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
 };
 
-#endif
+typedef std::shared_ptr<GeomAPI_Wire> GeomWirePtr;
 
+#endif