SHAPER  9.12.0
FeaturesAPI_Symmetry.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 FEATURESAPI_SYMMETRY_H_
21 #define FEATURESAPI_SYMMETRY_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_Symmetry.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 
33 
38 {
39 public:
41  FEATURESAPI_EXPORT
42  explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 
45  FEATURESAPI_EXPORT
46  explicit FeaturesAPI_Symmetry(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47  const std::list<ModelHighAPI_Selection>& theMainObjects,
48  const ModelHighAPI_Selection& theObject,
49  bool theKeepOriginal = true);
50 
52  FEATURESAPI_EXPORT
53  virtual ~FeaturesAPI_Symmetry();
54 
55  INTERFACE_6(FeaturesPlugin_Symmetry::ID(),
68 
69 
70  FEATURESAPI_EXPORT
71  void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
72 
74  FEATURESAPI_EXPORT
75  void setPoint(const ModelHighAPI_Selection& thePointObject);
76 
78  FEATURESAPI_EXPORT
79  void setAxis(const ModelHighAPI_Selection& theAxisObject);
80 
82  FEATURESAPI_EXPORT
83  void setPlane(const ModelHighAPI_Selection& thePlaneObject);
84 
86  FEATURESAPI_EXPORT
87  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
88 };
89 
91 typedef std::shared_ptr<FeaturesAPI_Symmetry> SymmetryPtr;
92 
95 FEATURESAPI_EXPORT
96 SymmetryPtr addSymmetry(const std::shared_ptr<ModelAPI_Document>& part,
97  const std::list<ModelHighAPI_Selection>& objects,
98  const ModelHighAPI_Selection& basis,
99  const bool keepOriginal = true,
100  const bool keepSubResults = false);
101 
102 #endif // FEATURESAPI_SYMMETRY_H_
Interface for Symmetry feature.
Definition: FeaturesAPI_Symmetry.h:38
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > mainObjects() const
Main objects.
Definition: FeaturesAPI_Symmetry.h:67
void setPoint(const ModelHighAPI_Selection &thePointObject)
Modify CreationMethod, point_object attribute of the feature.
Definition: FeaturesAPI_Symmetry.cpp:68
virtual std::shared_ptr< ModelAPI_AttributeSelection > pointObject() const
Point object.
Definition: FeaturesAPI_Symmetry.h:67
void setMainObjects(const std::list< ModelHighAPI_Selection > &theMainObjects)
Set main objects.
Definition: FeaturesAPI_Symmetry.cpp:59
virtual std::shared_ptr< ModelAPI_AttributeSelection > axisObject() const
Axis object.
Definition: FeaturesAPI_Symmetry.h:67
void setPlane(const ModelHighAPI_Selection &thePlaneObject)
Modify CreationMethod, plane_object attribute of the feature.
Definition: FeaturesAPI_Symmetry.cpp:86
FeaturesAPI_Symmetry(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_Symmetry.cpp:26
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: FeaturesAPI_Symmetry.h:67
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_Symmetry.cpp:95
virtual std::shared_ptr< ModelAPI_AttributeSelection > planeObject() const
Plane object.
Definition: FeaturesAPI_Symmetry.h:67
virtual std::shared_ptr< ModelAPI_AttributeBoolean > keepOriginal() const
Keep original shape.
Definition: FeaturesAPI_Symmetry.h:67
virtual ~FeaturesAPI_Symmetry()
Destructor.
Definition: FeaturesAPI_Symmetry.cpp:54
void setAxis(const ModelHighAPI_Selection &theAxisObject)
Modify CreationMethod, axis_object attribute of the feature.
Definition: FeaturesAPI_Symmetry.cpp:77
static const std::string & ID()
Symmetry kind.
Definition: FeaturesPlugin_Symmetry.h:39
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_Symmetry.h:46
static const std::string & AXIS_OBJECT_ID()
Attribute name of an axis.
Definition: FeaturesPlugin_Symmetry.h:88
static const std::string & KEEP_ORIGINAL_RESULT()
Attribute name of keeping original shape.
Definition: FeaturesPlugin_Symmetry.h:102
static const std::string & POINT_OBJECT_ID()
Attribute name of a point.
Definition: FeaturesPlugin_Symmetry.h:81
static const std::string & OBJECTS_LIST_ID()
Attribute name of referenced objects.
Definition: FeaturesPlugin_Symmetry.h:74
static const std::string & PLANE_OBJECT_ID()
Attribute name of a plane.
Definition: FeaturesPlugin_Symmetry.h:95
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
Attribute that contains reference to the sub-shape of some result, the selected shape.
Definition: ModelAPI_AttributeSelection.h:35
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Class for filling ModelAPI_AttributeDouble.
Definition: ModelHighAPI_Double.h:37
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
SymmetryPtr addSymmetry(const std::shared_ptr< ModelAPI_Document > &part, const std::list< ModelHighAPI_Selection > &objects, const ModelHighAPI_Selection &basis, const bool keepOriginal=true, const bool keepSubResults=false)
Create Symmetry feature.
Definition: FeaturesAPI_Symmetry.cpp:130