Salome HOME
Merge branch 'BR_2018_V8_5' into BR_PY3
[modules/hydro.git] / doc / salome / gui / HYDRO / input / import_obstacle_GEOM.doc
1
2 /**
3   @file
4   \brief Help for Import GEOM object as obstacle operation
5 */
6
7 /**
8   \page import_obstacle_GEOM Import GEOM object as obstacle
9
10  <a href="index.html"><b>Back to Main page.</b></a>
11  
12   A geometrical object can be imported into the HYDROGUI module as an obstacle. 
13   
14
15   The <b>Import GEOM object as obstacle</b> operation can be started via Context menu of GEOM object in Object browser - <b>Import as obstacle</b>.
16
17  The user can select one/several objects in GEOM, in this case for each selected object the corresponding instance of HYDRO obstacle will be created.
18  
19  
20  <b>Import GEOM object as obstacle</b> input panel appears.
21
22 The same input panel appears after creation of new geometrical primitives as results of <b>Create box</b> and <b>Create cylinder</b> operations.
23
24 <b>Import GEOM object as obstacle</b> input panel appears.
25
26   \image html box_input_panel_create.png " Import GEOM object as obstacle input panel - Create mode"
27   
28    \image html box_input_panel.png " Import GEOM object as obstacle input panel - Modify mode"
29
30 Arguments of the input panel:
31  
32 <b>Name</b> - field to define the obstacle name. By default name is the same as name of corresponding GEOM object;<br>
33 <b>Mode</b> - allows to generate a new obstacle (radio-button <b>Create new</b>) or replace existing obstacle (radio-button <b>Modify</b>) ;<br>
34 <b>Apply</b> - button to generate obstacle;<br>
35 <b>Apply and Close</b> - button to generate obstacle and close input panel;<br>
36 <b>Close</b> - button to close input panel.
37   
38    The obstacle is presented as the face and 3D object.
39    \image html box_presentation.png  "Box obstacle example" 
40
41  <a href="index.html"><b>Back to Main page.</b></a>
42   
43 */