src/GeomAlgoAPI/GeomAlgoAPI_Offset.h

   1 // Copyright (C) 2019-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 GeomAlgoAPI_Offset_H_
  21 #define GeomAlgoAPI_Offset_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 class GeomAPI_Pln;
  27
  28 /// \enum GeomAlgoAPI_OffsetJoint
  29 /// \brief Type of joint of straight edges in 2D offset
  30 /// \a KeepDistance Keep the distance from initial contour to the resulting one,
  31 ///    creating contour from lines and arcs where it is needed
  32 /// \a Arcs On connection of straight edges, tangent arcs are created,
  33 ///    except the case of too short edges. Radius of arcs equals to the offset value.
  34 /// \a Lines No arcs is created on the connection of the resulting lines,
  35 ///    adjacent lines are prolonged to the point of their intersection.
  36 enum class GeomAlgoAPI_OffsetJoint { KeepDistance, Arcs, Lines };
  37
  38 /// \class GeomAlgoAPI_Offset
  39 /// \ingroup DataAlgo
  40 /// \brief Perform 3D offset for the shape
  41 class GeomAlgoAPI_Offset : public GeomAlgoAPI_MakeShape
  42 {
  43 public:
  44   /// \brief Construct offset.
  45   GEOMALGOAPI_EXPORT GeomAlgoAPI_Offset(const GeomShapePtr& theShape,
  46                                         const double theOffsetValue);
  47
  48   /// \brief Perform the offset algorithm on the plane
  49   /// \param[in] thePlane base plane for all offsets
  50   /// \param[in] theEdgesOrWire base shapes
  51   /// \param[in] theOffsetValue offset distance, it can be negative
  52   /// \param[in] theJointType type of joint of straight edges
  53   GEOMALGOAPI_EXPORT GeomAlgoAPI_Offset
  54     (const std::shared_ptr<GeomAPI_Pln>& thePlane,
  55      const GeomShapePtr& theEdgeOrWire,
  56      const double theOffsetValue,
  57      const GeomAlgoAPI_OffsetJoint theJoint = GeomAlgoAPI_OffsetJoint::KeepDistance,
  58      const bool theIsApprox = false);
  59
  60   /// \return the list of shapes generated from the shape \a theShape.
  61   /// \param[in] theOldShape base shape.
  62   /// \param[out] theNewShapes shapes generated from \a theShape. Does not cleared!
  63   GEOMALGOAPI_EXPORT virtual void generated(const GeomShapePtr theOldShape,
  64                                             ListOfShape& theNewShapes);
  65
  66
  67 private:
  68   /// \brief Perform offset operation
  69   void build(const GeomShapePtr& theShape, const double theOffsetValue);
  70 };
  71
  72 #endif