Salome HOME
Merge from V6_main 13/12/2012
[modules/hexablock.git] / doc / tui_hexahedron.rst
index e9e421039f3df6c3d914e6be3048b550623fcd32..67b3f54bcfc0fb67bd495be07edcf6ff3499c5d9 100644 (file)
@@ -24,5 +24,47 @@ Get the number of all hexahedra of the document::
 Get an hexahedron of the document::
 
     hexa_i = doc.getHexa(i)
+    
+Get a vertex of an hexahedron::
+
+       vertex_i = hexa_i.getVertex(i)
+
+Get an edge of an hexahedron::
+
+       edge_i = hexa_i.getEdge(i)
+
+Get a quad of an hexahedron::
+
+       quad_i = hexa_i.getQuad(i)
+       
+Get the number of used hexahedrons in the model of blocks::
+
+    nb_used_hexa = doc.countUsedHexa()
+    
+Get the hexahedrons used by the model of blocks
+
+.. literalinclude:: test_doc/hexa/hexa.py
+
+Find an hexahedron in the document::
+
+    hexa = doc.findHexa(vertex_1, vertex_2)
+    
+Add an hexahedron with 5 quads::
+
+       doc.addHexa5Quads (qa, qc, qd, qe, qf)
+       
+Add an hexahedron with 4 quads::
+
+       doc.addHexa4Quads (qa, qd, qe, qf)
+       
+Add an hexahedron with 3 quads::
+
+       doc.addHexa3Quads (qa, qd, qe)
+       
+Add an hexahedron with 2 quads::
+
+       doc.addHexa2Quads (qa, qb)
+
+More operations: *Hexa* inherits :ref:`Element <tuielement>`.
 
 GUI command: :ref:`guihexahedron`