1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GEOMALGOAPI_SYMMETRY_H_
22 #define GEOMALGOAPI_SYMMETRY_H_
24 #include <GeomAlgoAPI.h>
25 #include <GeomAlgoAPI_MakeShape.h>
27 #include <GeomAPI_Pnt.h>
28 #include <GeomAPI_Ax1.h>
29 #include <GeomAPI_Ax2.h>
31 /// \class GeomAlgoAPI_Symmetry
33 /// \brief Creates a copy of the object by performing a symmetry operation by a point,
34 /// by an axis or by a plane.
35 class GeomAlgoAPI_Symmetry : public GeomAlgoAPI_MakeShape
38 /// Type of symmetry operation
40 BY_POINT, ///< Symmetry by point.
41 BY_AXIS, ///< Symmetry by axis.
42 BY_PLANE ///< Symmetry by plane.
45 /// \brief Creates an object which is obtained from current object by performing
46 /// a symmetry operation by a point.
47 /// \param[in] theSourceShape the shape to be moved.
48 /// \param[in] thePoint the symmetry point.
49 GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
50 std::shared_ptr<GeomAPI_Pnt> thePoint);
52 /// \brief Creates an object which is obtained from current object by performing
53 /// a symmetry operation by a point.
54 /// \param[in] theSourceShape the shape to be moved.
55 /// \param[in] theAxis the symmetry axis.
56 GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
57 std::shared_ptr<GeomAPI_Ax1> theAxis);
59 /// \brief Creates an object which is obtained from current object by performing
60 /// a symmetry operation by a point.
61 /// \param[in] theSourceShape the shape to be moved.
62 /// \param[in] thePlane the symmetry plane.
63 GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
64 std::shared_ptr<GeomAPI_Ax2> thePlane);
66 /// Checks if data for the symmetry execution is OK.
67 GEOMALGOAPI_EXPORT bool check();
69 /// Execute the symmetry.
70 GEOMALGOAPI_EXPORT void build();
73 MethodType myMethodType; /// Type of method used.
74 std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be moved.
75 std::shared_ptr<GeomAPI_Pnt> myPoint; /// Reflection point.
76 std::shared_ptr<GeomAPI_Ax1> myAxis; /// Reflection axis.
77 std::shared_ptr<GeomAPI_Ax2> myPlane; /// Reflection plane.
80 #endif // GEOMALGOAPI_SYMMETRY_H_