0028407: Visualization - remove ::UpdateMode() from Graphic3d_StructureManager
[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;
2df785d7 32class XCAFDoc_ViewTool;
42cf5bc1 33class TDF_Attribute;
34class TDF_RelocationTable;
35
36
37class XCAFDoc_DocumentTool;
38DEFINE_STANDARD_HANDLE(XCAFDoc_DocumentTool, TDF_Attribute)
39
40//! Defines sections structure of an XDE document.
41//! attribute marking CAF document as being DECAF document.
42//! Creates the sections structure of the document.
43class XCAFDoc_DocumentTool : public TDF_Attribute
44{
45
46public:
47
48
49 Standard_EXPORT static const Standard_GUID& GetID();
50
51 //! Create (if not exist) DocumentTool attribute
52 //! on 0.1 label if <IsAcces> is true, else
53 //! on <L> label.
54 //! This label will be returned by DocLabel();
55 //! If the attribute is already set it won't be reset on
56 //! <L> even if <IsAcces> is false.
57 //! ColorTool and ShapeTool attributes are also set by this method.
58 Standard_EXPORT static Handle(XCAFDoc_DocumentTool) Set (const TDF_Label& L, const Standard_Boolean IsAcces = Standard_True);
59
60 Standard_EXPORT static Standard_Boolean IsXCAFDocument (const Handle(TDocStd_Document)& Doc);
61
62 //! Returns label where the DocumentTool attribute is or
63 //! 0.1 if DocumentTool is not yet set.
64 Standard_EXPORT static TDF_Label DocLabel (const TDF_Label& acces);
65
66 //! Returns sub-label of DocLabel() with tag 1.
67 Standard_EXPORT static TDF_Label ShapesLabel (const TDF_Label& acces);
68
69 //! Returns sub-label of DocLabel() with tag 2.
70 Standard_EXPORT static TDF_Label ColorsLabel (const TDF_Label& acces);
71
72 //! Returns sub-label of DocLabel() with tag 3.
73 Standard_EXPORT static TDF_Label LayersLabel (const TDF_Label& acces);
74
75 //! Returns sub-label of DocLabel() with tag 4.
76 Standard_EXPORT static TDF_Label DGTsLabel (const TDF_Label& acces);
77
78 //! Returns sub-label of DocLabel() with tag 5.
79 Standard_EXPORT static TDF_Label MaterialsLabel (const TDF_Label& acces);
2df785d7 80
81 //! Returns sub-label of DocLabel() with tag 7.
82 Standard_EXPORT static TDF_Label ViewsLabel(const TDF_Label& acces);
42cf5bc1 83
84 //! Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
85 Standard_EXPORT static Handle(XCAFDoc_ShapeTool) ShapeTool (const TDF_Label& acces);
86
87 //! Creates (if it does not exist) ColorTool attribute on ColorsLabel().
88 Standard_EXPORT static Handle(XCAFDoc_ColorTool) ColorTool (const TDF_Label& acces);
89
90 //! Creates (if it does not exist) LayerTool attribute on LayersLabel().
91 Standard_EXPORT static Handle(XCAFDoc_LayerTool) LayerTool (const TDF_Label& acces);
92
93 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
94 Standard_EXPORT static Handle(XCAFDoc_DimTolTool) DimTolTool (const TDF_Label& acces);
95
96 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
97 Standard_EXPORT static Handle(XCAFDoc_MaterialTool) MaterialTool (const TDF_Label& acces);
2df785d7 98
99 //! Creates (if it does not exist) ViewTool attribute on ViewsLabel().
100 Standard_EXPORT static Handle(XCAFDoc_ViewTool) ViewTool(const TDF_Label& acces);
42cf5bc1 101
102 Standard_EXPORT XCAFDoc_DocumentTool();
103
104 //! to be called when reading this attribute from file
105 Standard_EXPORT void Init() const;
106
79104795 107 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
42cf5bc1 108
79104795 109 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
42cf5bc1 110
79104795 111 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
42cf5bc1 112
79104795 113 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
e6f550da 114
92efcf78 115 DEFINE_STANDARD_RTTIEXT(XCAFDoc_DocumentTool,TDF_Attribute)
42cf5bc1 116
117protected:
118
119
120
121
122private:
123
124
125
126
127};
128
129
130
131
132
133
134
135#endif // _XCAFDoc_DocumentTool_HeaderFile