0024602: Documentation Code Snippets missing sign
[occt.git] / dox / user_guides / shape_healing / shape_healing.md
1 Shape Healing  {#occt_user_guides__shape_healing}
2 ===================
3
4 @tableofcontents
5
6 @section occt_shg_1 Overview
7
8 This manual explains how to use Shape Healing. It provides basic documentation on its operation. For advanced information on Shape Healing and its applications, see our offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>  
9
10 The **Shape Healing** toolkit provides a set of tools to work on the geometry and topology of Open CASCADE Technology (**OCCT**) shapes. Shape Healing adapts shapes so as to make them as appropriate for use by Open CASCADE Technology as possible. 
11 **Shape Healing** currently includes several packages that are designed to help you to: 
12   *  analyze shape characteristics and, in particular, identify shapes that do not comply with Open CASCADE Technology validity rules 
13   *  fix some of the problems shapes may have 
14   *  upgrade shape characteristics for users needs, for example a C0 supporting surface can be upgraded so that it becomes C1 continuous. 
15   
16 The following diagram shows dependencies of API packages: 
17
18 @figure{/user_guides/shape_healing/images/shape_healing_image009.svg, "Shape Healing packages"}
19
20 Each sub-domain has its own scope of functionality: 
21 * analysis - exploring shape properties, computing shape features, detecting violation of OCCT requirements (shape itself is not modified);
22 * fixing - fixing shape to meet the OCCT requirements (the shape may change its original form: modifying, removing, constructing sub-shapes, etc.); 
23 * upgrade - shape improvement for better usability in Open CASCADE Technology or other algorithms (the shape is replaced with a new one, but geometrically they are the same); 
24 * customization - modifying shape representation to fit specific needs (shape is not modified, only the form of its representation is modified); 
25 * processing  - mechanism of managing shape modification via a user-editable resource file. 
26
27 Message management is used for creating messages, filling them with various parameters and storing them in the trace file. This tool provides functionality for attaching messages to the shapes for deferred analysis of various run-time events. In this document only general principles of using Shape Healing will be described. For more detailed information please see the corresponding CDL files. 
28
29 Tools responsible for analysis, fixing and upgrading of shapes can give the information about how these operations were performed. This information can be obtained by the user with the help of mechanism of status querying. 
30
31 @subsection occt_shg_1_1 Querying the statuses
32
33 Each fixing and upgrading tool has its own status, which is reset when their methods are called. The status can contain several flags, which give the information about how the method was performed. For exploring the statuses, a set of methods named *Status...()* is provided. These methods accept enumeration *ShapeExtend_Status* and return True if the status has the corresponding flag set. The meaning of flags for each method is described below. 
34
35 The status may contain a set of Boolean flags (internally represented by bits). Flags are coded by enumeration ShapeExtend_Status. This enumeration provides the following families of statuses: 
36 * *ShapeExtend_OK*  -  The situation is OK, no operation is necessary and has not been performed. 
37 * *ShapeExtend_DONE* - The operation has been successfully performed. 
38 * *ShapeExtend_FAIL* - An error has occurred during operation. 
39
40 It is possible to test the status for the presence of some flag(s), using Status...() method(s) provided by the class: 
41
42 ~~~~~
43 if ( object.Status.. ( ShapeExtend_DONE ) ) {// something was done 
44
45 ~~~~~
46
47 8 'DONE' and 8 'FAIL' flags, named ShapeExtend_DONE1 ... ShapeExtend_FAIL8, are defined for a detailed analysis of the encountered situation. Each method assigns its own meaning to each flag, documented in the CDL for that method. There are also three enumerative values used for testing several flags at a time: 
48 * *ShapeExtend_OK*   -     if no flags have been set; 
49 * *ShapeExtend_DONE* - if at least one ShapeExtend_DONEi has been set; 
50 * *ShapeExtend_FAIL* - if at least one ShapeExtend_FAILi has been set. 
51
52 @section occt_shg_2 Repair
53
54 Algorithms for fixing problematic (violating the OCCT requirements) shapes are placed in package *ShapeFix*. 
55
56 Each class of package *ShapeFix* deals with one certain type of shapes or with some family of problems. 
57
58 There is no necessity for you to detect problems before using *ShapeFix* because all components of package *ShapeFix* make an analysis of existing problems before fixing them by a corresponding tool from package of *ShapeAnalysis* and then fix the discovered problems. 
59
60 The *ShapeFix* package currently includes functions that: 
61   * add a 2D curve or a 3D curve where one is missing,
62   * correct a deviation of a 2D curve from a 3D curve when it exceeds a given tolerance value,
63   * limit the tolerance value of shapes within a given range,
64   * set a given tolerance value for shapes,
65   * repair the connections between adjacent edges of a wire,
66   * correct self–intersecting wires,
67   * add seam edges,
68   * correct gaps between 3D and 2D curves,
69   * merge and remove small edges,
70   * correct orientation of shells and solids.
71
72 @subsection occt_shg_2_1 Basic Shape Repair
73
74 The simplest way for fixing shapes is to use classes *ShapeFix_Shape* and *ShapeFix_Wireframe* on a whole shape with default parameters. A combination of these tools can fix most of the problems that shapes may have. 
75 The sequence of actions is as follows : 
76
77 1. Create tool *ShapeFix_Shape* and initialize it by shape: 
78 ~~~~~
79 Handle(ShapeFix_Shape) sfs = new ShapeFix_Shape; 
80 sfs->Init ( shape ); 
81 ~~~~~
82 2. Set the basic precision and the maximum allowed tolerance:
83 ~~~~~
84 sfs->SetPrecision ( Prec ); 
85 sfs->SetMaxTolerance ( maxTol ); 
86 ~~~~~
87 where *Prec* – basic precision,  *maxTol* – maximum allowed tolerance. 
88 All problems will be detected for cases when a dimension of invalidity is larger than the basic precision or a tolerance of sub-shape on that problem is detected.
89 The maximum tolerance value limits the increasing tolerance for fixing a problem. If a value larger than the maximum allowed tolerance is necessary for correcting a detected problem the problem can not be fixed.
90 3. Launch fixing:
91 ~~~~~
92 sfs->Perform(); 
93 ~~~~~
94 4. Get the result:
95 ~~~~~
96 TopoDS_Shape aResult = sfs->Shape(); 
97 ~~~~~
98 In some cases using  only *ShapeFix_Shape* can be insufficient. It is possible to use tools for merging and removing small edges and fixing gaps between 2D and 3D curves.
99 5. Create *ShapeFix_Wireframe* tool and initialize it by shape:
100 ~~~~~
101 Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme(shape); 
102 Or 
103 Handle(ShapeFix_Wirefarme) SFWF = new ShapeFix_Wirefarme; 
104 SFWF->Load(shape); 
105 ~~~~~
106 6. Set the basic precision and the maximum allowed tolerance:
107 ~~~~~
108 sfs->SetPrecision ( Prec ); 
109 sfs->SetMaxTolerance ( maxTol ); 
110 ~~~~~
111 See the description for *Prec* and *maxTol* above. 
112 7. Merge and remove small edges:
113 ~~~~~
114 SFWF->DropSmallEdgesMode() = Standard_True; 
115 SFWF->FixSmallEdges(); 
116 ~~~~~
117 **Note:** Small edges are not removed with the default mode, but in many cases removing small edges is very useful for fixing a shape. 
118 8. Fix gaps for 2D and 3D curves
119 ~~~~~
120 SFWF->FixWireGaps(); 
121 ~~~~~
122 9. Get the result
123 ~~~~~
124 TopoDS_Shape Result = SFWF->Shape(); 
125 ~~~~~
126
127
128 @subsection occt_shg_2_2 Shape Correction.
129
130 If you do not want to make fixes on the whole shape or make a definite set of fixes you can set flags for separate fix cases (marking them ON or OFF) and you can also use classes for fixing specific types of sub-shapes such as solids, shells, faces, wires, etc.  
131
132 For each type of sub-shapes there are specific types of fixing tools such as *ShapeFix_Solid, ShapeFix_Shell, ShapeFix_Face, ShapeFix_Wire,* etc.
133
134 @subsubsection occt_shg_2_2_1 Fixing sub-shapes
135 If you want to make a fix on one subshape of a certain shape it is possible to take the following steps: 
136   * create a tool for a specified subshape type and initialize this tool by the subshape;
137   * create a tool for rebuilding the shape and initialize it by the whole shape (section 5.1);
138   * set a tool for rebuilding the shape in the tool for fixing the subshape;
139   * fix the subshape;
140   * get the resulting whole shape containing a new corrected subshape.
141
142 For example, in the following way it is possible to fix face *Face1* of shape *Shape1*: 
143
144 ~~~~~
145 //create tools for fixing a face 
146 Handle(ShapeFix_Face)  SFF= new ShapeFix_Face; 
147
148 // create tool for rebuilding a shape and initialize it by shape 
149 Handle(ShapeBuild_ReShape) Context = new ShapeBuild_ReShape;  
150 Context->Apply(Shape1); 
151
152 //set a tool for rebuilding a shape in the tool for fixing 
153 SFF->SetContext(Context); 
154         
155 //initialize the fixing tool by one face 
156 SFF->Init(Face1); 
157
158 //fix the set face 
159 SFF->Perform(); 
160         
161 //get the result 
162 TopoDS_Shape  NewShape = Context->Apply(Shape1); 
163 //Resulting shape contains the fixed face. 
164 ~~~~~
165
166 A set of required fixes and invalid sub-shapes can be obtained with the help of tools responsible for the analysis of shape validity (section 3.2). 
167
168 @subsection occt_shg_2_3 Repairing tools
169
170 Each class of package ShapeFix deals with one certain type of shapes or with a family of problems. Each repairing tool makes fixes for the specified shape and its sub-shapes with the help of method *Perform()* containing an optimal set of fixes. The execution of these fixes in the method Perform can be managed with  help of a set of control flags (fixes can be either forced or forbidden). 
171
172 @subsubsection occt_shg_2_3_1 General Workflow 
173
174 The following sequence of actions should be applied to perform fixes:
175 1. Create a tool. 
176 2. Set the following values: 
177         + the working precision by method  *SetPrecision()* (default 1.e-7) 
178         + set the maximum allowed tolerance by method *SetMaxTolerance()* (by default it is equal to the working precision). 
179         + set the minimum tolerance by method *SetMinTolerance()* (by default it is equal to the working precision). 
180         + set a tool for rebuilding shapes after the modification (tool *ShapeBuild_ReShape*) by method *SetContext()*. For separate faces, wires and edges this tool is set optionally. 
181         + to force or forbid some of fixes, set the corresponding flag to 0 or 1. 
182 3. Initialize the tool by the shape with the help of methods Init or Load
183 4. Use method *Perform()* or create a custom set of fixes. 
184 5. Check the statuses of fixes by the general method *Status* or specialized methods *Status_*(for example *StatusSelfIntersection* (*ShapeExtentd_DONE*)). See the description of statuses below. 
185 6. Get the result in two ways : 
186         - with help of a special method *Shape(),Face(),Wire().Edge()*. 
187         - from the rebuilding tool by method *Apply* (for access to rebuilding tool use method *Context()*): 
188 ~~~~~
189         TopoDS_Shape resultShape = fixtool->Context()->Apply(initialShape); 
190 ~~~~~
191 Modification fistory for the shape and its sub-shapes can be obtained from the tool for shape re-building (*ShapeBuild_ReShape*). 
192
193 ~~~~~
194 TopoDS_Shape modifsubshape = fixtool->Context() -> Apply(initsubshape); 
195 ~~~~~
196
197  
198 @subsubsection occt_shg_2_3_2 Flags Management
199  
200 The flags *Fix...Mode()* are used to control the execution of fixing procedures from the API fixing methods. By default, these flags have values equal to -1, this means that the corresponding procedure will either be called or not called, depending on the situation. If the flag is set to 1, the procedure is executed anyway; if the flag is 0, the procedure is not executed. The name of the flag corresponds to the fixing procedure that is controlled. For each fixing tool there exists its own set of flags. To set a flag to the desired value, get a tool containing this flag and set the flag to the required value. 
201
202 For example, it is possible to forbid performing fixes to remove small edges - *FixSmall* 
203
204 ~~~~~
205 Handle(ShapeFix_Shape) Sfs = new ShapeFix_Shape(shape); 
206 Sfs-> FixWireTool ()->FixSmallMode () =0; 
207 if(Sfs->Perform()) 
208         TopoDS_Shape resShape = Sfs->Shape(); 
209 ~~~~~
210
211
212 @subsubsection occt_shg_2_3_3 Repairing tool for shapes
213
214 Class *ShapeFix_Shape* allows using repairing tools for all sub-shapes of a shape. It provides access to all repairing tools for fixing sub-shapes of the specified shape and to all control flags from these tools.
215
216 For example, it is possible to force the removal of invalid 2D curves from a face. 
217
218 ~~~~~
219 TopoDS_Face face … // face with invalid 2D curves. 
220 //creation of tool and its initialization by shape. 
221 Handle(ShapeFix_Shape) sfs = new ShapeFix_Shape(face); 
222 //set work precision and max allowed tolerance. 
223 sfs->SetPrecision(prec); 
224 sfs->SetMaxTolerance(maxTol); 
225 //set the value of flag for forcing the removal of 2D curves 
226 sfs->FixWireTool()->FixRemovePCurveMode() =1; 
227 //reform fixes 
228 sfs->Perform(); 
229 //getting the result 
230 if(sfs->Status(ShapeExtend_DONE) ) { 
231  cout << "Shape was fixed" << endl; 
232  TopoDS_Shape resFace = sfs->Shape(); 
233
234 else if(sfs->Status(ShapeExtend_FAIL)) { 
235 cout<< "Shape could not be fixed" << endl; 
236
237 else if(sfs->Status(ShapeExtent_OK)) { 
238 cout<< "Initial face is valid with specified precision ="<< precendl; 
239
240 ~~~~~
241
242 @subsubsection occt_shg_2_3_4 Repairing tool for solids
243
244 Class *ShapeFix_Solid* allows fixing solids and building a solid from a shell to obtain a valid solid with a finite volume. The tool *ShapeFix_Shell* is used for correction of shells belonging to a solid. 
245
246 This tool has the following control flags:
247 * *FixShellMode* - Mode for applying fixes of ShapeFix_Shell, True by default. 
248 * *CreateOpenShellMode* - If it is equal to true solids are created from open shells, else solids are created from closed shells only, False by default. 
249
250 @subsubsection occt_shg_2_3_5 Repairing tool for shells 
251 Class *ShapeFix_Shell* allows fixing wrong orientation of faces in a shell. It changes the orientation of faces in the shell  so that all faces in the shell have coherent orientations. If it is impossible to orient all faces in the shell (like in case of Mebious tape), then a few manifold or non-manifold shells will be created depending on the specified Non-manifold mode. The *ShapeFix_Face* tool is used to correct faces in the shell. 
252 This tool has the following control flags:
253 * *FixFaceMode* - mode for applying the fixes of  *ShapeFix_Face*, *True* by default. 
254 * *FixOrientationMode*  - mode for applying a fix for the orientation of faces in the shell. 
255
256 @subsubsection occt_shg_2_3_6 Repairing tool for faces 
257
258 Class *ShapeFix_Face* allows fixing the problems connected with wires of a face. It allows controlling the creation of a face (adding wires), and fixing wires by means of tool *ShapeFix_Wire*. 
259 When a wire is added to a face, it can be reordered and degenerated edges can be fixed. This is performed or not depending on the user-defined flags (by default, False). 
260 The following fixes are available: 
261   * fixing of wires orientation on the face. If the face has no wire, the natural bounds are computed. If the face is on a spherical surface and has two or more wires on it describing holes, the natural bounds are added. In case of a single wire, it is made to be an outer one. If the face has several wires, they are oriented to lay one outside another (if possible). If the supporting surface is periodic, 2D curves of internal wires can be shifted on integer number of periods to put them inside the outer wire. 
262   * fixing the case when the face on the closed surface is defined by a set of closed wires, and the seam is missing (this is not valid in OCCT). In that case, these wires are connected by means of seam edges into the same wire.
263
264 This tool has the following control flags: 
265 * *FixWireMode*  - mode for applying fixes of a wire, True by default. 
266 * *FixOrientationMode*  - mode for orienting a wire to border a limited square, True by default. 
267 * *FixAddNaturalBoundMode* - mode for adding natural bounds to a face, False by default. 
268 * *FixMissingSeamMode* – mode to fix a missing seam, True by default. If True, tries to insert a seam. 
269 * *FixSmallAreaWireMode* - mode to fix a small-area wire, False by default. If True, drops wires bounding small areas. 
270
271 ~~~~~
272
273 TopoDS_Face face = ...; 
274 TopoDS_Wire wire = ...; 
275
276 //Creates a tool and adds a wire to the face 
277 ShapeFix_Face sff (face); 
278 sff.Add (wire); 
279
280 //use method Perform to fix the wire and the face 
281 sff.Perfom(); 
282
283 //or make a separate fix for the orientation of wire on the face 
284 sff.FixOrientation(); 
285
286 //Get the resulting face 
287 TopoDS_Face newface = sff.Face(); 
288 ~~~~~
289
290 @subsubsection occt_shg_2_3_7 Repairing tool for wires 
291
292 Class *ShapeFix_Wire* allows fixing a wire. Its method *Perform()* performs all the available fixes in addition to the geometrical filling of gaps. The geometrical filling of gaps can be made with the help of the tool for fixing the wireframe of shape *ShapeFix_Wireframe*.  
293
294 The fixing order and the default behavior of *Perform()* is as follows: 
295   * Edges in the wire are reordered by *FixReorder*. Most of fixing methods expect edges in a wire to be ordered, so it is necessary to make call to *FixReorder()* before making any other fixes. Even if it is forbidden, the analysis of whether the wire is ordered or not is performed anyway. 
296   * Small edges are removed by *FixSmall* . 
297   * Edges in the wire are connected (topologically) by *FixConnected* (if the wire is ordered). 
298   * Edges (3Dcurves and 2D curves)  are fixed by *FixEdgeCurves* (without *FixShifted* if the wire is not ordered). 
299   * Degenerated edges  are added by *FixDegenerated*(if the wire is ordered). 
300   * Self-intersection is fixed by *FixSelfIntersection* (if the wire is ordered and *ClosedMode* is True). 
301   * Lacking edges are fixed by *FixLacking* (if the wire is ordered). 
302   
303  The flag *ClosedWireMode* specifies whether the wire is (or should be) closed or not. If that flag is True (by default), fixes that require or force connection between edges are also executed for the last and the first edges. 
304   
305 The fixing methods can be turned on/off by using their corresponding control flags: 
306 * *FixReorderMode,* 
307 * *FixSmallMode,* 
308 * *FixConnectedMode,* 
309 * *FixEdgeCurvesMode,* 
310 * *FixDegeneratedMode,* 
311 * *FixSelfIntersectionMode* 
312
313 Some fixes can be made in three ways: 
314   * Increasing the tolerance of an edge or a vertex. 
315   * Changing topology (adding/removing/replacing an edge in the wire and/or replacing the vertex in the edge, copying the edge etc.). 
316   * Changing geometry (shifting a vertex or adjusting ends of an edge curve to vertices, or re-computing a 3D curve or 2D curves of the edge). 
317   
318 When it is possible to make a fix in more than one way (e.g., either by increasing the tolerance or shifting a vertex), it is chosen according to the user-defined flags: 
319 * *ModifyTopologyMode* -   allows modifying topology, False by default. 
320 * *ModifyGeometryMode* -  allows modifying geometry. Now this flag is used only in fixing self-intersecting edges (allows to modify 2D curves) and is True by default. 
321   
322 #### Fixing disordered edges
323
324 *FixReorder* is necessary for most other fixes (but is not necessary for Open CASCADE Technology). It checks whether edges in the wire go in a sequential order (the end of a preceding edge is the start of a following one). If it is not so, an attempt to reorder the edges is made. 
325
326 #### Fixing small edges
327
328 *FixSmall* method searches for the edges, which have a length less than the given value (degenerated edges are ignored). If such an edge is found, it is removed provided that one of the following conditions is satisfied: 
329   * both end vertices of that edge are one and the same vertex, 
330   * end vertices of the edge are different, but the flag *ModifyTopologyMode* is True. In the latter case, method *FixConnected* is applied to the preceding and the following edges to ensure their connection.
331  
332 #### Fixing disconnected edges
333
334 *FixConnected* method forces two adjacent edges to share the same common vertex (if they do not have a common one). It checks whether the end vertex of the preceding edge coincides with the start vertex of the following edge with the given precision, and then creates a new vertex and sets it as a common vertex for the fixed edges. At that point, edges are copied, hence the wire topology is changed (regardless of the *ModifyTopologyMode* flag). If the vertices do not coincide, this method fails. 
335
336 #### Fixing the consistency of edge curves
337
338 *FixEdgeCurves* method performs a set of fixes dealing with 3D curves and 2D curves of edges in a wire. 
339
340 These fixes will be activated with the help of a set of fixes from the repairing tool for edges called *ShapeFix_Edge*. Each of these fixes can be forced or forbidden by means of setting the corresponding flag to either True or False. 
341
342 The mentioned fixes and the conditions of their execution are: 
343   * fixing a disoriented 2D curve by call to *ShapeFix_Edge::FixReversed2d* - if not forbidden by flag *FixReversed2dMode*;
344   * removing a wrong 2D curve  by call to *ShapeFix_Edge::FixRemovePCurve* - only if forced by flag *FixRemovePCurveMode*;
345   * fixing a missing  2D curve by call to *ShapeFix_Edge::FixAddPCurve* - if not forbidden by flag *FixAddPCurveMode*; 
346   * removing a wrong 3D curve by call to *ShapeFix_Edge::FixRemoveCurve3d* - only if forced by flag *FixRemoveCurve3dMode*; 
347   * fixing a missing 3D curve by call to *ShapeFix_Edge::FixAddCurve3d* - if not forbidden by flag *FixAddCurve3dMode*;
348   * fixing 2D curves of seam edges - if not forbidden by flag *FixSeamMode*; 
349   * fixing 2D curves which can be shifted at an integer number of periods on the closed surface by call to *ShapeFix_Edge::FixShifted*  - if not forbidden by flag *FixShiftedMode*. 
350   
351 This fix is required if 2D curves of some edges in a wire lying on a closed surface were recomputed from 3D curves. In that case, the 2D curve for the edge, which goes along the seam of the surface, can be incorrectly shifted at an integer number of periods. The method *FixShifted* detects such cases and shifts wrong 2D curves back, ensuring that the 2D curves of the edges in the wire are connected.
352
353   * fixing the SameParameter problem by call to *ShapeFix_Edge::FixSameParameter* - if not forbidden by flag *FixSameParameterMode*.
354   
355   
356 #### Fixing degenerated edges
357
358 *FixDegenerated*  method checks whether an edge in a wire lies on a degenerated point of the supporting surface, or whether there is a degenerated point between the edges. If one of these cases is detected for any edge, a new degenerated edge is created and it replaces the current edge in the first case or is added to the wire in the second case. The newly created degenerated edge has a straight 2D curve, which goes from the end of the 2D curve of the preceding edge to the start of the following one. 
359
360 #### Fixing intersections of 2D curves of the edges
361
362 *FixSelfIntersection* method detects and fixes the following problems: 
363   * self-intersection of 2D curves of individual edges. If the flag *ModifyGeometryMode()* is False this fix will be performed by increasing the tolerance of one of end vertices to a value less then *MaxTolerance()*.
364   * intersection of 2D curves of each of the two adjacent edges (except the first and the last edges if the flag ClosedWireMode is False). If such intersection is found, the common vertex is modified in order to comprise the intersection point. If the flag *ModifyTopologyMode* is False this fix will be performed by increasing the tolerance of the vertex to a value less then *MaxTolerance()*.
365   * intersection of 2D curves of non-adjacent edges. If such intersection is found the tolerance of the nearest vertex is increased to comprise the intersection point. If such increase cannot be done with a tolerance less than *MaxTolerance* this fix will not be performed.
366
367 #### Fixing a lacking edge
368
369 *FixLacking* method checks whether a wire is not closed in the parametrical space of the surface (while it can be closed in 3D). This is done by checking whether the gap between 2D curves of each of the two adjacent edges in the wire is smaller than the tolerance of the corresponding vertex. The algorithm computes the gap between the edges, analyses positional relationship of the ends of these edges and (if possible) tries to insert a new edge into the gap or increases the tolerance. 
370
371 #### Fixing gaps in 2D and 3D wire by geometrical filling
372 The following methods check gaps between the ends of 2D or 3D curves of adjacent edges:
373 * Method *FixGap2d* moves the ends of 2D curves to the middle point. 
374 * Method *FixGaps3d* moves the ends of 3D curves to a common vertex. 
375
376 Boolean flag *FixGapsByRanges* is used to activate an additional mode applied before converting to B-Splines. When this mode is on, methods try to find the most precise intersection of curves, or the most precise projection of a target point, or an extremity point between two curves (to modify their parametric range accordingly). This mode is off by default. Independently of the additional mode described above, if gaps remain, these methods convert curves to B-Spline form and shift their ends if a gap is detected. 
377
378 #### Example: A custom set of fixes 
379
380
381 Let us create a custom set of fixes as an example. 
382 ~~~~~
383 TopoDS_Face face = ...; 
384 TopoDS_Wire wire = ...; 
385 Standard_Real precision = 1e-04; 
386 ShapeFix_Wire sfw (wire, face, precision); 
387 //Creates a tool and loads objects into it 
388 sfw.FixReorder(); 
389 //Orders edges in the wire so that each edge starts at the end of the one before it. 
390 sfw.FixConnected(); 
391 //Forces all adjacent edges to share 
392 //the same vertex 
393 Standard_Boolean LockVertex = Standard_True; 
394         if (sfw.FixSmall (LockVertex, precision)) { 
395         //Removes all edges which are shorter than the given precision and have the same vertex at both ends. 
396
397         if (sfw.FixSelfIntersection()) { 
398         //Fixes self-intersecting edges and intersecting adjacent edges. 
399         cout <<"Wire was slightly self-intersecting. Repaired"<<endl; 
400
401         if ( sfw.FixLacking ( Standard_False ) ) { 
402         //Inserts edges to connect adjacent non-continuous edges. 
403
404 TopoDS_Wire newwire = sfw.Wire(); 
405 //Returns the corrected wire 
406 ~~~~~
407
408 #### Example: Correction of a wire 
409
410 Let us correct the following wire:
411
412 @image html /user_guides/shape_healing/images/shape_healing_image013.png "Initial shape"
413 @image latex /user_guides/shape_healing/images/shape_healing_image013.png "Initial shape"
414
415 It is necessary to apply the <a href="#_3_1_2">Tools for the analysis of validity of wires</a> to check that:
416 * the edges are correctly oriented;
417 * there are no edges that are too short;
418 * there are no intersecting adjacent edges;
419 and then immediately apply fixing tools. 
420
421 ~~~~~
422 TopoDS_Face face = ...;
423 TopoDS_Wire wire = ...;
424 Standard_Real precision = 1e-04;
425 ShapeAnalysis_Wire saw (wire, face, precision);
426 ShapeFix_Wire sfw (wire, face, precision);
427 if (saw.CheckOrder()) {
428   cout<<“Some edges in the wire need to be reordered”<<endl;
429   // Two edges are incorrectly oriented
430   sfw.FixReorder();
431   cout<<“Reordering is done”<<endl;
432 }
433 // their orientation is corrected
434 if (saw.CheckSmall (precision)) {
435   cout<<“Wire contains edge(s) shorter than “<<precision<<endl;
436   // An edge that is shorter than the given tolerance is found.
437   Standard_Boolean LockVertex = Standard_True;
438   if (sfw.FixSmall (LockVertex, precision)) {
439     cout<<“Edges shorter than “<<precision<<“ have been removed”
440 <<endl;
441     //The edge is removed
442   }
443 }
444 if (saw.CheckSelfIntersection()) {
445   cout<<“Wire has self-intersecting or intersecting
446 adjacent edges”<<endl;
447   // Two intersecting adjacent edges are found.
448   if (sfw.FixSelfIntersection()) {
449     cout<<“Wire was slightly self-intersecting. Repaired”<<endl;
450     // The edges are cut at the intersection point so that they no longer intersect.
451   }
452 }
453 ~~~~~
454
455 As the result all failures have been fixed.
456
457 @image html /user_guides/shape_healing/images/shape_healing_image014.png "Resulting shape"
458 @image latex /user_guides/shape_healing/images/shape_healing_image014.png "Resulting shape"
459
460 @subsubsection occt_shg_2_3_8 Repairing tool for edges 
461
462 Class *ShapeFix_Edge*  provides tools for fixing invalid edges. The following geometrical and/or topological inconsistencies are detected and fixed: 
463   * missing 3D curve or 2D curve, 
464   * mismatching orientation of a 3D curve and a 2D curve, 
465   * incorrect SameParameter flag (curve deviation is greater than the edge tolerance). 
466 Each fixing method first checks whether the problem exists using methods of the *ShapeAnalysis_Edge* class. If the problem is not detected, nothing is done. 
467 This tool does not have the method *Perform()*. 
468
469 To see how this tool works, it is possible to take an edge, where the maximum deviation between the 3D curve and 2D curve P1 is greater than the edge tolerance.
470
471 @image html /user_guides/shape_healing/images/shape_healing_image011.png "Initial shape"
472 @image latex /user_guides/shape_healing/images/shape_healing_image011.png "Initial shape"
473
474 First it is necessary to apply the <a href="#_3_1_3">Tool for checking the validity of edges</a> to find that maximum deviation between pcurve and 3D curve is greater than tolerance. Then we can use the repairing tool to increase the tolerance and make the deviation acceptable.
475
476 ~~~~~   
477 ShapeAnalysis_Edge sae;
478 TopoDS_Face face = ...; 
479 TopoDS_Wire wire = ...; 
480 Standard_Real precision = 1e-04; 
481 ShapeFix_Edge sfe;
482 Standard_Real maxdev;
483 if (sae.CheckSameParameter (edge, maxdev)) {
484   cout<<“Incorrect SameParameter flag”<<endl;
485   cout<<“Maximum deviation “<<maxdev<< “, tolerance “
486 <<BRep_Tool::Tolerance(edge)<<endl;
487   sfe.FixSameParameter();
488   cout<<“New tolerance “<<BRep_Tool::Tolerance(edge)<<endl;
489 }
490 ~~~~~
491
492 @image html /user_guides/shape_healing/images/shape_healing_image012.png "Resulting shape"
493 @image latex /user_guides/shape_healing/images/shape_healing_image012.png "Resulting shape"
494
495 As the result, the  edge tolerance has been increased.
496
497
498 @subsubsection occt_shg_2_3_9 Repairing tool for the wireframe of a shape 
499
500 Class *ShapeFix_Wireframe* provides methods for geometrical fixing of gaps and merging small edges in a shape. This class performs the following operations: 
501   * fills gaps in the 2D and 3D wireframe of a shape. 
502   * merges and removes small edges.
503   
504 Fixing of small edges can be managed with the help of two flags: 
505   * *ModeDropSmallEdges()* – mode for removing small edges that can not be merged, by default it is equal to Standard_False. 
506   * *LimitAngle* – maximum possible angle for merging two adjacent edges, by default no limit angle is applied (-1).
507 To perform fixes it is necessary to: 
508   * create a tool and initialize it by shape,
509   * set the working precision problems will be detected with and the maximum allowed tolerance
510   * perform fixes
511   
512 ~~~~~
513 //creation of a tool 
514 Handle(ShapeFix_Wireframe) sfwf = new ShapeFix_Wireframe(shape); 
515 //sets the working precision problems will be detected with and the maximum allowed tolerance 
516 sfwf->SetPrecision(prec); 
517 sfwf->SetMaxTolerance(maxTol); 
518 //fixing of gaps 
519 sfwf->FixWireGaps(); 
520 //fixing of small edges 
521 //setting of the drop mode for the fixing of small edges and max possible angle between merged edges. 
522 sfwf->ModeDropSmallEdges = Standard_True; 
523 sfwf->SetLimliteAngle(angle); 
524 //performing the fix 
525 sfwf->FixSmallEdges(); 
526 //getting the result 
527 TopoDS_Shape resShape = sfwf->Shape(); 
528 ~~~~~
529
530 It is desirable that a shape is topologically correct before applying the methods of this class. 
531
532 @subsubsection occt_shg_2_3_10 Tool for removing small faces from a shape 
533
534 Class ShapeFix_FixSmallFaceThis tool is intended for dropping small faces from the shape. The following cases are processed: 
535 * Spot face: if the size of the face is less than the given precision;
536 * Strip face: if the size of the face in one dimension is less then the given precision. 
537
538 The sequence of actions for performing the fix is the same as for the fixes described above: 
539
540 ~~~~~
541 //creation of a tool 
542 Handle(ShapeFix_FixSmallFace) sff = new ShapeFix_FixSmallFace(shape); 
543 //setting of tolerances 
544 sff->SetPrecision(prec); 
545 sff->SetMaxTolerance(maxTol); 
546 //performing fixes 
547 sff.Perform(); 
548 //getting the result 
549 TopoDS_Shape resShape = sff.FixShape(); 
550 ~~~~~
551
552 @subsubsection occt_shg_2_3_11 Tool to modify  tolerances of shapes (Class ShapeFix_ShapeTolerance).
553
554 This tool provides a functionality to set tolerances of a shape and its sub-shapes. 
555 In Open CASCADE Technology only vertices, edges and faces have tolerances. 
556
557 This tool allows processing each concrete type of sub-shapes or all types at a time. 
558 You set the tolerance functionality as follows: 
559   * set a tolerance for sub-shapes, by method SetTolerance,
560   * limit tolerances with given ranges, by method LimitTolerance.
561   
562 ~~~~~
563 //creation of a tool 
564 ShapeFix_ShapeTolerance Sft; 
565 //setting a specified tolerance on shape and all of its sub-shapes. 
566 Sft.SetTolerance(shape,toler); 
567 //setting a specified tolerance for vertices only 
568 Sft.SetTolerance(shape,toler,TopAbs_VERTEX); 
569 //limiting the tolerance on the shape and its sub-shapes between minimum and maximum tolerances 
570 Sft.LimitTolerance(shape,tolermin,tolermax); 
571 ~~~~~
572
573
574 @section occt_shg_3 Analysis
575
576 @subsection occt_shg_3_1 Analysis of shape validity
577
578 The *ShapeAnalysis* package provides tools for the analysis of topological shapes. 
579 It is not necessary to check a shape by these tools before the execution of repairing tools because these tools are used for the analysis before performing fixes inside the repairing tools. 
580 However, if you want, these tools can be used for detecting some of shape problems independently from the repairing tools. 
581
582  It can be done in the following way: 
583   * create an analysis tool. 
584   * initialize it by shape and set a tolerance problems will be detected with if it is necessary.
585   * check the problem that interests you.
586   
587 ~~~~~
588 TopoDS_Face face = ...; 
589 ShapeAnalysis_Edge sae; 
590 //Creates a tool for analyzing an edge 
591 for(TopExp_Explorer Exp(face,TopAbs_EDGE);Exp.More();Exp.Next()) { 
592   TopoDS_Edge edge = TopoDS::Edge (Exp.Current()); 
593   if (!sae.HasCurve3d (edge)) { 
594     cout  <<"Edge has no 3D curve"<<  endl;  } 
595
596 ~~~~~
597
598 @subsubsection occt_shg_3_1_1 Analysis of orientation of wires on a face.
599
600 It is possible to check whether a face has an outer boundary with the help of method *ShapeAnalysis::IsOuterBound*. 
601
602 ~~~~~
603 TopoDS_Face face … //analyzed face 
604 if(!ShapeAnalysis::IsOuterBound(face)) { 
605 cout<<"Face has not outer boundary"<<endl; 
606
607 ~~~~~
608
609 @subsubsection occt_shg_3_1_2 Analysis of wire validity
610
611 Class *ShapeAnalysis_Wire* is intended to analyze a wire. It provides functionalities both to explore wire properties and to check its conformance to Open CASCADE Technology requirements. 
612 These functionalities include: 
613   * checking the order of edges in the wire, 
614   * checking for the presence of small edges (with a length less than the given value), 
615   * checking for the presence of disconnected edges (adjacent edges having different vertices), 
616   * checking the consistency of edge curves, 
617   * checking for the presence or missing of degenerated edges, 
618   * checking for the presence of self-intersecting edges and intersecting edges (edges intersection is understood as intersection of their 2D curves), 
619   * checking for lacking edges to fill gaps in the surface parametrical space, 
620   * analyzing the wire orientation (to define the outer or the inner bound on the face), 
621   * analyzing the orientation of the shape (edge or wire) being added to an already existing wire. 
622
623 **Note** that all checking operations except for the first one are based on the assumption that edges in the wire are ordered. Thus, if the wire is detected as non-ordered it is necessary to order it before calling other checking operations. This can be done, for example, with the help of the *ShapeFix_Wire::FixOrder()* method. 
624
625 This tool should be initialized with wire, face (or a surface with a location) or precision. 
626 Once the tool has been initialized, it is possible to perform the necessary checking operations. In order to obtain all information on a wire at a time the global method *Perform* is provided. It calls all other API checking operations to check each separate case. 
627
628 API methods check for corresponding cases only, the value and the status they return can be analyzed to understand whether the case was detected or not. 
629
630 Some methods in this class are: 
631   *  *CheckOrder* checks whether edges in the wire are in the right order 
632   *  *CheckConnected* checks whether edges are disconnected 
633   *  *CheckSmall* checks whether there are edges that are shorter than the given value 
634   *  *CheckSelfIntersection* checks, whether there are self-intersecting or adjacent intersecting edges. If the intersection takes place due to nonadjacent edges, it is not detected. 
635   
636 This class maintains status management. Each API method stores the status of its last execution which can be queried by the corresponding *Status..()* method. In addition, each API method returns a Boolean value, which is True when a case being analyzed is detected (with the set *ShapeExtend_DONE* status), otherwise it is False. 
637
638 ~~~~~
639 TopoDS_Face face = ...; 
640 TopoDS_Wire wire = ...; 
641 Standard_Real precision = 1e-04; 
642 ShapeAnalysis_Wire saw (wire, face, precision); 
643 //Creates a tool and loads objects into it 
644 if (saw.CheckOrder()) { 
645   cout<<"Some edges in the wire need to be reordered"<<endl; 
646   cout<<"Please ensure that all the edges are correctly ordered before further analysis"<<endl; 
647   return; 
648
649 if (saw.CheckSmall (precision)) { 
650   cout<<"Wire contains edge(s) shorter than "<<precisionendl; 
651
652 if (saw.CheckConnected()) { 
653   cout<<"Wire is disconnected"<<endl; 
654
655 if (saw.CheckSelfIntersection()) { 
656   cout<<"Wire has self-intersecting or intersecting adjacent edges"<<  endl; 
657
658 ~~~~~
659
660 @subsubsection occt_shg_3_1_3 Analysis of edge validity 
661
662 Class *ShapeAnalysis_Edge* is intended to analyze edges. It provides the following functionalities to work with an edge: 
663   * querying geometrical representations (3D curve and pcurve(s) on a given face or surface), 
664   * querying topological sub-shapes (bounding vertices), 
665   * checking overlapping edges,
666   * analyzing the curves consistency: 
667                 + mutual orientation of the 3D curve and 2D curve (co-directions or opposite directions), 
668                 + correspondence of 3D and 2D curves to vertices. 
669
670 This class supports status management described above. 
671
672 ~~~~~
673 TopoDS_Face face = ...; 
674 ShapeAnalysis_Edge sae; 
675 //Creates a tool for analyzing an edge 
676 for(TopExp_Explorer Exp(face,TopAbs_EDGE);Exp.More();Exp.Next()) { 
677   TopoDS_Edge edge = TopoDS::Edge (Exp.Current()); 
678   if (!sae.HasCurve3d (edge)) { 
679     cout << "Edge has no 3D curve" <<  endl; 
680   } 
681   Handle(Geom2d_Curve) pcurve; 
682   Standard_Real cf, cl; 
683   if (sae.PCurve (edge, face, pcurve, cf, cl, Standard_False)) { 
684     //Returns the pcurve and its range on the given face 
685     cout<<"Pcurve range ["<<cf<<", "<<cl<<"]"<< endl; 
686   } 
687   Standard_Real maxdev; 
688   if (sae.CheckSameParameter (edge, maxdev)) { 
689     //Checks the consistency of all the curves in the edge 
690     cout<<"Incorrect SameParameter flag"<<endl; 
691   } 
692   cout<<"Maximum deviation "<<maxdev<<", tolerance" 
693              <<BRep_Tool::Tolerance(edge)<<endl; 
694
695 //checks the overlapping of two edges 
696 if(sae.CheckOverlapping(edge1,edge2,prec,dist)) { 
697          cout<<"Edges are overlapped with tolerance = "<<prec<<endl; 
698          cout<<"Domain of overlapping ="<<dist<<endl; 
699
700 ~~~~~
701
702 @subsubsection occt_shg_3_1_4 Analysis of presence of small faces
703
704 Class *ShapeAnalysis_CheckSmallFace* class is intended for analyzing small faces from the shape using the following methods: 
705 * *CheckSpotFace()* checks if the size of the face is less than the given precision; 
706 * *CheckStripFace* checks if the size of the face in one dimension is less than the given precision.
707
708 ~~~~~
709 TopoDS_Shape shape … // checked shape 
710 //Creation of a tool 
711 ShapeAnalysis_CheckSmallFace saf; 
712 //exploring the shape on faces and checking each face 
713 Standard_Integer numSmallfaces =0; 
714 for(TopExp_Explorer aExp(shape,TopAbs_FACE); aExp.More(); aExp.Next()) { 
715  TopoDS_Face face = TopoDS::Face(aexp.Current()); 
716  TopoDS_Edge E1,E2; 
717 if(saf.CheckSpotFace(face,prec) || 
718 saf.CheckStripFace(face,E1,E2,prec)) 
719 NumSmallfaces++; 
720
721 if(numSmallfaces) 
722  cout<<"Number of small faces in the shape ="<< numSmallfaces <<endl; 
723 ~~~~~ 
724  
725 @subsubsection occt_shg_3_1_5 Analysis of shell validity and closure 
726
727 Class *ShapeAnalysis_Shell* allows checking the orientation of edges in a manifold shell. With the help of this tool, free edges (edges entered into one face) and bad edges (edges entered into the shell twice with the same orientation) can be found. By occurrence of bad and free edges a conclusion about the shell validity and the closure of the shell can be made. 
728
729 ~~~~~
730 TopoDS_Shell shell // checked shape 
731 ShapeAnalysis_Shell sas(shell); 
732 //analysis of the shell , second parameter is set to True for //getting free edges,(default False) 
733 sas.CheckOrientedShells(shell,Standard_True); 
734 //getting the result of analysis 
735 if(sas.HasBadEdges()) { 
736 cout<<"Shell is invalid"<<endl; 
737 TopoDS_Compound badEdges = sas.BadEdges(); 
738
739 if(sas.HasFreeEdges()) { 
740  cout<<"Shell is open"<<endl; 
741  TopoDS_Compound freeEdges = sas.FreeEdges(); 
742
743 ~~~~~
744
745 @subsection occt_shg_3_2 Analysis of shape properties.
746 @subsubsection occt_shg_3_2_1 Analysis of tolerance on shape 
747
748 Class *ShapeAnalysis_ShapeTolerance* allows computing tolerances of the shape and its sub-shapes. In Open CASCADE Technology only vertices, edges and faces have tolerances: 
749
750 This tool allows analyzing each concrete type of sub-shapes or all types at a time. 
751 The analysis of tolerance functionality is the following: 
752   * computing the minimum, maximum and average tolerances of sub-shapes, 
753   * finding sub-shapes with tolerances exceeding the given value, 
754   * finding sub-shapes with tolerances in the given range. 
755   
756 ~~~~~
757 TopoDS_Shape shape = ...; 
758 ShapeAnalysis_ShapeTolerance sast; 
759 Standard_Real AverageOnShape = sast.Tolerance (shape, 0); 
760 cout<<"Average tolerance of the shape is "<<AverageOnShape<<endl; 
761 Standard_Real MinOnEdge = sast.Tolerance (shape,-1,TopAbs_EDGE); 
762 cout<<"Minimum tolerance of the edges is "<<MinOnEdge<<endl; 
763 Standard_Real MaxOnVertex = sast.Tolerance (shape,1,TopAbs_VERTEX); 
764 cout<<"Maximum tolerance of the vertices is "<<MaxOnVertex<<endl; 
765 Standard_Real MaxAllowed = 0.1; 
766 if (MaxOnVertex > MaxAllowed) { 
767   cout<<"Maximum tolerance of the vertices exceeds maximum allowed"<<endl; 
768
769 ~~~~~
770
771 @subsubsection occt_shg_3_2_2 Analysis of free boundaries. 
772
773 Class ShapeAnalysis_FreeBounds is intended to analyze and output the free bounds of a shape. Free bounds are wires consisting of edges referenced only once by only one face in the shape. 
774 This class works on two distinct types of shapes when analyzing their free bounds: 
775 * Analysis of possible free bounds taking the specified tolerance into account. This analysis can be applied to a compound of faces. The analyzer of the sewing algorithm (*BRepAlgo_Sewing*) is used to forecast what free bounds would be obtained after the sewing of these faces is performed. The following method should be used for this analysis:
776 ~~~~~
777 ShapeAnalysis_FreeBounds safb(shape,toler); 
778 ~~~~~
779 * Analysis of already existing free bounds. Actual free bounds (edges shared by the only face in the shell) are output in this case. *ShapeAnalysis_Shell* is used for that. 
780 ~~~~~
781 ShapeAnalysis_FreeBounds safb(shape); 
782 ~~~~~
783
784 When connecting edges into wires this algorithm tries to build wires of maximum length. Two options are provided for the user to extract closed sub-contours out of closed and/or open contours. Free bounds are returned as two compounds, one for closed and one for open wires. To obtain a result it is necessary to use methods: 
785 ~~~~~
786 TopoDS_Compound ClosedWires  = safb.GetClosedWires(); 
787 TopoDS_Compound OpenWires = safb.GetOpenWires(); 
788 ~~~~~
789 This class also provides some static methods for advanced use: connecting edges/wires to wires, extracting closed sub-wires from wires, distributing wires into compounds for closed and open wires. 
790
791 ~~~~~
792 TopoDS_Shape shape = ...; 
793 Standard_Real SewTolerance = 1.e-03; 
794 //Tolerance for sewing 
795 Standard_Boolean SplitClosed = Standard_False; 
796 Standard_Boolean SplitOpen = Standard_True; 
797 //in case of analysis of possible free boundaries 
798 ShapeAnalysis_FreeBounds safb (shape, SewTolerance, 
799 SplitClosed, SplitOpen); 
800 //in case of analysis of existing free bounds 
801 ShapeAnalysis_FreeBounds safb (shape, SplitClosed, SplitOpen); 
802 //getting the results 
803 TopoDS_Compound ClosedWires = safb.GetClosedWires(); 
804 //Returns a compound of closed free bounds 
805 TopoDS_Compound OpenWires = safb.GetClosedWires(); 
806 //Returns a compound of open free bounds 
807 ~~~~~
808
809 @subsubsection occt_shg_3_2_3 Analysis of shape contents
810
811 Class *ShapeAnalysis_ShapeContents* provides tools counting the number of sub-shapes and selecting a sub-shape by the following criteria: 
812
813 Methods for getting the number of sub-shapes: 
814   * number of solids,
815   * number of shells,
816   * number of faces,
817   * number of edges,
818   * number of vertices.
819   
820 Methods for calculating the number of geometrical objects or sub-shapes with a specified type: 
821   * number of free faces,
822   * number of free wires,
823   * number of free edges,
824   * number of C0 surfaces,
825   * number of C0 curves,
826   * number of BSpline surfaces,… etc
827   
828 and selecting sub-shapes by various criteria. 
829
830 The corresponding flags should be set to True for storing a shape by a specified criteria: 
831   * faces based on indirect surfaces - *safc.MofifyIndirectMode() = Standard_True*; 
832   * faces based on offset surfaces - *safc.ModifyOffsetSurfaceMode() = Standard_True*; 
833   * edges if their 3D curves are trimmed - *safc.ModifyTrimmed3dMode() = Standard_True*; 
834   * edges if their 3D curves and 2D curves are offset curves - *safc.ModifyOffsetCurveMode() = Standard_True*; 
835   * edges if their 2D curves are trimmed - *safc.ModifyTrimmed2dMode() = Standard_True*; 
836
837 Let us, for example, select faces based on offset surfaces.
838
839 ~~~~~ 
840 ShapeAnalysis_ShapeContents safc; 
841 //set a corresponding flag for storing faces based on the offset surfaces 
842 safc.ModifyOffsetSurfaceMode() = Standard_True; 
843 safc.Perform(shape); 
844 //getting the number of offset surfaces in the shape 
845 Standard_Integer NbOffsetSurfaces = safc.NbOffsetSurf(); 
846 //getting the sequence of faces based on offset surfaces. 
847 Handle(TopTools_HSequenceOfShape) seqFaces = safc.OffsetSurfaceSec(); 
848 ~~~~~
849
850 @section occt_shg_4 Upgrading
851
852 Upgrading tools are intended for adaptation of shapes for better use by Open CASCADE Technology or for customization to particular needs, i.e. for export to another system. This means that not only it corrects and upgrades but also changes the definition of a shape with regard to its geometry, size and other aspects. Convenient API allows you to create your own tools to perform specific upgrading. Additional tools for particular cases provide an ability to divide shapes and surfaces according to certain criteria. 
853
854 @subsection occt_shg_4_1 Tools for splitting a shape according to a specified criterion
855
856 @subsubsection occt_shg_4_1_1 Overview
857
858 These tools provide such modifications when one topological object can be divided or converted to several ones according to specified criteria. Besides, there are high level API tools for particular cases which: 
859   * Convert the geometry of shapes up to a given continuity, 
860   * split revolutions by U to segments less than the given value, 
861   * convert to Bezier surfaces and Bezier curves, 
862   * split closed faces,
863   * convert C0 BSpline curve to a sequence of C1 BSpline curves. 
864   
865 All tools for particular cases are based on general tools for shape splitting but each of them has its own tools for splitting or converting geometry in accordance with the specified criteria. 
866
867 General tools for shape splitting are: 
868   * tool for splitting the whole shape,
869   * tool for splitting a face,
870   * tool for splitting wires.
871   
872 Tools for shape splitting use tools for geometry splitting: 
873   * tool for splitting surfaces,
874   * tool for splitting 3D curves,
875   * tool for splitting 2D curves.
876   
877 @subsubsection occt_shg_4_1_2 Using tools available for shape splitting.
878 If it is necessary to split a shape by a specified continuity, split closed faces in the shape, split surfaces of revolution in the shape by angle or to convert all surfaces, all 3D curves, all 2D curves in the shape to Bezier, it is possible to use the existing/available tools. 
879
880 The usual way to use these tools exception for the tool of converting a C0 BSpline curve is the following: 
881   * a tool is created and initialized by shape.
882   * work precision for splitting and the maximum allowed tolerance are set
883   * the value of splitting criterion Is set (if necessary)
884   * splitting is performed.
885   * splitting statuses are obtained.
886   * result is obtained
887   * the history of modification of the initial shape and its sub-shapes is output (this step is optional).
888
889 Let us, for example, split all surfaces and all 3D and 2D curves having a continuity of less the C2. 
890
891 ~~~~~
892 //create a tool and initializes it by shape. 
893 ShapeUpgrade_ShapeDivideContinuity ShapeDivedeCont(initShape); 
894
895 //set the working 3D and 2D precision and the maximum allowed //tolerance 
896 ShapeDivideCont.SetTolerance(prec); 
897 ShapeDivideCont.SetTolerance2D(prec2d); 
898 ShapeDivideCont.SetMaxTolerance(maxTol); 
899
900 //set the values of criteria for surfaces, 3D curves and 2D curves. 
901 ShapeDivideCont.SetBoundaryCriterion(GeomAbs_C2); 
902 ShapeDivideCont.SetPCurveCriterion(GeomAbs_C2); 
903 ShapeDivideCont.SetSurfaceCriterion(GeomAbs_C2); 
904
905 //perform the splitting. 
906 ShapeDivideCont.Perform(); 
907
908 //check the status and gets the result 
909 if(ShapeDivideCont.Status(ShapeExtend_DONE) 
910  TopoDS_Shape result = ShapeDivideCont.GetResult(); 
911 //get the history of modifications made to faces 
912 for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) { 
913   TopoDS_Shape modifShape = ShapeDivideCont.GetContext()-> Apply(aExp.Current()); 
914
915 ~~~~~
916
917 @subsubsection occt_shg_4_1_3 Creation of a new tool for splitting a shape.
918 To create a new splitting tool it is necessary to create tools for geometry splitting according to a desirable criterion. The new tools should be inherited from basic tools for geometry splitting. Then the new tools should be set into corresponding tools for shape splitting. 
919   * a new tool for surface splitting  should be set into the tool for face splitting
920   * new tools for splitting of 3D and 2D curves  should be set into the splitting tool for wires.
921   
922 To change the value of criterion of shape splitting it is necessary to create a new tool for shape splitting that should be inherited from the general splitting tool for shapes. 
923
924 Let us split a shape according to a specified criterion. 
925
926 ~~~~~
927 //creation of new tools for geometry splitting by a specified criterion. 
928 Handle(MyTools_SplitSurfaceTool) MySplitSurfaceTool = new MyTools_SplitSurfaceTool; 
929 Handle(MyTools_SplitCurve3DTool) MySplitCurve3Dtool = new MyTools_SplitCurve3DTool; 
930 Handle(MyTools_SplitCurve2DTool) MySplitCurve2Dtool = new MyTools_SplitCurve2DTool; 
931
932 //creation of a tool for splitting the shape and initialization of that tool by shape. 
933 TopoDS_Shape initShape 
934 MyTools_ShapeDivideTool ShapeDivide (initShape); 
935
936 //setting of work precision for splitting and maximum allowed tolerance. 
937 ShapeDivide.SetPrecision(prec); 
938 ShapeDivide.SetMaxTolerance(MaxTol); 
939
940 //setting of new splitting geometry tools in the shape splitting tools 
941 Handle(ShapeUpgrade_FaceDivide) FaceDivide = ShapeDivide->GetSplitFaceTool(); 
942 Handle(ShapeUpgrade_WireDivide) WireDivide = FaceDivide->GetWireDivideTool(); 
943 FaceDivide->SetSplitSurfaceTool(MySplitSurfaceTool); 
944 WireDivide->SetSplitCurve3dTool(MySplitCurve3DTool); 
945 WireDivide->SetSplitCurve2dTool(MySplitCurve2DTool); 
946
947 //setting of the value criterion. 
948  ShapeDivide.SetValCriterion(val); 
949             
950 //shape splitting 
951 ShapeDivide.Perform(); 
952
953 //getting the result 
954 TopoDS_Shape splitShape = ShapeDivide.GetResult(); 
955
956 //getting the history of modifications of faces 
957 for(TopExp_Explorer aExp(initShape,TopAbs_FACE); aExp.More(0; aExp.Next()) { 
958 TopoDS_Shape modifShape = ShapeDivide.GetContext()-> Apply(aExp.Current()); 
959
960 ~~~~~
961
962 @subsection occt_shg_4_2 General splitting tools.
963  
964 @subsubsection occt_shg_4_2_1 General tool for shape splitting 
965
966 Class *ShapeUpgrade_ShapeDivide* provides shape splitting and converting according to the given criteria. It performs these operations for each face with the given tool for face splitting (*ShapeUpgrade_FaceDivide* by default). 
967
968 This tool provides access to the tool for dividing faces with the help of the methods *SetSplitFaceTool* and *GetSpliFaceTool.* 
969
970 @subsubsection occt_shg_4_2_2 General tool for face splitting
971
972 Class *ShapeUpgrade_FaceDivide* divides a Face (edges in the wires, by splitting 3D and 2D curves, as well as the face itself, by splitting the supporting surface) according to the given criteria. 
973
974 The area of the face intended for division is defined by 2D curves of the wires on the Face. 
975 All 2D curves are supposed to be defined (in the parametric space of the supporting surface). 
976 The result is available after the call to the *Perform* method. It is a Shell containing all resulting Faces. All modifications made during the splitting operation are recorded in the external context (*ShapeBuild_ReShape*). 
977
978 This tool provides access to the tool for wire division and surface splitting by means of the following methods: 
979 * *SetWireDivideTool,* 
980 * *GetWireDivideTool,* 
981 * *SetSurfaceSplitTool,* 
982 * *GetSurfaceSplitTool*. 
983
984 @subsubsection occt_shg_4_2_3 General tool for wire splitting
985 Class *ShapeUpgrade_WireDivide* divides edges in the wire lying on the face or free wires or free edges with a given criterion. It splits the 3D curve and 2D curve(s) of the edge on the face. Other 2D curves, which may be associated with the edge, are simply copied. If the 3D curve is split then the 2D curve on the face is split as well, and vice-versa. The original shape is not modified. Modifications made are recorded in the context (*ShapeBuild_ReShape*). 
986
987 This tool provides access to the tool for dividing and splitting 3D and 2D curves by means of the following methods: 
988 * *SetEdgeDivdeTool,* 
989 * *GetEdgeDivideTool,* 
990 * *SetSplitCurve3dTool,* 
991 * *GetSplitCurve3dTool,* 
992 * *SetSplitCurve2dTool,* 
993 * *GetSplitCurve2dTool* 
994
995 and it also provides access to the mode for splitting edges by methods *SetEdgeMode* and *GetEdgeMode*.
996  
997 This mode sets whether only free edges, only shared edges or all edges are split.
998
999 @subsubsection occt_shg_4_2_4 General tool for edge splitting
1000
1001 Class *ShapeUpgrade_EdgeDivide* divides edges and their geometry according to the specified criteria. It is used in the wire-dividing tool. 
1002
1003 This tool provides access to the tool for dividing and splitting 3D and 2D curves by the following methods: 
1004 * *SetSplitCurve3dTool,* 
1005 * *GetSplitCurve3dTool,* 
1006 * *SetSplitCurve2dTool,* 
1007 * *GetSplitCurve2dTool*. 
1008
1009 @subsubsection occt_shg_4_2_5 General tools for geometry splitting
1010
1011 There are three general tools for geometry splitting. 
1012   * General tool for surface splitting.(*ShapeUpgrade_SplitSurface*)
1013   * General tool for splitting 3D curves.(*ShapeUpgrade_SplitCurve3d*)
1014   * General tool for splitting 2D curves.(*ShapeUpgrade_SplitCurve2d*)
1015   
1016 All these tools are constructed the same way: 
1017 They have methods: 
1018   * for initializing by geometry (method *Init*) 
1019   * for splitting (method *Perform*)
1020   * for getting the status after splitting and the results:
1021         + *Status* – for getting the result status; 
1022         + *ResSurface* - for splitting surfaces; 
1023         + *GetCurves* - for splitting 3D and 2D curves. 
1024 During the process of splitting in the method *Perform* : 
1025   * splitting values in the parametric space are computed according to a specified criterion (method  *Compute*) 
1026   * splitting is made in accordance with the values computed for splitting (method *Build*).
1027
1028 To create new tools for geometry splitting it is enough to inherit a new tool from the general tool for splitting a corresponding type of geometry and to re-define the method for computation of splitting values according to the specified criterion in them. (method *Compute*). 
1029
1030 Header file for the tool for surface splitting by continuity: 
1031
1032 ~~~~~
1033 class ShapeUpgrade_SplitSurfaceContinuity : public ShapeUpgrade_SplitSurface { 
1034 Standard_EXPORT ShapeUpgrade_SplitSurfaceContinuity(); 
1035
1036 //methods to set the criterion and the tolerance into the splitting tool 
1037 Standard_EXPORT   void SetCriterion(const GeomAbs_Shape Criterion) ; 
1038 Standard_EXPORT   void SetTolerance(const Standard_Real Tol) ; 
1039
1040 //redefinition of method Compute 
1041 Standard_EXPORT virtual void Compute(const Standard_Boolean Segment) ; 
1042 Standard_EXPORT ~ShapeUpgrade_SplitSurfaceContinuity(); 
1043 private: 
1044 GeomAbs_Shape myCriterion; 
1045 Standard_Real myTolerance; 
1046 Standard_Integer myCont; 
1047 }; 
1048 ~~~~~
1049
1050 @subsection occt_shg_4_3 Specific splitting tools.
1051
1052 @subsubsection occt_shg_4_3_1 Conversion of shape geometry to the target continuity
1053 Class *ShapeUpgrade_ShapeDivideContinuity* allows converting geometry with continuity less than the specified continuity to geometry with target continuity. If converting is not possible than geometrical object is split into several ones, which satisfy the given criteria. A topological object based on this geometry is replaced by several objects based on the new geometry. 
1054
1055 ~~~~~
1056 ShapeUpgrade_ShapeDivideContinuity sdc (shape); 
1057 sdc.SetTolerance (tol3d); 
1058 sdc.SetTolerance3d (tol2d); // if known, else 1.e-09 is taken 
1059 sdc.SetBoundaryCriterion (GeomAbs_C2); // for Curves 3D 
1060 sdc.SetPCurveCriterion (GeomAbs_C2); // for Curves 2D 
1061 sdc.SetSurfaceCriterion (GeomAbs_C2); // for Surfaces 
1062 sdc.Perform (); 
1063 TopoDS_Shape bshape = sdc.Result(); 
1064 //.. to also get the correspondances before/after 
1065 Handle(ShapeBuild_ReShape) ctx = sdc.Context(); 
1066 //.. on a given shape 
1067 if (ctx.IsRecorded (sh)) { 
1068   TopoDS_Shape newsh = ctx->Value (sh); 
1069 // if there are several results, they are recorded inside a Compound.
1070 // .. process as needed 
1071
1072 ~~~~~
1073
1074 @subsubsection occt_shg_4_3_2 Splitting by angle
1075 Class *ShapeUpgrade_ShapeDivideAngle* allows  splitting all surfaces of revolution, cylindrical, toroidal, conical, spherical surfaces in the given shape so that each resulting segment covers not more than the defined angle (in radians). 
1076
1077 @subsubsection occt_shg_4_3_3 Conversion of 2D, 3D curves and surfaces to Bezier
1078
1079 Class *ShapeUpgrade_ShapeConvertToBezier* is an API tool for performing a conversion of 3D, 2D curves to Bezier curves and surfaces to Bezier based surfaces (Bezier surface, surface of revolution based on Bezier curve, offset surface based on any of previous types).
1080  
1081 This tool provides access to various flags for conversion of different types of curves and surfaces to Bezier by methods: 
1082 * For 3D curves: 
1083         * *Set3dConversion,* 
1084         * *Get3dConversion,* 
1085         * *Set3dLineConversion,* 
1086         * *Get3dLineConversion,* 
1087         * *Set3dCircleConversion,* 
1088         * *Get3dCircleConversion,* 
1089         * *Set3dConicConversion,* 
1090         * *Get3dConicConversion* 
1091 * For 2D curves: 
1092         * *Set2dConversion,* 
1093         * *Get2dConversion* 
1094 * For surfaces : 
1095         * *GetSurfaceConversion,* 
1096         * *SetPlaneMode,* 
1097         * *GetPlaneMode,* 
1098         * *SetRevolutionMode,* 
1099         * *GetRevolutionMode,* 
1100         * *SetExtrusionMode,* 
1101         * *GetExtrusionMode,* 
1102         * *SetBSplineMode,* 
1103         * *GetBSplineMode,* 
1104
1105 Let us attempt to produce a conversion of planes to Bezier surfaces. 
1106 ~~~~~
1107 //Creation and initialization of a tool. 
1108 ShapeUpgrade_ShapeConvertToBezier SCB (Shape); 
1109 //setting tolerances 
1110 ...
1111 //setting mode for conversion of planes 
1112 SCB.SetSurfaceConversion (Standard_True); 
1113 SCB.SetPlaneMode(Standard_True); 
1114 SCB.Perform(); 
1115 If(SCB.Status(ShapeExtend_DONE) 
1116     TopoDS_Shape result = SCB.GetResult(); 
1117 ~~~~~
1118
1119 @subsubsection occt_shg_4_3_4 Tool for splitting closed faces
1120
1121 Class *ShapeUpgrade_ShapeDivideClosed* provides splitting of closed faces in the shape to a defined number of components by the U and V parameters. It topologically and (partially) geometrically processes closed faces and performs splitting with the help of class *ShapeUpgrade_ClosedFaceDivide*. 
1122
1123 ~~~~~
1124 TopoDS_Shape aShape = …; 
1125 ShapeUpgrade_ShapeDivideClosed tool (aShape ); 
1126 Standard_Real closeTol = …; 
1127 tool.SetPrecision(closeTol); 
1128 Standard_Real maxTol = …; 
1129 tool.SetMaxTolerance(maxTol); 
1130 Standard_Integer NbSplitPoints = …; 
1131 tool.SetNbSplitPoints(num); 
1132 if ( ! tool.Perform() && tool.Status (ShapeExtend_FAIL) ) { 
1133   cout<<"Splitting of closed faces failed"<<endl; 
1134   . . . 
1135
1136 TopoDS_Shape aResult = tool.Result(); 
1137 ~~~~~
1138
1139 @subsubsection occt_shg_4_3_5 Tool for splitting a C0 BSpline 2D or 3D curve to a sequence C1 BSpline curves
1140
1141 The API methods for this tool is a package of methods *ShapeUpgrade::C0BSplineToSequenceOfC1BsplineCurve*, which converts a C0 B-Spline curve into a sequence of C1 B-Spline curves. This method splits a B-Spline at the knots with multiplicities equal to degree, it does not use any tolerance and therefore does not change the geometry of the B-Spline. The method returns True if C0 B-Spline was successfully split, otherwise returns False (if BS is C1 B-Spline). 
1142
1143 @subsubsection occt_shg_4_3_6 Tool for splitting faces
1144
1145 *ShapeUpgrade_ShapeDivideArea* can work with compounds, solids, shells and faces. 
1146 During the work this tool examines each face of a specified shape and if the face area exceeds the specified maximal area, this face is divided. Face splitting is performed in the parametric space of this face. The values of splitting in U and V directions are calculated with the account of translation of the bounding box form parametric space to 3D space. 
1147
1148 Such calculations are necessary to avoid creation of strip faces. In the process of splitting the holes on the initial face are taken into account. After the splitting all new faces are checked by area again and the splitting procedure is repeated for the faces whose area still exceeds the max allowed area. Sharing between faces in the shape is preserved and the resulting shape is of the same type as the source shape. 
1149
1150 An example of using this tool is presented in the figures below: 
1151
1152 @image html /user_guides/shape_healing/images/shape_healing_image003.png "Source Face"
1153 @image latex /user_guides/shape_healing/images/shape_healing_image003.png "Source Face"
1154
1155 @image html /user_guides/shape_healing/images/shape_healing_image004.png "Resulting shape"
1156 @image latex /user_guides/shape_healing/images/shape_healing_image004.png "Resulting shape"
1157
1158
1159 *ShapeUpgrade_ShapeDivideArea* is inherited from the base class *ShapeUpgrade_ShapeDivide* and should be used in the following way: 
1160 *       This class should be initialized on a shape with the help of the constructor or  method *Init()* from the base class. 
1161 *       The maximal allowed area should be specified by the method *MaxArea()*.
1162 *       To produce a splitting use  method Perform from the base class. 
1163 *       The result shape can be obtained with the help the method *Result()*.
1164
1165 ~~~~~
1166 ShapeUpgrade_ShapeDivideArea tool (inputShape); 
1167 tool.MaxArea() = aMaxArea; 
1168 tool.Perform(); 
1169 if(tool.Status(ShapeExtend_DONE)) { 
1170   TopoDS_Shape ResultShape = tool.Result(); 
1171   ShapeFix::SameParameter ( ResultShape, Standard_False ); 
1172
1173 ~~~~~
1174
1175 **Note** that the use of method *ShapeFix::SameParameter* is necessary, otherwise the parameter edges obtained as a result of splitting can be different. 
1176
1177 #### Additional methods
1178
1179 * Class *ShapeUpgrade_FaceDivideArea* inherited from *ShapeUpgrade_FaceDivide* is intended for splitting a face by the maximal area criterion. 
1180 * Class *ShapeUpgrade_SplitSurfaceArea* inherited from *ShapeUpgrade_SplitSurface* calculates the parameters of face splitting in the parametric space. 
1181
1182
1183 @subsection occt_shg_4_4 Customization of shapes
1184
1185 Customization tools are intended for adaptation of shape geometry in compliance with the customer needs. They modify a geometrical object to another one in the shape. 
1186
1187 To implement the necessary shape modification it is enough to initialize the appropriate tool by the shape and desirable parameters and to get the resulting shape. For example for conversion of indirect surfaces in the shape do the following:
1188
1189 ~~~~~
1190 TopoDS_Shape initialShape .. 
1191 TopoDS_Shape resultShape = ShapeCustom::DirectFaces(initialShape); 
1192 ~~~~~
1193
1194 @subsubsection occt_shg_4_4_1 Conversion of indirect surfaces.
1195
1196 ~~~~~
1197 ShapeCustom::DirectFaces 
1198         static TopoDS_Shape DirectFaces(const TopoDS_Shape& S); 
1199 ~~~~~ 
1200
1201 This method provides conversion of indirect elementary surfaces (elementary surfaces with left-handed coordinate systems) in the shape into direct ones. New 2d curves (recomputed for converted surfaces) are added to the same edges being shared by both the resulting shape and the original shape *S*. 
1202
1203 @subsubsection occt_shg_4_4_2 Shape Scaling 
1204
1205 ~~~~~
1206 ShapeCustom::ScaleShape 
1207         TopoDS_Shape ShapeCustom::ScaleShape(const TopoDS_Shape& S,
1208                 const Standard_Real scale); 
1209 ~~~~~
1210
1211 This method returns a new shape, which is a scaled original shape with a coefficient equal to the specified value of scale. It uses the tool *ShapeCustom_TrsfModification*. 
1212
1213 @subsubsection occt_shg_4_4_3 Conversion of curves and surfaces to BSpline
1214
1215 *ShapeCustom_BSplineRestriction* allows approximation of surfaces, curves and 2D curves with a specified degree, maximum number of segments, 2d tolerance and 3d tolerance. If the approximation result cannot be achieved with the specified continuity, the latter can be reduced. 
1216
1217 The method with all parameters looks as follows:
1218 ~~~~~
1219 ShapeCustom::BsplineRestriction 
1220         TopoDS_Shape ShapeCustom::BSplineRestriction (const TopoDS_Shape& S, 
1221                 const Standard_Real Tol3d, const Standard_Real Tol2d, 
1222                 const Standard_Integer MaxDegree, 
1223                 const Standard_Integer MaxNbSegment, 
1224                 const GeomAbs_Shape Continuity3d, 
1225                 const GeomAbs_Shape Continuity2d, 
1226                 const Standard_Boolean Degree, 
1227                 const Standard_Boolean Rational, 
1228                 const Handle(ShapeCustom_RestrictionParameters)& aParameters) 
1229 ~~~~~
1230                 
1231 It returns a new shape with all surfaces, curves and 2D curves of BSpline/Bezier type or based on them, converted with a degree less than *MaxDegree* or with a number of spans less then *NbMaxSegment* depending on the priority parameter *Degree*. If this parameter is equal to True then *Degree* will be increased to the value *GmaxDegree*, otherwise *NbMaxSegments* will be increased to the value *GmaxSegments*. *GmaxDegree* and *GMaxSegments* are the maximum possible degree and the number of spans correspondingly. These values will be used in cases when an approximation with specified parameters is impossible and either *GmaxDegree* or *GMaxSegments* is selected depending on the priority. 
1232
1233 Note that if approximation is impossible with *GMaxDegree*, even then the number of spans can exceed the specified *GMaxSegment*. *Rational* specifies whether Rational BSpline/Bezier should be converted into polynomial B-Spline. 
1234
1235 Also note that the continuity of surfaces in the resulting shape can be less than the given value. 
1236
1237 #### Flags
1238
1239 To convert other types of curves and surfaces to BSpline with required parameters it is necessary to use flags from class ShapeCustom_RestrictionParameters, which is just a container of flags. 
1240 The following flags define whether a specified-type geometry has been converted to BSpline with the required parameters: 
1241 * *ConvertPlane,* 
1242 * *ConvertBezierSurf,* 
1243 * *ConvertRevolutionSurf,* 
1244 * *ConvertExtrusionSurf,* 
1245 * *ConvertOffsetSurf,* 
1246 * *ConvertCurve3d,* - for conversion of all types of 3D curves. 
1247 * *ConvertOffsetCurv3d,* - for conversion of offset 3D curves. 
1248 * *ConvertCurve2d,* - for conversion of all types of 2D curves. 
1249 * *ConvertOffsetCurv2d,* - for conversion of offset 2D curves. 
1250 * *SegmentSurfaceMode* - defines whether the surface would be approximated within the boundaries of the face lying on this surface. 
1251
1252
1253
1254 @subsubsection occt_shg_4_4_4 Conversion of elementary surfaces into surfaces of revolution 
1255
1256 ~~~~~
1257 ShapeCustom::ConvertToRevolution()
1258         TopoDS_Shape ShapeCustom::ConvertToRevolution(const TopoDS_Shape& S) ; 
1259 ~~~~~
1260
1261 This method returns a new shape with all elementary periodic surfaces converted to *Geom_SurfaceOfRevolution*. It uses the tool *ShapeCustom_ConvertToRevolution*. 
1262
1263 @subsubsection occt_shg_4_4_5 Conversion of elementary surfaces into Bspline surfaces
1264
1265 ~~~~~
1266 ShapeCustom::ConvertToBSpline() 
1267         TopoDS_Shape ShapeCustom::ConvertToBSpline( const TopoDS_Shape& S, 
1268                 const Standard_Boolean extrMode, 
1269                 const Standard_Boolean revolMode, 
1270                 const Standard_Boolean offsetMode); 
1271 ~~~~~           
1272
1273 This method returns a new shape with all surfaces of linear extrusion, revolution and offset surfaces converted according to flags to *Geom_BSplineSurface* (with the same parameterization). It uses the tool *ShapeCustom_ConvertToBSpline*. 
1274
1275 @subsubsection occt_shg_4_4_6 Getting the history of modification of sub-shapes.
1276 If, in addition to the resulting shape, you want to get the history of modification of sub-shapes you should not use the package methods described above and should use your own code instead: 
1277 1. Create a tool that is responsible for the necessary modification. 
1278 2. Create the tool *BRepTools_Modifier* that performs a specified modification in the shape. 
1279 3. To get the history and to keep the assembly structure use the method *ShapeCustom::ApplyModifier*. 
1280
1281
1282 The general calling syntax for scaling is
1283 ~~~~~ 
1284 TopoDS_Shape scaled_shape = ShapeCustom::ScaleShape(shape, scale); 
1285 ~~~~~
1286
1287 Note that scale is a real value. You can refine your mapping process by using additional calls to follow shape mapping subshape by subshape. The following code along with pertinent includes can be used: 
1288
1289 ~~~~~
1290 p_Trsf T; 
1291 Standard_Real scale = 100; // for example! 
1292 T.SetScale (gp_Pnt (0, 0, 0), scale); 
1293 Handle(ShapeCustom_TrsfModification) TM = new 
1294 ShapeCustom_TrsfModification(T); 
1295 TopTools_DataMapOfShapeShape context; 
1296 BRepTools_Modifier MD; 
1297 TopoDS_Shape res = ShapeCustom::ApplyModifier ( 
1298 Shape, TM, context,MD ); 
1299 ~~~~~
1300
1301 The map, called context in our example, contains the history. 
1302 Substitutions are made one by one and all shapes are transformed. 
1303 To determine what happens to a particular subshape, it is possible to use: 
1304
1305 ~~~~~
1306 TopoDS_Shape oneres = context.Find (oneshape); 
1307 //In case there is a doubt, you can also add: 
1308 if (context.IsBound(oneshape)) oneres = context.Find(oneshape); 
1309 //You can also sweep the entire data map by using: 
1310 TopTools_DataMapIteratorOfDataMapOfShapeShape 
1311 //To do this, enter: 
1312 for(TopTools_DataMapIteratorOfDataMapOfShapeShape 
1313 iter(context);iter(more ();iter.next ()) { 
1314   TopoDs_Shape oneshape = iter.key (); 
1315   TopoDs_Shape oneres = iter.value (); 
1316
1317 ~~~~~
1318
1319
1320 @subsubsection occt_shg_4_4_7 Remove internal wires
1321
1322 *ShapeUpgrade_RemoveInternalWires* tool removes internal wires with contour area less than the specified minimal area. It can work with compounds, solids, shells and faces.
1323
1324 If the flag *RemoveFaceMode* is set to TRUE, separate faces or a group of faces with outer wires, which consist only of edges that belong to the removed internal wires, are removed (seam edges are not taken into account). Such faces can be removed only for a sewed shape.
1325
1326 Internal wires can be removed   by the methods *Perform*.  Both methods *Perform* can not be carried out if the class has not been initialized by the shape. In such case the status of *Perform* is set to FAIL . 
1327
1328 The method *Perform* without arguments removes from all faces in the specified shape internal wires whose area is less than the minimal area.
1329
1330 The other method *Perform* has a sequence of shapes as an argument. This sequence can contain faces or wires. 
1331 If the sequence of shapes contains wires, only the internal wires are removed.
1332
1333 If the sequence of shapes contains faces, only the internal wires from these faces are removed. 
1334
1335 *       The status of the performed operation can be obtained using  method *Status()*;
1336 *       The resulting shape can be obtained using  method *GetResult()*.
1337
1338 An example of using this tool is presented in the figures below: 
1339
1340 @image html /user_guides/shape_healing/images/shape_healing_image005.png "Source Face"
1341 @image latex /user_guides/shape_healing/images/shape_healing_image005.png "Source Face"
1342 @image html /user_guides/shape_healing/images/shape_healing_image006.png "Resulting shape"
1343 @image latex /user_guides/shape_healing/images/shape_healing_image006.png "Resulting shape"
1344
1345 After the processing three internal wires with contour area less than the specified minimal area have been removed. One internal face has been removed. The outer wire of this face consists of the edges belonging to the removed internal wires and a seam edge. 
1346 Two other internal faces have not been removed because their outer wires consist not only of edges belonging to the removed wires.
1347
1348 @image html /user_guides/shape_healing/images/shape_healing_image007.png "Source Face"
1349 @image latex /user_guides/shape_healing/images/shape_healing_image007.png "Source Face"
1350
1351 @image html /user_guides/shape_healing/images/shape_healing_image008.png "Resulting shape"
1352 @image latex /user_guides/shape_healing/images/shape_healing_image008.png "Resulting shape"
1353
1354 After the processing six internal wires with contour area less than the specified minimal area have been removed. Six internal faces have been removed. These faces can be united into groups of faces. Each group of faces has an outer wire consisting only of edges belonging to the removed internal wires. Such groups of faces are also removed. 
1355
1356 The example of method application is also given below:
1357
1358 ~~~~~
1359 //Initialization of the class by shape. 
1360 Handle(ShapeUpgrade_RemoveInternalWires) aTool = new ShapeUpgrade_RemoveInternalWires(inputShape); 
1361 //setting parameters 
1362 aTool->MinArea() = aMinArea; 
1363 aTool->RemoveFaceMode() = aModeRemoveFaces; 
1364  
1365 //when method Perform is carried out on separate shapes. 
1366 aTool->Perform(aSeqShapes); 
1367  
1368 //when method Perform is carried out on whole shape. 
1369 aTool->Perform(); 
1370 //check status set after method Perform 
1371 if(aTool->Status(ShapeExtend_FAIL) { 
1372   cout<<"Operation failed"<< <<"\n"; 
1373    return; 
1374
1375
1376 if(aTool->Status(ShapeExtend_DONE1)) { 
1377     const TopTools_SequenceOfShape& aRemovedWires =aTool->RemovedWires(); 
1378      cout<<aRemovedWires.Length()<<" internal wires were removed"<<"\n"; 
1379     
1380   } 
1381
1382   if(aTool->Status(ShapeExtend_DONE2)) { 
1383     const TopTools_SequenceOfShape& aRemovedFaces =aTool->RemovedFaces(); 
1384      cout<<aRemovedFaces.Length()<<" small faces were removed"<<"\n"; 
1385     
1386   }   
1387     //getting result shape 
1388   TopoDS_Shape res = aTool->GetResult(); 
1389 ~~~~~
1390
1391 @subsubsection occt_shg_4_4_8 Conversion of surfaces 
1392
1393 Class ShapeCustom_Surface allows:
1394   * converting BSpline and Bezier surfaces to the analytical form (using method *ConvertToAnalytical())*
1395   * converting closed B-Spline surfaces to periodic ones.(using method *ConvertToPeriodic*)
1396   
1397 To convert surfaces to analytical form this class analyzes the form and the closure of the source surface and defines whether it can be approximated by analytical surface of one of the following types: 
1398 *       *Geom_Plane,*
1399 *       *Geom_SphericalSurface,*
1400 *       *Geom_CylindricalSurface,* 
1401 *       *Geom_ConicalSurface,* 
1402 *       *Geom_ToroidalSurface*.
1403  
1404 The conversion is done only if the new (analytical) surface does not deviate from the source one more than by the given precision. 
1405
1406 ~~~~~
1407 Handle(Geom_Surface) initSurf; 
1408 ShapeCustom_Surface ConvSurf(initSurf); 
1409 //conversion to analytical form 
1410 Handle(Geom_Surface) newSurf  = ConvSurf.ConvertToAnalytical(allowedtol,Standard_False); 
1411 //or conversion to a periodic surface 
1412 Handle(Geom_Surface) newSurf  = ConvSurf.ConvertToPeriodic(Standard_False); 
1413 //getting the maximum deviation of the new surface from the initial surface 
1414 Standard_Real maxdist = ConvSurf.Gap(); 
1415 ~~~~~
1416
1417 @section occt_shg_5_ Auxiliary tools for repairing, analysis and upgrading
1418
1419 @subsection occt_shg_5_1 Tool for rebuilding shapes
1420
1421   Class *ShapeBuild_ReShape* rebuilds a shape by making pre-defined substitutions on some of its components. During the first phase, it records requests to replace or remove some individual shapes. For each shape, the last given request is recorded. Requests may be applied as *Oriented* (i.e. only to an item with the same orientation) or not (the orientation of the replacing shape corresponds to that of the original one). Then these requests may be applied to any shape, which may contain one or more of these individual shapes. 
1422
1423 This tool has a flag for taking the location of shapes into account (for keeping the structure of assemblies) (*ModeConsiderLocation*). If this mode is equal to Standard_True, the shared shapes with locations will be kept. If this mode is equal to Standard_False, some different shapes will be produced from one shape with different locations after rebuilding. By default, this mode is equal to Standard_False. 
1424
1425 To use this tool for the reconstruction of shapes it is necessary to take the following steps:
1426 1. Create this tool and use method *Apply()* for its initialization by the initial shape. Parameter *until* sets the level of shape type and requests are taken into account up to this level only. Sub-shapes of the type standing beyond the *line* set by parameter until will not be rebuilt and no further exploration will be done 
1427 2. Replace or remove sub-shapes of the initial shape. Each sub-shape can be replaced by a shape of the same type or by shape containing shapes of that type only (for example, *TopoDS_Edge* can be replaced by *TopoDS_Edge, TopoDS_Wire* or *TopoDS_Compound* containing *TopoDS_Edges*). If an incompatible shape type is encountered, it is ignored and flag FAIL1 is set in Status. 
1428 For a sub-shape it is recommended to use method *Apply* before methods *Replace* and *Remove*, because the sub-shape has already been changed for the moment by its previous modifications or modification of its sub-shape (for example *TopoDS_Edge* can be changed by a modification of its *TopoDS_Vertex*, etc.). 
1429 3. Use method *Apply* for the initial shape again to get the resulting shape after all modifications have been made.
1430 4. Use method *Apply* to obtain the history of sub-shape modification.
1431
1432 **Note** that in fact class *ShapeBuild_ReShape* is an alias for class *BRepTools_ReShape*. They differ only in queries of statuses in the *ShapeBuild_ReShape* class. 
1433
1434 Let us use the tool to get the result shape after modification of sub-shapes of the initial shape:
1435
1436 ~~~~~ 
1437 TopoDS_Shape initialShape… 
1438 //creation of a rebuilding tool 
1439 Handle(ShapeBuild_ReShape) Context = new ShapeBuild_ReShape. 
1440
1441 //next step is optional. It can be used for keeping the assembly structure. 
1442 Context-> ModeConsiderLocation = Standard_True; 
1443
1444 //initialization of this tool by the initial shape 
1445 Context->Apply(initialShape); 
1446 … 
1447 //getting the intermediate result for replacing subshape1 with the modified subshape1. 
1448 TopoDS_Shape tempshape1 = Context->Apply(subshape1); 
1449
1450 //replacing the intermediate shape obtained from subshape1 with the newsubshape1. 
1451 Context->Replace(tempsubshape1,newsubshape1); 
1452 … 
1453 //for removing the subshape 
1454 TopoDS_Shape tempshape2 = Context->Apply(subshape2); 
1455 Context->Remove(tempsubshape2); 
1456
1457 //getting the result and the history of modification 
1458 TopoDS_Shape resultShape = Context->Apply(initialShape); 
1459
1460 //getting the resulting subshape from the subshape1 of the initial shape. 
1461 TopoDS_Shape result_subshape1 = Context->Apply(subshape1); 
1462 ~~~~~
1463
1464 @subsection occt_shg_5_2 Status definition
1465
1466 *ShapExtend_Status* is used to report the status after executing some methods that can either fail, do something, or do nothing. The status is a set of flags *DONEi* and *FAILi*. Any combination of them can be set at the same time. For exploring the status, enumeration is used. 
1467
1468 The values have the following meaning: 
1469
1470 | Value | Meaning |
1471 | :----- | :----------------- |
1472 | *OK,*     |  Nothing is done, everything OK |
1473 | *DONE1,*  |  Something was done, case 1 |
1474 | *DONE8*,  |  Something was done, case 8 |
1475 | *DONE*,   |  Something was done (any of DONE#) |
1476 | *FAIL1*,  |  The method failed, case 1 |
1477 | *FAIL8*,  |  The method failed, case 8 |
1478 | *FAIL*    |  The method failed (any of FAIL# occurred) |
1479
1480
1481 @subsection occt_shg_5_3 Tool representing a wire 
1482 Class *ShapeExtend_WireData* provides a data structure necessary to work with the wire as with an ordered list of edges, and that is required for many algorithms. The advantage of this class is that it allows to work with incorrect wires. 
1483
1484 The object of the class *ShapeExtend_WireData* can be initialized by *TopoDS_Wire* and converted back to *TopoDS_Wire*. 
1485
1486 An edge in the wire is defined by its rank number. Operations of accessing, adding and removing an edge at/to the given rank number are provided. Operations of circular permutation and reversing (both orientations of all edges and the order of edges) are provided on the whole wire as well. 
1487
1488 This class also provides a method to check if the edge in the wire is a seam (if the wire lies on a face). 
1489
1490 Let us remove edges from the wire and define whether it is seam edge 
1491
1492 ~~~~~
1493 TopoDS_Wire ini = .. 
1494 Handle(ShapeExtend_Wire) asewd = new ShapeExtend_Wire(initwire); 
1495 //Removing edge Edge1 from the wire. 
1496
1497 Standard_Integer index_edge1 = asewd->Index(Edge1); 
1498 asewd.Remove(index_edge1); 
1499 //Definition of whether Edge2 is a seam edge 
1500 Standard_Integer index_edge2 = asewd->Index(Edge2); 
1501 asewd->IsSeam(index_edge2); 
1502 ~~~~~
1503
1504
1505 @subsection occt_shg_5_4 Tool for exploring shapes 
1506 Class *ShapeExtend_Explorer* is intended to explore shapes and convert different representations (list, sequence, compound) of complex shapes. It provides tools for: 
1507   * obtaining the type of the shapes in the context of *TopoDS_Compound*, 
1508   * exploring shapes in the context of *TopoDS_Compound*, 
1509   * converting different representations of shapes (list, sequence, compound). 
1510   
1511 @subsection occt_shg_5_5 Tool for attaching messages to objects 
1512 Class *ShapeExtend_MsgRegistrator* attaches messages to objects (generic Transient or shape). The objects of this class are transmitted to the Shape Healing algorithms so that they could collect messages occurred during shape processing. Messages are added to the Maps (stored as a field) that can be used, for instance, by Data Exchange processors to attach those messages to initial file entities. 
1513
1514 Let us send and get a message attached to object:
1515
1516 ~~~~~ 
1517 Handle(ShapeExtend_MsgRegistrator) MessageReg = new ShapeExtend_MsgRegistrator; 
1518 //attaches messages to an object (shape or entity) 
1519 Message_Msg msg.. 
1520 TopoDS_Shape Shape1… 
1521 MessageReg->Send(Shape1,msg,Message_WARNING); 
1522 Handle(Standard_Transient) ent .. 
1523 MessageReg->Send(ent,msg,Message_WARNING); 
1524 //gets messages attached to shape 
1525 const ShapeExtend_DataMapOfShapeListOfMsg& msgmap = MessageReg->MapShape(); 
1526 if (msgmap.IsBound (Shape1)) { 
1527  const Message_ListOfMsg &msglist = msgmap.Find (Shape1); 
1528  for (Message_ListIteratorOfListOfMsg iter (msglist); 
1529 iter.More(); iter.Next()) { 
1530        Message_Msg msg = iter.Value(); 
1531  } 
1532     } 
1533 ~~~~~
1534
1535 @subsection occt_shg_5_6 Tools for performance measurement
1536
1537 Classes *MoniTool_Timer* and *MoniTool_TimerSentry* are used for measuring the performance of a current operation or any part of code, and provide the necessary API. Timers are used for debugging and performance optimizing purposes. 
1538
1539 Let us try to use timers in *XSDRAWIGES.cxx* and *IGESBRep_Reader.cxx* to analyse the performance of command *igesbrep*:
1540
1541 ~~~~~
1542 XSDRAWIGES.cxx
1543   ...
1544   #include <MoniTool_Timer.hxx>
1545   #include <MoniTool_TimerSentry.hxx>
1546   ...
1547   MoniTool_Timer::ClearTimers();
1548   ...
1549   MoniTool_TimerSentry MTS("IGES_LoadFile");
1550   Standard_Integer status = Reader.LoadFile(fnom.ToCString());
1551   MTS.Stop();
1552   ...
1553   MoniTool_Timer::DumpTimers(cout);
1554   return;
1555                                                                                 
1556                         
1557 IGESBRep_Reader.cxx
1558   ...
1559   #include <MoniTool_TimerSentry.hxx>
1560   ...
1561   Standard_Integer nb = theModel->NbEntities();
1562   ...
1563   for (Standard_Integer i=1; i<=nb; i++) {
1564     MoniTool_TimerSentry MTS("IGESToBRep_Transfer");
1565     ...
1566     try {
1567       TP.Transfer(ent);
1568       shape = TransferBRep::ShapeResult (theProc,ent);
1569     }
1570     ...
1571   }
1572 ~~~~~
1573
1574 The result of *DumpTimer()* after file translation is as follows: 
1575
1576 | TIMER | Elapsed | CPU User | CPU Sys | Hits |
1577 | :--- | :---- | :----- | :---- | :---- |
1578 | *IGES_LoadFile* | 1.0 sec |  0.9 sec | 0.0 sec | 1 |  
1579 | *IGESToBRep_Transfer* | 14.5 sec | 4.4 sec | 0.1 sec | 1311 |
1580
1581
1582 @section occt_shg_6 Shape Processing
1583
1584 @subsection occt_shg_6_1 Usage Workflow
1585
1586 The Shape Processing module allows defining and applying the general Shape Processing as a customizable sequence of Shape Healing operators. The customization is implemented via the user-editable resource file, which defines the sequence of operators to be executed and their parameters. 
1587
1588 The Shape Processing functionality is implemented with the help of the *XSAlgo* interface. The main function *XSAlgo_AlgoContainer::ProcessShape()* does shape processing with specified tolerances and returns the resulting shape and associated information in the form of *Transient*. 
1589
1590 This function is used in the following way:
1591
1592 ~~~~~
1593 TopoDS_Shape aShape = …; 
1594 Standard_Real Prec = …, 
1595 Standard_Real MaxTol = …; 
1596 TopoDS_Shape aResult; 
1597 Handle(Standard_Transient) info; 
1598 TopoDS_Shape aResult = XSAlgo::AlgoContainer()->ProcessShape(aShape, Prec, MaxTol., "Name of ResourceFile", "NameSequence", info ); 
1599 ~~~~~
1600
1601 Let us create a custom sequence of operations: 
1602
1603 1. Create a resource file with the name *ResourceFile*, which includes the following string: 
1604 ~~~~~
1605 NameSequence.exec.op:    MyOper 
1606 ~~~~~
1607 where *MyOper* is the name of operation. 
1608 2. Input a custom parameter for this operation in the resource file, for example: 
1609 ~~~~~
1610 NameSequence.MyOper.Tolerance: 0.01 
1611 ~~~~~
1612 where *Tolerance* is the name of the parameter and 0.01 is its value. 
1613 3. Add the following string into *void ShapeProcess_OperLibrary::Init()*: 
1614 ~~~~~
1615 ShapeProcess::RegisterOperator(;MyOper;, 
1616 new ShapeProcess_UOperator(myfunction)); 
1617 ~~~~~
1618 where *myfunction* is a function which implements the operation. 
1619 4. Create this function in *ShapeProcess_OperLibrary* as follows:
1620 ~~~~~
1621 static Standard_Boolean myfunction (const 
1622                         Handle(ShapeProcess_Context)& context) 
1623
1624         Handle(ShapeProcess_ShapeContext) ctx = Handle(ShapeProcess_ShapeContext)::DownCast(context); 
1625   if(ctx.IsNull()) return Standard_False; 
1626   TopoDS_Shape aShape = ctx->Result(); 
1627   //receive our parameter: 
1628   Standard_Real toler; 
1629   ctx->GetReal(;Tolerance;, toler);
1630 ~~~~~
1631 5. Make the necessary operations with *aShape* using the received value of parameter *Tolerance* from the resource file. 
1632 ~~~~~
1633   return Standard_True; 
1634
1635 ~~~~~
1636 6. Define some operations (with their parameters) *MyOper1, MyOper2, MyOper3*, etc. and describe the corresponding functions in *ShapeProcess_OperLibrary*. 
1637 7. Perform the required sequence using the specified name of operations and values of parameters in the resource file. 
1638
1639 For example: input of the following string:
1640 ~~~~~
1641 NameSequence.exec.op:    MyOper1,MyOper3 
1642 ~~~~~
1643 means that the corresponding functions from *ShapeProcess_OperLibrary* will be performed with the original shape *aShape* using parameters defined for *MyOper1* and *MyOper3* in the resource file. 
1644
1645 It is necessary to note that these operations will be performed step by step and the result obtained after performing the first operation will be used as the initial shape for the second operation. 
1646
1647 @subsection occt_shg_6_2 Operators
1648
1649 ### DirectFaces 
1650 This operator sets all faces based on indirect surfaces, defined with left-handed coordinate systems as direct faces. This concerns surfaces defined by Axis Placement (Cylinders, etc). Such Axis Placement may be indirect, which is allowed in Cascade, but not allowed in some other systems. This operator reverses indirect placements and recomputes PCurves accordingly. 
1651
1652 ### SameParameter
1653 This operator is required after calling some other operators, according to the computations they do. Its call is explicit, so each call can be removed according to the operators, which are either called or not afterwards. This mainly concerns splitting operators that can split edges. 
1654
1655 The operator applies the computation *SameParameter* which ensures that various representations of each edge (its 3d curve, the pcurve on each of the faces on which it lies) give the same 3D point for the same parameter, within a given tolerance.  
1656 * For each edge coded as *same parameter*, deviation of curve representation is computed and if the edge tolerance is less than that deviation, the tolerance is increased so that it satisfies the deviation. No geometry modification, only an increase of tolerance is possible.  
1657 * For each edge coded as *not same parameter* the deviation is computed as in the first case. Then an attempt is made to achieve the edge equality to *same parameter* by means of modification of 2d curves. If the deviation of this modified edge is less than the original deviation then this edge is returned, otherwise the original edge (with non-modified 2d curves) is returned with an increased (if necessary) tolerance.  Computation is done by call to the standard algorithm *BRepLib::SameParameter*. 
1658
1659 This operator can be called with the following parameters: 
1660         * *Boolean : Force* (optional) - if True, encodes all edges as *not same parameter* then runs the computation. Else, the computation is done only for those edges already coded as *not same parameter*. 
1661         * *Real : Tolerance3d* (optional) - if not defined, the local tolerance of each edge is taken for its own computation. Else, this parameter gives the global tolerance for the whole shape.
1662         
1663 ### BSplineRestriction
1664
1665 This operator is used for conversion of surfaces, curves 2d curves to BSpline surfaces with a specified degree and a specified number of spans. It performs approximations on surfaces, curves and 2d curves with a specified degree, maximum number of segments, 2d tolerance, 3d tolerance. The specified continuity can be reduced if the approximation with a specified continuity was not done successfully. 
1666
1667 This operator can be called with the following parameters: 
1668 * *Boolean : SurfaceMode* allows considering the surfaces; 
1669 * *Boolean : Curve3dMode*  allows considering the 3d curves; 
1670 * *Boolean : Curve2dMode* allows considering the 2d curves; 
1671 * *Real : Tolerance3d* defines 3d tolerance to be used in computation; 
1672 * *Real : Tolerance2d* defines 2d tolerance to be used when computing 2d curves; 
1673 * *GeomAbs_Shape (C0 G1 C1 G2 C2 CN) : Continuity3d* is the continuity required in 2d; 
1674 * *GeomAbs_Shape (C0 G1 C1 G2 C2 CN) : Continuity2d* is the continuity required in 3d; 
1675 * *Integer : RequiredDegree* gives the required degree;
1676 * *Integer : RequiredNbSegments* gives the required number of segments;
1677 * *Boolean : PreferDegree* if true, *RequiredDegree* has a priority, else *RequiredNbSegments* has a priority;
1678 * *Boolean : RationalToPolynomial*  serves for conversion of BSplines to polynomial form; 
1679 * *Integer : MaxDegree* gives the maximum allowed Degree, if *RequiredDegree* cannot be reached; 
1680 * *Integer : MaxNbSegments* gives the maximum allowed NbSegments, if *RequiredNbSegments* cannot be reached.
1681  
1682 The following flags allow managing the conversion of special types of curves or surfaces, in addition to BSpline. They are controlled by *SurfaceMode, Curve3dMode* or *Curve2dMode* respectively; by default, only BSplines and Bezier Geometries are considered:
1683 * *Boolean : OffsetSurfaceMode*  
1684 * *Boolean : LinearExtrusionMode*  
1685 * *Boolean : RevolutionMode*  
1686 * *Boolean : OffsetCurve3dMode* 
1687 * *Boolean : OffsetCurve2dMode* 
1688 * *Boolean : PlaneMode* 
1689 * *Boolean : BezierMode* 
1690 * *Boolean : ConvCurve3dMode* 
1691 * *Boolean : ConvCurve2dMode* 
1692
1693 For each of the Mode parameters listed above, if it is True, the specified geometry is converted to BSpline, otherwise only its basic geometry is checked and converted (if necessary) keeping the original type of geometry (revolution, offset, etc). 
1694
1695 * *Boolean :SegmentSurfaceMode* has effect only for Bsplines and Bezier surfaces. When False a surface will be replaced by a Trimmed Surface, else new geometry will be created by splitting the original Bspline or Bezier surface. 
1696
1697 ### ElementaryToRevolution
1698
1699 This operator converts elementary periodic surfaces to SurfaceOfRevolution. 
1700
1701 ### SplitAngle
1702
1703 This operator splits surfaces of revolution, cylindrical, toroidal, conical, spherical surfaces in the given shape so that each resulting segment covers not more than the defined number of degrees. 
1704
1705 It can be called with the following parameters: 
1706 * *Real : Angle* - the maximum allowed angle for resulting faces; 
1707 *  *Real : MaxTolerance* - the maximum tolerance used in computations.
1708  
1709 ### SurfaceToBSpline
1710 This operator converts some specific types of Surfaces, to BSpline (according to parameters). 
1711 It can be called with the following parameters: 
1712 * *Boolean : LinearExtrusionMode* allows converting surfaces of Linear Extrusion; 
1713 * *Boolean : RevolutionMode* allows converting surfaces of Revolution; 
1714 * *Boolean : OffsetMode* allows converting Offset Surfaces 
1715
1716 ### ToBezier
1717
1718 This operator is used for data supported as Bezier only  and converts various types of geometries to Bezier. It can be called with the following parameters used in computation of conversion :  
1719 * *Boolean : SurfaceMode*  
1720 * *Boolean : Curve3dMode*  
1721 * *Boolean : Curve2dMode*  
1722 * *Real : MaxTolerance* 
1723 * *Boolean : SegmentSurfaceMode* (default is True) has effect only for Bsplines and Bezier surfaces. When False a surface will be replaced by a Trimmed Surface, else new geometry will be created by splitting the original Bspline or Bezier surface. 
1724
1725 The following parameters are controlled by *SurfaceMode, Curve3dMode* or *Curve2dMode* (according to the case): 
1726 * *Boolean : Line3dMode*  
1727 * *Boolean : Circle3dMode*  
1728 * *Boolean : Conic3dMode*  
1729 * *Boolean : PlaneMode*  
1730 * *Boolean : RevolutionMode*  
1731 * *Boolean : ExtrusionMode*  
1732 * *Boolean : BSplineMode* 
1733
1734 ### SplitContinuity
1735 This operator splits a shape in order to have each geometry (surface, curve 3d, curve 2d) correspond the given criterion of continuity. It can be called with the following parameters: 
1736 * *Real : Tolerance3d*  
1737 * *Integer (GeomAbs_Shape ) : CurveContinuity*  
1738 * *Integer (GeomAbs_Shape ) : SurfaceContinuity*  
1739 * *Real : MaxTolerance* 
1740
1741 Because of algorithmic limitations in the operator *BSplineRestriction* (in some particular cases, this operator can produce unexpected C0 geometry), if *SplitContinuity* is called, it is recommended to call it after *BSplineRestriction*. 
1742 Continuity Values will be set as *GeomAbs_Shape* (i.e. C0 G1 C1 G2 C2 CN) besides direct integer values (resp. 0 1 2 3 4 5). 
1743
1744 ### SplitClosedFaces
1745 This operator splits faces, which are closed even if they are not revolutionary or cylindrical, conical, spherical, toroidal. This corresponds to BSpline or Bezier surfaces which can be closed (whether periodic or not), hence they have a seam edge.  As a result, no more seam edges remain. The number of points allows to control the minimum count of faces to be produced per input closed face. 
1746
1747 This operator can be called with the following parameters: 
1748 * *Integer : NbSplitPoints* gives the number of points to use for splitting (the number of intervals produced is *NbSplitPoints+1*); 
1749 * *Real : CloseTolerance* tolerance used to determine if a face is closed;  
1750 * *Real : MaxTolerance* is used in the computation of splitting.
1751  
1752 ### FixGaps
1753
1754 This operator must be called when *FixFaceSize* and/or *DropSmallEdges* are called. Using Surface Healing may require an additional call to *BSplineRestriction* to ensure that modified geometries meet the requirements for BSpline. 
1755 This operators repairs geometries which contain gaps between edges in wires (always performed) or gaps on faces, controlled by parameter *SurfaceMode*, Gaps on Faces are fixed by using algorithms of Surface Healing 
1756 This operator can be called with the following parameters: 
1757 * *Real : Tolerance3d* sets the tolerance to reach in 3d. If a gap is less than this value, it is not fixed. 
1758 * *Boolean : SurfaceMode* sets the mode of fixing gaps between edges and faces (yes/no) ;
1759 * *Integer : SurfaceAddSpans* sets the number of spans to add to the surface in order to fix gaps ;
1760 * *GeomAbs_Shape (C0 G1 C1 G2 C2 CN) : SurfaceContinuity* sets the minimal continuity of a resulting surface ;
1761 * *Integer : NbIterations* sets the number of iterations 
1762 * *Real : Beta* sets the elasticity coefficient for modifying a surface [1-1000] ;
1763 * *Reals : Coeff1 to Coeff6* sets energy coefficients for modifying a surface [0-10000] ;
1764 * *Real : MaxDeflection*  sets maximal deflection of surface from an old position. 
1765
1766 This operator may change the original geometry. In addition, it is CPU consuming, and it may fail in some cases.  Also **FixGaps** can help only when there are gaps obtained as a result of removal of small edges that can be removed by **DropSmallEdges** or **FixFaceSize**. 
1767
1768 ### FixFaceSize
1769 This operator  removes faces, which are small in all directions (spot face) or small in one direction (strip face). It can be called with the parameter *Real : Tolerance*, which sets the minimal dimension, which is used to consider a face, is small enough to be removed. 
1770
1771 ### DropSmallEdges
1772 This operator drops edges in a wire, and merges them with adjacent edges, when they are smaller than the given value (*Tolerance3d*) and when the topology allows such merging (i.e. same adjacent faces for each of the merged edges). Free (non-shared by adjacent faces) small edges can be also removed in case if they share the same vertex Parameters. 
1773
1774 It can be called with the parameter *Real : Tolerance3d*, which sets the dimension used to determine if an edge is small. 
1775
1776 ### FixShape
1777
1778 This operator may be added for fixing invalid shapes. It performs various checks and fixes, according to the modes listed hereafter. Management of a set of fixes can be performed by flags as follows: 
1779 * if the flag for a fixing tool is set to 0 , it is not performed;
1780 * if set to 1 , it is performed in any case;
1781 * if not set, or set to -1 , for each shape to be applied on, a check is done to evaluate whether a fix is needed. The fix is performed if the check is positive.
1782  
1783 By default, the flags are not set, the checks are carried out each individual shape. 
1784
1785 This operator can be called with the following parameters: 
1786 * *Real : Tolerance3d* sets basic tolerance used for fixing; 
1787 * *Real : MaxTolerance3d* sets maximum allowed value for the resulting tolerance; 
1788 * *Real : MinTolerance3d* sets minimum allowed value for the resulting tolerance. 
1789 * *Boolean : FixFreeShellMode*
1790 * *Boolean : FixFreeFaceMode*  
1791 * *Boolean : FixFreeWireMode*  
1792 * *Boolean : FixSameParameterMode*
1793 * *Boolean : FixSolidMode*
1794 * *Boolean : FixShellMode*
1795 * *Boolean : FixFaceMode*
1796 * *Boolean : FixWireMode*
1797 * *Boolean : FixOrientationMode*
1798 * *Boolean : FixMissingSeamMode*
1799 * *Boolean : FixSmallAreaWireMode* 
1800 * *Boolean (not checked) : ModifyTopologyMode* specifies the mode for modifying topology. Should be False (default) for shapes with shells and can be True for free faces. 
1801 * *Boolean (not checked) : ModifyGeometryMode* specifies the mode for modifying geometry. Should be False if geometry is to be kept and True if it can be modified. 
1802 * *Boolean (not checked) : ClosedWireMode*  specifies the mode for wires. Should be True for wires on faces and False for free wires. 
1803 * *Boolean (not checked) : PreferencePCurveMode (not used)* specifies the preference of 3d or 2d representations for an edge 
1804 * *Boolean : FixReorderMode*  
1805 * *Boolean : FixSmallMode*  
1806 * *Boolean : FixConnectedMode*  
1807 * *Boolean : FixEdgeCurvesMode*  
1808 * *Boolean : FixDegeneratedMode*  
1809 * *Boolean : FixLackingMode*  
1810 * *Boolean : FixSelfIntersectionMode*  
1811 * *Boolean : FixGaps3dMode*  
1812 * *Boolean : FixGaps2dMode*  
1813 * *Boolean : FixReversed2dMode*  
1814 * *Boolean : FixRemovePCurveMode*  
1815 * *Boolean : FixRemoveCurve3dMode*  
1816 * *Boolean : FixAddPCurveMode*  
1817 * *Boolean : FixAddCurve3dMode*  
1818 * *Boolean : FixSeamMode* 
1819 * *Boolean : FixShiftedMode* 
1820 * *Boolean : FixEdgeSameParameterMode*
1821 * *Boolean : FixSelfIntersectingEdgeMode* 
1822 * *Boolean : FixIntersectingEdgesMode*  
1823 * *Boolean : FixNonAdjacentIntersectingEdgesMode* 
1824
1825 ### SplitClosedEdges
1826 This operator handles closed edges i.e. edges with one vertex. Such edges are not supported in some receiving systems. This operator  splits topologically closed edges (i.e. edges having one vertex) into two edges. Degenerated edges and edges with a size of less than Tolerance are not processed. 
1827
1828 @section occt_shg_7 Messaging mechanism
1829
1830 Various messages about modification, warnings and fails can be generated in the process of shape fixing or upgrade. The messaging mechanism allows generating messages, which will be sent to the chosen target medium  a file or the screen. The messages may report failures and/or warnings or provide information on events such as analysis, fixing or upgrade of shapes. 
1831
1832 @subsection occt_shg_7_1  Message Gravity
1833 Enumeration *Message_Gravity* is used for defining message gravity. 
1834 It provides the following message statuses: 
1835 * *Message_FAIL* - the message reports a fail;
1836 * *Message_WARNING*  - the message reports a warning;
1837 * *Message_INFO* - the message supplies information. 
1838
1839 @subsection occt_shg_7_2 Tool for loading a message file into memory
1840 Class *Message_MsgFile* allows defining messages by loading a custom message file into memory. It is necessary to create a custom message file before loading it into memory, as its path will be used as the argument to load it. Each message in the message file is identified by a key. The user can get the text content of the message by specifying the message key. 
1841
1842 ### Format of the message file
1843
1844 The message file is an ASCII file, which defines a set of messages. Each line of the file must have a length of less than 255 characters.  
1845 All lines in the file starting with the exclamation sign (perhaps preceded by spaces and/or tabs) are considered as comments and are ignored. 
1846 A message file may contain several messages. Each message is identified by its key (string). 
1847 Each line in the file starting with the *dot* character (perhaps preceded by spaces and/or tabs) defines the key. The key is a string starting with a symbol placed after the dot and ending with the symbol preceding the ending of the newline character <i>\\n.</i> 
1848 All lines in the file after the key and before the next keyword (and which are not comments) define the message for that key. If the message consists of several lines, the message string will contain newline symbols <i>\\n</i> between each line (but not at the end). 
1849
1850 The following example illustrates the structure of a message file: 
1851
1852 ~~~~~
1853 !This is a sample message file 
1854 !------------------------------ 
1855 !Messages for ShapeAnalysis package 
1856
1857 .SampleKeyword 
1858 Your message string goes here 
1859
1860 !... 
1861
1862 !End of the message file 
1863 ~~~~~
1864
1865 ### Loading the message file
1866
1867 A custom file can be loaded into memory using the method *Message_MsgFile::LoadFile*, taking as an argument the path to your file as in the example below: 
1868 ~~~~~
1869 Standard_CString MsgFilePath = ;(path)/sample.file;; 
1870 Message_MsgFile::LoadFile (MsgFilePath); 
1871 ~~~~~
1872
1873 @subsection occt_shg_7_3 Tool for managing filling messages 
1874
1875 The class *Message_Msg* allows using the message file loaded as a template. This class provides a tool for preparing the message, filling it with parameters, storing and outputting to the default trace file. 
1876 A message is created from a key: this key identifies the message to be created in the message file. The text of the message is taken from the loaded message file (class *Message_MsgFile* is used). 
1877 The text of the message can contain places for parameters, which are to be filled by the proper values when the message is prepared. These parameters can be of the following types: 
1878 * string - coded in the text as \%s, 
1879 * integer - coded in the text as \%d, 
1880 * real - coded in the text as \%f. 
1881 The parameter fields are filled by the message text by calling the corresponding methods *AddInteger, AddReal* and *AddString*. Both the original text of the message and the input text with substituted parameters are stored in the object. The prepared and filled message can be output to the default trace file. The text of the message (either original or filled) can be also obtained. 
1882 ~~~~~
1883 Message_Msg msg01 (;SampleKeyword;); 
1884 //Creates the message msg01, identified in the file by the keyword SampleKeyword 
1885 msg1.AddInteger (73); 
1886 msg1.AddString (;SampleFile;); 
1887 //fills out the code areas 
1888 ~~~~~
1889
1890 @subsection occt_shg_7_4 Tool for managing trace files
1891
1892 Class *Message_TraceFile* is intended to manage the trace file (or stream) for outputting messages and the current trace level. Trace level is an integer number, which is used when messages are sent. Generally, 0 means minimum, \> 0 various levels. If the current trace level is lower than the level of the message it is not output to the trace file. The trace level is to be managed and used by the users. 
1893 There are two ways of using trace files: 
1894 * define an object of *Message_TraceFile*, with its own definition (file name or cout, trace level), and use it where it is defined, 
1895 * use the default trace file (file name or cout, trace level), usable from anywhere. 
1896 Use the constructor method to define the target file and the level of the messages as in the example below: 
1897 ~~~~~
1898 Message_TraceFile myTF 
1899         (tracelevel, "tracefile.log", Standard_False); 
1900 ~~~~~
1901 The parameters are as follows:  
1902 * *tracelevel* is a Standard_Integer and modifies the level of messages. It has the following values and semantics: 
1903         + 0: gives general information such as the start and end of process;
1904         + 1: gives exceptions raised and fail messages;
1905         + 2: gives the same information as 1 plus warning messages.
1906 * *filename* is the string containing the path to the log file. 
1907 The Boolean set to False will rewrite the existing file. When set to True, new messages will be appended to the existing file. 
1908
1909 A new default log file can be added using  method *SetDefault* with the same arguments as in the constructor. 
1910 The default trace level can be changed by using method *SetDefLevel*. In this way, the information received in the log file is modified. 
1911 It is possible to close the log file and set the default trace output to the screen display instead of the log file using the method *SetDefault* without any arguments. 
1912