SHAPER  9.12.0
ModelAPI_Result.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_Result_H_
21 #define ModelAPI_Result_H_
22 
23 #include "ModelAPI_Object.h"
24 
25 class GeomAPI_Shape;
26 class ModelAPI_Feature;
27 
35 {
36  bool myIsConcealed;
37  protected:
38  bool myIsDisabled;
39  public:
40 
44  inline static const std::string& COLOR_ID()
45  {
46  static const std::string MY_COLOR_ID("Color");
47  return MY_COLOR_ID;
48  }
49 
52  inline static const std::string& DEFLECTION_ID()
53  {
54  static const std::string MY_DEFLECTION_ID("Deflection");
55  return MY_DEFLECTION_ID;
56  }
57 
60  inline static const std::string& TRANSPARENCY_ID()
61  {
62  static const std::string MY_TRANSPARENCY_ID("Transparency");
63  return MY_TRANSPARENCY_ID;
64  }
65 
68  inline static const std::string& ISO_LINES_ID()
69  {
70  static const std::string MY_ISO_LINES_ID("Iso_lines");
71  return MY_ISO_LINES_ID;
72  }
73 
76  inline static const std::string& SHOW_ISO_LINES_ID()
77  {
78  static const std::string MY_SHOW_ISO_LINES_ID("Show_Iso_lines");
79  return MY_SHOW_ISO_LINES_ID;
80  }
81 
84  inline static const std::string& SHOW_EDGES_DIRECTION_ID()
85  {
86  static const std::string MY_SHOW_EDGES_DIRECTION_ID("Show_Edges_direction");
87  return MY_SHOW_EDGES_DIRECTION_ID;
88  }
89 
92  inline static const std::string& BRING_TO_FRONT_ID()
93  {
94  static const std::string MY_BRING_TO_FRONT_ID("Bring_To_Front");
95  return MY_BRING_TO_FRONT_ID;
96  }
97 
99  MODELAPI_EXPORT virtual bool isConcealed();
100 
102  MODELAPI_EXPORT virtual void setIsConcealed(const bool theValue, const bool theForced = false);
103 
110  MODELAPI_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
111  const bool theFlag);
112 
114  MODELAPI_EXPORT virtual bool isDisabled();
115 
117  MODELAPI_EXPORT virtual void initAttributes();
118 
120  MODELAPI_EXPORT virtual ~ModelAPI_Result();
121 
123  MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
124 
127  MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
128 
129 protected:
132  MODELAPI_EXPORT virtual void init();
133 
134 friend class Model_Objects;
135 };
136 
138 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;
139 
140 #endif
Interface to the topological shape object.
Definition: GeomAPI_Shape.h:43
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:39
Represents any object in the data model and in the object browser.
Definition: ModelAPI_Object.h:45
The result of a feature.
Definition: ModelAPI_Result.h:35
static const std::string & BRING_TO_FRONT_ID()
Reference to the BringToFront flag of the result.
Definition: ModelAPI_Result.h:92
static const std::string & COLOR_ID()
Reference to the color of the result.
Definition: ModelAPI_Result.h:44
virtual void init()
This method is called just after creation of the object: it must initialize all fields,...
Definition: ModelAPI_Result.cpp:118
virtual bool isConcealed()
Returns true if the result is concealed from the data tree (referenced by other objects)
Definition: ModelAPI_Result.cpp:81
virtual bool isDisabled()
Returns the result is disabled or not.
Definition: ModelAPI_Result.cpp:73
virtual bool setDisabled(std::shared_ptr< ModelAPI_Result > theThis, const bool theFlag)
Enables/disables the result.
Definition: ModelAPI_Result.cpp:49
virtual void initAttributes()
Request for initialization of data model of the result: adding all attributes.
Definition: ModelAPI_Result.cpp:34
static const std::string & DEFLECTION_ID()
Reference to the deflection of the result.
Definition: ModelAPI_Result.h:52
virtual ~ModelAPI_Result()
To virtually destroy the fields of successors.
Definition: ModelAPI_Result.cpp:30
bool myIsDisabled
the result is disabled: removed for the user, but keeps the general info
Definition: ModelAPI_Result.h:38
static const std::string & SHOW_EDGES_DIRECTION_ID()
Reference to the transparency of the result.
Definition: ModelAPI_Result.h:84
virtual void attributeChanged(const std::string &theID)
On change of attribute of the result update presentation of this result: for the current moment there...
Definition: ModelAPI_Result.cpp:110
virtual std::shared_ptr< GeomAPI_Shape > shape()
Returns the shape-result produced by this feature (or null if no shapes)
Definition: ModelAPI_Result.cpp:105
static const std::string & TRANSPARENCY_ID()
Reference to the transparency of the result.
Definition: ModelAPI_Result.h:60
static const std::string & SHOW_ISO_LINES_ID()
Reference to the transparency of the result.
Definition: ModelAPI_Result.h:76
static const std::string & ISO_LINES_ID()
Reference to the transparency of the result.
Definition: ModelAPI_Result.h:68
virtual void setIsConcealed(const bool theValue, const bool theForced=false)
Sets the result as concealed in the data tree (referenced by other objects)
Definition: ModelAPI_Result.cpp:86
Manager of objects of the document.
Definition: Model_Objects.h:46