SHAPER  9.12.0
FeaturesAPI_Partition.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_Partition_H_
21 #define FeaturesAPI_Partition_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_Partition.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 #include <ModelHighAPI_Double.h>
30 
33 
38 {
39 public:
41  FEATURESAPI_EXPORT
42  explicit FeaturesAPI_Partition(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 
45  FEATURESAPI_EXPORT
46  explicit FeaturesAPI_Partition(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47  const std::list<ModelHighAPI_Selection>& theBaseObjects,
48  const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
49 
51  FEATURESAPI_EXPORT
52  virtual ~FeaturesAPI_Partition();
53 
54  INTERFACE_3(FeaturesPlugin_Partition::ID(),
61 
62 
63  FEATURESAPI_EXPORT
64  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
65 
67  FEATURESAPI_EXPORT
68  void setUseFuzzy(bool theUseFuzzy);
69 
71  FEATURESAPI_EXPORT
72  void setFuzzy(const ModelHighAPI_Double& theFuzzy);
73 
75  FEATURESAPI_EXPORT
76  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
77 };
78 
80 typedef std::shared_ptr<FeaturesAPI_Partition> PartitionPtr;
81 
84 FEATURESAPI_EXPORT
85 PartitionPtr addPartition(const std::shared_ptr<ModelAPI_Document>& thePart,
86  const std::list<ModelHighAPI_Selection>& theBaseObjects,
88  const bool keepSubResults = false);
89 
90 #endif // FeaturesAPI_Partition_H_
Interface for Partition feature.
Definition: FeaturesAPI_Partition.h:38
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_Partition.cpp:90
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > baseObjects() const
Base objects.
Definition: FeaturesAPI_Partition.h:60
void setBase(const std::list< ModelHighAPI_Selection > &theBaseObjects)
Modify base attribute of the feature.
Definition: FeaturesAPI_Partition.cpp:66
virtual std::shared_ptr< ModelAPI_AttributeBoolean > useFuzzy() const
Use Fuzzy parameter.
Definition: FeaturesAPI_Partition.h:60
void setUseFuzzy(bool theUseFuzzy)
Set use fuzzy parameter.
Definition: FeaturesAPI_Partition.cpp:74
virtual std::shared_ptr< ModelAPI_AttributeDouble > fuzzyParam() const
Fuzzy parameter.
Definition: FeaturesAPI_Partition.h:60
virtual ~FeaturesAPI_Partition()
Destructor.
Definition: FeaturesAPI_Partition.cpp:60
FeaturesAPI_Partition(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_Partition.cpp:30
void setFuzzy(const ModelHighAPI_Double &theFuzzy)
Modify fuzzy parameter attribute of the feature.
Definition: FeaturesAPI_Partition.cpp:82
static const std::string & USE_FUZZY_ID()
Attribute name of use fuzzy parameter.
Definition: FeaturesPlugin_Partition.h:50
static const std::string & BASE_OBJECTS_ID()
Attribute name of base objects.
Definition: FeaturesPlugin_Partition.h:43
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_Partition.h:36
static const std::string & FUZZY_PARAM_ID()
Attribute name of fuzzy parameter.
Definition: FeaturesPlugin_Partition.h:57
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains real value with double precision.
Definition: ModelAPI_AttributeDouble.h:34
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
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
PartitionPtr addPartition(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Double &fuzzyParam=ModelHighAPI_Double(-1), const bool keepSubResults=false)
Create Partition feature.
Definition: FeaturesAPI_Partition.cpp:112