SHAPER 9.16.0
ModelHighAPI_Services.h
1// Copyright (C) 2014-2026 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 SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_
21#define SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_
22
23//--------------------------------------------------------------------------------------
24#include "ModelHighAPI.h"
25
26#include <memory>
27#include <string>
28//--------------------------------------------------------------------------------------
29class GeomAPI_Ax3;
30class GeomAPI_Dir;
31class GeomAPI_Pnt;
33class ModelAPI_Result;
34//--------------------------------------------------------------------------------------
36MODELHIGHAPI_EXPORT
37std::shared_ptr<ModelAPI_Document> moduleDocument();
38
44MODELHIGHAPI_EXPORT
45std::shared_ptr<ModelAPI_Document> activeDocument();
46
51MODELHIGHAPI_EXPORT
52std::shared_ptr<GeomAPI_Ax3> defaultPlane(const std::wstring & theName);
53
55MODELHIGHAPI_EXPORT
56std::wstring defaultPlane(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
57 const std::shared_ptr<GeomAPI_Dir>& theNormal,
58 const std::shared_ptr<GeomAPI_Dir>& theDirX);
59
64MODELHIGHAPI_EXPORT
65std::shared_ptr<ModelAPI_Result> standardPlane(const std::wstring & theName);
66
72MODELHIGHAPI_EXPORT
73void begin();
74
79MODELHIGHAPI_EXPORT
80void end();
81
87MODELHIGHAPI_EXPORT
88void apply();
89
95MODELHIGHAPI_EXPORT
96void updateFeatures();
97
99MODELHIGHAPI_EXPORT
100void undo();
101
103MODELHIGHAPI_EXPORT
104void redo();
105
107MODELHIGHAPI_EXPORT
108void reset();
109
110//--------------------------------------------------------------------------------------
111//--------------------------------------------------------------------------------------
112#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_ */
The class represents a coordinate plane which is 2d plane with X and Y directions and origin.
Definition: GeomAPI_Ax3.h:33
3D direction defined by three normalized coordinates
Definition: GeomAPI_Dir.h:34
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:53
The result of a feature.
Definition: ModelAPI_Result.h:37