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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #ifndef FEATURESAPI_SYMMETRY_H_
21 #define FEATURESAPI_SYMMETRY_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_Symmetry.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
30 class ModelHighAPI_Double;
31 class ModelHighAPI_Dumper;
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_Symmetry
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for Symmetry feature.
37 class FeaturesAPI_Symmetry: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
46 explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47 const std::list<ModelHighAPI_Selection>& theMainObjects,
48 const ModelHighAPI_Selection& theObject);
52 virtual ~FeaturesAPI_Symmetry();
54 INTERFACE_5(FeaturesPlugin_Symmetry::ID(),
55 creationMethod, FeaturesPlugin_Symmetry::CREATION_METHOD(),
56 ModelAPI_AttributeString, /** Creation method */,
57 mainObjects, FeaturesPlugin_Symmetry::OBJECTS_LIST_ID(),
58 ModelAPI_AttributeSelectionList, /** Main objects */,
59 pointObject, FeaturesPlugin_Symmetry::POINT_OBJECT_ID(),
60 ModelAPI_AttributeSelection, /** Point object */,
61 axisObject, FeaturesPlugin_Symmetry::AXIS_OBJECT_ID(),
62 ModelAPI_AttributeSelection, /** Axis object */,
63 planeObject, FeaturesPlugin_Symmetry::PLANE_OBJECT_ID(),
64 ModelAPI_AttributeSelection, /** Plane object */)
68 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
70 /// Modify CreationMethod, point_object attribute of the feature.
72 void setPoint(const ModelHighAPI_Selection& thePointObject);
74 /// Modify CreationMethod, axis_object attribute of the feature.
76 void setAxis(const ModelHighAPI_Selection& theAxisObject);
78 /// Modify CreationMethod, plane_object attribute of the feature.
80 void setPlane(const ModelHighAPI_Selection& thePlaneObject);
82 /// Dump wrapped feature
84 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
87 /// Pointer on Symmetry object.
88 typedef std::shared_ptr<FeaturesAPI_Symmetry> SymmetryPtr;
90 /// \ingroup CPPHighAPI
91 /// \brief Create Symmetry feature.
93 SymmetryPtr addSymmetry(const std::shared_ptr<ModelAPI_Document>& thePart,
94 const std::list<ModelHighAPI_Selection>& theMainObjects,
95 const ModelHighAPI_Selection& theObject);
97 #endif // FEATURESAPI_SYMMETRY_H_