FeaturesAPI_BooleanCommon.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef FeaturesAPI_BooleanCommon_H_
#define FeaturesAPI_BooleanCommon_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_BooleanCommon.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
#include <ModelHighAPI_Double.h>
 
class ModelHighAPI_Integer;
class ModelHighAPI_Selection;
 
class FeaturesAPI_BooleanCommon: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                            const std::list<ModelHighAPI_Selection>& theMainObjects,
                            const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
 
  FEATURESAPI_EXPORT
  FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                            const std::list<ModelHighAPI_Selection>& theMainObjects,
                            const std::list<ModelHighAPI_Selection>& theToolObjects,
                            const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_BooleanCommon();
 
  INTERFACE_5(FeaturesPlugin_BooleanCommon::ID(),
              creationMethod, FeaturesPlugin_BooleanCommon::CREATION_METHOD(),
              ModelAPI_AttributeString, ,
              mainObjects, FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID(),
              ModelAPI_AttributeSelectionList, ,
              toolObjects, FeaturesPlugin_BooleanCommon::TOOL_LIST_ID(),
              ModelAPI_AttributeSelectionList, ,
              useFuzzy, FeaturesPlugin_BooleanCommon::USE_FUZZY_ID(),
              ModelAPI_AttributeBoolean, ,
              fuzzyParam, FeaturesPlugin_BooleanCommon::FUZZY_PARAM_ID(),
              ModelAPI_AttributeDouble, )
 
  
  FEATURESAPI_EXPORT
  void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
 
  FEATURESAPI_EXPORT
  void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
 
  FEATURESAPI_EXPORT
  void setUseFuzzy(bool theUseFuzzy);
 
  FEATURESAPI_EXPORT
  void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
 
  FEATURESAPI_EXPORT
  void setAdvancedMode(const bool theMode);
 
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
 
FEATURESAPI_EXPORT BooleanCommonPtr addCommon(
    const std::shared_ptr<ModelAPI_Document>& part,
    const std::list<ModelHighAPI_Selection>& objects,
    const std::list<ModelHighAPI_Selection>& tools = std::list<ModelHighAPI_Selection>(),
    const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(-1),
    const bool keepSubResults = false);
 
#endif // FeaturesAPI_BooleanCommon_H_