1 // Copyright (C) 2007-2011 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_Object_HeaderFile
24 #define _GEOM_Object_HeaderFile
26 #ifndef _Standard_TypeMismatch_HeaderFile
27 #include <Standard_TypeMismatch.hxx>
29 #ifndef _Standard_HeaderFile
30 #include <Standard.hxx>
32 #ifndef _Standard_Macro_HeaderFile
33 #include <Standard_Macro.hxx>
35 #ifndef _Standard_HeaderFile
36 #include <Standard.hxx>
38 #ifndef _Handle_MMgt_TShared_HeaderFile
39 #include <Handle_MMgt_TShared.hxx>
41 #ifndef _MMgt_TShared_HeaderFile
42 #include <MMgt_TShared.hxx>
44 #ifndef _Standard_GUID_HeaderFile
45 #include <Standard_GUID.hxx>
47 #ifndef _TopoDS_Shape_HeaderFile
48 #include <TopoDS_Shape.hxx>
50 #ifndef _TDF_Label_HeaderFile
51 #include <TDF_Label.hxx>
53 #ifndef _TColStd_HSequenceOfTransient_HeaderFile
54 #include <TColStd_HSequenceOfTransient.hxx>
56 #ifndef _TCollection_AsciiString_HeaderFile
57 #include <TCollection_AsciiString.hxx>
59 #ifndef _Aspect_TypeOfMarker_HeaderFile
60 #include <Aspect_TypeOfMarker.hxx>
64 class Handle_TColStd_HSequenceOfTransient;
65 class Standard_Transient;
66 class Handle_Standard_Type;
67 class Handle(MMgt_TShared);
71 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Object);
73 class Handle(GEOM_Object) : public Handle(MMgt_TShared) {
75 inline void* operator new(size_t,void* anAddress)
79 inline void* operator new(size_t size)
81 return Standard::Allocate(size);
83 inline void operator delete(void *anAddress)
85 if (anAddress) Standard::Free((Standard_Address&)anAddress);
88 Handle(GEOM_Object)():Handle(MMgt_TShared)() {}
89 Handle(GEOM_Object)(const Handle(GEOM_Object)& aHandle) : Handle(MMgt_TShared)(aHandle)
93 Handle(GEOM_Object)(const GEOM_Object* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
97 Handle(GEOM_Object)& operator=(const Handle(GEOM_Object)& aHandle)
99 Assign(aHandle.Access());
103 Handle(GEOM_Object)& operator=(const GEOM_Object* anItem)
105 Assign((Standard_Transient *)anItem);
109 GEOM_Object* operator->()
111 return (GEOM_Object *)ControlAccess();
114 GEOM_Object* operator->() const
116 return (GEOM_Object *)ControlAccess();
119 Standard_EXPORT ~Handle(GEOM_Object)() {};
121 Standard_EXPORT static const Handle(GEOM_Object) DownCast(const Handle(Standard_Transient)& AnObject);
125 #include <Standard_GUID.hxx>
126 #include <TDataStd_TreeNode.hxx>
127 #include "GEOM_Function.hxx"
128 #include "GEOM_Engine.hxx"
130 class GEOM_Object : public MMgt_TShared
132 friend class GEOM_Engine;
136 //! Red component of the color
138 //! Green component of the color
140 //! Blue component of the color
145 inline void* operator new(size_t,void* anAddress)
149 inline void* operator new(size_t size)
151 return Standard::Allocate(size);
153 inline void operator delete(void *anAddress)
155 if (anAddress) Standard::Free((Standard_Address&)anAddress);
160 Standard_EXPORT friend Handle_Standard_Type& GEOM_Object_Type_();
161 Standard_EXPORT const Handle(Standard_Type)& DynamicType() const { return STANDARD_TYPE(GEOM_Object) ; }
162 Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)& AType) const
163 { return (STANDARD_TYPE(GEOM_Object) == AType || MMgt_TShared::IsKind(AType)); }
166 GEOM_Object(TDF_Label& theLabel);
169 Standard_EXPORT GEOM_Object(TDF_Label& theEntry, int theType);
170 Standard_EXPORT ~GEOM_Object();
172 //Finds a GEOM_Object on the label theLabel
173 Standard_EXPORT static Handle(GEOM_Object) GetObject(TDF_Label& theLabel);
175 //Finds a GEOM_Object by a reference, stored on the label theLabel
176 Standard_EXPORT static Handle(GEOM_Object) GetReferencedObject(TDF_Label& theLabel);
178 //Returns a GEOM_Object common GUID
179 Standard_EXPORT static const Standard_GUID& GetObjectID();
181 //Returns a GUID associated with a sub shape object
182 Standard_EXPORT static const Standard_GUID& GetSubShapeID();
184 //###########################################################
185 //Access to properties
186 //###########################################################
188 //Returns a TreeNode that presents a root of a function tree for this GEOM_Object
189 Standard_EXPORT Handle(TDataStd_TreeNode) GetRootNode() { return _root; }
191 //Returns a label of this GEOM_Object
192 Standard_EXPORT TDF_Label GetEntry() { return _label; }
194 //Returns a type of this GEOM_Object (GEOM_POINT, GEOM_VECTOR...)
195 Standard_EXPORT int GetType();
197 //Sets the type of this GEOM_Object
198 Standard_EXPORT void SetType(int theType);
200 //Modifications counter management
201 Standard_EXPORT int GetTic();
202 Standard_EXPORT void SetTic(int theTic);
203 Standard_EXPORT void IncrementTic();
205 //Returns an ID of the OCAF document where this GEOM_Object is stored
206 Standard_EXPORT int GetDocID();
208 //Returns a value (as TopoDS_Shape) of this GEOM_Object
209 Standard_EXPORT TopoDS_Shape GetValue();
211 //Sets a name of this GEOM_Object
212 Standard_EXPORT void SetName(const char* theName);
214 //Returns a name of this GEOM_Object
215 Standard_EXPORT char* GetName();
217 //Sets a color of this GEOM_Object
218 Standard_EXPORT void SetColor(const Color& theColor);
220 //Returns a color of this GEOM_Object
221 Standard_EXPORT Color GetColor();
223 //Toggles an auto color mode on this GEOM_Object
224 Standard_EXPORT void SetAutoColor(bool theAutoColor);
226 //Returns a flag of auto color mode of this GEOM_Object
227 Standard_EXPORT bool GetAutoColor();
229 //Sets predefined point marker texture
230 Standard_EXPORT void SetMarkerStd(const Aspect_TypeOfMarker theType, double theSize);
232 //Sets custom point marker texture
233 Standard_EXPORT void SetMarkerTexture(int theTextureId);
235 //Gets point marker type
236 Standard_EXPORT Aspect_TypeOfMarker GetMarkerType();
238 //Gets point marker scale factor / size
239 Standard_EXPORT double GetMarkerSize();
241 //Gets custom marker texture ID
242 Standard_EXPORT int GetMarkerTexture();
244 //Unsets point marker
245 Standard_EXPORT void UnsetMarker();
247 //Sets an auxiliary data
248 Standard_EXPORT void SetAuxData(const char* theData);
250 //Returns an auxiliary data
251 Standard_EXPORT TCollection_AsciiString GetAuxData();
253 //Set a notebook variables used for object creation
254 Standard_EXPORT void SetParameters(const TCollection_AsciiString& theParameters);
256 //Get a notebook variables used for object creation
257 Standard_EXPORT TCollection_AsciiString GetParameters() const;
259 //###########################################################
261 //###########################################################
263 //Returns false if the object is a sub shape of another object
264 Standard_EXPORT bool IsMainShape();
266 //###########################################################
267 // CORBA related methods
268 //###########################################################
270 //Sets an IOR of CORBA GEOM_Object_i which refers to this object
271 Standard_EXPORT void SetIOR(TCollection_AsciiString& theIOR) { _ior = theIOR; }
273 //Returns an IOR of CORBA GEOM_Object_i which refers to this object
274 Standard_EXPORT TCollection_AsciiString GetIOR() { return _ior; }
276 //###########################################################
278 //###########################################################
280 //Adds a function with a driver GUID = theGUID and a type theFunctionType
281 //to the function tree of this GEOM_Object
282 Standard_EXPORT Handle(GEOM_Function) AddFunction(const Standard_GUID& theGUID, int theFunctionType);
284 //Returns a number of functions of this GEOM_Object
285 Standard_EXPORT int GetNbFunctions();
287 //Returns a function with given number theFunctionNumber
288 Standard_EXPORT Handle(GEOM_Function) GetFunction(int theFunctionNumber);
290 //Return the last function of this GEOM_Object
291 Standard_EXPORT Handle(GEOM_Function) GetLastFunction();
293 //Returns all dependencies of the object
294 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetAllDependency();
296 //Returns the dependencies of the last function
297 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetLastDependency();
299 //###########################################################
301 //###########################################################
303 //Returns a label which could be used to store some additional data
304 Standard_EXPORT TDF_Label GetFreeLabel();
307 Handle(TDataStd_TreeNode) _root;
309 TCollection_AsciiString _ior;
310 TCollection_AsciiString _parameters;