SHAPER  9.12.0
ModelAPI_ResultConstruction.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_ResultConstruction_H_
21 #define ModelAPI_ResultConstruction_H_
22 
23 #include "ModelAPI_Result.h"
24 #include <GeomAPI_Shape.h>
25 #include <GeomAPI_Face.h>
26 
27 #include <string>
28 
37 {
38  public:
40  MODELAPI_EXPORT virtual std::string groupName();
41 
43  inline static std::string group()
44  {
45  static std::string MY_GROUP = "Construction";
46  return MY_GROUP;
47  }
48 
50  inline static const std::string& DEFAULT_COLOR()
51  {
52  static const std::string RESULT_CONSTRUCTION_COLOR("120,120,120");
53  return RESULT_CONSTRUCTION_COLOR;
54  }
55 
57  inline static const std::string& RESULT_COLOR_NAME()
58  {
59  static const std::string COLOR_NAME("result_construction_color");
60  return COLOR_NAME;
61  }
62 
64  inline static const std::string DEFAULT_DEFLECTION()
65  {
66  return "0.00001";
67  }
68 
70  virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape) = 0;
71 
74  virtual bool updateShape() = 0;
75 
77  virtual void setIsInHistory(const bool isInHistory) = 0;
78 
81  virtual int facesNum(const bool theUpdateNaming = true) = 0;
83  virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex) = 0;
85  virtual void setFacesOrder(const std::list<std::shared_ptr<GeomAPI_Face> >& theFaces) = 0;
86 
88  virtual bool isInfinite() = 0;
90  virtual void setInfinite(const bool theInfinite) = 0;
91 };
92 
94 typedef std::shared_ptr<ModelAPI_ResultConstruction> ResultConstructionPtr;
95 
96 #endif
virtual bool isInHistory()
By default object is displayed in the object browser.
Definition: ModelAPI_Object.cpp:26
The construction element result of a feature.
Definition: ModelAPI_ResultConstruction.h:37
virtual bool isInfinite()=0
By default object is not infinite.
virtual int facesNum(const bool theUpdateNaming=true)=0
if the construction result may be used as faces, this method returns not zero number of faces
static std::string group()
Returns the group identifier of this result.
Definition: ModelAPI_ResultConstruction.h:43
virtual void setShape(std::shared_ptr< GeomAPI_Shape > theShape)=0
Sets the result.
virtual void setFacesOrder(const std::list< std::shared_ptr< GeomAPI_Face > > &theFaces)=0
Change the order of faces.
virtual std::shared_ptr< GeomAPI_Face > face(const int theIndex)=0
if the construction result may be used as faces, this method returns face by zero based index
static const std::string DEFAULT_DEFLECTION()
default deflection for a result construction
Definition: ModelAPI_ResultConstruction.h:64
virtual bool updateShape()=0
Updates the shape taking the current value from the data structure, returns true if update has been c...
virtual void setIsInHistory(const bool isInHistory)=0
Sets the flag that it must be displayed in history (default is true)
virtual std::string groupName()
Returns the group identifier of this result.
Definition: ModelAPI_ResultConstruction.cpp:23
virtual void setInfinite(const bool theInfinite)=0
Sets the flag that it is infinite.
static const std::string & DEFAULT_COLOR()
default color for a result construction
Definition: ModelAPI_ResultConstruction.h:50
static const std::string & RESULT_COLOR_NAME()
default color for a result construction
Definition: ModelAPI_ResultConstruction.h:57
The result of a feature.
Definition: ModelAPI_Result.h:35