doc/salome/gui/GEOM/input/creating_explode.doc

   1 /*!
   2
   3 \page create_explode_page Explode
   4
   5 \n To \b Explode an object into subshapes, in the <b>Main Menu</b>
   6 select <b>New Entity > Explode</b>.
   7
   8 \n To create a list of  subshapes (vertices, edges, wires etc.) of the
   9 given shape using the \b Explode operation, you need to define the <b>Main
  10 Object</b>, which will be exploded and the <b>Type of Subshapes</b> you wish to
  11 obtain from it.
  12 \n The \b Result of the operation will be a List of \b GEOM_Objects
  13 (vertexes, edges, wires, faces, shells or solids).
  14
  15 \n Using <b>TUI Commands</b> you can perform this operation in a
  16 variety of ways:
  17 <ul>
  18 <li><em>geompy.SubShapeAll(Shape, Type)</em> explodes a Shape on
  19 subshapes of a given Type and returns a List of sub-shapes.</li>
  20 <li><em>geompy.SubShapeAllIDs(Shape, Type)</em> explodes a Shape on
  21 subshapes of a given Type and returns a List of IDs of
  22 sub-shapes.</li>
  23 <li><em>geompy.SubShapeAllSorted(Shape, Type)</em> xplodes a shape on
  24 subshapes of a given type and sorts them by coordinates of their
  25 gravity centers, returning      a list of sub-shapes.</li>
  26 <li><em>geompy.SubShapeAllSortedIDs(Shape, Type)</em> explodes a shape
  27 on subshapes of a given type and sorts them by coordinates of their
  28 gravity centers,  returning a List of IDs of sub-shapes.</li>
  29 <li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
  30 a compound of sub-shapes of  the Shape,  selected by they indices in a
  31 list of all sub-shapes of the given Type. Each index is in the range
  32 [1, Nb_Sub-Shapes_Of_Given_Type].</li>
  33 <li><em>geompy.SubShapeSorted(Shape, Type, ListOfInd)</em> allows to
  34 obtain a compound of sub-shapes of the Shape, selected by they indices
  35 in sorted list of all sub-shapes of the given Type. Each index is in
  36 the range [1, Nb_Sub-Shapes_Of_Given_Type]</li>
  37 </ul>
  38
  39 \n <b>Arguments: </b>1 SHAPE + 1 type of SubShape.
  40
  41 \image html neo-obj1.png
  42
  43 <b>Example:</b>
  44
  45 \image html explode.png "A box, exploded into faces"
  46
  47 */