fc27d8c68fd2bbdcb0f80ab3cda0ac4151d8883a
[occt.git] / 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 <TDataStd_GenericEmpty.hxx>
20 class TDF_Label;
21 class gp_Pnt;
22
23
24 class TDataXtd_Point;
25 DEFINE_STANDARD_HANDLE(TDataXtd_Point, TDataStd_GenericEmpty)
26
27
28 //! The basis to define a point attribute.
29 //! The topological attribute must contain a vertex.
30 //! You use this class to create reference points in a design.
31 //!
32 //! Warning:  Use TDataXtd_Geometry  attribute  to retrieve the
33 //! gp_Pnt of the Point attribute
34 class TDataXtd_Point : public TDataStd_GenericEmpty
35 {
36
37 public:
38
39   
40   //! class methods
41   //! =============
42   //!
43   //! Returns the GUID for point attributes.
44   Standard_EXPORT static const Standard_GUID& GetID();
45   
46
47   //! Sets the label Label as a point attribute.
48   //! If no object is found, a point attribute is created.
49   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label);
50   
51
52   //! Sets the label Label as a point attribute containing the point P.
53   //! If no object is found, a point attribute is created.
54   //! Point methods
55   //! =============
56   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label, const gp_Pnt& P);
57   
58   Standard_EXPORT TDataXtd_Point();
59   
60   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
61   
62   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
63
64
65   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Point, TDataStd_GenericEmpty)
66
67 protected:
68
69
70
71
72 private:
73
74
75
76
77 };
78
79
80
81
82
83
84
85 #endif // _TDataXtd_Point_HeaderFile