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 sub-shapes, in the <b>Main Menu</b>
   6 select <b>New Entity > Explode</b>.
   7
   8 \n To create a list of  sub-shapes (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 Sub-shapes</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.ExtractShapes(Shape, Type, isSorted)</em> explodes a
  19 Shape into sub-shapes of a given Type and returns a List of sub-shapes.
  20 This method does not return the Shape itself if it matches the
  21 Type.</li>
  22 <li><em>geompy.SubShapeAll(Shape, Type)</em> explodes a Shape on
  23 sub-shapes of a given Type and returns a List of sub-shapes.</li>
  24 <li><em>geompy.SubShapeAllIDs(Shape, Type)</em> explodes a Shape on
  25 sub-shapes of a given Type and returns a List of IDs of
  26 sub-shapes.</li>
  27 <li><em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a
  28 shape on sub-shapes of a given type and sorts them taking into account
  29 their gravity centers, to provide a stable order of sub-shapes.
  30 It returns a list of sub-shapes.</li>
  31 <li><em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes
  32 a shape on sub-shapes of a given type and sorts them taking into
  33 account their gravity centers, to provide a stable order of sub-shapes.
  34 It returns a List of IDs of sub-shapes.</li>
  35 <li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
  36 a compound of sub-shapes of  the Shape,  selected by they indices in a
  37 list of all sub-shapes of the given Type. Each index is in the range
  38 [1, Nb_Sub-Shapes_Of_Given_Type].</li>
  39 <li><em>geompy.SubShapeSortedCentres(Shape, Type, ListOfInd)</em>
  40 allows to obtain a compound of sub-shapes of the Shape, selected by
  41 they indices in sorted list of all sub-shapes of the given Type. Each
  42 index is in the range [1, Nb_Sub-Shapes_Of_Given_Type]</li>
  43 </ul>
  44
  45 \n <b>Arguments: </b>1 SHAPE + 1 type of SubShape.
  46
  47 \image html neo-obj1.png
  48
  49 <b>Example:</b>
  50
  51 \image html explode.png "A box, exploded into faces"
  52
  53 */