Salome HOME
0021672: [CEA 565] Dump Study from script
[modules/geom.git] / src / GEOM / GEOM_Engine.hxx
index 5a45bdc9372dcad97bea07caee8dd5116cb6789a..4ae37dfec29406681bb53f7b75c1d705ed4a0baa 100644 (file)
@@ -1,24 +1,25 @@
-//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
-//  This library is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU Lesser General Public
-//  License as published by the Free Software Foundation; either
-//  version 2.1 of the License.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
 //
-//  This library is distributed in the hope that it will be useful,
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
 #ifndef _GEOM_Engine_HXX_
 #define _GEOM_Engine_HXX_
 
 #include "GEOM_Object.hxx"
 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
 
-#include <Interface_DataMapOfIntegerTransient.hxx> 
+#include <Basics_OCCTVersion.hxx>
+
+#if OCC_VERSION_LARGE > 0x06040000 // Porting to OCCT6.5.1
+#include <TColStd_DataMapOfIntegerTransient.hxx>
+#else
+#include <Interface_DataMapOfIntegerTransient.hxx>
+#endif
+
 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
 #include <TDocStd_Document.hxx>
 #include <TColStd_HArray1OfInteger.hxx>
 #include <TDF_Label.hxx>
 
 #include <map>
+#include <list>
 #include <vector>
+#include <string>
+
+/*!
+ * \brief Data of GEOM_Object
+ */
+struct TObjectData
+{
+  TCollection_AsciiString _entry;
+  TCollection_AsciiString _studyEntry;
+  TCollection_AsciiString _name;
+  TCollection_AsciiString _pyName;
+  bool                    _unpublished;
+};
+  
+#if OCC_VERSION_LARGE > 0x06040000 // Porting to OCCT6.5.1
+class Handle_TColStd_HArray1OfByte;
+#else
+class Handle_TDataStd_HArray1OfByte;
+#endif
 
 struct TVariable{
   TCollection_AsciiString myVariable;
@@ -67,6 +95,8 @@ private:
 
 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
 
+typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
+
 class GEOM_Engine
 {
  public:
@@ -77,7 +107,7 @@ class GEOM_Engine
   Standard_EXPORT static GEOM_Engine* GetEngine();   
 
   //Returns the OCAF document by its ID, if document doesn't exists it will be created
-  Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID);
+  Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID, bool force=true);
 
   //Returns the ID of the given OCAF document
   Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
@@ -86,7 +116,7 @@ class GEOM_Engine
   Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
 
   //Returns a pointer to GEOM_Object defined by a document and the entry
-  Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry);
+  Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry, bool force=true);
   
   //Adds a new object of the type theType in the OCAF document
   Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
@@ -112,34 +142,59 @@ class GEOM_Engine
   //Applies an Redo to document with ID = theDocID
   Standard_EXPORT void Redo(int theDocID);
 
-  //Adds a new sub shape object of the MainShape object
+  //Adds a new sub-shape object of the MainShape object
   Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape, 
-                                 Handle(TColStd_HArray1OfInteger) theIndices,
-                                 bool isStandaloneOperation = false);
+                                  Handle(TColStd_HArray1OfInteger) theIndices,
+                                  bool isStandaloneOperation = false);
 
   Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID, 
-                                    Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
-                                     TVariablesList theVariables,
-                                    bool isPublished, 
-                                    bool& aValidScript);
+                                                     std::vector<TObjectData>& theObjectData,
+                                                     TVariablesList theVariables,
+                                                     bool isPublished, 
+                                                     bool isMultiFile, 
+                                                     bool& aValidScript);
 
   Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
 
   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
 
+  Standard_EXPORT int addTexture(int theDocID, int theWidth, int theHeight,
+#if OCC_VERSION_LARGE > 0x06040000 // Porting to OCCT6.5.1
+                                 const Handle(TColStd_HArray1OfByte)& theTexture,
+#else
+                                 const Handle(TDataStd_HArray1OfByte)& theTexture,
+#endif
+                                 const TCollection_AsciiString& theFileName = "");
+
+#if OCC_VERSION_LARGE > 0x06040000 // Porting to OCCT6.5.1
+  Standard_EXPORT Handle(TColStd_HArray1OfByte) getTexture(int theDocID, int theTextureID,
+#else
+  Standard_EXPORT Handle(TDataStd_HArray1OfByte) getTexture(int theDocID, int theTextureID,
+#endif
+                                                           int& theWidth, int& theHeight,
+                                                           TCollection_AsciiString& theFileName);
+
+  Standard_EXPORT std::list<int> getAllTextures(int theDocID);
+
+  static const Standard_GUID& GetTextureGUID();
+
  protected:
   Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);       
   
  private:
 
   Handle(GEOM_Application)  _OCAFApp;
+#if OCC_VERSION_LARGE > 0x06040000 // Porting to OCCT6.5.1
+  TColStd_DataMapOfIntegerTransient _mapIDDocument;
+#else
   Interface_DataMapOfIntegerTransient _mapIDDocument;
+#endif
   int _UndoLimit;
   GEOM_DataMapOfAsciiStringTransient _objects;
 
   Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
 
-  TDF_Label _lastCleared;
+  TFreeLabelsList _freeLabels;
 };
 
 #endif