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_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>
63 #include "SALOMEconfig.h"
64 #include CORBA_SERVER_HEADER(SALOMEDS)
65 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
67 class Handle_TColStd_HSequenceOfTransient;
68 class Standard_Transient;
69 class Handle_Standard_Type;
70 class Handle(MMgt_TShared);
74 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Object);
76 class Handle(GEOM_Object) : public Handle(MMgt_TShared) {
78 inline void* operator new(size_t,void* anAddress)
82 inline void* operator new(size_t size)
84 return Standard::Allocate(size);
86 inline void operator delete(void *anAddress)
88 if (anAddress) Standard::Free((Standard_Address&)anAddress);
91 Handle(GEOM_Object)():Handle(MMgt_TShared)() {}
92 Handle(GEOM_Object)(const Handle(GEOM_Object)& aHandle) : Handle(MMgt_TShared)(aHandle)
96 Handle(GEOM_Object)(const GEOM_Object* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
100 Handle(GEOM_Object)& operator=(const Handle(GEOM_Object)& aHandle)
102 Assign(aHandle.Access());
106 Handle(GEOM_Object)& operator=(const GEOM_Object* anItem)
108 Assign((Standard_Transient *)anItem);
112 GEOM_Object* operator->()
114 return (GEOM_Object *)ControlAccess();
117 GEOM_Object* operator->() const
119 return (GEOM_Object *)ControlAccess();
122 Standard_EXPORT ~Handle(GEOM_Object)() {};
124 Standard_EXPORT static const Handle(GEOM_Object) DownCast(const Handle(Standard_Transient)& AnObject);
128 #include <Standard_GUID.hxx>
129 #include <TDataStd_TreeNode.hxx>
130 #include "GEOM_Function.hxx"
131 #include "GEOM_Engine.hxx"
133 class GEOM_Object : public MMgt_TShared
135 friend class GEOM_Engine;
138 inline void* operator new(size_t,void* anAddress)
142 inline void* operator new(size_t size)
144 return Standard::Allocate(size);
146 inline void operator delete(void *anAddress)
148 if (anAddress) Standard::Free((Standard_Address&)anAddress);
153 Standard_EXPORT friend Handle_Standard_Type& GEOM_Object_Type_();
154 Standard_EXPORT const Handle(Standard_Type)& DynamicType() const { return STANDARD_TYPE(GEOM_Object) ; }
155 Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)& AType) const
156 { return (STANDARD_TYPE(GEOM_Object) == AType || MMgt_TShared::IsKind(AType)); }
159 GEOM_Object(TDF_Label& theLabel);
162 Standard_EXPORT GEOM_Object(TDF_Label& theEntry, int theType);
163 Standard_EXPORT ~GEOM_Object();
165 //Finds a GEOM_Object on the label theLabel
166 Standard_EXPORT static Handle(GEOM_Object) GetObject(TDF_Label& theLabel);
168 //Finds a GEOM_Object by a reference, stored on the label theLabel
169 Standard_EXPORT static Handle(GEOM_Object) GetReferencedObject(TDF_Label& theLabel);
171 //Returns a GEOM_Object common GUID
172 Standard_EXPORT static const Standard_GUID& GetObjectID();
174 //Returns a GUID associated with a sub shape object
175 Standard_EXPORT static const Standard_GUID& GetSubShapeID();
177 //###########################################################
178 //Access to properties
179 //###########################################################
181 //Returns a TreeNode that presents a root of a function tree for this GEOM_Object
182 Standard_EXPORT Handle(TDataStd_TreeNode) GetRootNode() { return _root; }
184 //Returns a label of this GEOM_Object
185 Standard_EXPORT TDF_Label GetEntry() { return _label; }
187 //Returns a type of this GEOM_Object (GEOM_POINT, GEOM_VECTOR...)
188 Standard_EXPORT int GetType();
190 //Sets the type of this GEOM_Object
191 Standard_EXPORT void SetType(int theType);
193 //Modifications counter management
194 Standard_EXPORT int GetTic();
195 Standard_EXPORT void SetTic(int theTic);
196 Standard_EXPORT void IncrementTic();
198 //Returns an ID of the OCAF document where this GEOM_Object is stored
199 Standard_EXPORT int GetDocID();
201 //Returns a value (as TopoDS_Shape) of this GEOM_Object
202 Standard_EXPORT TopoDS_Shape GetValue();
204 //Sets a name of this GEOM_Object
205 Standard_EXPORT void SetName(const char* theName);
207 //Returns a name of this GEOM_Object
208 Standard_EXPORT char* GetName();
210 //Sets a color of this GEOM_Object
211 Standard_EXPORT void SetColor(const SALOMEDS::Color& theColor);
213 //Returns a color of this GEOM_Object
214 Standard_EXPORT SALOMEDS::Color GetColor();
216 //Toggles an auto color mode on this GEOM_Object
217 Standard_EXPORT void SetAutoColor(CORBA::Boolean theAutoColor);
219 //Returns a flag of auto color mode of this GEOM_Object
220 Standard_EXPORT CORBA::Boolean GetAutoColor();
222 //Sets predefined point marker texture
223 Standard_EXPORT void SetMarkerStd(const Aspect_TypeOfMarker theType, double theSize);
225 //Sets custom point marker texture
226 Standard_EXPORT void SetMarkerTexture(int theTextureId);
228 //Gets point marker type
229 Standard_EXPORT Aspect_TypeOfMarker GetMarkerType();
231 //Gets point marker scale factor / size
232 Standard_EXPORT double GetMarkerSize();
234 //Gets custom marker texture ID
235 Standard_EXPORT int GetMarkerTexture();
237 //Unsets point marker
238 Standard_EXPORT void UnsetMarker();
240 //Sets an auxiliary data
241 Standard_EXPORT void SetAuxData(const char* theData);
243 //Returns an auxiliary data
244 Standard_EXPORT TCollection_AsciiString GetAuxData();
246 //Set a notebook variables used for object creation
247 Standard_EXPORT void SetParameters(const TCollection_AsciiString& theParameters);
249 //Get a notebook variables used for object creation
250 Standard_EXPORT TCollection_AsciiString GetParameters() const;
252 //###########################################################
254 //###########################################################
256 //Returns false if the object is a sub shape of another object
257 Standard_EXPORT bool IsMainShape();
259 //###########################################################
260 // CORBA related methods
261 //###########################################################
263 //Sets an IOR of CORBA GEOM_Object_i which refers to this object
264 Standard_EXPORT void SetIOR(TCollection_AsciiString& theIOR) { _ior = theIOR; }
266 //Returns an IOR of CORBA GEOM_Object_i which refers to this object
267 Standard_EXPORT TCollection_AsciiString GetIOR() { return _ior; }
269 //###########################################################
271 //###########################################################
273 //Adds a function with a driver GUID = theGUID and a type theFunctionType
274 //to the function tree of this GEOM_Object
275 Standard_EXPORT Handle(GEOM_Function) AddFunction(const Standard_GUID& theGUID, int theFunctionType);
277 //Returns a number of functions of this GEOM_Object
278 Standard_EXPORT int GetNbFunctions();
280 //Returns a function with given number theFunctionNumber
281 Standard_EXPORT Handle(GEOM_Function) GetFunction(int theFunctionNumber);
283 //Return the last function of this GEOM_Object
284 Standard_EXPORT Handle(GEOM_Function) GetLastFunction();
286 //Returns all dependencies of the object
287 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetAllDependency();
289 //Returns the dependencies of the last function
290 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetLastDependency();
292 //###########################################################
294 //###########################################################
296 //Returns a label which could be used to store some additional data
297 Standard_EXPORT TDF_Label GetFreeLabel();
300 Handle(TDataStd_TreeNode) _root;
302 TCollection_AsciiString _ior;
303 TCollection_AsciiString _parameters;