src/TDataXtd/TDataXtd_Point.hxx

   1 // Created on: 2009-04-06
   2 // Created by: Sergey ZARITCHNY
   3 // Copyright (c) 2009-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _TDataXtd_Point_HeaderFile
  17 #define _TDataXtd_Point_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <TDF_Attribute.hxx>
  23 #include <Standard_OStream.hxx>
  24 class Standard_GUID;
  25 class TDF_Label;
  26 class gp_Pnt;
  27 class TDF_Attribute;
  28 class TDF_RelocationTable;
  29
  30
  31 class TDataXtd_Point;
  32 DEFINE_STANDARD_HANDLE(TDataXtd_Point, TDF_Attribute)
  33
  34
  35 //! The basis to define a point attribute.
  36 //! The topological attribute must contain a vertex.
  37 //! You use this class to create reference points in a design.
  38 //!
  39 //! Warning:  Use TDataXtd_Geometry  attribute  to retrieve the
  40 //! gp_Pnt of the Point attribute
  41 class TDataXtd_Point : public TDF_Attribute
  42 {
  43
  44 public:
  45
  46
  47   //! class methods
  48   //! =============
  49   //!
  50   //! Returns the GUID for point attributes.
  51   Standard_EXPORT static const Standard_GUID& GetID();
  52
  53
  54   //! Sets the label Label as a point attribute.
  55   //! If no object is found, a point attribute is created.
  56   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label);
  57
  58
  59   //! Sets the label Label as a point attribute containing the point P.
  60   //! If no object is found, a point attribute is created.
  61   //! Point methods
  62   //! =============
  63   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label, const gp_Pnt& P);
  64
  65   Standard_EXPORT TDataXtd_Point();
  66
  67   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  68
  69   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  70
  71   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  72
  73   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  74
  75   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  76
  77
  78
  79
  80   DEFINE_STANDARD_RTTIEXT(TDataXtd_Point,TDF_Attribute)
  81
  82 protected:
  83
  84
  85
  86
  87 private:
  88
  89
  90
  91
  92 };
  93
  94
  95
  96
  97
  98
  99
 100 #endif // _TDataXtd_Point_HeaderFile