Salome HOME
GPUSPHGUI: add an option to Offset Surface opreation
[modules/geom.git] / doc / salome / gui / GEOM / input / offset_operation.doc
1 /*!
2
3 \page offset_operation_page Offset Surface
4
5 \n To produce an <b>Offset Surface</b> in the <b>Main Menu</b> select
6 <b>Operations - > Transformation - > Offset Surface</b>
7
8 \n This operation translates each point of an \b Object (a set of
9 Objects) along a local normal by a given \b Offset distance (signed
10 number, negative value meaning inner offset). Gaps between translated 
11 adjacent surfaces are filled in either of two ways: 
12 - if <b>Join by pipes</b> is activated, they are filled with pipes;
13 - else the surfaces are extended and intersected, so that sharp edges
14   are preserved.
15
16 \n \b Offset operation is applicable to faces, shells and solids.
17 \n \ref restore_presentation_parameters_page "Advanced options".
18
19
20 \image html transformation11.png
21
22 \n <b>Example:</b>
23
24 \image html offsetsn.png "The box and its offset surface (Join by pipes activated)"
25
26 \n <b>TUI Command:</b> 
27 - Gaps filled by pipes: <em>geompy.MakeOffset(Shape, Offset),</em>
28 - Gaps filled by intersection: <em>geompy.MakeOffsetIntersectionJoin(Shape, Offset),</em>
29
30 where Shape is a shape(s) which has to be an offset, Offset is a value of
31 the offset.
32 \n <b>Arguments:</b> Name + Object (face(s), shell(s), solid(s)) +
33 Offset value.
34 \n The \b Result will be a \b GEOM_Object. 
35
36 Our <b>TUI Scripts</b> provide you with useful examples of the use of
37 \ref tui_offset "Transformation Operations".
38
39 */