0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_ShapeWriter.hxx
1 // Copyright (c) 2021 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BinTools_ShapeWriter_HeaderFile
15 #define _BinTools_ShapeWriter_HeaderFile
16
17 #include <BinTools_ShapeSetBase.hxx>
18 #include <BinTools_OStream.hxx>
19 #include <NCollection_DataMap.hxx>
20 #include <NCollection_Map.hxx>
21 #include <TopTools_ShapeMapHasher.hxx>
22
23 class TopLoc_Location;
24 class Geom_Curve;
25 class Geom2d_Curve;
26 class Geom_Surface;
27 class Poly_Polygon3D;
28 class Poly_PolygonOnTriangulation;
29 class Poly_Triangulation;
30
31 //! Writes topology in OStream in binary format without grouping of objects by types
32 //! and using relative positions in a file as references.
33 class BinTools_ShapeWriter : public BinTools_ShapeSetBase
34 {
35 public:
36
37   DEFINE_STANDARD_ALLOC
38   
39   //! Builds an empty ShapeSet.
40   //! Parameter <theWithTriangles> is added for XML Persistence
41   Standard_EXPORT BinTools_ShapeWriter();
42   
43   Standard_EXPORT virtual ~BinTools_ShapeWriter();
44
45   //! Clears the content of the set.
46   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
47   
48   //! Writes the shape to stream using previously stored shapes and objects to refer them.
49   Standard_EXPORT virtual void Write (const TopoDS_Shape& theShape, Standard_OStream& theStream) Standard_OVERRIDE;
50
51   //! Writes location to the stream (all the needed sub-information or reference if it is already used).
52   Standard_EXPORT virtual void WriteLocation (BinTools_OStream& theStream, const TopLoc_Location& theLocation);
53
54 private:
55   //! Writes shape to the stream (all the needed sub-information or reference if it is already used).
56   virtual void WriteShape (BinTools_OStream& theStream, const TopoDS_Shape& theShape);
57   //! Writes curve to the stream (all the needed sub-information or reference if it is already used).
58   void WriteCurve (BinTools_OStream& theStream, const Handle(Geom_Curve)& theCurve);
59   //! Writes curve2d to the stream (all the needed sub-information or reference if it is already used).
60   void WriteCurve (BinTools_OStream& theStream, const Handle(Geom2d_Curve)& theCurve);
61   //! Writes surface to the stream.
62   void WriteSurface (BinTools_OStream& theStream, const Handle(Geom_Surface)& theSurface);
63   //! Writes ploygon3d to the stream.
64   void WritePolygon (BinTools_OStream& theStream, const Handle(Poly_Polygon3D)& thePolygon);
65   //! Writes polygon on triangulation to the stream.
66   void WritePolygon (BinTools_OStream& theStream, const Handle(Poly_PolygonOnTriangulation)& thePolygon);
67   //! Writes triangulation to the stream.
68   void WriteTriangulation (BinTools_OStream& theStream, const Handle(Poly_Triangulation)& theTriangulation,
69     const Standard_Boolean theNeedToWriteNormals);
70
71   /// position of the shape previously stored
72   NCollection_DataMap<TopoDS_Shape, uint64_t, TopTools_ShapeMapHasher> myShapePos;
73   NCollection_DataMap<TopLoc_Location, uint64_t> myLocationPos;
74   NCollection_DataMap<Handle(Geom_Curve), uint64_t> myCurvePos;
75   NCollection_DataMap<Handle(Geom2d_Curve), uint64_t> myCurve2dPos;
76   NCollection_DataMap<Handle(Geom_Surface), uint64_t> mySurfacePos;
77   NCollection_DataMap<Handle(Poly_Polygon3D), uint64_t> myPolygon3dPos;
78   NCollection_DataMap<Handle(Poly_PolygonOnTriangulation), uint64_t> myPolygonPos;
79   NCollection_DataMap<Handle(Poly_Triangulation), uint64_t> myTriangulationPos;
80 };
81
82 #endif // _BinTools_ShapeWriter_HeaderFile