include/opencascade/XCAFDoc_Centroid.hxx

0001 // Created on: 2000-09-08
0002 // Created by: data exchange team
0003 // Copyright (c) 2000-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 _XCAFDoc_Centroid_HeaderFile
0017 #define _XCAFDoc_Centroid_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <gp_Pnt.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Standard_Boolean.hxx>
0024 #include <Standard_OStream.hxx>
0025 class Standard_GUID;
0026 class TDF_Label;
0027 class TDF_RelocationTable;
0028
0029
0030 class XCAFDoc_Centroid;
0031 DEFINE_STANDARD_HANDLE(XCAFDoc_Centroid, TDF_Attribute)
0032
0033 //! attribute to store centroid
0034 class XCAFDoc_Centroid : public TDF_Attribute
0035 {
0036
0037 public:
0038
0039
0040   //! class methods
0041   //! =============
0042   Standard_EXPORT XCAFDoc_Centroid();
0043
0044   Standard_EXPORT static const Standard_GUID& GetID();
0045
0046   //! Find, or create, a Location attribute and set it's value
0047   //! the Location attribute is returned.
0048   //! Location methods
0049   //! ===============
0050   Standard_EXPORT static Handle(XCAFDoc_Centroid) Set (const TDF_Label& label, const gp_Pnt& pnt);
0051
0052   Standard_EXPORT void Set (const gp_Pnt& pnt);
0053
0054   Standard_EXPORT gp_Pnt Get() const;
0055
0056   //! Returns point as argument
0057   //! returns false if no such attribute at the <label>
0058   Standard_EXPORT static Standard_Boolean Get (const TDF_Label& label, gp_Pnt& pnt);
0059
0060   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0061
0062   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0063
0064   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0065
0066   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0067
0068   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0069
0070   //! Dumps the content of me into the stream
0071   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0072
0073
0074
0075
0076   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Centroid,TDF_Attribute)
0077
0078 protected:
0079
0080
0081
0082
0083 private:
0084
0085
0086   gp_Pnt myCentroid;
0087
0088
0089 };
0090
0091
0092
0093
0094
0095
0096
0097 #endif // _XCAFDoc_Centroid_HeaderFile