X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2FFeaturesPlugin_Boolean.h;h=6fe5a24d623432c64a60cba9d3a4fbc00b29c382;hb=36d073223602690de9598f17b40ba2f61e55b0a7;hp=2f99dbdf42314c5312b7c5f34e6771c0501a919a;hpb=5e2e5c8e92f1d022158ef717c711a8ea79e5dd13;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/FeaturesPlugin_Boolean.h b/src/FeaturesPlugin/FeaturesPlugin_Boolean.h index 2f99dbdf4..6fe5a24d6 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_Boolean.h +++ b/src/FeaturesPlugin/FeaturesPlugin_Boolean.h @@ -1,75 +1,238 @@ -// File: FeaturesPlugin_Boolean.h -// Created: 02 Sept 2014 -// Author: Vitaly SMETANNIKOV +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// 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 FeaturesPlugin_Cut_H_ -#define FeaturesPlugin_Cut_H_ +#ifndef FeaturesPlugin_Boolean_H_ +#define FeaturesPlugin_Boolean_H_ #include "FeaturesPlugin.h" +#include "FeaturesPlugin_Tools.h" + +#include +#include + #include -#include -#include +class ModelAPI_Result; +class GeomAlgoAPI_MakeShapeList; + +/// \class FeaturesPlugin_Boolean +/// \ingroup Plugins +/// \brief Feature for applying of Boolean operations on Solids. +/// Supports four kinds of Boolean operations: Cut, Fuse, Common and Smash. class FeaturesPlugin_Boolean : public ModelAPI_Feature { - public: - /// Extrusion kind - inline static const std::string& ID() - { - static const std::string MY_CUT_ID("Boolean"); - return MY_CUT_ID; - } - /// attribute name of referenced object - inline static const std::string& OBJECT_ID() +public: + enum OperationType { + BOOL_CUT, + BOOL_FUSE, + BOOL_COMMON, + BOOL_FILL, + BOOL_SMASH + }; + + /// Attribute name of main objects. + inline static const std::string& OBJECT_LIST_ID() { - static const std::string MY_OBJECT_ID("main_object"); - return MY_OBJECT_ID; + static const std::string MY_OBJECT_LIST_ID("main_objects"); + return MY_OBJECT_LIST_ID; } - /// attribute name of tool object - inline static const std::string& TOOL_ID() + + /// Attribute name of tool objects. + inline static const std::string& TOOL_LIST_ID() { - static const std::string MY_TOOL_ID("tool_object"); - return MY_TOOL_ID; + static const std::string MY_TOOL_LIST_ID("tool_objects"); + return MY_TOOL_LIST_ID; } - /// attribute name of operation type - inline static const std::string& TYPE_ID() + + /// Attribute name of the version of Boolean feature + inline static const std::string& VERSION_ID() { - static const std::string MY_TOOL_ID("bool_type"); - return MY_TOOL_ID; + static const std::string MY_VERSION_ID("version"); + return MY_VERSION_ID; } - enum { - BOOL_CUT, - BOOL_FUSE, - BOOL_COMMON + /// \return boolean operation type. + FEATURESPLUGIN_EXPORT OperationType operationType(); + + /// Request for initialization of data model of the feature: adding all attributes. + FEATURESPLUGIN_EXPORT virtual void initAttributes(); + +protected: + + /// Use plugin manager for features creation. + FeaturesPlugin_Boolean(const OperationType theOperationType); + + /// Initialize version field of the Boolean feature. + /// The version is initialized for newly created features, + /// not read from previously stored document. + void initVersion(const int theVersion); + + /// Load Naming data structure of the feature to the document + void loadNamingDS(std::shared_ptr theResultBody, + const std::shared_ptr theBaseShape, + const ListOfShape& theTools, + const std::shared_ptr theResultShape, + const GeomMakeShapePtr& theMakeShape); + + + /// Auxiliary class to store hierarchy of Boolean operation objects/tools + /// and their parent shapes (compounds or compsolids) + class ObjectHierarchy { + typedef std::pair ShapeAndSubshapes; + typedef std::map MapShapeToParent; + typedef std::map MapShapeToIndex; + typedef std::set SetOfShape; + + ListOfShape myObjects; ///< list of objects/tools of Boolean operation + MapShapeToParent myParent; ///< refer a shape to compound/compsolid containing it + /// indices of compounds/compsolids to keep the order of parent shapes + /// corresponding to the order of objects + MapShapeToIndex myParentIndices; + /// list of shape and its subshapes stored according to the index of parent shape + std::vector mySubshapes; + + SetOfShape myProcessedObjects; + + public: + /// Add object of Boolean opration + void AddObject(const GeomShapePtr& theObject); + + /// Maps shape and its parent + void AddParent(const GeomShapePtr& theShape, const GeomShapePtr& theParent); + + /// Return parent shape for the given, or empty if it is a high-level shape. + /// By default, the parent and all its subshapes are marked as processed for further skip. + GeomShapePtr Parent(const GeomShapePtr& theShape, bool theMarkProcessed = true); + + /// Split compound/compsolid shape for subshapes selected for Boolean operation and the other. + void SplitCompound(const GeomShapePtr& theCompShape, + ListOfShape& theUsed, + ListOfShape& theNotUsed) const; + + /// Generates the list of top-level compounds, which contain the objects of Boolean operation. + /// The generated list will contain only shapes unused during the Boolean operation. + void CompoundsOfUnusedObjects(ListOfShape& theDestination) const; + + /// Return \c true if there is no object in hierarchy + bool IsEmpty() const; + + /// Return list of objects + const ListOfShape& Objects() const { return myObjects; } + /// Separate objects of the given range of types and all other objects + void ObjectsByType(ListOfShape& theShapesByType, ListOfShape& theOtherShapes, + const GeomAPI_Shape::ShapeType theMinType = GeomAPI_Shape::COMPOUND, + const GeomAPI_Shape::ShapeType theMaxType = GeomAPI_Shape::SHAPE) const; + + private: + GeomShapePtr collectUnusedSubs(const GeomShapePtr theTopLevelCompound, + const SetOfShape& theUsed) const; + + public: + class Iterator { + friend class ObjectHierarchy; + + ObjectHierarchy* myHierarchy; + ListOfShape::iterator myObject; + + Iterator() {} + Iterator(ObjectHierarchy* theHierarchy, bool isBegin = true); + + void SkipAlreadyProcessed(); + + public: + bool operator==(const Iterator&) const; + bool operator!=(const Iterator&) const; + + Iterator& operator++(); + Iterator operator++(int); + + GeomShapePtr operator*() const; + }; + + Iterator Begin(); + Iterator End(); }; + /// Process SelectionList attribute and fill the objects hierarchy. + bool processAttribute(const std::string& theAttributeName, + ObjectHierarchy& theObjects, + ListOfShape& thePlanesList); - /// Returns the kind of a feature - FEATURESPLUGIN_EXPORT virtual const std::string& getKind() - { - static std::string MY_KIND = FeaturesPlugin_Boolean::ID(); - return MY_KIND; - } + /// Perform Boolean operation of the object with the tools. + /// In case of theResultCompound is not empty, the result of Boolean operation + /// is added to this compound, and corresponding ResultBody is not generated. + /// \return \c false if something went wrong + bool processObject(const GeomAlgoAPI_Tools::BOPType theBooleanType, + const GeomShapePtr& theObject, + const ListOfShape& theTools, + const ListOfShape& thePlanes, + int& theResultIndex, + std::vector& theResultBaseAlgoList, + ListOfShape& theResultShapesList, + GeomShapePtr theResulCompound = GeomShapePtr()); - /// Creates a new part document if needed - FEATURESPLUGIN_EXPORT virtual void execute(); + /// Perform Boolean operation of the Compsolid with the tools + /// In case of theResultCompound is not empty, the result of Boolean operation + /// is added to this compound, and corresponding ResultBody is not generated. + /// \return \c false if something went wrong + bool processCompsolid(const GeomAlgoAPI_Tools::BOPType theBooleanType, + const ObjectHierarchy& theCompsolidHierarchy, + const GeomShapePtr& theCompsolid, + const ListOfShape& theTools, + const ListOfShape& thePlanes, + int& theResultIndex, + std::vector& theResultBaseAlgoList, + ListOfShape& theResultShapesList, + GeomShapePtr theResulCompound = GeomShapePtr()); - /// Request for initialization of data model of the feature: adding all attributes - FEATURESPLUGIN_EXPORT virtual void initAttributes(); + /// Perform Boolean operation of the Compound with the tools + /// In case of theResultCompound is not empty, the result of Boolean operation + /// is added to this compound, and corresponding ResultBody is not generated. + /// \return \c false if something went wrong + bool processCompound(const GeomAlgoAPI_Tools::BOPType theBooleanType, + const ObjectHierarchy& theCompoundHierarchy, + const GeomShapePtr& theCompound, + const ListOfShape& theTools, + int& theResultIndex, + std::vector& theResultBaseAlgoList, + ListOfShape& theResultShapesList, + GeomShapePtr theResulCompound = GeomShapePtr()); + + /// Process unused sub-shapes of compounds. + /// Keep the compound hierarchy, but merge top-level compounds + /// into a single compound and add the result of the FUSE operation. + GeomShapePtr keepUnusedSubsOfCompound( + const GeomShapePtr& theResult, + const ObjectHierarchy& theObjectsHierarchy, + const ObjectHierarchy& theToolsHierarchy, + std::shared_ptr theMakeShapeList); - /// Use plugin manager for features creation - FeaturesPlugin_Boolean(); + /// Return version of the feature + int version(); private: - boost::shared_ptr getShape(const std::string& theAttrName); - - /// Load Naming data structure of the feature to the document - void LoadNamingDS(GeomAlgoAPI_Boolean* theFeature, - boost::shared_ptr theResultBody, - boost::shared_ptr theObject, - boost::shared_ptr theTool, - int theType); + void parentForShape(const GeomShapePtr& theShape, + const std::shared_ptr& theContext, + ObjectHierarchy& theShapesHierarchy); + +private: + OperationType myOperationType; }; #endif