include/opencascade/TDataXtd_Plane.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_Plane_HeaderFile
0017 #define _TDataXtd_Plane_HeaderFile
0018
0019 #include <TDataStd_GenericEmpty.hxx>
0020 class TDF_Label;
0021 class gp_Pln;
0022
0023 class TDataXtd_Plane;
0024 DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty)
0025
0026 //! The basis to define a plane attribute.
0027 //! Warning:  Use TDataXtd_Geometry  attribute  to retrieve  the
0028 //! gp_Pln of the Plane attribute
0029 class TDataXtd_Plane : public TDataStd_GenericEmpty
0030 {
0031
0032 public:
0033   //! class methods
0034   //! =============
0035   //!
0036   //! Returns the GUID for plane attributes.
0037   Standard_EXPORT static const Standard_GUID& GetID();
0038
0039   //! Finds or creates the plane attribute defined by
0040   //! the label label.
0041   //! Warning
0042   //! If you are creating the attribute with this syntax, a
0043   //! planar face should already be associated with label.
0044   Standard_EXPORT static Handle(TDataXtd_Plane) Set(const TDF_Label& label);
0045
0046   //! Finds,  or creates,  a Plane  attribute  and sets <P>  as
0047   //! generated the associated NamedShape.
0048   //! Plane methods
0049   //! =============
0050   Standard_EXPORT static Handle(TDataXtd_Plane) Set(const TDF_Label& label, const gp_Pln& P);
0051
0052   Standard_EXPORT TDataXtd_Plane();
0053
0054   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0055
0056   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0057
0058   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Plane, TDataStd_GenericEmpty)
0059
0060 protected:
0061 private:
0062 };
0063
0064 #endif // _TDataXtd_Plane_HeaderFile