1 // Copyright (C) 2005 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License.
9 // This library is distributed in the hope that it will be useful
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 #ifndef _GEOM_Engine_HXX_
22 #define _GEOM_Engine_HXX_
24 #include "GEOM_Application.hxx"
25 #include "GEOM_Object.hxx"
26 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
28 #include <Interface_DataMapOfIntegerTransient.hxx>
29 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
30 #include <TDocStd_Document.hxx>
31 #include <TColStd_HArray1OfInteger.hxx>
32 #include <TColStd_HSequenceOfAsciiString.hxx>
37 Standard_EXPORT GEOM_Engine();
38 Standard_EXPORT ~GEOM_Engine() { _mapIDDocument.Clear(); _objects.Clear(); }
41 Standard_EXPORT static GEOM_Engine* GetEngine();
43 //Returns the OCAF document by its ID, if document doesn't exists it will be created
44 Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID);
46 //Returns the ID of the given OCAF document
47 Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
49 //Returns the OCAF appliaction
50 Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
52 //Returns a pointer to GEOM_Object defined by a document and the entry
53 Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry);
55 //Adds a new object of the type theType in the OCAF document
56 Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
58 //Removes the object from the OCAF document
59 Standard_EXPORT bool RemoveObject(Handle(GEOM_Object) theObject);
61 //Saves the OCAF document with ID = theDocID with file with name theFileName
62 Standard_EXPORT bool Save(int theDocID, char* theFileName);
64 //Loads the OCAF document into the application and assigns to it an ID = theDocID
65 Standard_EXPORT bool Load(int theDocID, char* theFileName);
67 //Closes the document with ID = theDocID
68 Standard_EXPORT void Close(int theDocID);
70 //Sets the number of Undos (default value = 10)
71 Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
73 //Applies an Undo to document with ID = theDocID
74 Standard_EXPORT void Undo(int theDocID);
76 //Applies an Redo to document with ID = theDocID
77 Standard_EXPORT void Redo(int theDocID);
79 //Adds a new sub shape object of the MainShape object
80 Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
81 Handle(TColStd_HArray1OfInteger) theIndices,
82 bool isStandaloneOperation = false);
84 Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID,
85 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
89 Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
91 Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
94 Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
98 Handle(GEOM_Application) _OCAFApp;
99 Interface_DataMapOfIntegerTransient _mapIDDocument;
101 GEOM_DataMapOfAsciiStringTransient _objects;
103 Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;