Salome HOME
Switch development flag to 1
[modules/hexablock.git] / doc / tui_cut_hexa.rst
index cd943e7cad82312a34dee90a1f39f70b74bf5261..fadc2a9b89d1cbe61f0ec1f38993ef4c5b7b13a0 100644 (file)
@@ -7,34 +7,47 @@
 Cut hexahedra
 =============
 
-Cut hexahedra from the model of blocks::
+.. _tuicuthexauniform:
 
-    elts = doc.cut(an_edge, nb_of_cuts)
+Uniform Cut
+===========
 
-Operations on *elts*: :ref:`tuielements2`
+To make a uniform cut of an hexahedra in python mode, you need the following arguments:
 
-This method enables to cut in two (or more) a series of hexahedra using a series of edges propagation.
+- *edge*    : an edge on the hexahedra to cut.
+- *nbCuts*: the number of cuts.
 
+Use the function **cutUni**::
 
-Example
--------
+       elts = doc.cutUni(edge, nbCuts)
+       
 
-.. literalinclude:: test_doc/cut_hexa/cut_hexa.py
-   :linenos:
+GUI command: :ref:`guicuthexauniform`
+
+
+.. _tuicuthexacustom:
+
+Custom Cut
+==========
+
+To make a custom cut of an hexahedra you need the following arguments:
 
+- *edge*: an edge on the hexahedra to cut.
+- *tl*  : the list of the lengths of the layers in ascendant order.
 
-.. image:: _static/non_cut_hexa.png
-   :align: center
+Use the funtion **cut**::
 
-.. centered::
-   Initial hexa
-   
-   
-.. image:: _static/cut_hexa.png
-   :align: center
+       elts = doc.cut(edge, tl)
+       
+GUI command: :ref:`guicuthexacustom`
 
-.. centered::
-   Cut hexa
-   
+Operations on *elts*: :ref:`tuielements2`
+
+
+Example
+=======
+
+.. literalinclude:: test_doc/cutHexa/cut_hexa.py
+   :linenos:
 
-GUI command: :ref:`guicuthexa`
+   
\ No newline at end of file