doc/salome/gui/GEOM/input/extract_and_rebuild.doc

   1 /*!
   2
   3 \page extract_and_rebuild_page Extract and Rebuild
   4
   5
   6 This operation allows extraction of sub-shapes from a given
   7 shape.
   8
   9 To use this operation, select in the Main Menu <b>Operations -> Extract and Rebuild</b>.
  10 The following dialog box appears:
  11
  12 \image html extract_rebuild.png "Extract and Rebuild Dialog"
  13
  14 In this dialog:
  15 <ul>
  16 <li> \b Name is a result object name.</li>
  17 <li> <b>Main Object</b> is the main object selected for the operation. It is
  18 possible to select the object in the Object Browser or in the viewer using
  19 "selection" button.</li>
  20 <li> <b>Sub-shape type</b> is the type filter for sub-shapes to be chosen
  21 for the extraction.</li>
  22 <li> <b>Filtered shapes</b> is the list of filtered sub-shape IDs available
  23 for the extraction.</li>
  24 <li> <b>Shapes to extract</b> is the list of sub-shape IDs to be extracted
  25 grouped by shape types.</li>
  26 <li> \b >> is the button to copy object IDs from <b>Filtered shapes</b> to
  27 <b>Shapes to extract</b>.</li>
  28 <li> \b << is the button to copy object IDs from <b>Shapes to extract</b> to
  29 <b>Filtered shapes</b>.</li>
  30 <li> <b>Show Only Selected</b> is the button to show objects selected in the
  31 <b>Filtered shapes</b> list and hide all other objects.</li>
  32 <li> <b>Hide Selected</b> is the button to hide objects selected in the
  33 <b>Filtered shapes</b> list.</li>
  34 <li> <b>Show all sub-shapes</b> is the button to show all objects from the
  35 <b>Filtered shapes</b> list.</li>
  36 <li> \b Rebuild is the button to perform extraction and show the operation
  37 statistics.</li>
  38 <li> The block of \b Statistics shows how many shapes of a certain type
  39 are \b Removed, \b Modified and \b Added.</li>
  40 <li> \b Apply is the button to create the result.</li>
  41 <li> <b>Apply and Close</b> is the button to create the result and close
  42 the dialog.</li>
  43 <li> \b Close is the button to close this dialog.</li>
  44 <li> \b Help is the button to show this help page.</li>
  45 </ul>
  46
  47 <b>TUI Command:</b> <em>geompy.MakeExtraction(theShape, theListOfID),</em>
  48 <br> where \em theShape is the main shape, \em theListOfID is a list of
  49 sub-shape IDs to be extracted.
  50
  51 Our <b>TUI Scripts</b> provide you with useful example of the use of
  52 \ref swig_MakeExtraction "Extract and Rebuild" functionality.
  53
  54 <b>More details</b>
  55
  56 If a sub-shape is extracted, all its ancestors should be modified. An ancestors
  57 of extracted sub-shapes can be either:
  58 - created anew without extracted sub-shapes, or
  59 - extracted if it is not possible to create a valid shape without extracted
  60 sub-shape.
  61
  62 E.g. it is necessary to extract the vertex from the box:
  63
  64 \image html extract_init.png "Extraction of the vertex from the box"
  65
  66 In this case 3 ancestor edges are removed as they can't be valid without
  67 this vertex. 3 faces that contain these edges are also removed. It is because
  68 the wires without edges are not closed and it is not possible to create
  69 a valid face on not closed wire. These wires should contain two remaining
  70 edges, but they are removed as they are the part of the remaining shell.
  71 So these wires become empty that means that they should be removed as well.
  72
  73 The shell is replaced by another one that contains 3 not modified faces. As
  74 It is not possible to construct a valid solid from not closed shell the solid
  75 is removed. So the result of the extraction is a shell that contains 3 faces:
  76
  77 \image html extract_result.png "Result shape"
  78
  79 Please, refer to <a href="ExtractAndRebuild.pdf">this document</a> for a detailed
  80 description of Extract and Rebuild operation.
  81
  82 */