]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_ResultPart.h
Salome HOME
7a7df7ef4b17093656c105df66da64fd3b390cd7
[modules/shaper.git] / src / ModelAPI / ModelAPI_ResultPart.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_ResultPart.h
4 // Created:     07 Jul 2014
5 // Author:      Mikhail PONIKAROV
6
7 #ifndef ModelAPI_ResultPart_H_
8 #define ModelAPI_ResultPart_H_
9
10 #include "ModelAPI_Result.h"
11 class GeomAPI_Trsf;
12
13 #include <string>
14
15 /**\class ModelAPI_ResultPart
16  * \ingroup DataModel
17  * \brief The Part document, result of a creation of new part feature.
18  *
19  * This result leaves without feature: no parametricity for this element,
20  * only add/remove, undo/redo.
21  */
22 class ModelAPI_ResultPart : public ModelAPI_Result
23 {
24  public:
25   /// Returns the group identifier of this result
26   MODELAPI_EXPORT virtual std::string groupName();
27
28   /// Returns the group identifier of this result
29   inline static std::string group()
30   {
31     static std::string MY_GROUP = "Parts";
32     return MY_GROUP;
33   }
34
35   /// part document reference attribute
36   inline static const std::string& DOC_REF()
37   {
38     static const std::string MY_DOC_REF("PartDocument");
39     return MY_DOC_REF;
40   }
41
42   /// default color for a result body
43   inline static const std::string& DEFAULT_COLOR()
44   {
45     static const std::string RESULT_BODY_COLOR("96,157,255");
46     return RESULT_BODY_COLOR;
47   }
48
49   /// Returns the part-document of this result
50   virtual std::shared_ptr<ModelAPI_Document> partDoc() = 0;
51
52   /// Returns the original part result: for transfomration features results this is
53   /// the original Part feature result
54   virtual std::shared_ptr<ModelAPI_ResultPart> original() = 0;
55
56   /// Sets this document as current and if it is not loaded yet, loads it
57   virtual void activate() = 0;
58
59   /// Returns true if document is activated (loaded into the memory)
60   virtual bool isActivated() = 0;
61
62   /// Returns the name of the shape inside of the part
63   virtual std::string nameInPart(const std::shared_ptr<GeomAPI_Shape>& theShape,
64     int& theIndex) = 0;
65   /// Updates the selection inside of the part by the selection index
66   virtual bool updateInPart(const int theIndex) = 0;
67
68   /// Applies the additional transformation of the part
69   virtual void setTrsf(std::shared_ptr<ModelAPI_Result> theThis,
70     const std::shared_ptr<GeomAPI_Trsf>& theTransformation) = 0;
71
72   /// Returns the shape by the name in the part
73   virtual std::shared_ptr<GeomAPI_Shape> shapeInPart(
74     const std::string& theName, const std::string& theType, int& theIndex) = 0;
75
76   /// Returns the shape selected in the selection index
77   virtual std::shared_ptr<GeomAPI_Shape> selectionValue(const int theIndex) = 0;
78
79   /// Updates the shape-result of the part (called on Part feature execution)
80   virtual void updateShape() = 0;
81 };
82
83 //! Pointer on feature object
84 typedef std::shared_ptr<ModelAPI_ResultPart> ResultPartPtr;
85
86 #endif