1 // Copyright (C) 2007-2013 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);
69 class Handle(TFunction_Driver);
72 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Object);
74 class Handle(GEOM_Object) : public Handle(MMgt_TShared) {
76 inline void* operator new(size_t,void* anAddress)
80 inline void* operator new(size_t size)
82 return Standard::Allocate(size);
84 inline void operator delete(void *anAddress)
86 if (anAddress) Standard::Free((Standard_Address&)anAddress);
89 Handle(GEOM_Object)():Handle(MMgt_TShared)() {}
90 Handle(GEOM_Object)(const Handle(GEOM_Object)& aHandle) : Handle(MMgt_TShared)(aHandle)
94 Handle(GEOM_Object)(const GEOM_Object* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
98 Handle(GEOM_Object)& operator=(const Handle(GEOM_Object)& aHandle)
100 Assign(aHandle.Access());
104 Handle(GEOM_Object)& operator=(const GEOM_Object* anItem)
106 Assign((Standard_Transient *)anItem);
110 GEOM_Object* operator->()
112 return (GEOM_Object *)ControlAccess();
115 GEOM_Object* operator->() const
117 return (GEOM_Object *)ControlAccess();
120 Standard_EXPORT ~Handle(GEOM_Object)() {};
122 Standard_EXPORT static const Handle(GEOM_Object) DownCast(const Handle(Standard_Transient)& AnObject);
126 #include <Standard_GUID.hxx>
127 #include <TDataStd_TreeNode.hxx>
128 #include "GEOM_Function.hxx"
129 #include "GEOM_Engine.hxx"
131 class GEOM_Object : public MMgt_TShared
133 friend class GEOM_Engine;
137 //! Red component of the color
139 //! Green component of the color
141 //! Blue component of the color
146 inline void* operator new(size_t,void* anAddress)
150 inline void* operator new(size_t size)
152 return Standard::Allocate(size);
154 inline void operator delete(void *anAddress)
156 if (anAddress) Standard::Free((Standard_Address&)anAddress);
161 Standard_EXPORT friend Handle_Standard_Type& GEOM_Object_Type_();
162 Standard_EXPORT const Handle(Standard_Type)& DynamicType() const { return STANDARD_TYPE(GEOM_Object) ; }
163 Standard_EXPORT Standard_Boolean IsKind(const Handle(Standard_Type)& AType) const
164 { return (STANDARD_TYPE(GEOM_Object) == AType || MMgt_TShared::IsKind(AType)); }
167 GEOM_Object(TDF_Label& theLabel);
170 Standard_EXPORT GEOM_Object(TDF_Label& theEntry, int theType);
171 Standard_EXPORT ~GEOM_Object();
173 //Finds a GEOM_Object on the label theLabel
174 Standard_EXPORT static Handle(GEOM_Object) GetObject(TDF_Label& theLabel);
176 //Finds a GEOM_Object by a reference, stored on the label theLabel
177 Standard_EXPORT static Handle(GEOM_Object) GetReferencedObject(TDF_Label& theLabel);
179 //Returns a GEOM_Object common GUID
180 Standard_EXPORT static const Standard_GUID& GetObjectID();
182 //Returns a GUID associated with a sub-shape object
183 Standard_EXPORT static const Standard_GUID& GetSubShapeID();
185 //###########################################################
186 //Access to properties
187 //###########################################################
189 //Returns a TreeNode that presents a root of a function tree for this GEOM_Object
190 Standard_EXPORT Handle(TDataStd_TreeNode) GetRootNode() { return _root; }
192 //Returns a label of this GEOM_Object
193 Standard_EXPORT TDF_Label GetEntry() { return _label; }
195 //Returns a type of this GEOM_Object (GEOM_POINT, GEOM_VECTOR...)
196 Standard_EXPORT int GetType();
198 //Sets the type of this GEOM_Object
199 Standard_EXPORT void SetType(int theType);
201 //Modifications counter management
202 Standard_EXPORT int GetTic();
203 Standard_EXPORT void SetTic(int theTic);
204 Standard_EXPORT void IncrementTic();
206 //Returns an ID of the OCAF document where this GEOM_Object is stored
207 Standard_EXPORT int GetDocID();
209 //Returns a value (as TopoDS_Shape) of this GEOM_Object
210 Standard_EXPORT TopoDS_Shape GetValue();
212 //Sets a name of this GEOM_Object
213 Standard_EXPORT void SetName(const char* theName);
215 //Returns a name of this GEOM_Object
216 Standard_EXPORT char* GetName();
218 //Sets a color of this GEOM_Object
219 Standard_EXPORT void SetColor(const Color& theColor);
221 //Returns a color of this GEOM_Object
222 Standard_EXPORT Color GetColor();
224 //Toggles an auto color mode on this GEOM_Object
225 Standard_EXPORT void SetAutoColor(bool theAutoColor);
227 //Returns a flag of auto color mode of this GEOM_Object
228 Standard_EXPORT bool GetAutoColor();
230 //Sets predefined point marker texture
231 Standard_EXPORT void SetMarkerStd(const Aspect_TypeOfMarker theType, double theSize);
233 //Sets custom point marker texture
234 Standard_EXPORT void SetMarkerTexture(int theTextureId);
236 //Gets point marker type
237 Standard_EXPORT Aspect_TypeOfMarker GetMarkerType();
239 //Gets point marker scale factor / size
240 Standard_EXPORT double GetMarkerSize();
242 //Gets custom marker texture ID
243 Standard_EXPORT int GetMarkerTexture();
245 //Unsets point marker
246 Standard_EXPORT void UnsetMarker();
248 //Sets an auxiliary data
249 Standard_EXPORT void SetAuxData(const char* theData);
251 //Returns an auxiliary data
252 Standard_EXPORT TCollection_AsciiString GetAuxData();
254 //Set a notebook variables used for object creation
255 Standard_EXPORT void SetParameters(const TCollection_AsciiString& theParameters);
257 //Get a notebook variables used for object creation
258 Standard_EXPORT TCollection_AsciiString GetParameters() const;
260 //###########################################################
262 //###########################################################
264 //Returns false if the object is a sub-shape of another object
265 Standard_EXPORT bool IsMainShape();
267 //###########################################################
268 // CORBA related methods
269 //###########################################################
271 //Sets an IOR of CORBA GEOM_Object_i which refers to this object
272 Standard_EXPORT void SetIOR(TCollection_AsciiString& theIOR) { _ior = theIOR; }
274 //Returns an IOR of CORBA GEOM_Object_i which refers to this object
275 Standard_EXPORT TCollection_AsciiString GetIOR() { return _ior; }
277 //###########################################################
279 //###########################################################
281 //Adds a function with a driver GUID = theGUID and a type theFunctionType
282 //to the function tree of this GEOM_Object
283 Standard_EXPORT Handle(GEOM_Function) AddFunction(const Standard_GUID& theGUID,
285 bool allowSubShape=false);
287 //Returns a number of functions of this GEOM_Object
288 Standard_EXPORT int GetNbFunctions();
290 //Returns a function with given number theFunctionNumber
291 Standard_EXPORT Handle(GEOM_Function) GetFunction(int theFunctionNumber);
293 //Return the last function of this GEOM_Object
294 Standard_EXPORT Handle(GEOM_Function) GetLastFunction();
296 //Returns all dependencies of the object
297 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetAllDependency();
299 //Returns the dependencies of the last function
300 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetLastDependency();
302 //Returns a driver creator of this object
303 Standard_EXPORT Handle(TFunction_Driver) GetCreationDriver();
305 //###########################################################
307 //###########################################################
309 //Returns a label which could be used to store some additional data
310 Standard_EXPORT TDF_Label GetFreeLabel();
313 Handle(TDataStd_TreeNode) _root;
315 TCollection_AsciiString _ior;
316 TCollection_AsciiString _parameters;