22763: [EDF] Shape processing

[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 ca438ada1da7b18beb792dbfbf165f3e1e7e0c80..c92d48b8cedbcc05d6f9a6aac3ad27ae847cd597 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> 
-select <b>Repair - > Shape Processing</b>.
+   select <b>Repair - > Shape Processing</b>.
 \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
@@ -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.
 
+\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.
@@ -38,11 +51,27 @@ spots and strips.</li>
 possible face size.</li>
 </ul>
 <li><b>Drop Small Edges</b> (DropSmallEdges) - removes edges, which
-merge with neighbouring edges.</li>
+merge with neighboring edges.</li>
 <ul>
 <li><b>3D Tolerance</b> (DropSmallEdges.Tolerance3d) - defines minimum
 possible distance between two parallel edges.</li>
 </ul>
+<li><b>Drop Small Solids</b> (DropSmallSolids) - either removes small
+  solids or merges them with neighboring ones.</li>
+<ul>
+<li><b>Width factor tol.</b> (DropSmallSolids.WidthFactorThreshold) -
+  defines maximum value of <em>2V/S</em> of a solid which is
+  considered small, where \a V is volume and \a S is surface area of
+  the solid.</li>
+<li><b>Volume tol.</b> (DropSmallSolids.VolumeThreshold) - defines
+  maximum volume of a solid which is considered small.</li>
+<li><b>To merge solids</b> (DropSmallSolids.MergeSolids) - if
+  activated, small solids are removed, else small solids are merged to
+  adjacent non-small solids or left untouched if cannot be merged.
+</li>
+</ul>
+If the both tolerances are activated a solid is considered small if
+it meets the both criteria.
 <li><b>Split Angle</b> (SplitAngle) - splits faces based on conical
 surfaces, surfaces of revolution and cylindrical surfaces in segments
 using a certain angle.</li>
@@ -140,15 +169,15 @@ curves not having the same parameter.</li>
 
 \n <b>Example:</b>
 
-\image html image154.jpg
+\image html image154.png
 <center><em>Shape before applying Shape Processing (FixShape
 operator). View # 1.</em></center>
 
-\image html image156.jpg
+\image html image156.png
 <center><em>Shape before applying Shape Processing (FixShape
 operator). View # 2.</em></center>
 
-\image html image160.jpg
+\image html image160.png
 <center><em>The same shape after applying Shape
 Processing.</em></center>