src/GeomAlgoAPI/GeomAlgoAPI_Offset.h

   1 // Copyright (C) 2019-2019  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 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 #include <GeomAPI_Pln.h>
  27
  28 /// \class GeomAlgoAPI_Offset
  29 /// \ingroup DataAlgo
  30 /// \brief Perform 3D offset for the shape
  31 class GeomAlgoAPI_Offset : public GeomAlgoAPI_MakeShape
  32 {
  33 public:
  34   /// \brief Construct offset.
  35   GEOMALGOAPI_EXPORT GeomAlgoAPI_Offset(const GeomShapePtr& theShape,
  36                                         const double theOffsetValue);
  37
  38   /// \return the list of shapes generated from the shape \a theShape.
  39   /// \param[in] theOldShape base shape.
  40   /// \param[out] theNewShapes shapes generated from \a theShape. Does not cleared!
  41   GEOMALGOAPI_EXPORT virtual void generated(const GeomShapePtr theOldShape,
  42                                             ListOfShape& theNewShapes);
  43
  44   /// \return a compound of offset wires
  45   /// \param[in] thePlane base plane for all offsets
  46   /// \param[in] theEdgesAndWires base shapes
  47   /// \param[in] theOffsetValue offset distance, it can be negative
  48   //GEOMALGOAPI_EXPORT static GeomShapePtr OffsetInPlane (const std::shared_ptr<GeomAPI_Pln>& thePlane,
  49   //                                                      const ListOfShape& theEdgesAndWires,
  50   //                                                      const double theOffsetValue);
  51   GEOMALGOAPI_EXPORT static GeomShapePtr OffsetInPlane (const std::shared_ptr<GeomAPI_Pln>& thePlane,
  52                                                         const GeomShapePtr& theEdgeOrWire,
  53                                                         const double theOffsetValue);
  54
  55 private:
  56   /// \brief Perform offset operation
  57   void build(const GeomShapePtr& theShape, const double theOffsetValue);
  58 };
  59
  60 #endif