1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef _GEOM_Engine_HXX_
24 #define _GEOM_Engine_HXX_
26 #include "GEOM_Application.hxx"
27 #include "GEOM_Object.hxx"
28 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
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>
41 class Handle_TDataStd_HArray1OfByte;
44 TCollection_AsciiString myVariable;
47 TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
48 myVariable(theVariable),
52 typedef std::vector<TVariable> TState;
53 typedef std::vector<TState> TAllStates;
58 Standard_EXPORT ObjectStates();
61 TAllStates GetAllStates() const { return _states; }
63 TState GetCurrectState() const;
64 Standard_EXPORT void AddState(const TState &theState);
65 void IncrementState();
72 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
74 typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
79 Standard_EXPORT GEOM_Engine();
80 Standard_EXPORT virtual ~GEOM_Engine();
83 Standard_EXPORT static GEOM_Engine* GetEngine();
85 //Returns the OCAF document by its ID, if document doesn't exists it will be created
86 Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID, bool force=true);
88 //Returns the ID of the given OCAF document
89 Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
91 //Returns the OCAF appliaction
92 Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
94 //Returns a pointer to GEOM_Object defined by a document and the entry
95 Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry, bool force=true);
97 //Adds a new object of the type theType in the OCAF document
98 Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
100 //Removes the object from the OCAF document
101 Standard_EXPORT bool RemoveObject(Handle(GEOM_Object) theObject);
103 //Saves the OCAF document with ID = theDocID with file with name theFileName
104 Standard_EXPORT bool Save(int theDocID, char* theFileName);
106 //Loads the OCAF document into the application and assigns to it an ID = theDocID
107 Standard_EXPORT bool Load(int theDocID, char* theFileName);
109 //Closes the document with ID = theDocID
110 Standard_EXPORT void Close(int theDocID);
112 //Sets the number of Undos (default value = 10)
113 Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
115 //Applies an Undo to document with ID = theDocID
116 Standard_EXPORT void Undo(int theDocID);
118 //Applies an Redo to document with ID = theDocID
119 Standard_EXPORT void Redo(int theDocID);
121 //Adds a new sub shape object of the MainShape object
122 Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
123 Handle(TColStd_HArray1OfInteger) theIndices,
124 bool isStandaloneOperation = false);
126 Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID,
127 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
128 TVariablesList theVariables,
132 Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
134 Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
136 Standard_EXPORT int addTexture(int theDocID, int theWidth, int theHeight,
137 const Handle(TDataStd_HArray1OfByte)& theTexture,
138 const TCollection_AsciiString& theFileName = "");
140 Standard_EXPORT Handle(TDataStd_HArray1OfByte) getTexture(int theDocID, int theTextureID,
141 int& theWidth, int& theHeight,
142 TCollection_AsciiString& theFileName);
144 Standard_EXPORT std::list<int> getAllTextures(int theDocID);
146 static const Standard_GUID& GetTextureGUID();
149 Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
153 Handle(GEOM_Application) _OCAFApp;
154 Interface_DataMapOfIntegerTransient _mapIDDocument;
156 GEOM_DataMapOfAsciiStringTransient _objects;
158 Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
160 TFreeLabelsList _freeLabels;