0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_ShapeSet.hxx
1 // Created on: 2004-05-11
2 // Created by: Sergey ZARITCHNY <szy@opencascade.com>
3 // Copyright (c) 2004-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 _BinTools_ShapeSet_HeaderFile
17 #define _BinTools_ShapeSet_HeaderFile
18
19 #include <BinTools_ShapeSetBase.hxx>
20
21 #include <TopTools_IndexedMapOfShape.hxx>
22 #include <BinTools_LocationSet.hxx>
23 #include <BRep_Builder.hxx>
24 #include <BinTools_SurfaceSet.hxx>
25 #include <BinTools_CurveSet.hxx>
26 #include <BinTools_Curve2dSet.hxx>
27 #include <TColStd_IndexedMapOfTransient.hxx>
28 #include <Standard_OStream.hxx>
29 #include <Standard_IStream.hxx>
30
31
32 //! Writes topology in OStream in binary format
33 class BinTools_ShapeSet : public BinTools_ShapeSetBase
34 {
35 public:
36
37   DEFINE_STANDARD_ALLOC
38
39   //! Builds an empty ShapeSet.
40   //! @param theWithTriangles [in] flag to write triangulation data
41   Standard_EXPORT BinTools_ShapeSet ();
42
43   Standard_EXPORT virtual ~BinTools_ShapeSet();
44
45   //! Clears the content of the set.
46   Standard_EXPORT virtual void Clear();
47   
48   //! Stores <S> and its sub-shape. Returns the index of <S>.
49   //! The method AddGeometry is called on each sub-shape.
50   Standard_EXPORT Standard_Integer Add (const TopoDS_Shape& S);
51   
52   //! Returns the sub-shape of index <I>.
53   Standard_EXPORT const TopoDS_Shape& Shape (const Standard_Integer I);
54   
55   //! Returns the index of <S>.
56   Standard_EXPORT Standard_Integer Index (const TopoDS_Shape& S) const;
57   
58   Standard_EXPORT const BinTools_LocationSet& Locations() const;
59   
60   Standard_EXPORT BinTools_LocationSet& ChangeLocations();
61   
62   //! Returns number of shapes read from file.
63   Standard_EXPORT Standard_Integer NbShapes() const;
64   
65   //! Writes the content of  me  on the stream <OS> in binary
66   //! format that can be read back by Read.
67   //!
68   //! Writes the locations.
69   //!
70   //! Writes the geometry calling WriteGeometry.
71   //!
72   //! Dumps the shapes from last to first.
73   //! For each shape  :
74   //! Write the type.
75   //! calls WriteGeometry(S).
76   //! Write the flags, the subshapes.
77   Standard_EXPORT virtual void Write
78     (Standard_OStream& OS,
79      const Message_ProgressRange& theRange = Message_ProgressRange());
80   
81   //! Reads the content of me from the binary stream  <IS>. me
82   //! is first cleared.
83   //!
84   //! Reads the locations.
85   //!
86   //! Reads the geometry calling ReadGeometry.
87   //!
88   //! Reads the shapes.
89   //! For each shape
90   //! Reads the type.
91   //! calls ReadGeometry(T,S).
92   //! Reads the flag, the subshapes.
93   Standard_EXPORT virtual void Read
94     (Standard_IStream& IS,
95      const Message_ProgressRange& theRange = Message_ProgressRange());
96   
97   //! Writes   on  <OS>   the shape   <S>.    Writes the
98   //! orientation, the index of the TShape and the index
99   //! of the Location.
100   Standard_EXPORT virtual void Write (const TopoDS_Shape& S, Standard_OStream& OS);
101   
102   //! Writes the geometry of  me  on the stream <OS> in a
103   //! binary format that can be read back by Read.
104   Standard_EXPORT virtual void WriteGeometry
105     (Standard_OStream& OS,
106      const Message_ProgressRange& theRange = Message_ProgressRange()) const;
107   
108   //! Reads the geometry of me from the  stream  <IS>.
109   Standard_EXPORT virtual void ReadGeometry
110     (Standard_IStream& IS,
111      const Message_ProgressRange& theRange = Message_ProgressRange());
112   
113   //! Reads from <IS> a shape flags and sub-shapes and modifies S.
114   Standard_EXPORT virtual void ReadFlagsAndSubs
115     (TopoDS_Shape& S, const TopAbs_ShapeEnum T,
116      Standard_IStream& IS, const Standard_Integer NbShapes);
117
118   //! Reads from <IS> a shape and returns it in S.
119   //! <NbShapes> is the number of tshapes in the set.
120   Standard_EXPORT virtual void ReadSubs
121   (TopoDS_Shape& S, Standard_IStream& IS, const Standard_Integer NbShapes);
122
123   //! An empty virtual method for redefinition in shape-reader.
124   Standard_EXPORT virtual void Read (Standard_IStream& /*theStream*/, TopoDS_Shape& /*theShape*/) {};
125
126   //! Writes the shape <S> on the stream <OS> in a
127   //! binary format that can be read back by Read.
128   Standard_EXPORT virtual void WriteShape (const TopoDS_Shape& S, Standard_OStream& OS) const;
129   
130   //! Reads  a shape of type <T> from the stream <IS> and returns it in <S>.
131   Standard_EXPORT virtual void ReadShape (const TopAbs_ShapeEnum T, Standard_IStream& IS, TopoDS_Shape& S);
132
133   //! Stores the shape <S>.
134   Standard_EXPORT virtual void AddShape (const TopoDS_Shape& S);
135   
136   //! Inserts  the shape <S2> in the shape <S1>.
137   Standard_EXPORT virtual void AddShapes (TopoDS_Shape& S1, const TopoDS_Shape& S2);
138   
139   //! Reads the 3d polygons  of me
140   //! from the  stream  <IS>.
141   Standard_EXPORT void ReadPolygon3D
142     (Standard_IStream& IS,
143         const Message_ProgressRange& theRange = Message_ProgressRange());
144   
145   //! Writes the 3d polygons
146   //! on the stream <OS> in a format that can
147   //! be read back by Read.
148   Standard_EXPORT void WritePolygon3D
149     (Standard_OStream& OS,
150         const Message_ProgressRange& theRange = Message_ProgressRange()) const;
151   
152   //! Reads the triangulation of me
153   //! from the  stream  <IS>.
154   Standard_EXPORT void ReadTriangulation
155     (Standard_IStream& IS,
156         const Message_ProgressRange& theRange = Message_ProgressRange());
157   
158   //! Writes the triangulation
159   //! on the stream <OS> in a format that can
160   //! be read back by Read.
161   Standard_EXPORT void WriteTriangulation
162     (Standard_OStream& OS,
163         const Message_ProgressRange& theRange = Message_ProgressRange()) const;
164   
165   //! Reads the polygons on triangulation of me
166   //! from the  stream  <IS>.
167   Standard_EXPORT void ReadPolygonOnTriangulation
168     (Standard_IStream& IS,
169         const Message_ProgressRange& theRange = Message_ProgressRange());
170   
171   //! Writes the polygons on triangulation
172   //! on the stream <OS> in a format that can
173   //! be read back by Read.
174   Standard_EXPORT void WritePolygonOnTriangulation
175     (Standard_OStream& OS,
176         const Message_ProgressRange& theRange = Message_ProgressRange()) const;
177
178 private:
179
180   TopTools_IndexedMapOfShape myShapes; ///< index and its shape (started from 1)
181   BinTools_LocationSet myLocations;
182   BRep_Builder myBuilder;
183   BinTools_SurfaceSet mySurfaces;
184   BinTools_CurveSet myCurves;
185   BinTools_Curve2dSet myCurves2d;
186   NCollection_IndexedMap<Handle(Poly_Polygon2D), TColStd_MapTransientHasher> myPolygons2D;
187   NCollection_IndexedMap<Handle(Poly_Polygon3D), TColStd_MapTransientHasher> myPolygons3D;
188   NCollection_IndexedDataMap<Handle(Poly_Triangulation),
189                              Standard_Boolean> myTriangulations; //!< Contains a boolean flag with information
190                                                                  //!  to save normals for triangulation
191   NCollection_IndexedMap<Handle(Poly_PolygonOnTriangulation), TColStd_MapTransientHasher> myNodes;
192 };
193
194 #endif // _BinTools_ShapeSet_HeaderFile