SHAPER  9.15.0
GeomAlgoAPI_Tools.h
1 // Copyright (C) 2014-2025 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 GEOMALGOAPI_TOOLS_H_
21 #define GEOMALGOAPI_TOOLS_H_
22 
23 #include <GeomAlgoAPI.h>
24 
25 #include <ModelAPI_ResultBody.h>
26 #include <TDF_Label.hxx>
27 #include <GeomAPI_Shape.h>
28 #include <Quantity_Color.hxx>
29 
30 #include <memory>
31 #include <string>
32 
34 
35 namespace GeomAlgoAPI_Tools {
37 enum BOPType {
38  BOOL_CUT,
39  BOOL_FUSE,
40  BOOL_COMMON,
41  BOOL_PARTITION
42 };
43 
48 class Localizer
49 {
50 public:
51  GEOMALGOAPI_EXPORT Localizer();
52  GEOMALGOAPI_EXPORT ~Localizer();
53 private:
54  std::string myCurLocale;
55 };
56 
61 class File_Tools {
62 public:
66  GEOMALGOAPI_EXPORT static std::string extension(const std::string& theFileName);
70  GEOMALGOAPI_EXPORT static std::string name(const std::string& theFileName);
74  GEOMALGOAPI_EXPORT static std::string path(const std::string& theFileName);
75 };
76 
81 class AlgoError {
82 public:
89  GEOMALGOAPI_EXPORT static bool isAlgorithmFailed(
90  const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm,
91  const std::string& theFeature,
92  std::string& theError);
93 };
94 
100 public:
101 
102  // a structure to manage exported attributes
104  bool myHasColor;
105  Quantity_Color myColor;
106  std::wstring myName;
107  const TDF_Label myMain;
108 
109  GeomAlgoAPI_Attributes(const TDF_Label& theMain) : myHasColor(false), myMain(theMain){ }
110 };
111 
112  GEOMALGOAPI_EXPORT static TDF_Label exportShape(const GeomShapePtr theShape, GeomAlgoAPI_Attributes& theAttrs,
113  const GeomShapePtr theFatherShape, TDF_Label& theFaterID);
114 
115  GEOMALGOAPI_EXPORT static void getAttributes(const ResultPtr& theResult, GeomAlgoAPI_Attributes& theAttrs);
116 
117  GEOMALGOAPI_EXPORT static void putResult(const ResultPtr& theResult, const GeomShapePtr theFatherShape,
118  TDF_Label& theFaterID, GeomAlgoAPI_Attributes& theAttrs);
119 };
120 } // GeomAlgoAPI_Tools
121 
122 #endif /* GEOMALGOAPI_TOOLS_H_ */
Interface to the root class of all topological shapes constructions.
Definition: GeomAlgoAPI_MakeShape.h:35
Verify error in MakeShape algorithm.
Definition: GeomAlgoAPI_Tools.h:81
static GEOMALGOAPI_EXPORT bool isAlgorithmFailed(const std::shared_ptr< GeomAlgoAPI_MakeShape > &theAlgorithm, const std::string &theFeature, std::string &theError)
Verify MakeShape algorithm for failures.
Definition: GeomAlgoAPI_Tools.cpp:108
Manage attributes for export.
Definition: GeomAlgoAPI_Tools.h:99
File tool.
Definition: GeomAlgoAPI_Tools.h:61
static GEOMALGOAPI_EXPORT std::string extension(const std::string &theFileName)
Returns an extension of theFileName.
Definition: GeomAlgoAPI_Tools.cpp:78
static GEOMALGOAPI_EXPORT std::string path(const std::string &theFileName)
Returns a directory path of theFileName.
Definition: GeomAlgoAPI_Tools.cpp:100
static GEOMALGOAPI_EXPORT std::string name(const std::string &theFileName)
Returns a name of theFileName.
Definition: GeomAlgoAPI_Tools.cpp:92
Localizer tool.
Definition: GeomAlgoAPI_Tools.h:49
bool myHasColor
true if color is defined
Definition: GeomAlgoAPI_Tools.h:104