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
20 #ifndef _GEOM_Object_HeaderFile
21 #define _GEOM_Object_HeaderFile
23 #ifndef _Standard_TypeMismatch_HeaderFile
24 #include <Standard_TypeMismatch.hxx>
26 #ifndef _Standard_HeaderFile
27 #include <Standard.hxx>
29 #ifndef _Standard_Macro_HeaderFile
30 #include <Standard_Macro.hxx>
32 #ifndef _Standard_HeaderFile
33 #include <Standard.hxx>
35 #ifndef _Handle_MMgt_TShared_HeaderFile
36 #include <Handle_MMgt_TShared.hxx>
38 #ifndef _MMgt_TShared_HeaderFile
39 #include <MMgt_TShared.hxx>
41 #ifndef _Standard_GUID_HeaderFile
42 #include <Standard_GUID.hxx>
44 #ifndef _TopoDS_Shape_HeaderFile
45 #include <TopoDS_Shape.hxx>
47 #ifndef _TDF_Label_HeaderFile
48 #include <TDF_Label.hxx>
50 #ifndef _TColStd_HSequenceOfTransient_HeaderFile
51 #include <TColStd_HSequenceOfTransient.hxx>
53 #ifndef _TCollection_AsciiString_HeaderFile
54 #include <TCollection_AsciiString.hxx>
57 class Handle_TColStd_HSequenceOfTransient;
58 class Standard_Transient;
59 class Handle_Standard_Type;
60 class Handle(MMgt_TShared);
64 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Object);
66 class Handle(GEOM_Object) : public Handle(MMgt_TShared) {
68 inline void* operator new(size_t,void* anAddress)
72 inline void* operator new(size_t size)
74 return Standard::Allocate(size);
76 inline void operator delete(void *anAddress)
78 if (anAddress) Standard::Free((Standard_Address&)anAddress);
81 Handle(GEOM_Object)():Handle(MMgt_TShared)() {}
82 Handle(GEOM_Object)(const Handle(GEOM_Object)& aHandle) : Handle(MMgt_TShared)(aHandle)
86 Handle(GEOM_Object)(const GEOM_Object* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
90 Handle(GEOM_Object)& operator=(const Handle(GEOM_Object)& aHandle)
92 Assign(aHandle.Access());
96 Handle(GEOM_Object)& operator=(const GEOM_Object* anItem)
98 Assign((Standard_Transient *)anItem);
102 GEOM_Object* operator->()
104 return (GEOM_Object *)ControlAccess();
107 GEOM_Object* operator->() const
109 return (GEOM_Object *)ControlAccess();
112 Standard_EXPORT ~Handle(GEOM_Object)() {};
114 Standard_EXPORT static const Handle(GEOM_Object) DownCast(const Handle(Standard_Transient)& AnObject);
118 #include <Standard_GUID.hxx>
119 #include <TDataStd_TreeNode.hxx>
120 #include "GEOM_Function.hxx"
121 #include "GEOM_Engine.hxx"
123 class GEOM_Object : public MMgt_TShared
125 friend class GEOM_Engine;
128 inline void* operator new(size_t,void* anAddress)
132 inline void* operator new(size_t size)
134 return Standard::Allocate(size);
136 inline void operator delete(void *anAddress)
138 if (anAddress) Standard::Free((Standard_Address&)anAddress);
143 Standard_EXPORT friend Handle_Standard_Type& GEOM_Object_Type_();
144 Standard_EXPORT const Handle(Standard_Type)& DynamicType() const { return STANDARD_TYPE(GEOM_Object) ; }
145 Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)& AType) const
146 { return (STANDARD_TYPE(GEOM_Object) == AType || MMgt_TShared::IsKind(AType)); }
149 GEOM_Object(TDF_Label& theLabel);
152 Standard_EXPORT GEOM_Object(TDF_Label& theEntry, int theType);
153 Standard_EXPORT ~GEOM_Object() {;}
155 //Finds a GEOM_Object on the label theLabel
156 Standard_EXPORT static Handle(GEOM_Object) GetObject(TDF_Label& theLabel);
158 //Finds a GEOM_Object by a reference, stored on the label theLabel
159 Standard_EXPORT static Handle(GEOM_Object) GetReferencedObject(TDF_Label& theLabel);
161 //Returns a GEOM_Object common GUID
162 Standard_EXPORT static const Standard_GUID& GetObjectID();
164 //Returns a GUID associated with a sub shape object
165 Standard_EXPORT static const Standard_GUID& GetSubShapeID();
167 //###########################################################
168 //Access to properties
169 //###########################################################
171 //Returns a TreeNode that presents a root of a function tree for this GEOM_Object
172 Standard_EXPORT Handle(TDataStd_TreeNode) GetRootNode() { return _root; }
174 //Returns a label of this GEOM_Object
175 Standard_EXPORT TDF_Label GetEntry() { return _label; }
177 //Returns a type of this GEOM_Object (GEOM_POINT, GEOM_VECTOR...)
178 Standard_EXPORT int GetType();
180 //Sets the type of this GEOM_Object
181 Standard_EXPORT void SetType(int theType);
183 //Modifications counter management
184 Standard_EXPORT int GetTic();
185 Standard_EXPORT void SetTic(int theTic);
186 Standard_EXPORT void IncrementTic();
188 //Returns an ID of the OCAF document where this GEOM_Object is stored
189 Standard_EXPORT int GetDocID();
191 //Returns a value (as TopoDS_Shape) of this GEOM_Object
192 Standard_EXPORT TopoDS_Shape GetValue();
194 //Sets a name of this GEOM_Object
195 Standard_EXPORT void SetName(const char* theName);
197 //Returns a name of this GEOM_Object
198 Standard_EXPORT char* GetName();
200 //Sets an auxiliary data
201 Standard_EXPORT void SetAuxData(const char* theData);
203 //Returns an auxiliary data
204 Standard_EXPORT TCollection_AsciiString GetAuxData();
206 //###########################################################
208 //###########################################################
210 //Returns false if the object is a sub shape of another object
211 Standard_EXPORT bool IsMainShape();
213 //###########################################################
214 // CORBA related methods
215 //###########################################################
217 //Sets an IOR of CORBA GEOM_Object_i which refers to this object
218 Standard_EXPORT void SetIOR(TCollection_AsciiString& theIOR) { _ior = theIOR; }
220 //Returns an IOR of CORBA GEOM_Object_i which refers to this object
221 Standard_EXPORT TCollection_AsciiString GetIOR() { return _ior; }
223 //###########################################################
225 //###########################################################
227 //Adds a function with a driver GUID = theGUID and a type theFunctionType
228 //to the function tree of this GEOM_Object
229 Standard_EXPORT Handle(GEOM_Function) AddFunction(const Standard_GUID& theGUID, int theFunctionType);
231 //Returns a number of functions of this GEOM_Object
232 Standard_EXPORT int GetNbFunctions();
234 //Returns a function with given number theFunctionNumber
235 Standard_EXPORT Handle(GEOM_Function) GetFunction(int theFunctionNumber);
237 //Return the last function of this GEOM_Object
238 Standard_EXPORT Handle(GEOM_Function) GetLastFunction();
240 //Returns all dependencies of the object
241 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetAllDependency();
243 //Returns the dependencies of the last function
244 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetLastDependency();
246 //###########################################################
248 //###########################################################
250 //Returns a label which could be used to store some additional data
251 Standard_EXPORT TDF_Label GetFreeLabel();
254 Handle(TDataStd_TreeNode) _root;
256 TCollection_AsciiString _ior;