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

   1 /*!
   2
   3 \page create_explode_page Explode
   4
   5 To \b Explode an object into sub-shapes, in the <b>Main Menu</b>
   6 select <b>New Entity > Explode</b>. This operation opens the
   7 <b>Sub Shapes Selection</b> dialog box.
   8
   9 \image html neo-obj1.png
  10
  11 To create a list of  sub-shapes (vertices, edges, wires etc.) of the
  12 given shape using the \b Explode operation, you need to define the <b>Main
  13 Object</b>, which will be exploded and the <b>Type of Sub-shapes</b> you wish to
  14 obtain from it.
  15
  16 The \b Result of the operation will be a List of \b GEOM_Objects
  17 (vertexes, edges, wires, faces, shells or solids).
  18
  19 Available choices in the <b>Sub Shapes Type</b> combo box depend on the type
  20 of selected <b>Main Object</b>:
  21 - \b Compound: to extract compounds;
  22 - \b Compsolid: to extract compsolids;
  23 - \b Solid: to extract solids;
  24 - \b Shell: to extract shells;
  25 - \b Face: to extract faces;
  26 - \b Wire: to extract wires;
  27 - \b Edge: to extract edges;
  28 - \b Vertex: to extract vertices;
  29 - \b Shape: to extract top-level contents of the compound shape;
  30 - \b Flat: to extract "flat" contents of the compound shape.
  31
  32 Note: "flat" contents means top-level simple-type sub-shapes extracted from
  33 the compound object recursively (i.e. there is no compounds in the result).
  34 For example, if a compound C1 contains a solid S1 and another compound C2 that
  35 contains solids S2 and S3 (see picture below):
  36 - Explode operation with \b Shape type given as parameter will return S1 and C2;
  37 - Explode operation with \b Flat type given as parameter will return S1, S2 and S3.
  38
  39 \image html flat_contents.png
  40
  41 Switching on <b>Select Sub-shapes</b> check box allows manual selection of sub-shapes
  42 to be extracted from the main object. In this mode the user can select sub-shapes
  43 directly in 3D viewer.
  44
  45 When <b>Select Sub-shapes</b> check box is switched on, additional \b Filter controls
  46 allow to automatically pick up entites which satisfy specified threshold value(s).
  47 The numerical functor for each sub-shape that is compared with threshold value(s)
  48 is computed according to the shape's topological properties:
  49 - length for edges and wires
  50 - area for faces and shells
  51 - volume for solids, compounds, compsolids
  52
  53 Filtering capabilities are not available for vertices.
  54
  55 In order to filter out some entities:
  56 - Activate one or two filtering controls by switching on corresponding check boxes;
  57 - Select required threshold comparator type; the following choices are available:
  58   - <b>Less Than</b> or <b>Equal or Less Than</b> for the first comparator;
  59   - <b>Greater Than</b> or <b>Equal or Greater Than</b> for the second comparator;
  60 - Enter required threshold value (values);
  61 - Press \b Apply button in the \b Filter group.
  62
  63 The entities which satisfy entered filtering parameters will be automatically highlighted
  64 in the 3D viewer.
  65
  66 Using <b>TUI Commands</b> you can perform this operation in a
  67 variety of ways:
  68 - <em>geompy.ExtractShapes(Shape, Type, isSorted)</em> explodes a
  69   Shape into sub-shapes of a given Type and returns a List of sub-shapes.
  70   This method does not return the Shape itself if it matches the
  71   Type.
  72 - <em>geompy.SubShapeAll(Shape, Type)</em> explodes a Shape on
  73   sub-shapes of a given Type and returns a List of sub-shapes.
  74 - <em>geompy.SubShapeAllIDs(Shape, Type)</em> explodes a Shape on
  75   sub-shapes of a given Type and returns a List of IDs of
  76   sub-shapes.
  77 - <em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a
  78   shape on sub-shapes of a given type and sorts them taking into account
  79   their gravity centers, to provide stable order of sub-shapes.
  80   It returns a list of sub-shapes.
  81 - <em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes
  82   a shape on sub-shapes of a given type and sorts them taking into
  83   account their gravity centers, to provide stable order of sub-shapes.
  84   It returns a List of IDs of sub-shapes.
  85 - <em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
  86   a compound of sub-shapes of  the Shape,  selected by they indices in a
  87   list of all sub-shapes of the given Type. Each index is in the range
  88   [1, Nb_Sub-Shapes_Of_Given_Type].
  89 - <em>geompy.SubShapeSortedCentres(Shape, Type, ListOfInd)</em>
  90   allows to obtain a compound of sub-shapes of the Shape, selected by
  91   they indices in sorted list of all sub-shapes of the given Type. Each
  92   index is in the range [1, Nb_Sub-Shapes_Of_Given_Type]
  93
  94 <b>Arguments: </b>1 SHAPE + 1 type of SubShape.
  95
  96 <b>Example:</b>
  97
  98 \image html explode.png "A box, exploded into faces"
  99
 100 */