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_ResultBody_H_
22 #define Model_ResultBody_H_
25 #include <ModelAPI_ResultBody.h>
29 /**\class Model_ResultBody
31 * \brief The body (shape) result of a feature.
33 * Provides a shape that may be displayed in the viewer.
34 * May provide really huge results, so, working with this kind
35 * of result must be optimized.
36 * Also provides a container of sub-body result in case it is compound or compsolid.
38 class Model_ResultBody : public ModelAPI_ResultBody
40 /// Sub-bodies if this is compsolid or compound: zero-based index to subs
41 std::vector<ResultBodyPtr> mySubs;
42 /// Also keep map of result to index in mySubs to facilitate speed of access from OB
43 std::map<ObjectPtr, int> mySubsMap;
44 /// Keeps the last state of the concealment flag in order to update it when needed.
46 /// History information for update subs
47 std::shared_ptr<GeomAlgoAPI_MakeShape> myAlgo;
48 /// All old shapes used for the root result construction
49 std::list<GeomShapePtr> myOlds;
50 /// Information about the kind of the history information: modified or generated
55 /// Removes the stored builders
56 MODEL_EXPORT virtual ~Model_ResultBody();
58 /// Records the subshape newShape which was generated during a topological construction.
59 /// As an example, consider the case of a face generated in construction of a box.
60 MODEL_EXPORT virtual bool generated(const GeomShapePtr& theNewShape,
61 const std::string& theName, const bool theCheckIsInResult = true) override;
63 /// load generated shapes
65 virtual void loadGeneratedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
66 const GeomShapePtr& theOldShape,
67 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
68 const std::string& theName = "") override;
70 /// load modified shapes for sub-objects
72 virtual void loadModifiedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
73 const GeomShapePtr& theOldShape,
74 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
75 const std::string& theName = "") override;
78 /// Returns the number of sub-elements
79 MODEL_EXPORT virtual int numberOfSubs(bool forTree = false) const;
81 /// Returns the sub-result by zero-base index
82 MODEL_EXPORT virtual ResultBodyPtr subResult(const int theIndex,
83 bool forTree = false) const;
85 /// Returns true if feature or result belong to this composite feature as subs
86 /// Returns theIndex - zero based index of sub if found
87 MODEL_EXPORT virtual bool isSub(ObjectPtr theObject, int& theIndex) const;
89 /// Returns the parameters of color definition in the resources configuration manager
90 MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
91 std::string& theDefault);
93 /// Disables the result body: keeps the resulting shape as selection, but erases the underlaying
94 /// naming data structure if theFlag if false. Or restores every thing on theFlag is true.
95 MODEL_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
98 /// The compsolid is concealed if at least one of the sub is concealed
99 MODEL_EXPORT virtual bool isConcealed();
101 /// Sets all subs as concealed in the data tree (referenced by other objects)
102 MODEL_EXPORT virtual void setIsConcealed(const bool theValue);
104 /// Returns true is the topology is connected.
105 MODEL_EXPORT virtual bool isConnectedTopology();
107 /// Cleans cash related to the already stored elements
108 MODEL_EXPORT virtual void cleanCash() override;
111 /// Makes a body on the given feature
114 /// Updates the sub-bodies if shape of this object is composite-solid
115 void updateSubs(const std::shared_ptr<GeomAPI_Shape>& theThisShape,
116 const bool theShapeChanged = true);
118 /// Updates the sub-bodies in accordance to the algorithm history information
120 const GeomShapePtr& theThisShape, const std::list<GeomShapePtr>& theOlds,
121 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape, const bool isGenerated);
123 // Checks the state of children and parents to send events of creation/erase when needed
124 void updateConcealment();
126 /// Adds to theOldForSub only old shapes that where used for theSub creation
127 void computeOldForSub(const GeomShapePtr& theSub,
128 const std::list<GeomShapePtr>& theAllOlds, std::list<GeomShapePtr>& theOldForSub);
130 friend class Model_Objects;