1 // Copyright (C) 2007-2022 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 <TColStd_DataMapOfIntegerTransient.hxx>
32 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
33 #include <TDocStd_Document.hxx>
34 #include <TColStd_HArray1OfInteger.hxx>
35 #include <TColStd_HArray1OfByte.hxx>
36 #include <TColStd_HSequenceOfAsciiString.hxx>
37 #include <TColStd_MapOfInteger.hxx>
38 #include <TDF_Label.hxx>
46 * \brief Data of GEOM_Object
50 TCollection_AsciiString _entry;
51 TCollection_AsciiString _studyEntry;
52 TCollection_AsciiString _name;
53 TCollection_AsciiString _pyName;
58 TCollection_AsciiString myVariable;
61 TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
62 myVariable(theVariable),
66 typedef std::vector<TVariable> TState;
67 typedef std::vector<TState> TAllStates;
72 Standard_EXPORT ObjectStates();
75 TAllStates GetAllStates() const { return _states; }
77 TState GetCurrectState() const;
78 Standard_EXPORT void AddState(const TState &theState);
79 void IncrementState();
86 typedef std::map<TCollection_AsciiString, ObjectStates* > TVariablesList;
88 typedef std::map<int, std::list<TDF_Label> > TFreeLabelsList;
93 Standard_EXPORT GEOM_Engine();
94 Standard_EXPORT virtual ~GEOM_Engine();
97 Standard_EXPORT static GEOM_Engine* GetEngine();
99 //Returns the OCAF document by its ID, if document doesn't exists it will be created
100 Standard_EXPORT Handle(TDocStd_Document) GetDocument(bool force=true);
102 //Returns the OCAF application
103 Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
105 //Returns a pointer to GEOM_BaseObject defined by a document and the entry
106 Standard_EXPORT Handle(GEOM_BaseObject) GetObject(const char* theEntry,
109 //Adds a new object of the type theType in the OCAF document
110 Standard_EXPORT Handle(GEOM_BaseObject) AddBaseObject(int theType);
112 //Adds a new object of the type theType in the OCAF document
113 Standard_EXPORT Handle(GEOM_Object) AddObject(int theType);
115 //Removes the object from the OCAF document
116 Standard_EXPORT bool RemoveObject(Handle(GEOM_BaseObject)& theObject);
118 //Saves the OCAF document with file with name theFileName
119 Standard_EXPORT bool Save(const char* theFileName);
121 //Loads the OCAF document into the application
122 Standard_EXPORT bool Load(const char* theFileName);
124 //Closes the document
125 Standard_EXPORT void Close();
127 //Sets the number of Undos (default value = 10)
128 Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
130 //Applies an Undo to document
131 Standard_EXPORT void Undo();
133 //Applies an Redo to document
134 Standard_EXPORT void Redo();
136 //Adds a new sub-shape object of the MainShape object
137 Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
138 Handle(TColStd_HArray1OfInteger) theIndices,
139 bool isStandaloneOperation = false);
141 Standard_EXPORT TCollection_AsciiString DumpPython(std::vector<TObjectData>& theObjectData,
142 TVariablesList theVariables,
147 Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
149 Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
151 Standard_EXPORT int addTexture(int theWidth, int theHeight,
152 const Handle(TColStd_HArray1OfByte)& theTexture,
153 const TCollection_AsciiString& theFileName = "");
155 Standard_EXPORT Handle(TColStd_HArray1OfByte) getTexture(int theTextureID,
156 int& theWidth, int& theHeight,
157 TCollection_AsciiString& theFileName);
159 Standard_EXPORT std::list<int> getAllTextures();
161 static const Standard_GUID& GetTextureGUID();
163 Standard_EXPORT void healPyName( TCollection_AsciiString& pyName,
164 const TCollection_AsciiString& anEntry,
165 Resource_DataMapOfAsciiStringAsciiString& aNameToEntry);
168 Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
172 Handle(GEOM_Application) _OCAFApp;
173 Handle(TDocStd_Document) _document;
176 GEOM_DataMapOfAsciiStringTransient _objects;
178 Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
180 std::list<TDF_Label> _freeLabels;