1 // Copyright (C) 2014-2022 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
20 #ifndef FeaturesAPI_Partition_H_
21 #define FeaturesAPI_Partition_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_Partition.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 #include <ModelHighAPI_Double.h>
31 class ModelHighAPI_Dumper;
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_Partition
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for Partition feature.
37 class FeaturesAPI_Partition: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_Partition(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
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.e-8));
52 virtual ~FeaturesAPI_Partition();
54 INTERFACE_2(FeaturesPlugin_Partition::ID(),
55 baseObjects, FeaturesPlugin_Partition::BASE_OBJECTS_ID(),
56 ModelAPI_AttributeSelectionList, /** Base objects */,
57 fuzzyParam, FeaturesPlugin_Partition::FUZZY_PARAM_ID(),
58 ModelAPI_AttributeDouble, /** Fuzzy parameter */)
60 /// Modify base attribute of the feature.
62 void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
64 /// Modify fuzzy parameter attribute of the feature.
66 void setFuzzy(const ModelHighAPI_Double& theFuzzy);
68 /// Dump wrapped feature
70 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
73 /// Pointer on Partition object.
74 typedef std::shared_ptr<FeaturesAPI_Partition> PartitionPtr;
76 /// \ingroup CPPHighAPI
77 /// \brief Create Partition feature.
79 PartitionPtr addPartition(const std::shared_ptr<ModelAPI_Document>& thePart,
80 const std::list<ModelHighAPI_Selection>& theBaseObjects,
81 const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(1.e-8),
82 const bool keepSubResults = false);
84 #endif // FeaturesAPI_Partition_H_