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 conainer 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.
49 /// Removes the stored builders
50 MODEL_EXPORT virtual ~Model_ResultBody();
52 /// Records the subshape newShape which was generated during a topological construction.
53 /// As an example, consider the case of a face generated in construction of a box.
54 MODEL_EXPORT virtual bool generated(const GeomShapePtr& theNewShape,
55 const std::string& theName, const bool theCheckIsInResult = true) override;
57 /// load generated shapes
59 virtual void loadGeneratedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
60 const GeomShapePtr& theOldShape,
61 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
62 const std::string& theName = "") override;
64 /// load modified shapes for sub-objects
66 virtual void loadModifiedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
67 const GeomShapePtr& theOldShape,
68 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
69 const std::string& theName = "") override;
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 ResultBodyPtr 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 every thing 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);
102 /// Returns true is the topology is connected.
103 MODEL_EXPORT virtual bool isConnectedTopology();
106 /// Makes a body on the given feature
109 /// Updates the sub-bodies if shape of this object is composite-solid
110 void updateSubs(const std::shared_ptr<GeomAPI_Shape>& theThisShape,
111 const bool theShapeChanged = true);
113 // Checks the state of children and partents to send events of creation/erase when needed
114 void updateConcealment();
116 friend class Model_Objects;