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
0024 class TDataXtd_Point;
0025 DEFINE_STANDARD_HANDLE(TDataXtd_Point, TDataStd_GenericEmpty)
0026
0027
0028 //! The basis to define a point attribute.
0029 //! The topological attribute must contain a vertex.
0030 //! You use this class to create reference points in a design.
0031 //!
0032 //! Warning:  Use TDataXtd_Geometry  attribute  to retrieve the
0033 //! gp_Pnt of the Point attribute
0034 class TDataXtd_Point : public TDataStd_GenericEmpty
0035 {
0036
0037 public:
0038
0039
0040   //! class methods
0041   //! =============
0042   //!
0043   //! Returns the GUID for point attributes.
0044   Standard_EXPORT static const Standard_GUID& GetID();
0045
0046
0047   //! Sets the label Label as a point attribute.
0048   //! If no object is found, a point attribute is created.
0049   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label);
0050
0051
0052   //! Sets the label Label as a point attribute containing the point P.
0053   //! If no object is found, a point attribute is created.
0054   //! Point methods
0055   //! =============
0056   Standard_EXPORT static Handle(TDataXtd_Point) Set (const TDF_Label& label, const gp_Pnt& P);
0057
0058   Standard_EXPORT TDataXtd_Point();
0059
0060   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0061
0062   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0063
0064
0065   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Point, TDataStd_GenericEmpty)
0066
0067 protected:
0068
0069
0070
0071
0072 private:
0073
0074
0075
0076
0077 };
0078
0079
0080
0081
0082
0083
0084
0085 #endif // _TDataXtd_Point_HeaderFile