Salome HOME
84301523e8c22a91f813a962cec133b2cd82abfe
[modules/geom.git] / doc / salome / gui / GEOM / input / using_boolean_operations.doc
1 /*!
2
3 \page using_boolean_operations_page 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 a list of shapes.</li>
16 <li>\subpage common_operation_page "Common" - transforms the common part
17 of a list of objects into an independent object.</li>
18 <li>\subpage cut_operation_page "Cut" - cuts one shape with
19 a list of others. </li>
20 <li>\subpage section_opeartion_page "Section" - creates a section between two shapes.</li>
21 </ul>
22
23 You can use advanced TUI commands performing these operations
24 independently from each other:
25 \par
26 <em>geompy.MakeFuseList(theShapesList)</em>, where \em theShapesList is
27 the list of shapes for Fuse operation; 
28 \par
29 <em>geompy.MakeCommonList(theShapesList)</em>, where \em theShapesList is
30 the list of shapes for Common operation;
31 \par
32 <em>geompy.MakeCutList(theMainShape, theShapesList)</em>, where \em
33 theMainShape is the object of the operation and \em theShapesList is
34 the list of tools for Cut operation;
35 \par
36 <em>geompy.MakeSection(Shape1, Shape2)</em>, where \em Shape1 is the first
37 argument and \em Shape2 is the second argument of Section operation;
38
39
40 There are several TUI commands that can be used to perform boolean operations
41 with only two arguments. There is a general TUI command covering these
42 operations, which can be used alongside with separate commands for each
43 operation.
44 \par
45 <em>geompy.MakeBoolean(Shape1, Shape2, Operation),</em> where \em
46 Shape1 is the first argument and \em Shape2 is the second argument of
47 Boolean operation, \em Operation is a type of the Boolean operation (1
48 &mdash; Common, 2 &mdash; Cut, 3 &mdash; Fuse, 4 &mdash; Section).
49
50
51 Besides, you can use advanced TUI commands performing these operations
52 independently from each other:
53 \par
54 <em>geompy.MakeFuse(Shape1, Shape2)</em>, where \em Shape1 is the first
55 argument and \em Shape2 is the second argument of Fuse operation; 
56 \par
57 <em>geompy.MakeCommon(Shape1, Shape2)</em>, where \em Shape1 is the first
58 argument and \em Shape2 is the second argument of Common operation;
59 \par
60 <em>geompy.MakeCut(Shape1, Shape2)</em>, where \em Shape1 is the first
61 argument and \em Shape2 is the second argument of Cut operation;
62
63 Our <b>TUI Scripts</b> provide you with useful examples of the use of 
64 \ref tui_boolean_operations_page "Boolean Operations".
65
66 */