updated copyright message

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Offset.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Offset.h b/src/GeomAlgoAPI/GeomAlgoAPI_Offset.h
index ee6d51062be446bc0171c595677ff6018dfd6fa2..f6afb6f319aa3bce05ab5d471bcd878f423580ed 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Offset.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Offset.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2019  CEA/DEN, EDF R&D
+// Copyright (C) 2019-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -23,7 +23,17 @@
 #include <GeomAlgoAPI.h>
 #include <GeomAlgoAPI_MakeShape.h>
 
-#include <GeomAPI_Pln.h>
+class GeomAPI_Pln;
+
+/// \enum GeomAlgoAPI_OffsetJoint
+/// \brief Type of joint of straight edges in 2D offset
+/// \a KeepDistance Keep the distance from initial contour to the resulting one,
+///    creating contour from lines and arcs where it is needed
+/// \a Arcs On connection of straight edges, tangent arcs are created,
+///    except the case of too short edges. Radius of arcs equals to the offset value.
+/// \a Lines No arcs is created on the connection of the resulting lines,
+///    adjacent lines are prolonged to the point of their intersection.
+enum class GeomAlgoAPI_OffsetJoint { KeepDistance, Arcs, Lines };
 
 /// \class GeomAlgoAPI_Offset
 /// \ingroup DataAlgo
@@ -35,22 +45,23 @@ public:
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Offset(const GeomShapePtr& theShape,
                                         const double theOffsetValue);
 
+  /// \brief Perform the offset algorithm on the plane
+  /// \param[in] thePlane base plane for all offsets
+  /// \param[in] theEdgesOrWire base shapes
+  /// \param[in] theOffsetValue offset distance, it can be negative
+  /// \param[in] theJointType type of joint of straight edges
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Offset
+    (const std::shared_ptr<GeomAPI_Pln>& thePlane,
+     const GeomShapePtr& theEdgeOrWire,
+     const double theOffsetValue,
+     const GeomAlgoAPI_OffsetJoint theJoint = GeomAlgoAPI_OffsetJoint::KeepDistance);
+
   /// \return the list of shapes generated from the shape \a theShape.
   /// \param[in] theOldShape base shape.
   /// \param[out] theNewShapes shapes generated from \a theShape. Does not cleared!
   GEOMALGOAPI_EXPORT virtual void generated(const GeomShapePtr theOldShape,
                                             ListOfShape& theNewShapes);
 
-  /// \return a compound of offset wires
-  /// \param[in] thePlane base plane for all offsets
-  /// \param[in] theEdgesAndWires base shapes
-  /// \param[in] theOffsetValue offset distance, it can be negative
-  //GEOMALGOAPI_EXPORT static GeomShapePtr OffsetInPlane (const std::shared_ptr<GeomAPI_Pln>& thePlane,
-  //                                                      const ListOfShape& theEdgesAndWires,
-  //                                                      const double theOffsetValue);
-  GEOMALGOAPI_EXPORT static GeomShapePtr OffsetInPlane (const std::shared_ptr<GeomAPI_Pln>& thePlane,
-                                                        const GeomShapePtr& theEdgeOrWire,
-                                                        const double theOffsetValue);
 
 private:
   /// \brief Perform offset operation