src/ModelHighAPI/ModelHighAPI_Services.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 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 //--------------------------------------------------------------------------------------
  29 class GeomAPI_Ax3;
  30 class GeomAPI_Dir;
  31 class GeomAPI_Pnt;
  32 class ModelAPI_Document;
  33 class ModelAPI_Result;
  34 //--------------------------------------------------------------------------------------
  35 /// Return the main document (the Partset) created or open from the Modeler.
  36 MODELHIGHAPI_EXPORT
  37 std::shared_ptr<ModelAPI_Document> moduleDocument();
  38
  39 /** Return the active document.
  40  *
  41  *  This document can be either the main application document (i.e. the Partset) or one of documents
  42  *  referred to by the main document (a Part).
  43  */
  44 MODELHIGHAPI_EXPORT
  45 std::shared_ptr<ModelAPI_Document> activeDocument();
  46
  47 /** Return one of the three planes defined by the global coordinate system.
  48  *
  49  *  These planes are respectively referred to by name "XOY" (Z=0), "XOZ" (Y=0) or "YOZ" (X=0).
  50  */
  51 MODELHIGHAPI_EXPORT
  52 std::shared_ptr<GeomAPI_Ax3> defaultPlane(const std::wstring & theName);
  53
  54 /// Return name of coordinate plane ("XOY", "XOZ" or "YOZ") or empty string for other planes.
  55 MODELHIGHAPI_EXPORT
  56 std::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
  60 /** Return one of the three standard results defined in PartSet document.
  61  *
  62  *  These planes are respectively referred to by name "XOY" (Z=0), "XOZ" (Y=0) or "YOZ" (X=0).
  63  */
  64 MODELHIGHAPI_EXPORT
  65 std::shared_ptr<ModelAPI_Result> standardPlane(const std::wstring & theName);
  66
  67 /** Start a data structure transaction.
  68  *
  69  *  Make a control point for being able to discard or undo
  70  *  all operations done during this transaction.
  71  */
  72 MODELHIGHAPI_EXPORT
  73 void begin();
  74
  75 /** Commit the data structure transaction.
  76  *
  77  *  Make all operations done since the last control point undo-able.
  78  */
  79 MODELHIGHAPI_EXPORT
  80 void end();
  81
  82 /** Commit the data structure transaction and start the new one.
  83  *
  84  *  Make all operations done since the last control point undo-able
  85  *  and continue with the new transaction.
  86  */
  87 MODELHIGHAPI_EXPORT
  88 void apply();
  89
  90 /** Executes features, created or updated before.
  91  *
  92  *  This method flushes creation and update events in order to make all
  93  *  features up to date.
  94  */
  95 MODELHIGHAPI_EXPORT
  96 void updateFeatures();
  97
  98 /// Roll-back the data structure to the previous control point.
  99 MODELHIGHAPI_EXPORT
 100 void undo();
 101
 102 /// Restore the data structure rolled-back by the last undo.
 103 MODELHIGHAPI_EXPORT
 104 void redo();
 105
 106 /// Reset the data structure to initial state.
 107 MODELHIGHAPI_EXPORT
 108 void reset();
 109
 110 //--------------------------------------------------------------------------------------
 111 //--------------------------------------------------------------------------------------
 112 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_SERVICES_H_ */