src/GEOM/GEOM_Engine.hxx

   1 // Copyright (C) 2007-2011  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
  23 #ifndef _GEOM_Engine_HXX_
  24 #define _GEOM_Engine_HXX_
  25
  26 #include "GEOM_Application.hxx"
  27 #include "GEOM_Object.hxx"
  28 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
  29
  30 #include <Interface_DataMapOfIntegerTransient.hxx>
  31 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
  32 #include <TDocStd_Document.hxx>
  33 #include <TColStd_HArray1OfInteger.hxx>
  34 #include <TColStd_HSequenceOfAsciiString.hxx>
  35 #include <TDF_Label.hxx>
  36
  37 #include <map>
  38 #include <list>
  39 #include <vector>
  40 #include <string>
  41
  42 /*!
  43  * \brief Data of GEOM_Object
  44  */
  45 struct TObjectData
  46 {
  47   TCollection_AsciiString _entry;
  48   TCollection_AsciiString _studyEntry;
  49   TCollection_AsciiString _name;
  50   TCollection_AsciiString _pyName;
  51   bool                    _unpublished;
  52 };
  53
  54 class Handle_TDataStd_HArray1OfByte;
  55
  56 struct TVariable{
  57   TCollection_AsciiString myVariable;
  58   bool isVariable;
  59
  60   TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
  61     myVariable(theVariable),
  62     isVariable(theFlag){}
  63 };
  64
  65 typedef std::vector<TVariable> TState;
  66 typedef std::vector<TState>    TAllStates;
  67
  68 class ObjectStates
  69 {
  70 public:
  71   Standard_EXPORT ObjectStates();
  72   ~ObjectStates();
  73
  74   TAllStates GetAllStates() const { return _states; }
  75
  76   TState GetCurrectState() const;
  77   Standard_EXPORT void AddState(const TState &theState);
  78   void IncrementState();
  79
  80 private:
  81   TAllStates              _states;
  82   int                     _dumpstate;
  83 };
  84
  85 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
  86
  87 typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
  88
  89 class GEOM_Engine
  90 {
  91  public:
  92   Standard_EXPORT GEOM_Engine();
  93   Standard_EXPORT virtual ~GEOM_Engine();
  94
  95   //Retuns the engine
  96   Standard_EXPORT static GEOM_Engine* GetEngine();
  97
  98   //Returns the OCAF document by its ID, if document doesn't exists it will be created
  99   Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID, bool force=true);
 100
 101   //Returns the ID of the given OCAF document
 102   Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
 103
 104   //Returns the OCAF appliaction
 105   Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
 106
 107   //Returns a pointer to GEOM_Object defined by a document and the entry
 108   Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry, bool force=true);
 109
 110   //Adds a new object of the type theType in the OCAF document
 111   Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
 112
 113   //Removes the object from the OCAF document
 114   Standard_EXPORT bool RemoveObject(Handle(GEOM_Object) theObject);
 115
 116   //Saves the OCAF document with ID = theDocID with file with name theFileName
 117   Standard_EXPORT bool Save(int theDocID, char* theFileName);
 118
 119   //Loads the OCAF document into the application and assigns to it an ID = theDocID
 120   Standard_EXPORT bool Load(int theDocID, char* theFileName);
 121
 122   //Closes the document with ID =  theDocID
 123   Standard_EXPORT void Close(int theDocID);
 124
 125   //Sets the number of Undos (default value = 10)
 126   Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
 127
 128   //Applies an Undo to document with ID = theDocID
 129   Standard_EXPORT void Undo(int theDocID);
 130
 131   //Applies an Redo to document with ID = theDocID
 132   Standard_EXPORT void Redo(int theDocID);
 133
 134   //Adds a new sub shape object of the MainShape object
 135   Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
 136                                   Handle(TColStd_HArray1OfInteger) theIndices,
 137                                   bool isStandaloneOperation = false);
 138
 139   Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID,
 140                                                      std::vector<TObjectData>& theObjectData,
 141                                                      TVariablesList theVariables,
 142                                                      bool isPublished,
 143                                                      bool isMultiFile,
 144                                                      bool& aValidScript);
 145
 146   Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
 147
 148   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
 149
 150   Standard_EXPORT int addTexture(int theDocID, int theWidth, int theHeight,
 151                                  const Handle(TDataStd_HArray1OfByte)& theTexture,
 152                                  const TCollection_AsciiString& theFileName = "");
 153
 154   Standard_EXPORT Handle(TDataStd_HArray1OfByte) getTexture(int theDocID, int theTextureID,
 155                                                             int& theWidth, int& theHeight,
 156                                                             TCollection_AsciiString& theFileName);
 157
 158   Standard_EXPORT std::list<int> getAllTextures(int theDocID);
 159
 160   static const Standard_GUID& GetTextureGUID();
 161
 162  protected:
 163   Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
 164
 165  private:
 166
 167   Handle(GEOM_Application)  _OCAFApp;
 168   Interface_DataMapOfIntegerTransient _mapIDDocument;
 169   int _UndoLimit;
 170   GEOM_DataMapOfAsciiStringTransient _objects;
 171
 172   Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
 173
 174   TFreeLabelsList _freeLabels;
 175 };
 176
 177 #endif