X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_ResultBody.h;h=98a4b6a290c53f76da28f7e60c94c1f3d8597b3f;hb=ecd0a4691b938201f97329f61ecd001a361c2909;hp=c2eff7efcfa22b68d049d9b235045d75860b7a4f;hpb=cd9217d7e87997ec8bc150a6d8c389e742ca0f84;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_ResultBody.h b/src/ModelAPI/ModelAPI_ResultBody.h index c2eff7efc..98a4b6a29 100644 --- a/src/ModelAPI/ModelAPI_ResultBody.h +++ b/src/ModelAPI/ModelAPI_ResultBody.h @@ -1,58 +1,168 @@ -// File: ModelAPI_ResultBody.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_ResultBody_H_ #define ModelAPI_ResultBody_H_ #include "ModelAPI_Result.h" #include - +#include #include +class ModelAPI_BodyBuilder; +class GeomAlgoAPI_MakeShape; + /**\class ModelAPI_ResultBody - * \ingroup DataModel - * \brief The body (shape) result of a feature. - * - * Provides a shape that may be displayed in the viewer. - * May provide really huge results, so, working with this kind - * of result must be optimized. - */ +* \ingroup DataModel +* \brief The body (shape) result of a feature. +* +* Provides a shape that may be displayed in the viewer. +* May provide really huge results, so, working with this kind +* of result must be optimized. +*/ class ModelAPI_ResultBody : public ModelAPI_Result { - public: +public: + MODELAPI_EXPORT virtual ~ModelAPI_ResultBody(); /// Returns the group identifier of this result - virtual std::string groupName() - { - return group(); - } + MODELAPI_EXPORT virtual std::string groupName(); /// Returns the group identifier of this result - static std::string group() + inline static std::string group() { static std::string MY_GROUP = "Bodies"; return MY_GROUP; } - /// Stores the shape (called by the execution method). - virtual void store(const boost::shared_ptr& theShape) = 0; - /// Returns the shape-result produced by this feature - virtual boost::shared_ptr shape() = 0; - - /// To virtually destroy the fields of successors - virtual ~ModelAPI_ResultBody() + /// default color for a result body + inline static const std::string& DEFAULT_COLOR() { + static const std::string RESULT_BODY_COLOR("200,200,230"); + return RESULT_BODY_COLOR; } - protected: - /// Use plugin manager for features creation: this method is - /// defined here only for SWIG-wrapping - ModelAPI_ResultBody() + /// default deflection for a result body + inline static const std::string DEFAULT_DEFLECTION() { + return "0.0001"; } + + /// Iternal enumeration for storage the information of connected topology flag + enum ConnectedTopologyFlag { + ConnectionNotComputed, ///< not yet computed + IsConnected, ///< the topology is connected + IsNotConnected ///< the topology is connected + }; + /// Keeps (not persistently) the connected topology flag + ConnectedTopologyFlag myConnect; + + /// \brief Stores the shape (called by the execution method). + /// param[in] theShape shape to store. + /// param[in] theIsStoreSameShapes if false stores reference to the same shape + /// if it is already in document. + MODELAPI_EXPORT virtual void store(const std::shared_ptr& theShape, + const bool theIsStoreSameShapes = true); + + /// Stores the generated shape (called by the execution method). + MODELAPI_EXPORT virtual void storeGenerated(const std::shared_ptr& theFromShape, + const std::shared_ptr& theToShape); + + /// Stores the modified shape (called by the execution method). + MODELAPI_EXPORT virtual void storeModified(const std::shared_ptr& theOldShape, + const std::shared_ptr& theNewShape, const int theDecomposeSolidsTag = 0); + + /// Stores the shape without naming support + MODELAPI_EXPORT virtual void storeWithoutNaming( + const std::shared_ptr& theShape); + + /// Returns the shape-result produced by this feature + MODELAPI_EXPORT virtual std::shared_ptr shape(); + + /// 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. + MODELAPI_EXPORT virtual void generated(const std::shared_ptr& theNewShape, + const std::string& theName, const int theTag = 1); + + /// 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. + MODELAPI_EXPORT virtual void generated(const std::shared_ptr& theOldShape, + const std::shared_ptr& theNewShape, const std::string& theName, + const int theTag = 1); + + /// 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. + MODELAPI_EXPORT virtual void modified(const std::shared_ptr& theOldShape, + const std::shared_ptr& theNewShape, const std::string& theName, + const int theTag = 1); + + /// 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. + MODELAPI_EXPORT virtual void deleted( + const std::shared_ptr& theOldShape, const int theTag = 1); + + /// load deleted shapes + MODELAPI_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS, + std::shared_ptr theShapeIn, + const int theKindOfShape, + const int theTag); + /// load and orient modified shapes + MODELAPI_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS, + std::shared_ptr theShapeIn, const int theKindOfShape, const int theTag, + const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes, + const bool theIsStoreSeparate = false, + const bool theIsStoreAsGenerated = false, + const bool theSplitInSubs = false); + /// load and orient generated shapes + MODELAPI_EXPORT virtual void loadAndOrientGeneratedShapes (GeomAlgoAPI_MakeShape* theMS, + std::shared_ptr theShapeIn, const int theKindOfShape, + const int theTag, const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes); + + /// load shapes of the first level (to be used during shape import) + MODELAPI_EXPORT virtual void loadFirstLevel(std::shared_ptr theShape, + const std::string& theName, int& theTag); + + /// load disconnected edges + MODELAPI_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr theShape, + const std::string& theName, int& theTag); + + /// load disconnected vetexes + MODELAPI_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr theShape, + const std::string& theName,int& theTag); + + /// Returns true if the latest modification of this body in the naming history + // is equal to the given shape + MODELAPI_EXPORT virtual bool isLatestEqual(const std::shared_ptr& theShape) = 0; + + /// Returns true is the topology is connected. Cashes this information for the current shape, + /// so it is more effective to use this method than directly GeomAPI_Shape. + MODELAPI_EXPORT virtual bool isConnectedTopology(); + +protected: + /// Default constructor accessible only from Model_Objects + MODELAPI_EXPORT ModelAPI_ResultBody(); + + ModelAPI_BodyBuilder* myBuilder; ///< provides the body processing in naming shape }; //! Pointer on feature object -typedef boost::shared_ptr ResultBodyPtr; +typedef std::shared_ptr ResultBodyPtr; #endif