src/GeomAlgoAPI/GeomAlgoAPI_Symmetry.h

   1 // Copyright (C) 2014-2023  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_SYMMETRY_H_
  21 #define GEOMALGOAPI_SYMMETRY_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_Transform.h>
  25
  26 class GeomAPI_Ax1;
  27 class GeomAPI_Ax2;
  28 class GeomAPI_Pnt;
  29
  30 /// \class GeomAlgoAPI_Symmetry
  31 /// \ingroup DataAlgo
  32 /// \brief Creates a copy of the object by performing a symmetry operation by a point,
  33 ///        by an axis or by a plane.
  34 class GeomAlgoAPI_Symmetry : public GeomAlgoAPI_Transform
  35 {
  36 public:
  37   /// \brief Creates an object which is obtained from current object by performing
  38   ///        a symmetry operation by a point.
  39   /// \param[in] theSourceShape  the shape to be moved.
  40   /// \param[in] thePoint        the symmetry point.
  41   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  42                                           std::shared_ptr<GeomAPI_Pnt>   thePoint);
  43
  44   /// \brief Creates an object which is obtained from current object by performing
  45   ///        a symmetry operation by a point.
  46   /// \param[in] theSourceShape  the shape to be moved.
  47   /// \param[in] theAxis         the symmetry axis.
  48   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  49                                           std::shared_ptr<GeomAPI_Ax1>   theAxis);
  50
  51   /// \brief Creates an object which is obtained from current object by performing
  52   ///        a symmetry operation by a point.
  53   /// \param[in] theSourceShape  the shape to be moved.
  54   /// \param[in] thePlane        the symmetry plane.
  55   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  56                                           std::shared_ptr<GeomAPI_Ax2>   thePlane);
  57 };
  58
  59 #endif // GEOMALGOAPI_SYMMETRY_H_