1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_ResultCompSolid.hxx
4 // Created: 20 Jul 2015
5 // Author: Natalia ERMOLAEVA
7 #ifndef ModelAPI_ResultCompSolid_H_
8 #define ModelAPI_ResultCompSolid_H_
10 #include "ModelAPI_Result.h"
11 #include "ModelAPI_ResultBody.h"
14 /**\class ModelAPI_ResultCompSolid
16 * \brief The comp solid (container of results) result of a feature.
18 * Provides a conainer of body result that may be displayed in the viewer.
20 class ModelAPI_ResultCompSolid : public ModelAPI_ResultBody
23 MODELAPI_EXPORT virtual ~ModelAPI_ResultCompSolid();
24 /// Returns the group identifier of this result
26 /// Returns the feature is disabled or not.
27 MODELAPI_EXPORT virtual bool isDisabled() const;
29 /// Adds result to the sketch and to its document
30 /// \param theIndex an index of the created body result in the compsolid
31 virtual std::shared_ptr<ModelAPI_ResultBody> addResult(const int theIndex) = 0;
33 /// Returns the number of sub-elements
34 virtual int numberOfSubs(bool forTree = false) const = 0;
36 /// Returns the sub-result by zero-base index
37 virtual std::shared_ptr<ModelAPI_ResultBody> subResult(const int theIndex,
38 bool forTree = false) const = 0;
40 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
41 //virtual int subResultId(const int theIndex) const = 0;
43 /// Returns true if feature or reuslt belong to this composite feature as subs
44 virtual bool isSub(ObjectPtr theObject) const = 0;
46 /// This method to inform that sub-feature is removed and must be removed from the internal data
47 /// structures of the owner (the remove from the document will be done outside just after)
48 virtual void removeResult(std::shared_ptr<ModelAPI_ResultBody> theResult) = 0;
53 //! Pointer on feature object
54 typedef std::shared_ptr<ModelAPI_ResultCompSolid> ResultCompSolidPtr;