1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef Model_ResultCompSolid_H_
22 #define Model_ResultCompSolid_H_
25 #include <ModelAPI_ResultCompSolid.h>
29 /**\class Model_ResultCompSolid
31 * \brief The compsolid (container of body results) result of a feature.
33 * Provides a container of shapes that may be displayed in the viewer.
35 class Model_ResultCompSolid : public ModelAPI_ResultCompSolid
37 /// Sub-bodies if this is compsolid: zero base index to subs
38 std::vector<std::shared_ptr<ModelAPI_ResultBody> > mySubs;
39 /// Also keep map of result to index in mySubs to facilitate speed of access from OB
40 std::map<ObjectPtr, int> mySubsMap;
41 /// Flag that stores the previous state of "concealed": if it is changed,
42 /// The event must be generated to redisplay this and all subs.
48 /// Removes the stored builders
49 MODEL_EXPORT virtual ~Model_ResultCompSolid();
51 /// Stores the shape (called by the execution method). Creates sub-results for compsolid.
52 MODEL_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape,
53 const bool theIsStoreSameShapes = true);
55 /// Stores the generated shape. Creates sub-results for compsolid.
56 MODEL_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
57 const std::shared_ptr<GeomAPI_Shape>& theToShape);
59 /// Stores the modified shape. Creates sub-results for compsolid.
60 MODEL_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
61 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const int theDecomposeSolidsTag = 0);
63 /// load and orient modified shapes for sub-objects
64 MODEL_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS,
65 std::shared_ptr<GeomAPI_Shape> theShapeIn, const int theKindOfShape, const int theTag,
66 const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes,
67 const bool theIsStoreSeparate = false,
68 const bool theIsStoreAsGenerated = false,
69 const bool theSplitInSubs = false);
72 /// Returns the number of sub-elements
73 MODEL_EXPORT virtual int numberOfSubs(bool forTree = false) const;
75 /// Returns the sub-result by zero-base index
76 MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> subResult(const int theIndex,
77 bool forTree = false) const;
79 /// Returns true if feature or reuslt belong to this composite feature as subs
80 /// Returns theIndex - zero based index of sub if found
81 MODEL_EXPORT virtual bool isSub(ObjectPtr theObject, int& theIndex) const;
83 /// Returns the parameters of color definition in the resources config manager
84 MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
85 std::string& theDefault);
87 /// Disables the result body: keeps the resulting shape as selection, but erases the underlaying
88 /// naming data structure if theFlag if false. Or restores everything on theFlag is true.
89 MODEL_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
92 /// The compsolid is concealed if at least one of the sub is concealed
93 MODEL_EXPORT virtual bool isConcealed();
95 /// Sets all subs as concealed in the data tree (referenced by other objects)
96 MODEL_EXPORT virtual void setIsConcealed(const bool theValue);
98 /// Returns true if the latest modification of this body in the naming history
99 // is equal to the given shape
100 MODEL_EXPORT virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape);
103 /// Makes a body on the given feature
104 Model_ResultCompSolid();
106 /// Updates the sub-bodies if shape of this object is composite-solid
107 void updateSubs(const std::shared_ptr<GeomAPI_Shape>& theThisShape);
109 friend class Model_Objects;