Salome HOME
small modification
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_divideddisk.doc
1 /*!
2
3 \page create_divideddisk_page DividedDisk
4
5 The <b>Divided disk</b> object is a disk divided into \b blocks. It means that it's a shape <b>prepared for hexaedral meshing</b>.
6
7 \n Moreover this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path" operation in order to obtain any <b>tube shape</b> prepared for hexaedral meshing 
8 (see example below). 
9
10 Example:
11
12 \image html divided_disk.png
13
14 To create a <b> Divided Disk </b> in the <b>Main Menu</b> select <b>New Entity - >
15 Advanced - > DividedDisk </b>
16
17 \n Then there are 2 ways to create a <b> Divided Disk</b> in 3D space. 
18 \n For both operations : 
19 Specify the parameters of the DividedDisk object creation in the opened dialog
20 box and press "Apply" or "Apply & Close" button.
21 Result of each operation will be a GEOM_Object.
22
23 \n First way : by radius and orientation (plane "OXY", "OYZ" or "OZX"). The resulting disk is located at the origin of coordinates
24
25 <b>TUI Command:</b> <em>geompy.MakeDividedDisk(Radius, Orientation)</em>
26
27 <b>Arguments:</b>
28 - \b Radius - Radius of the disk
29 - \b Orientation - Plane on wich the disk will be built
30
31 \image html divided_disk_dlg.png
32
33 \n Second way : by giving its center, normal and radius.
34
35 <b>TUI Command:</b> <em>geompy.MakeDividedDiskPntVecR(Center, Vector,
36 Radius)</em>
37
38 <b>Arguments:</b>
39 - \b Center - Center of the disk
40 - \b Vector - Normal to the plane of the disk
41 - \b Radius - Radius of the disk
42
43 \image html divided_disk_PntVecR_dlg.png
44
45 Our <b>TUI Scripts</b> provide you with useful examples of creation of
46 \ref tui_creation_divideddisk "Advanced objects".
47
48 */