0031353: TDocStd_Application does not have api to set progress indicator
[occt.git] / src / TopTools / TopTools_ShapeSet.hxx
1 // Created on: 1993-07-01
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 _TopTools_ShapeSet_HeaderFile
18 #define _TopTools_ShapeSet_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TopTools_IndexedMapOfShape.hxx>
25 #include <TopTools_LocationSet.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_OStream.hxx>
28 #include <Standard_IStream.hxx>
29 #include <TopAbs_ShapeEnum.hxx>
30
31 class TopoDS_Shape;
32 class TopTools_LocationSet;
33 class TCollection_AsciiString;
34
35
36 //! A ShapeSets    contains  a  Shape    and all   its
37 //! sub-shapes and locations.  It  can be dumped,  written
38 //! and read.
39 //!
40 //! Methods to handle the geometry can be redefined.
41 class TopTools_ShapeSet 
42 {
43 public:
44
45   DEFINE_STANDARD_ALLOC
46
47   //! Builds an empty ShapeSet.
48   Standard_EXPORT TopTools_ShapeSet();
49   
50   Standard_EXPORT virtual ~TopTools_ShapeSet();
51   
52   Standard_EXPORT void SetFormatNb (const Standard_Integer theFormatNb);
53   
54   //! two formats available for the moment:
55   //! First: does not write CurveOnSurface UV Points into the file
56   //! on reading calls Check() method.
57   //! Second: stores CurveOnSurface UV Points.
58   //! On reading format is recognized from Version string.
59   Standard_EXPORT Standard_Integer FormatNb() const;
60   
61   //! Clears the content of the set.  This method can be
62   //! redefined.
63   Standard_EXPORT virtual void Clear();
64   
65   //! Stores <S> and its sub-shape. Returns the index of <S>.
66   //! The method AddGeometry is called on each sub-shape.
67   Standard_EXPORT Standard_Integer Add (const TopoDS_Shape& S);
68   
69   //! Returns the sub-shape of index <I>.
70   Standard_EXPORT const TopoDS_Shape& Shape (const Standard_Integer I) const;
71   
72   //! Returns the index of <S>.
73   Standard_EXPORT Standard_Integer Index (const TopoDS_Shape& S) const;
74   
75   Standard_EXPORT const TopTools_LocationSet& Locations() const;
76   
77   Standard_EXPORT TopTools_LocationSet& ChangeLocations();
78   
79   //! Dumps the number of objects in me on the stream <OS>.
80   //! (Number of shapes of each type)
81   Standard_EXPORT Standard_OStream& DumpExtent (Standard_OStream& OS) const;
82   
83   //! Dumps the number of objects in me in the string S
84   //! (Number of shapes of each type)
85   Standard_EXPORT void DumpExtent (TCollection_AsciiString& S) const;
86   
87   //! Dumps the content of me on the stream <OS>.
88   //!
89   //! Dumps the shapes from first to last.
90   //! For each Shape
91   //! Dump the type, the flags, the subshapes
92   //! calls DumpGeometry(S)
93   //!
94   //! Dumps the geometry calling DumpGeometry.
95   //!
96   //! Dumps the locations.
97   Standard_EXPORT virtual void Dump (Standard_OStream& OS) const;
98   
99   //! Writes the content of  me  on the stream <OS> in a
100   //! format that can be read back by Read.
101   //!
102   //! Writes the locations.
103   //!
104   //! Writes the geometry calling WriteGeometry.
105   //!
106   //! Dumps the shapes from last to first.
107   //! For each shape  :
108   //! Write the type.
109   //! calls WriteGeometry(S).
110   //! Write the flags, the subshapes.
111   Standard_EXPORT virtual void Write
112     (Standard_OStream& OS,
113      const Handle(Message_ProgressIndicator) &theProgress = NULL);
114   
115   //! Reads the content of me from the  stream  <IS>. me
116   //! is first cleared.
117   //!
118   //! Reads the locations.
119   //!
120   //! Reads the geometry calling ReadGeometry.
121   //!
122   //! Reads the shapes.
123   //! For each shape
124   //! Reads the type.
125   //! calls ReadGeometry(T,S).
126   //! Reads the flag, the subshapes.
127   Standard_EXPORT virtual void Read
128     (Standard_IStream& IS,
129      const Handle(Message_ProgressIndicator) &theProgress = NULL);
130   
131   //! Dumps   on  <OS>    the  shape  <S>.   Dumps   the
132   //! orientation, the index of the TShape and the index
133   //! of the Location.
134   Standard_EXPORT void Dump (const TopoDS_Shape& S, Standard_OStream& OS) const;
135   
136   //! Writes   on  <OS>   the shape   <S>.    Writes the
137   //! orientation, the index of the TShape and the index
138   //! of the Location.
139   Standard_EXPORT void Write (const TopoDS_Shape& S, Standard_OStream& OS) const;
140   
141   //! Reads from <IS> a shape and returns it in S.
142   Standard_EXPORT void Read (TopoDS_Shape& S, Standard_IStream& IS) const;
143   
144   //! Stores the geometry of <S>.
145   Standard_EXPORT virtual void AddGeometry (const TopoDS_Shape& S);
146   
147   //! Dumps the geometry of me on the stream <OS>.
148   Standard_EXPORT virtual void DumpGeometry (Standard_OStream& OS) const;
149   
150   //! Writes the geometry of  me  on the stream <OS> in a
151   //! format that can be read back by Read.
152   Standard_EXPORT virtual void WriteGeometry
153     (Standard_OStream& OS,
154      const Handle(Message_ProgressIndicator) &theProgress = NULL);
155   
156   //! Reads the geometry of me from the  stream  <IS>.
157   Standard_EXPORT virtual void ReadGeometry
158     (Standard_IStream& IS,
159      const Handle(Message_ProgressIndicator) &theProgress = NULL);
160   
161   //! Dumps the geometry of <S> on the stream <OS>.
162   Standard_EXPORT virtual void DumpGeometry (const TopoDS_Shape& S, Standard_OStream& OS) const;
163   
164   //! Writes the geometry of <S>  on the stream <OS> in a
165   //! format that can be read back by Read.
166   Standard_EXPORT virtual void WriteGeometry (const TopoDS_Shape& S, Standard_OStream& OS) const;
167   
168   //! Reads the geometry of a shape of type <T> from the
169   //! stream <IS> and returns it in <S>.
170   Standard_EXPORT virtual void ReadGeometry (const TopAbs_ShapeEnum T, Standard_IStream& IS, TopoDS_Shape& S);
171   
172   //! Inserts  the shape <S2> in  the  shape <S1>.  This
173   //! method must be   redefined  to  use   the  correct
174   //! builder.
175   Standard_EXPORT virtual void AddShapes (TopoDS_Shape& S1, const TopoDS_Shape& S2);
176   
177   //! This method is   called after  each  new  completed
178   //! shape. <T> is the  type. <S> is  the shape. In this
179   //! class it does nothing, but it gives the opportunity
180   //! in derived  classes to perform  extra  treatment on
181   //! shapes.
182   Standard_EXPORT virtual void Check (const TopAbs_ShapeEnum T, TopoDS_Shape& S);
183   
184   //! Returns number of shapes read from file.
185   Standard_EXPORT Standard_Integer NbShapes() const;
186
187 private:
188   
189   //! Reads  from <IS>  a shape  and  returns  it in  S.
190   //! <NbShapes> is the number of tshapes in the set.
191   Standard_EXPORT void Read (TopoDS_Shape& S, Standard_IStream& IS, const Standard_Integer NbShapes) const;
192
193   TopTools_IndexedMapOfShape myShapes;
194   TopTools_LocationSet myLocations;
195   Standard_Integer myFormatNb;
196 };
197
198 #endif // _TopTools_ShapeSet_HeaderFile