Implementation of the "0020839: EDF 1370 DOC : Update of the TUI features documentati...

[modules/geom.git] / doc / salome / gui / GEOM / input / shape_processing_operation.doc

diff --git a/doc/salome/gui/GEOM/input/shape_processing_operation.doc b/doc/salome/gui/GEOM/input/shape_processing_operation.doc
index b10f35c6e198fdd1b48becaedc742735227d8596..aa97ec32f8489ef571a0b182fa4c19eb71b29bcd 100644 (file)
--- a/doc/salome/gui/GEOM/input/shape_processing_operation.doc
+++ b/doc/salome/gui/GEOM/input/shape_processing_operation.doc
@@ -3,10 +3,10 @@
 \page shape_processing_operation_page Shape Processing
 
 \n To produce a <b>Shape Processing</b> operation in the <b>Main Menu</b> 
 \page shape_processing_operation_page Shape Processing
 
 \n To produce a <b>Shape Processing</b> operation in the <b>Main Menu</b> 

-select <b>Repair - > Shape Processing</b>.
+   select <b>Repair - > Shape Processing</b>.

 \n This operation processes one or more shapes using various operators.
 
 \n This operation processes one or more shapes using various operators.
 

-\n The \b Result will be a \b GEOM_Object.
+\n The \b Result will be a \b GEOM.GEOM_Object.

 
 \n <b>TUI Command:</b> <em>geompy.ProcessShape(Shape, Operators,
 Parameters, Values),</em> where \em Shape is a processed shape, \em Operators
 
 \n <b>TUI Command:</b> <em>geompy.ProcessShape(Shape, Operators,
 Parameters, Values),</em> where \em Shape is a processed shape, \em Operators


@@ -15,6 +15,19 @@ is a list of operators ("FixShape", "SplitClosedFaces", etc.),
 etc), \em Values is a list of values of parameters placed in the same
 order as in the list of Parameters.
 
 etc), \em Values is a list of values of parameters placed in the same
 order as in the list of Parameters.
 

+\note <b>Shape Processing</b> is useful not only on invalid shapes,
+      but also on the shapes, that are classified as valid by
+      the <b>Check</b> functionality. Use it, if an operation (for
+      example, <b>Partition</b>) fails.
+      Example of usage:
+      <ol>
+      <li>Try to partition objects obj1 and obj2.</li>
+      <li>Partition fails.</li>
+      <li>Perform Shape Processing on objects obj1 and obj2.</li>
+      <li>Try to partition them again.</li>
+      </ol>
+      See also \ref tui_limit_tolerance "TUI example".
+

 \n In this dialog box you can select the object that you need to
 process, define its name and operators applied to it during
 processing.
 \n In this dialog box you can select the object that you need to
 process, define its name and operators applied to it during
 processing.