src/GEOM/GEOM_Object.hxx

   1 // Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef _GEOM_Object_HeaderFile
  24 #define _GEOM_Object_HeaderFile
  25
  26 #ifndef _Standard_TypeMismatch_HeaderFile
  27 #include <Standard_TypeMismatch.hxx>
  28 #endif
  29 #ifndef _Standard_HeaderFile
  30 #include <Standard.hxx>
  31 #endif
  32 #ifndef _Standard_Macro_HeaderFile
  33 #include <Standard_Macro.hxx>
  34 #endif
  35 #ifndef _Standard_HeaderFile
  36 #include <Standard.hxx>
  37 #endif
  38 #ifndef _Handle_MMgt_TShared_HeaderFile
  39 #include <Handle_MMgt_TShared.hxx>
  40 #endif
  41 #ifndef _MMgt_TShared_HeaderFile
  42 #include <MMgt_TShared.hxx>
  43 #endif
  44 #ifndef _Standard_GUID_HeaderFile
  45 #include <Standard_GUID.hxx>
  46 #endif
  47 #ifndef _TopoDS_Shape_HeaderFile
  48 #include <TopoDS_Shape.hxx>
  49 #endif
  50 #ifndef _TDF_Label_HeaderFile
  51 #include <TDF_Label.hxx>
  52 #endif
  53 #ifndef _TColStd_HSequenceOfTransient_HeaderFile
  54 #include <TColStd_HSequenceOfTransient.hxx>
  55 #endif
  56 #ifndef _TCollection_AsciiString_HeaderFile
  57 #include <TCollection_AsciiString.hxx>
  58 #endif
  59 #ifndef _Aspect_TypeOfMarker_HeaderFile
  60 #include <Aspect_TypeOfMarker.hxx>
  61 #endif
  62
  63
  64 class Handle_TColStd_HSequenceOfTransient;
  65 class Standard_Transient;
  66 class Handle_Standard_Type;
  67 class Handle(MMgt_TShared);
  68 class GEOM_Object;
  69
  70
  71 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(GEOM_Object);
  72
  73 class Handle(GEOM_Object) : public Handle(MMgt_TShared) {
  74   public:
  75     inline void* operator new(size_t,void* anAddress)
  76       {
  77         return anAddress;
  78       }
  79     inline void* operator new(size_t size)
  80       {
  81         return Standard::Allocate(size);
  82       }
  83     inline void  operator delete(void *anAddress)
  84       {
  85         if (anAddress) Standard::Free((Standard_Address&)anAddress);
  86       }
  87
  88     Handle(GEOM_Object)():Handle(MMgt_TShared)() {}
  89     Handle(GEOM_Object)(const Handle(GEOM_Object)& aHandle) : Handle(MMgt_TShared)(aHandle)
  90      {
  91      }
  92
  93     Handle(GEOM_Object)(const GEOM_Object* anItem) : Handle(MMgt_TShared)((MMgt_TShared *)anItem)
  94      {
  95      }
  96
  97     Handle(GEOM_Object)& operator=(const Handle(GEOM_Object)& aHandle)
  98      {
  99       Assign(aHandle.Access());
 100       return *this;
 101      }
 102
 103     Handle(GEOM_Object)& operator=(const GEOM_Object* anItem)
 104      {
 105       Assign((Standard_Transient *)anItem);
 106       return *this;
 107      }
 108
 109     GEOM_Object* operator->()
 110      {
 111       return (GEOM_Object *)ControlAccess();
 112      }
 113
 114     GEOM_Object* operator->() const
 115      {
 116       return (GEOM_Object *)ControlAccess();
 117      }
 118
 119    Standard_EXPORT ~Handle(GEOM_Object)() {};
 120
 121    Standard_EXPORT static const Handle(GEOM_Object) DownCast(const Handle(Standard_Transient)& AnObject);
 122 };
 123
 124
 125 #include <Standard_GUID.hxx>
 126 #include <TDataStd_TreeNode.hxx>
 127 #include "GEOM_Function.hxx"
 128 #include "GEOM_Engine.hxx"
 129
 130 class GEOM_Object : public MMgt_TShared
 131 {
 132  friend class GEOM_Engine;
 133
 134  public:
 135   struct Color {
 136     //! Red component of the color
 137     double R;
 138     //! Green component of the color
 139     double G;
 140     //! Blue component  of the color
 141     double B;
 142   };
 143
 144  public:
 145   inline void* operator new(size_t,void* anAddress)
 146     {
 147       return anAddress;
 148     }
 149   inline void* operator new(size_t size)
 150     {
 151       return Standard::Allocate(size);
 152     }
 153   inline void  operator delete(void *anAddress)
 154     {
 155       if (anAddress) Standard::Free((Standard_Address&)anAddress);
 156     }
 157
 158   // Type management
 159   //
 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)); }
 164
 165  private:
 166   GEOM_Object(TDF_Label& theLabel);
 167
 168  public:
 169   Standard_EXPORT GEOM_Object(TDF_Label& theEntry, int theType);
 170   Standard_EXPORT ~GEOM_Object();
 171
 172   //Finds a GEOM_Object on the label theLabel
 173   Standard_EXPORT static Handle(GEOM_Object) GetObject(TDF_Label& theLabel);
 174
 175   //Finds a GEOM_Object by a reference, stored on the label theLabel
 176   Standard_EXPORT static Handle(GEOM_Object) GetReferencedObject(TDF_Label& theLabel);
 177
 178   //Returns a GEOM_Object common GUID
 179   Standard_EXPORT static const Standard_GUID& GetObjectID();
 180
 181   //Returns a GUID associated with a sub shape object
 182   Standard_EXPORT static const Standard_GUID& GetSubShapeID();
 183
 184   //###########################################################
 185   //Access to properties
 186   //###########################################################
 187
 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; }
 190
 191   //Returns a label of this GEOM_Object
 192   Standard_EXPORT TDF_Label GetEntry() { return _label; }
 193
 194   //Returns a type of this GEOM_Object (GEOM_POINT, GEOM_VECTOR...)
 195   Standard_EXPORT int GetType();
 196
 197   //Sets the type of this GEOM_Object
 198   Standard_EXPORT void SetType(int theType);
 199
 200   //Modifications counter management
 201   Standard_EXPORT int  GetTic();
 202   Standard_EXPORT void SetTic(int theTic);
 203   Standard_EXPORT void IncrementTic();
 204
 205   //Returns an ID of the OCAF document where this GEOM_Object is stored
 206   Standard_EXPORT int GetDocID();
 207
 208   //Returns a value (as TopoDS_Shape) of this GEOM_Object
 209   Standard_EXPORT TopoDS_Shape GetValue();
 210
 211   //Sets a name of this GEOM_Object
 212   Standard_EXPORT void SetName(const char* theName);
 213
 214   //Returns a name of this GEOM_Object
 215   Standard_EXPORT char* GetName();
 216
 217   //Sets a color of this GEOM_Object
 218   Standard_EXPORT void SetColor(const Color& theColor);
 219
 220   //Returns a color of this GEOM_Object
 221   Standard_EXPORT Color GetColor();
 222
 223   //Toggles an auto color mode on this GEOM_Object
 224   Standard_EXPORT void SetAutoColor(bool theAutoColor);
 225
 226   //Returns a flag of auto color mode of this GEOM_Object
 227   Standard_EXPORT bool GetAutoColor();
 228
 229   //Sets predefined point marker texture
 230   Standard_EXPORT void SetMarkerStd(const Aspect_TypeOfMarker theType, double theSize);
 231
 232   //Sets custom point marker texture
 233   Standard_EXPORT void SetMarkerTexture(int theTextureId);
 234
 235   //Gets point marker type
 236   Standard_EXPORT Aspect_TypeOfMarker GetMarkerType();
 237
 238   //Gets point marker scale factor / size
 239   Standard_EXPORT double GetMarkerSize();
 240
 241   //Gets custom marker texture ID
 242   Standard_EXPORT int GetMarkerTexture();
 243
 244   //Unsets point marker
 245   Standard_EXPORT void UnsetMarker();
 246
 247   //Sets an auxiliary data
 248   Standard_EXPORT void SetAuxData(const char* theData);
 249
 250   //Returns an auxiliary data
 251   Standard_EXPORT TCollection_AsciiString GetAuxData();
 252
 253   //Set a notebook variables used for object creation
 254   Standard_EXPORT void SetParameters(const TCollection_AsciiString& theParameters);
 255
 256   //Get a notebook variables used for object creation
 257   Standard_EXPORT TCollection_AsciiString GetParameters() const;
 258
 259   //###########################################################
 260   // Sub shape methods
 261   //###########################################################
 262
 263   //Returns false if the object is a sub shape of another object
 264   Standard_EXPORT bool IsMainShape();
 265
 266   //###########################################################
 267   // CORBA related methods
 268   //###########################################################
 269
 270   //Sets an IOR of CORBA GEOM_Object_i which refers to this object
 271   Standard_EXPORT void SetIOR(TCollection_AsciiString& theIOR) { _ior = theIOR; }
 272
 273   //Returns an IOR of CORBA GEOM_Object_i which refers to this object
 274   Standard_EXPORT TCollection_AsciiString GetIOR() { return _ior; }
 275
 276   //###########################################################
 277   //Functions methods
 278   //###########################################################
 279
 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);
 283
 284   //Returns a number of functions of this GEOM_Object
 285   Standard_EXPORT int GetNbFunctions();
 286
 287   //Returns a function with given number theFunctionNumber
 288   Standard_EXPORT Handle(GEOM_Function) GetFunction(int theFunctionNumber);
 289
 290   //Return the last function of this GEOM_Object
 291   Standard_EXPORT Handle(GEOM_Function) GetLastFunction();
 292
 293   //Returns all dependencies of the object
 294   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetAllDependency();
 295
 296   //Returns the dependencies of the last function
 297   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetLastDependency();
 298
 299   //###########################################################
 300   // Internal methods
 301   //###########################################################
 302
 303   //Returns a label which could be used to store some additional data
 304   Standard_EXPORT TDF_Label GetFreeLabel();
 305
 306  private:
 307   Handle(TDataStd_TreeNode) _root;
 308   TDF_Label                 _label;
 309   TCollection_AsciiString   _ior;
 310   TCollection_AsciiString   _parameters;
 311   int                       _docID;
 312
 313
 314 };
 315
 316 #endif