src/XCAFDoc/XCAFDoc_DocumentTool.hxx

   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>
  24 class Standard_GUID;
  25 class TDF_Label;
  26 class TDocStd_Document;
  27 class XCAFDoc_ShapeTool;
  28 class XCAFDoc_ColorTool;
  29 class XCAFDoc_ClippingPlaneTool;
  30 class XCAFDoc_LayerTool;
  31 class XCAFDoc_DimTolTool;
  32 class XCAFDoc_MaterialTool;
  33 class XCAFDoc_NotesTool;
  34 class XCAFDoc_ViewTool;
  35 class TDF_Attribute;
  36 class TDF_RelocationTable;
  37
  38
  39 class XCAFDoc_DocumentTool;
  40 DEFINE_STANDARD_HANDLE(XCAFDoc_DocumentTool, TDF_Attribute)
  41
  42 //! Defines sections structure of an XDE document.
  43 //! attribute marking CAF document as being DECAF document.
  44 //! Creates the sections structure of the document.
  45 class XCAFDoc_DocumentTool : public TDF_Attribute
  46 {
  47
  48 public:
  49
  50
  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);
  82
  83   //! Returns sub-label of DocLabel() with tag 7.
  84   Standard_EXPORT static TDF_Label ViewsLabel(const TDF_Label& acces);
  85
  86   //! Returns sub-label of DocLabel() with tag 8.
  87   Standard_EXPORT static TDF_Label ClippingPlanesLabel(const TDF_Label& acces);
  88
  89   //! Returns sub-label of DocLabel() with tag 9.
  90   Standard_EXPORT static TDF_Label NotesLabel(const TDF_Label& acces);
  91
  92   //! Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
  93   Standard_EXPORT static Handle(XCAFDoc_ShapeTool) ShapeTool (const TDF_Label& acces);
  94
  95   //! Creates (if it does not exist) ColorTool attribute on ColorsLabel().
  96   Standard_EXPORT static Handle(XCAFDoc_ColorTool) ColorTool (const TDF_Label& acces);
  97
  98   //! Creates (if it does not exist) LayerTool attribute on LayersLabel().
  99   Standard_EXPORT static Handle(XCAFDoc_LayerTool) LayerTool (const TDF_Label& acces);
 100
 101   //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
 102   Standard_EXPORT static Handle(XCAFDoc_DimTolTool) DimTolTool (const TDF_Label& acces);
 103
 104   //! Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
 105   Standard_EXPORT static Handle(XCAFDoc_MaterialTool) MaterialTool (const TDF_Label& acces);
 106
 107   //! Creates (if it does not exist) ViewTool attribute on ViewsLabel().
 108   Standard_EXPORT static Handle(XCAFDoc_ViewTool) ViewTool(const TDF_Label& acces);
 109
 110   //! Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel().
 111   Standard_EXPORT static Handle(XCAFDoc_ClippingPlaneTool) ClippingPlaneTool(const TDF_Label& acces);
 112
 113   //! Creates (if it does not exist) NotesTool attribute on NotesLabel().
 114   Standard_EXPORT static Handle(XCAFDoc_NotesTool) NotesTool(const TDF_Label& acces);
 115
 116   Standard_EXPORT XCAFDoc_DocumentTool();
 117
 118   //! to be called when reading this attribute from file
 119   Standard_EXPORT void Init() const;
 120
 121   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
 122
 123   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
 124
 125   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
 126
 127   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
 128
 129   DEFINE_STANDARD_RTTIEXT(XCAFDoc_DocumentTool,TDF_Attribute)
 130
 131 protected:
 132
 133
 134
 135
 136 private:
 137
 138
 139
 140
 141 };
 142
 143
 144
 145
 146
 147
 148
 149 #endif // _XCAFDoc_DocumentTool_HeaderFile