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 FEATURESAPI_SYMMETRY_H_
22 #define FEATURESAPI_SYMMETRY_H_
24 #include "FeaturesAPI.h"
26 #include <FeaturesPlugin_Symmetry.h>
28 #include <ModelHighAPI_Interface.h>
29 #include <ModelHighAPI_Macro.h>
31 class ModelHighAPI_Double;
32 class ModelHighAPI_Dumper;
33 class ModelHighAPI_Selection;
35 /// \class FeaturesAPI_Symmetry
36 /// \ingroup CPPHighAPI
37 /// \brief Interface for Symmetry feature.
38 class FeaturesAPI_Symmetry: public ModelHighAPI_Interface
41 /// Constructor without values.
43 explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature);
45 /// Constructor with values.
47 explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature,
48 const std::list<ModelHighAPI_Selection>& theMainObjects,
49 const ModelHighAPI_Selection& theObject);
53 virtual ~FeaturesAPI_Symmetry();
55 INTERFACE_5(FeaturesPlugin_Symmetry::ID(),
56 creationMethod, FeaturesPlugin_Symmetry::CREATION_METHOD(),
57 ModelAPI_AttributeString, /** Creation method */,
58 mainObjects, FeaturesPlugin_Symmetry::OBJECTS_LIST_ID(),
59 ModelAPI_AttributeSelectionList, /** Main objects */,
60 pointObject, FeaturesPlugin_Symmetry::POINT_OBJECT_ID(),
61 ModelAPI_AttributeSelection, /** Point object */,
62 axisObject, FeaturesPlugin_Symmetry::AXIS_OBJECT_ID(),
63 ModelAPI_AttributeSelection, /** Axis object */,
64 planeObject, FeaturesPlugin_Symmetry::PLANE_OBJECT_ID(),
65 ModelAPI_AttributeSelection, /** Plane object */)
69 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
71 /// Modify CreationMethod, point_object attribute of the feature.
73 void setPoint(const ModelHighAPI_Selection& thePointObject);
75 /// Modify CreationMethod, axis_object attribute of the feature.
77 void setAxis(const ModelHighAPI_Selection& theAxisObject);
79 /// Modify CreationMethod, plane_object attribute of the feature.
81 void setPlane(const ModelHighAPI_Selection& thePlaneObject);
83 /// Dump wrapped feature
85 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
88 /// Pointer on Symmetry object.
89 typedef std::shared_ptr<FeaturesAPI_Symmetry> SymmetryPtr;
91 /// \ingroup CPPHighAPI
92 /// \brief Create Symmetry feature.
94 SymmetryPtr addSymmetry(const std::shared_ptr<ModelAPI_Document>& thePart,
95 const std::list<ModelHighAPI_Selection>& theMainObjects,
96 const ModelHighAPI_Selection& theObject);
98 #endif // FEATURESAPI_SYMMETRY_H_