X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_ResultBody.h;h=049e821753affd06603fb426f2ccfcb1a61cd424;hb=3f6a02c80da84b8356412858b060ba22e3148fd7;hp=4991cf27986c61ab24453c3873a87628baad583d;hpb=bca0d6dc03d998fb8fe24a0003f7b392b403ea11;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_ResultBody.h b/src/ModelAPI/ModelAPI_ResultBody.h index 4991cf279..049e82175 100644 --- a/src/ModelAPI/ModelAPI_ResultBody.h +++ b/src/ModelAPI/ModelAPI_ResultBody.h @@ -1,17 +1,34 @@ -// 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 -#include #include +class ModelAPI_BodyBuilder; +class GeomAlgoAPI_MakeShape; + /**\class ModelAPI_ResultBody * \ingroup DataModel * \brief The body (shape) result of a feature. @@ -19,81 +36,158 @@ * 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. +* Also provides a conainer of sub-body result in case it is compound or compsolid. */ class ModelAPI_ResultBody : public ModelAPI_Result { public: + /// 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 + }; + +protected: + /// Keeps (not persistently) the connected topology flag + ConnectedTopologyFlag myConnect; + + ModelAPI_BodyBuilder* myBuilder; ///< provides the body processing in naming shape + +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; + /// 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; + } + + /// default deflection for a result body + inline static const std::string DEFAULT_DEFLECTION() + { + return "0.0001"; + } + + /// Returns the number of sub-elements + MODELAPI_EXPORT virtual int numberOfSubs(bool forTree = false) const = 0; + + /// Returns the sub-result by zero-base index + MODELAPI_EXPORT virtual std::shared_ptr subResult( + const int theIndex, bool forTree = false) const = 0; + + /// Returns true if feature or reuslt belong to this composite feature as subs + /// Returns theIndex - zero based index of sub if found + MODELAPI_EXPORT virtual bool isSub(ObjectPtr theObject, int& theIndex) const = 0; + + /// \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). - virtual void storeGenerated(const boost::shared_ptr& theFromShape, - const boost::shared_ptr& theToShape) = 0; + MODELAPI_EXPORT virtual void storeGenerated(const std::shared_ptr& theFromShape, + const std::shared_ptr& theToShape); /// Stores the modified shape (called by the execution method). - virtual void storeModified(const boost::shared_ptr& theOldShape, - const boost::shared_ptr& theNewShape) = 0; + 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 - virtual boost::shared_ptr shape() = 0; + 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. - virtual void generated( - const boost::shared_ptr& theNewShape, const int theTag = 1) = 0; + 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 + /// 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 boost::shared_ptr& theOldShape, - const boost::shared_ptr& theNewShape, const int theTag = 1) = 0; + 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. - virtual void modified(const boost::shared_ptr& theOldShape, - const boost::shared_ptr& theNewShape, const int theTag = 1) = 0; + 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. - virtual void deleted( - const boost::shared_ptr& theOldShape, const int theTag = 1) = 0; - + MODELAPI_EXPORT virtual void deleted( + const std::shared_ptr& theOldShape, const int theTag = 1); + /// load deleted shapes - virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS, - boost::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag) = 0; + MODELAPI_EXPORT virtual void loadDeletedShapes(GeomAlgoAPI_MakeShape* theMS, + std::shared_ptr theShapeIn, + const int theKindOfShape, + const int theTag); + /// load and orient modified shapes - virtual void loadAndOrientModifiedShapes ( - GeomAlgoAPI_MakeShape* theMS, - boost::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag, - GeomAPI_DataMapOfShapeShape& theSubShapes) = 0; + 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 - virtual void loadAndOrientGeneratedShapes ( - GeomAlgoAPI_MakeShape* theMS, - boost::shared_ptr theShapeIn, - const int theKindOfShape, - const int theTag, - GeomAPI_DataMapOfShapeShape& theSubShapes) = 0; + 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(); + + /// Set displayed flag to the result and all sub results + /// \param theDisplay a boolean value + MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay); + + /// Updates the sub-bodies if shape of this object is compsolid or compound + MODELAPI_EXPORT virtual void updateSubs(const std::shared_ptr& theThisShape) = 0; + protected: + /// Default constructor accessible only from Model_Objects + MODELAPI_EXPORT ModelAPI_ResultBody(); + }; //! Pointer on feature object -typedef boost::shared_ptr ResultBodyPtr; +typedef std::shared_ptr ResultBodyPtr; #endif