Salome HOME
Doc : Add an Angle option in the cylinder primitive in order to build portion of...
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_explode.doc
index 747aba637346d72fc3ca7289b48fb4abbaa9b8b2..1de29847ad4f599962e0e4d385d727f5b3f8f395 100644 (file)
@@ -2,12 +2,12 @@
 
 \page create_explode_page Explode
 
-\n To \b Explode an object into subshapes, in the <b>Main Menu</b>
+\n To \b Explode an object into sub-shapes, in the <b>Main Menu</b>
 select <b>New Entity > Explode</b>.
 
-\n To create a list of  subshapes (vertices, edges, wires etc.) of the
+\n To create a list of  sub-shapes (vertices, edges, wires etc.) of the
 given shape using the \b Explode operation, you need to define the <b>Main
-Object</b>, which will be exploded and the <b>Type of Subshapes</b> you wish to
+Object</b>, which will be exploded and the <b>Type of Sub-shapes</b> you wish to
 obtain from it.
 \n The \b Result of the operation will be a List of \b GEOM_Objects
 (vertexes, edges, wires, faces, shells or solids).
@@ -15,25 +15,31 @@ obtain from it.
 \n Using <b>TUI Commands</b> you can perform this operation in a
 variety of ways:
 <ul>
+<li><em>geompy.ExtractShapes(Shape, Type, isSorted)</em> explodes a
+Shape into sub-shapes of a given Type and returns a List of sub-shapes.
+This method does not return the Shape itself if it matches the
+Type.</li>
 <li><em>geompy.SubShapeAll(Shape, Type)</em> explodes a Shape on
-subshapes of a given Type and returns a List of sub-shapes.</li>
+sub-shapes of a given Type and returns a List of sub-shapes.</li>
 <li><em>geompy.SubShapeAllIDs(Shape, Type)</em> explodes a Shape on
-subshapes of a given Type and returns a List of IDs of
+sub-shapes of a given Type and returns a List of IDs of
 sub-shapes.</li>
-<li><em>geompy.SubShapeAllSorted(Shape, Type)</em> xplodes a shape on
-subshapes of a given type and sorts them by coordinates of their
-gravity centers, returning      a list of sub-shapes.</li>
-<li><em>geompy.SubShapeAllSortedIDs(Shape, Type)</em> explodes a shape
-on subshapes of a given type and sorts them by coordinates of their
-gravity centers,  returning a List of IDs of sub-shapes.</li>
+<li><em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a
+shape on sub-shapes of a given type and sorts them taking into account
+their gravity centers, to provide stable order of sub-shapes.
+It returns a list of sub-shapes.</li>
+<li><em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes
+a shape on sub-shapes of a given type and sorts them taking into
+account their gravity centers, to provide stable order of sub-shapes.
+It returns a List of IDs of sub-shapes.</li>
 <li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
 a compound of sub-shapes of  the Shape,  selected by they indices in a
 list of all sub-shapes of the given Type. Each index is in the range
 [1, Nb_Sub-Shapes_Of_Given_Type].</li>
-<li><em>geompy.SubShapeSorted(Shape, Type, ListOfInd)</em> allows to
-obtain a compound of sub-shapes of the Shape, selected by they indices
-in sorted list of all sub-shapes of the given Type. Each index is in
-the range [1, Nb_Sub-Shapes_Of_Given_Type]</li>
+<li><em>geompy.SubShapeSortedCentres(Shape, Type, ListOfInd)</em>
+allows to obtain a compound of sub-shapes of the Shape, selected by
+they indices in sorted list of all sub-shapes of the given Type. Each
+index is in the range [1, Nb_Sub-Shapes_Of_Given_Type]</li>
 </ul>
 
 \n <b>Arguments: </b>1 SHAPE + 1 type of SubShape.