0031588: Visualization, TKOpenGl - display immediate updates in brackets within frame...
[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;
0c63f2f8 29class XCAFDoc_ClippingPlaneTool;
42cf5bc1 30class XCAFDoc_LayerTool;
31class XCAFDoc_DimTolTool;
32class XCAFDoc_MaterialTool;
024d6f77 33class XCAFDoc_NotesTool;
2df785d7 34class XCAFDoc_ViewTool;
a4815d55 35class XCAFDoc_VisMaterialTool;
42cf5bc1 36class TDF_Attribute;
37class TDF_RelocationTable;
38
39
40class XCAFDoc_DocumentTool;
41DEFINE_STANDARD_HANDLE(XCAFDoc_DocumentTool, TDF_Attribute)
42
43//! Defines sections structure of an XDE document.
44//! attribute marking CAF document as being DECAF document.
45//! Creates the sections structure of the document.
46class XCAFDoc_DocumentTool : public TDF_Attribute
47{
48
49public:
50
42cf5bc1 51 Standard_EXPORT static const Standard_GUID& GetID();
52
53 //! Create (if not exist) DocumentTool attribute
54 //! on 0.1 label if <IsAcces> is true, else
55 //! on <L> label.
56 //! This label will be returned by DocLabel();
57 //! If the attribute is already set it won't be reset on
58 //! <L> even if <IsAcces> is false.
59 //! ColorTool and ShapeTool attributes are also set by this method.
60 Standard_EXPORT static Handle(XCAFDoc_DocumentTool) Set (const TDF_Label& L, const Standard_Boolean IsAcces = Standard_True);
61
62 Standard_EXPORT static Standard_Boolean IsXCAFDocument (const Handle(TDocStd_Document)& Doc);
63
64 //! Returns label where the DocumentTool attribute is or
65 //! 0.1 if DocumentTool is not yet set.
66 Standard_EXPORT static TDF_Label DocLabel (const TDF_Label& acces);
67
68 //! Returns sub-label of DocLabel() with tag 1.
69 Standard_EXPORT static TDF_Label ShapesLabel (const TDF_Label& acces);
70
71 //! Returns sub-label of DocLabel() with tag 2.
72 Standard_EXPORT static TDF_Label ColorsLabel (const TDF_Label& acces);
73
74 //! Returns sub-label of DocLabel() with tag 3.
75 Standard_EXPORT static TDF_Label LayersLabel (const TDF_Label& acces);
76
77 //! Returns sub-label of DocLabel() with tag 4.
78 Standard_EXPORT static TDF_Label DGTsLabel (const TDF_Label& acces);
79
80 //! Returns sub-label of DocLabel() with tag 5.
81 Standard_EXPORT static TDF_Label MaterialsLabel (const TDF_Label& acces);
2df785d7 82
83 //! Returns sub-label of DocLabel() with tag 7.
84 Standard_EXPORT static TDF_Label ViewsLabel(const TDF_Label& acces);
42cf5bc1 85
0c63f2f8 86 //! Returns sub-label of DocLabel() with tag 8.
87 Standard_EXPORT static TDF_Label ClippingPlanesLabel(const TDF_Label& acces);
024d6f77 88
89 //! Returns sub-label of DocLabel() with tag 9.
90 Standard_EXPORT static TDF_Label NotesLabel(const TDF_Label& acces);
91
a4815d55 92 //! Returns sub-label of DocLabel() with tag 10.
93 Standard_EXPORT static TDF_Label VisMaterialLabel (const TDF_Label& theLabel);
94
42cf5bc1 95 //! Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
96 Standard_EXPORT static Handle(XCAFDoc_ShapeTool) ShapeTool (const TDF_Label& acces);
97
98 //! Creates (if it does not exist) ColorTool attribute on ColorsLabel().
99 Standard_EXPORT static Handle(XCAFDoc_ColorTool) ColorTool (const TDF_Label& acces);
a4815d55 100
101 //! Creates (if it does not exist) XCAFDoc_VisMaterialTool attribute on VisMaterialLabel().
102 //! Should not be confused with MaterialTool() defining physical/manufacturing materials.
103 Standard_EXPORT static Handle(XCAFDoc_VisMaterialTool) VisMaterialTool (const TDF_Label& theLabel);
104
42cf5bc1 105 //! Creates (if it does not exist) LayerTool attribute on LayersLabel().
106 Standard_EXPORT static Handle(XCAFDoc_LayerTool) LayerTool (const TDF_Label& acces);
107
108 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
109 Standard_EXPORT static Handle(XCAFDoc_DimTolTool) DimTolTool (const TDF_Label& acces);
110
111 //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
112 Standard_EXPORT static Handle(XCAFDoc_MaterialTool) MaterialTool (const TDF_Label& acces);
2df785d7 113
114 //! Creates (if it does not exist) ViewTool attribute on ViewsLabel().
115 Standard_EXPORT static Handle(XCAFDoc_ViewTool) ViewTool(const TDF_Label& acces);
42cf5bc1 116
0c63f2f8 117 //! Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel().
118 Standard_EXPORT static Handle(XCAFDoc_ClippingPlaneTool) ClippingPlaneTool(const TDF_Label& acces);
024d6f77 119
120 //! Creates (if it does not exist) NotesTool attribute on NotesLabel().
121 Standard_EXPORT static Handle(XCAFDoc_NotesTool) NotesTool(const TDF_Label& acces);
122
a4815d55 123public:
124
42cf5bc1 125 Standard_EXPORT XCAFDoc_DocumentTool();
126
127 //! to be called when reading this attribute from file
128 Standard_EXPORT void Init() const;
129
79104795 130 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
42cf5bc1 131
79104795 132 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
42cf5bc1 133
79104795 134 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
42cf5bc1 135
79104795 136 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
e6f550da 137
bc73b006 138 //! Dumps the content of me into the stream
139 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
140
92efcf78 141 DEFINE_STANDARD_RTTIEXT(XCAFDoc_DocumentTool,TDF_Attribute)
42cf5bc1 142
42cf5bc1 143};
144
42cf5bc1 145#endif // _XCAFDoc_DocumentTool_HeaderFile