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