include/opencascade/XCAFDoc.hxx

0001 // Created on: 2000-08-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_HeaderFile
0017 #define _XCAFDoc_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022 #include <TCollection_AsciiString.hxx>
0023
0024 #include <XCAFDoc_ColorType.hxx>
0025 class TDF_Attribute;
0026 class Standard_GUID;
0027
0028 //! Definition of general structure of DECAF document
0029 //! and tools to work with it
0030 //!
0031 //! The document is composed of sections, each section
0032 //! storing its own kind of data and managing by corresponding
0033 //! tool
0034 //! Some properties can be attached directly to shapes. These properties are:
0035 //! * Name (the standard definition from OCAF) - class TDataStd_Name
0036 //! * Centroid (for the validation of transfer) - class XCAFDoc_Centroid
0037 //! * Volume (for the validation of transfer) - class XCAFDoc_Volume
0038 //! * Area (for the validation of transfer) - class XCafDoc_Area
0039 //! Management of these attributes is realized by OCAF. For getting
0040 //! the attributes attached to a label the method class
0041 //! TDF_Label::FindAttribute() should be used.
0042 class XCAFDoc
0043 {
0044 public:
0045   DEFINE_STANDARD_ALLOC
0046
0047   //! class for containing GraphNodes.
0048   //! Returns GUID for UAttribute identifying assembly
0049   Standard_EXPORT static const Standard_GUID& AssemblyGUID();
0050
0051   //! Returns GUID for TreeNode representing assembly link
0052   Standard_EXPORT static const Standard_GUID& ShapeRefGUID();
0053
0054   //! Return GUIDs for TreeNode representing specified types of colors
0055   Standard_EXPORT static const Standard_GUID& ColorRefGUID(const XCAFDoc_ColorType type);
0056
0057   //! Return GUIDs for TreeNode representing specified types of DGT
0058   Standard_EXPORT static const Standard_GUID& DimTolRefGUID();
0059
0060   //! Return GUIDs for TreeNode representing specified types of Dimension
0061   Standard_EXPORT static const Standard_GUID& DimensionRefFirstGUID();
0062
0063   //! Return GUIDs for TreeNode representing specified types of Dimension
0064   Standard_EXPORT static const Standard_GUID& DimensionRefSecondGUID();
0065
0066   //! Return GUIDs for TreeNode representing specified types of GeomTolerance
0067   Standard_EXPORT static const Standard_GUID& GeomToleranceRefGUID();
0068
0069   //! Return GUIDs for TreeNode representing specified types of datum
0070   Standard_EXPORT static const Standard_GUID& DatumRefGUID();
0071
0072   //! Return GUIDs for TreeNode representing connections Datum-Toler
0073   Standard_EXPORT static const Standard_GUID& DatumTolRefGUID();
0074
0075   Standard_EXPORT static const Standard_GUID& LayerRefGUID();
0076
0077   Standard_EXPORT static const Standard_GUID& MaterialRefGUID();
0078
0079   //! Return GUID for TreeNode representing Visualization Material.
0080   Standard_EXPORT static const Standard_GUID& VisMaterialRefGUID();
0081
0082   //! Return GUIDs for representing notes
0083   Standard_EXPORT static const Standard_GUID& NoteRefGUID();
0084
0085   Standard_EXPORT static const Standard_GUID& InvisibleGUID();
0086
0087   Standard_EXPORT static const Standard_GUID& ColorByLayerGUID();
0088
0089   //! Returns GUID for UAttribute identifying external reference on no-step file
0090   Standard_EXPORT static const Standard_GUID& ExternRefGUID();
0091
0092   //! Returns GUID for UAttribute identifying specified higher usage occurrence
0093   Standard_EXPORT static const Standard_GUID& SHUORefGUID();
0094
0095   //! Return GUIDs for TreeNode representing specified types of View
0096   Standard_EXPORT static const Standard_GUID& ViewRefGUID();
0097
0098   //! Return GUIDs for TreeNode representing specified types of View
0099   Standard_EXPORT static const Standard_GUID& ViewRefShapeGUID();
0100
0101   //! Return GUIDs for TreeNode representing specified types of View
0102   Standard_EXPORT static const Standard_GUID& ViewRefGDTGUID();
0103
0104   //! Return GUIDs for TreeNode representing specified types of View
0105   Standard_EXPORT static const Standard_GUID& ViewRefPlaneGUID();
0106
0107   //! Return GUIDs for GraphNode representing specified types of View
0108   Standard_EXPORT static const Standard_GUID& ViewRefNoteGUID();
0109   Standard_EXPORT static const Standard_GUID& ViewRefAnnotationGUID();
0110
0111   //! Returns GUID for UAttribute identifying lock flag
0112   Standard_EXPORT static const Standard_GUID& LockGUID();
0113
0114   //! Prints attribute information into a string.
0115   //! @param theAtt an XDE attribute
0116   //! @return the generated info value
0117   Standard_EXPORT static TCollection_AsciiString AttributeInfo(
0118     const occ::handle<TDF_Attribute>& theAtt);
0119 };
0120
0121 #endif // _XCAFDoc_HeaderFile