src/GEOM/GEOM_Engine.hxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22 #ifndef _GEOM_Engine_HXX_
  23 #define _GEOM_Engine_HXX_
  24
  25 #include "GEOM_Application.hxx"
  26 #include "GEOM_Object.hxx"
  27 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
  28
  29 #include <Interface_DataMapOfIntegerTransient.hxx>
  30 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
  31 #include <TDocStd_Document.hxx>
  32 #include <TColStd_HArray1OfInteger.hxx>
  33 #include <TColStd_HSequenceOfAsciiString.hxx>
  34 #include <TDF_Label.hxx>
  35
  36 #include <map>
  37 #include <list>
  38 #include <vector>
  39
  40 struct TVariable{
  41   TCollection_AsciiString myVariable;
  42   bool isVariable;
  43
  44   TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
  45     myVariable(theVariable),
  46     isVariable(theFlag){}
  47 };
  48
  49 typedef std::vector<TVariable> TState;
  50 typedef std::vector<TState>    TAllStates;
  51
  52 class ObjectStates
  53 {
  54 public:
  55   Standard_EXPORT ObjectStates();
  56   ~ObjectStates();
  57
  58   TAllStates GetAllStates() const { return _states; }
  59
  60   TState GetCurrectState() const;
  61   Standard_EXPORT void AddState(const TState &theState);
  62   void IncrementState();
  63
  64 private:
  65   TAllStates              _states;
  66   int                     _dumpstate;
  67 };
  68
  69 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
  70
  71 typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
  72
  73 class GEOM_Engine
  74 {
  75  public:
  76   Standard_EXPORT GEOM_Engine();
  77   Standard_EXPORT virtual ~GEOM_Engine();
  78
  79   //Retuns the engine
  80   Standard_EXPORT static GEOM_Engine* GetEngine();
  81
  82   //Returns the OCAF document by its ID, if document doesn't exists it will be created
  83   Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID);
  84
  85   //Returns the ID of the given OCAF document
  86   Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
  87
  88   //Returns the OCAF appliaction
  89   Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
  90
  91   //Returns a pointer to GEOM_Object defined by a document and the entry
  92   Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry);
  93
  94   //Adds a new object of the type theType in the OCAF document
  95   Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
  96
  97   //Removes the object from the OCAF document
  98   Standard_EXPORT bool RemoveObject(Handle(GEOM_Object) theObject);
  99
 100   //Saves the OCAF document with ID = theDocID with file with name theFileName
 101   Standard_EXPORT bool Save(int theDocID, char* theFileName);
 102
 103   //Loads the OCAF document into the application and assigns to it an ID = theDocID
 104   Standard_EXPORT bool Load(int theDocID, char* theFileName);
 105
 106   //Closes the document with ID =  theDocID
 107   Standard_EXPORT void Close(int theDocID);
 108
 109   //Sets the number of Undos (default value = 10)
 110   Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
 111
 112   //Applies an Undo to document with ID = theDocID
 113   Standard_EXPORT void Undo(int theDocID);
 114
 115   //Applies an Redo to document with ID = theDocID
 116   Standard_EXPORT void Redo(int theDocID);
 117
 118   //Adds a new sub shape object of the MainShape object
 119   Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
 120                                   Handle(TColStd_HArray1OfInteger) theIndices,
 121                                   bool isStandaloneOperation = false);
 122
 123   Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID,
 124                                      Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
 125                                      TVariablesList theVariables,
 126                                      bool isPublished,
 127                                      bool& aValidScript);
 128
 129   Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
 130
 131   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
 132
 133  protected:
 134   Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
 135
 136  private:
 137
 138   Handle(GEOM_Application)  _OCAFApp;
 139   Interface_DataMapOfIntegerTransient _mapIDDocument;
 140   int _UndoLimit;
 141   GEOM_DataMapOfAsciiStringTransient _objects;
 142
 143   Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
 144
 145   TFreeLabelsList _freeLabels;
 146 };
 147
 148 #endif