Salome HOME
ParaView 4.1 / VTK 6.1 porting
[modules/hexablock.git] / doc / tui_pipe.rst
1 :tocdepth: 3
2
3
4 .. _tuipipe:
5
6 ====
7 Pipe
8 ====
9 To add a pipe, the following data have to be mentioned:
10
11 - the coordinates of the pipe base
12 - the direction of the pipe
13 - height and radius of the pipe
14 - the inner radius
15 - the outer radius
16
17
18 Add a pipe in the document::
19
20     p = doc.addPipe(base, direction, int_radius, ext_radius, height)
21
22 Get the values of a pipe::
23
24     ver = p.getBase()
25     vec = p.getDirection()
26     int_r = p.getInternal_radius()
27     ext_r = p.getRadius()
28     h = p.getHeight()
29
30 Access to the pipes of the document::
31
32     np = doc.countPipe()
33     pik = doc.getPipe(index)
34
35 More operations: *Pipe* inherits :ref:`Element <tuielement>`.
36
37 GUI command: :ref:`guipipe`
38