0026936: Drawbacks of inlining in new type system in OCCT 7.0 -- manual
[occt.git] / src / XCAFDoc / XCAFDoc_DocumentTool.hxx
CommitLineData
42cf5bc1 1// Created on: 2000-08-30
2// Created by: data exchange team
3// Copyright (c) 2000-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 _XCAFDoc_DocumentTool_HeaderFile
17#define _XCAFDoc_DocumentTool_HeaderFile
18
19#include <Standard.hxx>
20#include <Standard_Type.hxx>
21
22#include <TDF_Attribute.hxx>
23#include <Standard_Boolean.hxx>
24class Standard_GUID;
25class TDF_Label;
26class TDocStd_Document;
27class XCAFDoc_ShapeTool;
28class XCAFDoc_ColorTool;
29class XCAFDoc_LayerTool;
30class XCAFDoc_DimTolTool;
31class XCAFDoc_MaterialTool;
32class TDF_Attribute;
33class TDF_RelocationTable;
34
35
36class XCAFDoc_DocumentTool;
37DEFINE_STANDARD_HANDLE(XCAFDoc_DocumentTool, TDF_Attribute)
38
39//! Defines sections structure of an XDE document.
40//! attribute marking CAF document as being DECAF document.
41//! Creates the sections structure of the document.
42class XCAFDoc_DocumentTool : public TDF_Attribute
43{
44
45public:
46
47
48 Standard_EXPORT static const Standard_GUID& GetID();
49
50 //! Create (if not exist) DocumentTool attribute
51 //! on 0.1 label if <IsAcces> is true, else
52 //! on <L> label.
53 //! This label will be returned by DocLabel();
54 //! If the attribute is already set it won't be reset on
55 //! <L> even if <IsAcces> is false.
56 //! ColorTool and ShapeTool attributes are also set by this method.
57 Standard_EXPORT static Handle(XCAFDoc_DocumentTool) Set (const TDF_Label& L, const Standard_Boolean IsAcces = Standard_True);
58
59 Standard_EXPORT static Standard_Boolean IsXCAFDocument (const Handle(TDocStd_Document)& Doc);
60
61 //! Returns label where the DocumentTool attribute is or
62 //! 0.1 if DocumentTool is not yet set.
63 Standard_EXPORT static TDF_Label DocLabel (const TDF_Label& acces);
64
65 //! Returns sub-label of DocLabel() with tag 1.
66 Standard_EXPORT static TDF_Label ShapesLabel (const TDF_Label& acces);
67
68 //! Returns sub-label of DocLabel() with tag 2.
69 Standard_EXPORT static TDF_Label ColorsLabel (const TDF_Label& acces);
70
71 //! Returns sub-label of DocLabel() with tag 3.
72 Standard_EXPORT static TDF_Label LayersLabel (const TDF_Label& acces);
73
74 //! Returns sub-label of DocLabel() with tag 4.
75 Standard_EXPORT static TDF_Label DGTsLabel (const TDF_Label& acces);
76
77 //! Returns sub-label of DocLabel() with tag 5.
78 Standard_EXPORT static TDF_Label MaterialsLabel (const TDF_Label& acces);
79
80 //! Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
81 Standard_EXPORT static Handle(XCAFDoc_ShapeTool) ShapeTool (const TDF_Label& acces);
82
83 //! Creates (if it does not exist) ColorTool attribute on ColorsLabel().
84 Standard_EXPORT static Handle(XCAFDoc_ColorTool) ColorTool (const TDF_Label& acces);
85
86 //! Creates (if it does not exist) LayerTool attribute on LayersLabel().
87 Standard_EXPORT static Handle(XCAFDoc_LayerTool) LayerTool (const TDF_Label& acces);
88
89 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
90 Standard_EXPORT static Handle(XCAFDoc_DimTolTool) DimTolTool (const TDF_Label& acces);
91
92 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
93 Standard_EXPORT static Handle(XCAFDoc_MaterialTool) MaterialTool (const TDF_Label& acces);
94
95 Standard_EXPORT XCAFDoc_DocumentTool();
96
97 //! to be called when reading this attribute from file
98 Standard_EXPORT void Init() const;
99
79104795 100 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
42cf5bc1 101
79104795 102 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
42cf5bc1 103
79104795 104 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
42cf5bc1 105
79104795 106 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
42cf5bc1 107
108 //! Unregisters the document holding this attribute from an
109 //! internal global map of XDE documents.
110 Standard_EXPORT virtual void Destroy();
111~XCAFDoc_DocumentTool()
112{
113 Destroy();
114}
115
116
117
118 DEFINE_STANDARD_RTTI(XCAFDoc_DocumentTool,TDF_Attribute)
119
120protected:
121
122
123
124
125private:
126
127
128
129
130};
131
132
133
134
135
136
137
138#endif // _XCAFDoc_DocumentTool_HeaderFile