X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_BodyBuilder.h;h=d551a0104b10cc9f5695c1c249286ae65008ee8d;hb=65fb6fac9731831e7197d0841e4444e69eb7d7ce;hp=ff43ca7c454dc375fe6e19e128d1642309635e48;hpb=35d4b199e4d3581615470404d47e3bfae4def046;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_BodyBuilder.h b/src/ModelAPI/ModelAPI_BodyBuilder.h index ff43ca7c4..d551a0104 100755 --- a/src/ModelAPI/ModelAPI_BodyBuilder.h +++ b/src/ModelAPI/ModelAPI_BodyBuilder.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_BodyBuilder.hxx -// Created: 07 Jul 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 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 ModelAPI_BodyBuilder_H_ #define ModelAPI_BodyBuilder_H_ @@ -20,6 +34,7 @@ class ModelAPI_Object; /**\class ModelAPI_BodyBuilder * \ingroup DataModel + * \brief Extra API for the ResultBody that allows to work with naming. */ class ModelAPI_BodyBuilder { @@ -27,78 +42,80 @@ public: MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {}; /// Stores the shape (called by the execution method). - virtual void store(const std::shared_ptr& theShape) = 0; + virtual void store(const GeomShapePtr& theShape, + const bool theIsStoreSameShapes = true) = 0; /// Stores the generated shape (called by the execution method). - virtual void storeGenerated(const std::shared_ptr& theFromShape, - const std::shared_ptr& theToShape) = 0; + virtual void storeGenerated(const GeomShapePtr& theFromShape, + const GeomShapePtr& theToShape) = 0; /// Stores the modified shape (called by the execution method). - virtual void storeModified(const std::shared_ptr& theOldShape, - const std::shared_ptr& theNewShape, - const int theDecomposeSolidsTag = 0) = 0; + virtual void storeModified(const GeomShapePtr& theOldShape, + const GeomShapePtr& theNewShape, + const bool theIsCleanStored = true) = 0; /// Stores the shape without naming support - virtual void storeWithoutNaming(const std::shared_ptr& theShape) = 0; + virtual void storeWithoutNaming(const GeomShapePtr& theShape) = 0; /// Returns the shape-result produced by this feature - virtual std::shared_ptr shape() = 0; + virtual GeomShapePtr shape() = 0; /// Records the subshape newShape which was generated during a topological construction. /// As an example, consider the case of a face generated in construction of a box. - virtual void generated( - const std::shared_ptr& theNewShape, const std::string& theName, const int theTag = 1) = 0; + /// Returns true if it is stored correctly (the final shape contains this new sub-shape) + virtual bool generated(const GeomShapePtr& theNewShape, + const std::string& theName, const bool theCheckIsInResult = true) = 0; - /// Records the shape newShape which was generated from the shape oldShape during a topological - /// construction. As an example, consider the case of a face generated from an edge in + /// Records the shape newShape which was generated from the shape oldShape during a topological + /// construction. As an example, consider the case of a face generated from an edge in /// construction of a prism. - virtual void generated(const std::shared_ptr& theOldShape, - const std::shared_ptr& theNewShape, const std::string& theName, const int theTag = 1) = 0; + virtual void generated(const GeomShapePtr& theOldShape, + const GeomShapePtr& theNewShape, + const std::string& theName = "") = 0; /// Records the shape newShape which is a modification of the shape oldShape. /// As an example, consider the case of a face split or merged in a Boolean operation. - virtual void modified(const std::shared_ptr& theOldShape, - const std::shared_ptr& theNewShape, const std::string& theName, const int theTag = 1) = 0; + virtual void modified(const GeomShapePtr& theOldShape, + const GeomShapePtr& theNewShape, + const std::string& theName = "") = 0; /// Records the shape oldShape which was deleted from the current label. /// As an example, consider the case of a face removed by a Boolean operation. - virtual void deleted( - const std::shared_ptr& theOldShape, const int theTag = 1) = 0; - + virtual void deleted(const GeomShapePtr& theOldShape) = 0; + /// load deleted shapes - virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS, - std::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag) = 0; + virtual void loadDeletedShapes(const GeomMakeShapePtr& theAlgo, + const GeomShapePtr& theOldShape, + const GeomAPI_Shape::ShapeType theShapeTypeToExplore, + const GeomShapePtr& theShapesToAvoid = GeomShapePtr()) = 0; + /// load and orient modified shapes - virtual void loadAndOrientModifiedShapes ( - GeomAlgoAPI_MakeShape* theMS, - std::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag, - const std::string& theName, - GeomAPI_DataMapOfShapeShape& theSubShapes) = 0; + virtual void loadModifiedShapes(const GeomMakeShapePtr& theAlgo, + const GeomShapePtr& theOldShape, + const GeomAPI_Shape::ShapeType theShapeTypeToExplore, + const std::string& theName = "") = 0; + /// load and orient generated shapes - virtual void loadAndOrientGeneratedShapes ( - GeomAlgoAPI_MakeShape* theMS, - std::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag, - const std::string& theName, - GeomAPI_DataMapOfShapeShape& theSubShapes) = 0; + virtual void loadGeneratedShapes(const GeomMakeShapePtr& theAlgo, + const GeomShapePtr& theOldShape, + const GeomAPI_Shape::ShapeType theShapeTypeToExplore, + const std::string& theName = "") = 0; /// load shapes of the first level (to be used during shape import) - virtual void loadFirstLevel(std::shared_ptr theShape, const std::string& theName, int& theTag) = 0; - + virtual void loadFirstLevel(GeomShapePtr theShape, + const std::string& theName) = 0; + /// load disconnected edges - virtual void loadDisconnectedEdges(std::shared_ptr theShape, const std::string& theName, int& theTag) = 0; + virtual void loadDisconnectedEdges(GeomShapePtr theShape, + const std::string& theName) = 0; /// load disconnected vetexes - virtual void loadDisconnectedVertexes(std::shared_ptr theShape, const std::string& theName,int& theTag) = 0; + virtual void loadDisconnectedVertexes(GeomShapePtr theShape, + const std::string& theName) = 0; - /// Converts evolution of sub-shapes stored in naming structure to selection - /// (theFlag = true) and back (theFlag = false) - virtual void evolutionToSelection(const bool theFlag) = 0; + /// Returns true if the latest modification of this body in the naming history + // is equal to the given shape + virtual bool isLatestEqual(const GeomShapePtr& theShape) = 0; protected: /// Returns the data manager of this object: attributes @@ -108,9 +125,10 @@ protected: MODELAPI_EXPORT virtual std::shared_ptr document() const; protected: + /// Deafult constructor accessible only from Model_Object MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner); - ModelAPI_Object* myOwner; + ModelAPI_Object* myOwner; ///< the owner object this builder belongs to }; //! Pointer on feature object