Salome HOME
Implementation of the "0020839: EDF 1370 DOC : Update of the TUI features documentati...
[modules/geom.git] / doc / salome / gui / GEOM / input / using_boolean_operations.doc
1 /*!
2
3 \page using_boolean_operations_page Using Boolean Operations
4
5 For detail description of the Boolean operations please refer to
6 <a href="SALOME_BOA_PA.pdf">this document</a>. 
7 It provides a general review of the Partition and Boolean
8 operations algorithms, describes the usage methodology and highlighs
9 major limitations of these operations.
10
11 You can use the following boolean operations for construction of more
12 complex geometrical objects (2D & 3D elements):
13
14 <ul>
15 <li>\subpage fuse_operation_page "Fuse" - creates a shape from two shapes.</li>
16 <li>\subpage common_operation_page "Common" - transforms the common part
17 of two objects into an independent object.</li>
18 <li>\subpage cut_operation_page "Cut" - cuts one shape with
19 another. </li>
20 <li>\subpage section_opeartion_page "Section" - creates a section between two shapes.</li>
21 </ul>
22
23 There is a general TUI command covering all these operations, which
24 can be used alongside with separate commands for each operation.
25 \par
26 <em>geompy.MakeBoolean(Shape1, Shape2, Operation),</em> where \em
27 Shape1 is the first argument and \em Shape2 is the second argument of
28 Boolean operation, \em Operation is a type of the Boolean operation (1
29 &mdash; Common, 2 &mdash; Cut, 3 &mdash; Fuse, 4 &mdash; Section).
30
31
32 Besides, you can use advanced TUI commands performing these operations
33 independently from each other:
34 \par
35 <em>geompy.MakeFuse(Shape1, Shape2)</em>, where \em Shape1 and \em
36 Shape2 is the second argument of Fuse operation; 
37 \par
38 <em>geompy.MakeCommon(Shape1, Shape2)</em>, where \em Shape1 and \em
39 Shape2 is the second argument of Common operation;
40 \par
41 <em>geompy.MakeCut(Shape1, Shape2)</em>, where \em Shape1 and \em
42 Shape2 is the second argument of Cut operation;
43 \par
44 <em>geompy.MakeSection(Shape1, Shape2)</em>, where \em Shape1 and \em
45 Shape2 is the second argument of Section operation;
46
47 Our <b>TUI Scripts</b> provide you with useful examples of the use of 
48 \ref tui_boolean_operations_page "Boolean Operations".
49
50 */