1 // Name : ModelHighAPI_Services.h
5 // 17/06/16 - Sergey POKHODENKO - Creation of the file
7 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_
8 #define SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_
10 //--------------------------------------------------------------------------------------
11 #include "ModelHighAPI.h"
15 //--------------------------------------------------------------------------------------
19 class ModelAPI_Document;
20 //--------------------------------------------------------------------------------------
21 /// Return the main document (the Partset) created or open from the Modeler.
23 std::shared_ptr<ModelAPI_Document> moduleDocument();
25 /** Return the active document.
27 * This document can be either the main application document (i.e. the Partset) or one of documents
28 * referred to by the main document (a Part).
31 std::shared_ptr<ModelAPI_Document> activeDocument();
33 /** Return one of the three planes defined by the global coordinate system.
35 * These planes are respectively referred to by name "XOY" (Z=0), "XOZ" (Y=0) or "YOZ" (X=0).
38 std::shared_ptr<GeomAPI_Ax3> defaultPlane(const std::string & theName);
40 /// Return name of coordinate plane ("XOY", "XOZ" or "YOZ") or empty string for other planes.
42 std::string defaultPlane(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
43 const std::shared_ptr<GeomAPI_Dir>& theNormal,
44 const std::shared_ptr<GeomAPI_Dir>& theDirX);
46 /** Start a data structure transaction.
48 * Make a control point for being able to discard or undo
49 * all operations done during this transaction.
54 /** Commit the data structure transaction.
56 * Make all operations done since the last control point undo-able.
61 /** Commit the data structure transaction and start the new one.
63 * Make all operations done since the last control point undo-able
64 * and continue with the new transaction.
69 /// Roll-back the data structure to the previous control point.
73 /// Restore the data structure rolled-back by the last undo.
77 /// Reset the data structure to initial state.
81 //--------------------------------------------------------------------------------------
82 //--------------------------------------------------------------------------------------
83 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_ */