Salome HOME
updated copyright message
[modules/hexablock.git] / doc / tui_quad_revolution.rst
1 :tocdepth: 3
2
3
4 .. _tuiquadrevolution:
5
6 =============== 
7 Quad Revolution
8 ===============
9
10 .. _tuiquadsrevolutionuniform:
11
12 Uniform Quad Revolution
13 =======================
14
15 To make a uniform  quad revolution you need:
16
17 - *quad*    : the quadrangle from which hexahedrons will be created (only for one quad revolution).
18 - *quads*   : a set of quadrangles from which hexahedrons will be created (only for multiple quads revolution).
19 - *center*  : center of rotation (a vertex).
20 - *axis*    : axis of rotation (a vector).
21 - *angle*   : Specify the rotation's angle at each step.
22 - *nbLayers*: the number of steps.
23
24 One quad revolution::
25
26         elts = doc.revolutionQuadUni(quad, center, axis, angle, nbLayers)
27
28 Revolution of a set of quads::
29
30         elts = doc.revolutionQuadsUni(quads, center, axis, angle, nbLayers)
31         
32
33 GUI command: :ref:`guiquadsrevolutionuniform`
34
35
36 .. _tuiquadsrevolutioncustom:
37
38 Custom Quad Revolution
39 ======================
40
41 To make a custom quad revolution you need:
42
43 - *quad*    : the quadrangle from which hexahedrons will be created (only for one quad revolution).
44 - *quads*   : a set of quadrangles from which hexahedrons will be created (only for multiple quads revolution).
45 - *center*  : center of rotation (a vertex).
46 - *axis*    : axis of rotation (a vector).
47 - *angles*  : a set of angles (in degrees). Specify the rotation's angle at each step.
48
49 One quad revolution::
50
51         elts = doc.revolutionQuad(quad, center, axis, angles)
52         
53 Revolution of a set of quads::
54
55         elts = doc.revolutionQuads(quads, center, axis, angles)
56         
57         
58 GUI command: :ref:`guiquadsrevolutioncustom`
59
60 Operations on *elts*: :ref:`tuielements2`
61
62
63 Example
64 =======
65
66 .. literalinclude:: test_doc/quadRevolution/revolution_quad.py
67    :linenos:
68
69
70