1 // Copyright (C) 2007-2016 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, or (at your option) any later version.
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 <Basics_OCCTVersion.hxx>
32 #include <TColStd_DataMapOfIntegerTransient.hxx>
34 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
35 #include <TDocStd_Document.hxx>
36 #include <TColStd_HArray1OfInteger.hxx>
37 #include <TColStd_HArray1OfByte.hxx>
38 #include <TColStd_HSequenceOfAsciiString.hxx>
39 #include <TColStd_MapOfInteger.hxx>
40 #include <TDF_Label.hxx>
48 * \brief Data of GEOM_Object
52 TCollection_AsciiString _entry;
53 TCollection_AsciiString _studyEntry;
54 TCollection_AsciiString _name;
55 TCollection_AsciiString _pyName;
60 TCollection_AsciiString myVariable;
63 TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
64 myVariable(theVariable),
68 typedef std::vector<TVariable> TState;
69 typedef std::vector<TState> TAllStates;
74 Standard_EXPORT ObjectStates();
77 TAllStates GetAllStates() const { return _states; }
79 TState GetCurrectState() const;
80 Standard_EXPORT void AddState(const TState &theState);
81 void IncrementState();
88 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
90 typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
95 Standard_EXPORT GEOM_Engine();
96 Standard_EXPORT virtual ~GEOM_Engine();
99 Standard_EXPORT static GEOM_Engine* GetEngine();
101 //Returns the OCAF document by its ID, if document doesn't exists it will be created
102 Standard_EXPORT Handle(TDocStd_Document) GetDocument(bool force=true);
104 //Returns the OCAF appliaction
105 Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
107 //Returns a pointer to GEOM_BaseObject defined by a document and the entry
108 Standard_EXPORT Handle(GEOM_BaseObject) GetObject(const char* theEntry,
111 //Adds a new object of the type theType in the OCAF document
112 Standard_EXPORT Handle(GEOM_BaseObject) AddBaseObject(int theType);
114 //Adds a new object of the type theType in the OCAF document
115 Standard_EXPORT Handle(GEOM_Object) AddObject(int theType);
117 //Removes the object from the OCAF document
118 Standard_EXPORT bool RemoveObject(Handle(GEOM_BaseObject)& theObject);
120 //Saves the OCAF document with file with name theFileName
121 Standard_EXPORT bool Save(const char* theFileName);
123 //Loads the OCAF document into the application
124 Standard_EXPORT bool Load(const char* theFileName);
126 //Closes the document
127 Standard_EXPORT void Close();
129 //Sets the number of Undos (default value = 10)
130 Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
132 //Applies an Undo to document
133 Standard_EXPORT void Undo();
135 //Applies an Redo to document
136 Standard_EXPORT void Redo();
138 //Adds a new sub-shape object of the MainShape object
139 Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
140 Handle(TColStd_HArray1OfInteger) theIndices,
141 bool isStandaloneOperation = false);
143 Standard_EXPORT TCollection_AsciiString DumpPython(std::vector<TObjectData>& theObjectData,
144 TVariablesList theVariables,
149 Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
151 Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
153 Standard_EXPORT int addTexture(int theWidth, int theHeight,
154 const Handle(TColStd_HArray1OfByte)& theTexture,
155 const TCollection_AsciiString& theFileName = "");
157 Standard_EXPORT Handle(TColStd_HArray1OfByte) getTexture(int theTextureID,
158 int& theWidth, int& theHeight,
159 TCollection_AsciiString& theFileName);
161 Standard_EXPORT std::list<int> getAllTextures();
163 static const Standard_GUID& GetTextureGUID();
165 Standard_EXPORT void healPyName( TCollection_AsciiString& pyName,
166 const TCollection_AsciiString& anEntry,
167 Resource_DataMapOfAsciiStringAsciiString& aNameToEntry);
170 Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
174 Handle(GEOM_Application) _OCAFApp;
175 Handle(TDocStd_Document) _document;
178 GEOM_DataMapOfAsciiStringTransient _objects;
180 Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
182 std::list<TDF_Label> _freeLabels;