SHAPER  9.12.0
ModelAPI_ResultPart.h
1 // Copyright (C) 2014-2023 CEA, EDF
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef ModelAPI_ResultPart_H_
21 #define ModelAPI_ResultPart_H_
22 
23 #include "ModelAPI_Result.h"
24 class GeomAPI_Trsf;
25 
26 #include <string>
27 
36 {
37  public:
39  MODELAPI_EXPORT virtual std::string groupName();
40 
42  inline static std::string group()
43  {
44  static std::string MY_GROUP = "Parts";
45  return MY_GROUP;
46  }
47 
49  inline static const std::string& DOC_REF()
50  {
51  static const std::string MY_DOC_REF("PartDocument");
52  return MY_DOC_REF;
53  }
54 
56  inline static const std::string& DEFAULT_COLOR()
57  {
58  static const std::string RESULT_BODY_COLOR("96,157,255");
59  return RESULT_BODY_COLOR;
60  }
61 
63  virtual std::shared_ptr<ModelAPI_Document> partDoc() = 0;
64 
67  virtual std::shared_ptr<ModelAPI_ResultPart> original() = 0;
68 
70  virtual void activate() = 0;
71 
73  virtual bool isActivated() = 0;
74 
76  virtual std::wstring nameInPart(const std::shared_ptr<GeomAPI_Shape>& theShape,
77  int& theIndex) = 0;
79  virtual bool updateInPart(const int theIndex) = 0;
80 
82  virtual void setTrsf(std::shared_ptr<ModelAPI_Result> theThis,
83  const std::shared_ptr<GeomAPI_Trsf>& theTransformation) = 0;
84 
86  virtual std::shared_ptr<GeomAPI_Trsf> summaryTrsf() = 0;
87 
89  virtual std::shared_ptr<GeomAPI_Shape> shapeInPart(
90  const std::wstring& theName, const std::string& theType, int& theIndex) = 0;
91 
93  virtual bool combineGeometrical(const int theIndex, std::wstring& theNewName) = 0;
94 
96  virtual std::shared_ptr<GeomAPI_Shape> selectionValue(const int theIndex) = 0;
97 
99  virtual void updateShape() = 0;
100 
102  virtual void loadPart() = 0;
103 };
104 
106 typedef std::shared_ptr<ModelAPI_ResultPart> ResultPartPtr;
107 
108 #endif
Keep the transformation matrix coefficients.
Definition: GeomAPI_Trsf.h:36
The Part document, result of a creation of new part feature.
Definition: ModelAPI_ResultPart.h:36
virtual bool updateInPart(const int theIndex)=0
Updates the selection inside of the part by the selection index.
virtual std::shared_ptr< ModelAPI_ResultPart > original()=0
Returns the original part result: for transformation features results this is the original Part featu...
static const std::string & DOC_REF()
part document reference attribute
Definition: ModelAPI_ResultPart.h:49
virtual std::wstring nameInPart(const std::shared_ptr< GeomAPI_Shape > &theShape, int &theIndex)=0
Returns the name of the shape inside of the part.
virtual std::string groupName()
Returns the group identifier of this result.
Definition: ModelAPI_ResultPart.cpp:24
virtual void activate()=0
Sets this document as current and if it is not loaded yet, loads it.
virtual bool isActivated()=0
Returns true if document is activated (loaded into the memory)
virtual std::shared_ptr< GeomAPI_Trsf > summaryTrsf()=0
Returns the summary transformations of all references to the origin.
virtual std::shared_ptr< GeomAPI_Shape > shapeInPart(const std::wstring &theName, const std::string &theType, int &theIndex)=0
Returns the shape by the name in the part.
virtual std::shared_ptr< GeomAPI_Shape > selectionValue(const int theIndex)=0
Returns the shape selected in the selection index.
virtual void updateShape()=0
Updates the shape-result of the part (called on Part feature execution)
static std::string group()
Returns the group identifier of this result.
Definition: ModelAPI_ResultPart.h:42
static const std::string & DEFAULT_COLOR()
default color for a result body
Definition: ModelAPI_ResultPart.h:56
virtual std::shared_ptr< ModelAPI_Document > partDoc()=0
Returns the part-document of this result.
virtual bool combineGeometrical(const int theIndex, std::wstring &theNewName)=0
Updates the selection inside of the part as a geometrical selection.
virtual void loadPart()=0
Loading the part from file.
virtual void setTrsf(std::shared_ptr< ModelAPI_Result > theThis, const std::shared_ptr< GeomAPI_Trsf > &theTransformation)=0
Applies the additional transformation of the part.
The result of a feature.
Definition: ModelAPI_Result.h:35