src/GeomAlgoAPI/GeomAlgoAPI_Symmetry.h

   1 // Copyright (C) 2014-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_SYMMETRY_H_
  21 #define GEOMALGOAPI_SYMMETRY_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <GeomAPI_Pnt.h>
  27 #include <GeomAPI_Ax1.h>
  28 #include <GeomAPI_Ax2.h>
  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_MakeShape
  35 {
  36 public:
  37   /// Type of symmetry operation
  38   enum MethodType {
  39     BY_POINT, ///< Symmetry by point.
  40     BY_AXIS,  ///< Symmetry by axis.
  41     BY_PLANE  ///< Symmetry by plane.
  42   };
  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] thePoint        the symmetry point.
  48   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  49                                           std::shared_ptr<GeomAPI_Pnt>   thePoint);
  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] theAxis         the symmetry axis.
  55   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  56                                           std::shared_ptr<GeomAPI_Ax1>   theAxis);
  57
  58   /// \brief Creates an object which is obtained from current object by performing
  59   ///        a symmetry operation by a point.
  60   /// \param[in] theSourceShape  the shape to be moved.
  61   /// \param[in] thePlane        the symmetry plane.
  62   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  63                                           std::shared_ptr<GeomAPI_Ax2>   thePlane);
  64
  65   /// Checks if data for the symmetry execution is OK.
  66   GEOMALGOAPI_EXPORT bool check();
  67
  68   /// Execute the symmetry.
  69   GEOMALGOAPI_EXPORT void build();
  70
  71 private:
  72   MethodType myMethodType; /// Type of method used.
  73   std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be moved.
  74   std::shared_ptr<GeomAPI_Pnt> myPoint; /// Reflection point.
  75   std::shared_ptr<GeomAPI_Ax1> myAxis; /// Reflection axis.
  76   std::shared_ptr<GeomAPI_Ax2> myPlane; /// Reflection plane.
  77 };
  78
  79 #endif // GEOMALGOAPI_SYMMETRY_H_