0025748: Parallel version of progress indicator
[occt.git] / src / BRepTools / BRepTools_ShapeSet.hxx
1 // Created on: 1993-07-19
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _BRepTools_ShapeSet_HeaderFile
18 #define _BRepTools_ShapeSet_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <BRep_Builder.hxx>
25 #include <GeomTools_SurfaceSet.hxx>
26 #include <GeomTools_CurveSet.hxx>
27 #include <GeomTools_Curve2dSet.hxx>
28 #include <TColStd_IndexedMapOfTransient.hxx>
29 #include <Standard_Boolean.hxx>
30 #include <TopTools_ShapeSet.hxx>
31 #include <Standard_OStream.hxx>
32 #include <Standard_IStream.hxx>
33 #include <TopAbs_ShapeEnum.hxx>
34
35 class BRep_Builder;
36 class TopoDS_Shape;
37
38
39 //! Contains a Shape and all  its subshapes, locations
40 //! and geometries.
41 //!
42 //! The topology is inherited from TopTools.
43 class BRepTools_ShapeSet  : public TopTools_ShapeSet
44 {
45 public:
46
47   DEFINE_STANDARD_ALLOC
48
49   
50   //! Builds an empty ShapeSet.
51   //! Parameter <isWithTriangles> is added for XML Persistence
52   Standard_EXPORT BRepTools_ShapeSet (const Standard_Boolean isWithTriangles = Standard_True);
53   
54   //! Builds an empty ShapeSet.
55   //! Parameter <isWithTriangles> is added for XML Persistence
56   Standard_EXPORT BRepTools_ShapeSet (const BRep_Builder& B,
57                                       const Standard_Boolean isWithTriangles = Standard_True);
58   
59   //! Clears the content of the set.
60   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
61   
62   //! Stores the goemetry of <S>.
63   Standard_EXPORT virtual void AddGeometry (const TopoDS_Shape& S) Standard_OVERRIDE;
64   
65   //! Dumps the geometry of me on the stream <OS>.
66   Standard_EXPORT virtual void DumpGeometry (Standard_OStream& OS) const Standard_OVERRIDE;
67   
68   //! Writes the geometry of  me  on the stream <OS> in a
69   //! format that can be read back by Read.
70   Standard_EXPORT virtual void WriteGeometry (Standard_OStream& OS,
71                                               const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
72   
73   //! Reads the geometry of me from the  stream  <IS>.
74   Standard_EXPORT virtual void ReadGeometry (Standard_IStream& IS,
75                                              const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
76   
77   //! Dumps the geometry of <S> on the stream <OS>.
78   Standard_EXPORT virtual void DumpGeometry (const TopoDS_Shape& S, Standard_OStream& OS) const Standard_OVERRIDE;
79   
80   //! Writes the geometry of <S>  on the stream <OS> in a
81   //! format that can be read back by Read.
82   Standard_EXPORT virtual void WriteGeometry (const TopoDS_Shape& S, Standard_OStream& OS) const Standard_OVERRIDE;
83   
84   //! Reads the geometry of a shape of type <T> from the
85   //! stream <IS> and returns it in <S>.
86   Standard_EXPORT virtual void ReadGeometry (const TopAbs_ShapeEnum T, Standard_IStream& IS, TopoDS_Shape& S) Standard_OVERRIDE;
87   
88   //! Inserts  the shape <S2> in  the  shape <S1>.  This
89   //! method must be   redefined  to  use   the  correct
90   //! builder.
91   Standard_EXPORT virtual void AddShapes (TopoDS_Shape& S1, const TopoDS_Shape& S2) Standard_OVERRIDE;
92   
93   Standard_EXPORT virtual void Check (const TopAbs_ShapeEnum T, TopoDS_Shape& S) Standard_OVERRIDE;
94   
95   //! Reads the 3d polygons  of me
96   //! from the  stream  <IS>.
97   Standard_EXPORT void ReadPolygon3D (Standard_IStream& IS,
98                                       const Message_ProgressRange& theProgress = Message_ProgressRange());
99   
100   //! Writes the 3d polygons
101   //! on the stream <OS> in a format that can
102   //! be read back by Read.
103   Standard_EXPORT void WritePolygon3D (Standard_OStream& OS,
104                                        const Standard_Boolean Compact = Standard_True,
105                                        const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
106   
107   //! Dumps the 3d polygons
108   //! on the stream <OS>.
109   Standard_EXPORT void DumpPolygon3D (Standard_OStream& OS) const;
110   
111   //! Reads the triangulation of me
112   //! from the  stream  <IS>.
113   Standard_EXPORT void ReadTriangulation (Standard_IStream& IS,
114                                           const Message_ProgressRange& theProgress = Message_ProgressRange());
115   
116   //! Writes the triangulation
117   //! on the stream <OS> in a format that can
118   //! be read back by Read.
119   Standard_EXPORT void WriteTriangulation (Standard_OStream& OS,
120                                            const Standard_Boolean Compact = Standard_True,
121                                            const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
122   
123   //! Dumps the triangulation
124   //! on the stream <OS>.
125   Standard_EXPORT void DumpTriangulation (Standard_OStream& OS) const;
126   
127   //! Reads the polygons on triangulation of me
128   //! from the  stream  <IS>.
129   Standard_EXPORT void ReadPolygonOnTriangulation (Standard_IStream& IS,
130                                                    const Message_ProgressRange& theProgress = Message_ProgressRange());
131   
132   //! Writes the polygons on triangulation
133   //! on the stream <OS> in a format that can
134   //! be read back by Read.
135   Standard_EXPORT void WritePolygonOnTriangulation (Standard_OStream& OS,
136                                                     const Standard_Boolean Compact = Standard_True,
137                                                     const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
138   
139   //! Dumps the polygons on triangulation
140   //! on the stream <OS>.
141   Standard_EXPORT void DumpPolygonOnTriangulation (Standard_OStream& OS) const;
142
143
144
145
146 protected:
147
148
149
150
151
152 private:
153
154
155
156   BRep_Builder myBuilder;
157   GeomTools_SurfaceSet mySurfaces;
158   GeomTools_CurveSet myCurves;
159   GeomTools_Curve2dSet myCurves2d;
160   TColStd_IndexedMapOfTransient myPolygons2D;
161   TColStd_IndexedMapOfTransient myPolygons3D;
162   TColStd_IndexedMapOfTransient myTriangulations;
163   TColStd_IndexedMapOfTransient myNodes;
164   Standard_Boolean myWithTriangles;
165
166 };
167
168 #endif // _BRepTools_ShapeSet_HeaderFile