include/opencascade/TDataXtd_Point.hxx

0001 // Created on: 2009-04-06
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 2009-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDataXtd_Point_HeaderFile
0017 #define _TDataXtd_Point_HeaderFile
0018
0019 #include <TDataStd_GenericEmpty.hxx>
0020 class TDF_Label;
0021 class gp_Pnt;
0022
0023 //! The basis to define a point attribute.
0024 //! The topological attribute must contain a vertex.
0025 //! You use this class to create reference points in a design.
0026 //!
0027 //! Warning: Use TDataXtd_Geometry attribute to retrieve the
0028 //! gp_Pnt of the Point attribute
0029 class TDataXtd_Point : public TDataStd_GenericEmpty
0030 {
0031
0032 public:
0033   //! class methods
0034   //! =============
0035   //!
0036   //! Returns the GUID for point attributes.
0037   Standard_EXPORT static const Standard_GUID& GetID();
0038
0039   //! Sets the label Label as a point attribute.
0040   //! If no object is found, a point attribute is created.
0041   Standard_EXPORT static occ::handle<TDataXtd_Point> Set(const TDF_Label& label);
0042
0043   //! Sets the label Label as a point attribute containing the point P.
0044   //! If no object is found, a point attribute is created.
0045   //! Point methods
0046   //! =============
0047   Standard_EXPORT static occ::handle<TDataXtd_Point> Set(const TDF_Label& label, const gp_Pnt& P);
0048
0049   Standard_EXPORT TDataXtd_Point();
0050
0051   Standard_EXPORT const Standard_GUID& ID() const override;
0052
0053   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0054
0055   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Point, TDataStd_GenericEmpty)
0056 };
0057
0058 #endif // _TDataXtd_Point_HeaderFile