X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fusing_boolean_operations.doc;h=02a30251d246b12be9d52b9451f964e300c99f73;hb=69b2ec02a2002731ceaf0597fa9f4dd9cd57dc91;hp=c7fd67b75c75c6365be91f5d3a5e93094952a8b8;hpb=392885c1a8d50369708bbe5e6b44033ed8b8ba51;p=modules%2Fgeom.git
diff --git a/doc/salome/gui/GEOM/input/using_boolean_operations.doc b/doc/salome/gui/GEOM/input/using_boolean_operations.doc
index c7fd67b75..02a30251d 100644
--- a/doc/salome/gui/GEOM/input/using_boolean_operations.doc
+++ b/doc/salome/gui/GEOM/input/using_boolean_operations.doc
@@ -1,44 +1,90 @@
/*!
-\page using_boolean_operations_page Using Boolean Operations
+\page using_boolean_operations_page Boolean Operations
-\n You can use the following boolean operations for construction of more
+For a detailed description of Boolean operations refer to
+this document.
+It provides a general review of the Partition and Boolean
+operations algorithms, describes the usage methodology and highlights
+major limitations of these operations.
+
+You can use the following boolean operations for construction of more
complex geometrical objects (2D & 3D elements):
-- \subpage fuse_operation_page "Fuse" - creates a shape from two shapes.
+- \subpage fuse_operation_page "Fuse" - creates a shape from a list of shapes.
- \subpage common_operation_page "Common" - transforms the common part
-of two objects into an independent object.
+of a list of objects into an independent object.
- \subpage cut_operation_page "Cut" - cuts one shape with
-another.
+a list of others.
- \subpage section_opeartion_page "Section" - creates a section between two shapes.
-There is a general TUI command covering all these operations, which
-can be used alongside with separate commands for each operation.
+You can use advanced TUI commands performing these operations
+independently from each other:
+\par
+geompy.MakeFuseList(theShapesList, checkSelfInte, rmExtraEdges), where \em theShapesList is
+the list of shapes for Fuse operation;
+\par
+geompy.MakeCommonList(theShapesList, checkSelfInte), where \em theShapesList is
+the list of shapes for Common operation;
\par
-geompy.MakeBoolean(Shape1, Shape2, Operation), where \em
+geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte), where \em
+theMainShape is the object of the operation and \em theShapesList is
+the list of tools for Cut operation;
+\par
+geompy.MakeSection(Shape1, Shape2, checkSelfInte), where \em Shape1 is the first
+argument and \em Shape2 is the second argument of Section operation;
+
+
+There are several TUI commands that can be used to perform boolean operations
+with only two arguments. There is a general TUI command covering these
+operations, which can be used alongside with separate commands for each
+operation.
+\par
+geompy.MakeBoolean(Shape1, Shape2, Operation, checkSelfInte), where \em
Shape1 is the first argument and \em Shape2 is the second argument of
-Boolean operation, \em Operation is a type of the Boolean operation (1
+a Boolean operation, \em Operation is the type of a Boolean operation (1
— Common, 2 — Cut, 3 — Fuse, 4 — Section).
Besides, you can use advanced TUI commands performing these operations
independently from each other:
\par
-geompy.MakeFuse(Shape1, Shape2), where \em Shape1 and \em
-Shape2 is the second argument of Fuse operation;
-\par
-geompy.MakeCommon(Shape1, Shape2), where \em Shape1 and \em
-Shape2 is the second argument of Common operation;
+geompy.MakeFuse(Shape1, Shape2, checkSelfInte, rmExtraEdges), where \em Shape1 is the first
+argument and \em Shape2 is the second argument of Fuse operation;
\par
-geompy.MakeCut(Shape1, Shape2), where \em Shape1 and \em
-Shape2 is the second argument of Cut operation;
+geompy.MakeCommon(Shape1, Shape2, checkSelfInte), where \em Shape1 is the first
+argument and \em Shape2 is the second argument of Common operation;
\par
-geompy.MakeSection(Shape1, Shape2), where \em Shape1 and \em
-Shape2 is the second argument of Section operation;
+geompy.MakeCut(Shape1, Shape2, checkSelfInte), where \em Shape1 is the first
+argument and \em Shape2 is the second argument of Cut operation;
+
+The flag \em checkSelfInte indicates whether the arguments should be checked for
+self-intersection prior to an operation. Its default value is \em False, which
+means that there is no need to check it. This option is provided to ensure that
+an operation is performed on not self-intersected shapes as they are
+not valid for boolean operations.
+
+\note This algorithm does not find all types of self-intersections. It is tuned
+ to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
+ intersections. Face/face intersections detection is switched off as it
+ is a time-consuming operation that gives an impact on performance. To find
+ all self-intersections use \ref check_self_intersections_page
+ "Detect Self-intersection tool".
+
+The flag \em rmExtraEdges is used for \em MakeFuseList and \em MakeFuse
+operations only. It indicates if Remove Extra Edges operation should be
+performed during the operation. Its default value is \em False, which
+means that there is no need to do it.
+
+\note \em rmExtraEdges is not available for \em MakeBoolean call with
+ operation type 3 (Fuse). \em MakeBoolean operation doesn't perform
+ Remove Extra Edges. So the call geompy.MakeBoolean(Shape1, Shape2,
+ 3, checkSelfInte) is equivalent to geompy.MakeFuse(Shape1,
+ Shape2, checkSelfInte, False).
-\n Our TUI Scripts provide you with useful examples of the use of
+Our TUI Scripts provide you with useful examples of the use of
\ref tui_boolean_operations_page "Boolean Operations".
*/