From: rnc <rnc@opencascade.com>
Date: Mon, 23 Jul 2012 15:39:39 +0000 (+0000)
Subject: imporved documentation about partition, fuse and compound usage
X-Git-Tag: V6_6_0a1~68
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=cc6f3a695d637fd29140c9b18350a9e3335d3c74;p=modules%2Fgeom.git

imporved documentation about partition, fuse and compound usage
---

diff --git a/doc/salome/gui/GEOM/input/partition_explanation.doc b/doc/salome/gui/GEOM/input/partition_explanation.doc
index ecc641051..52ce69dcc 100644
--- a/doc/salome/gui/GEOM/input/partition_explanation.doc
+++ b/doc/salome/gui/GEOM/input/partition_explanation.doc
@@ -1,27 +1,55 @@
-/*!\page partition_explanation Fuse, Partition and Compound usage
+/*!
 
-It is frequently asked about the difference between the above mentioned operations. It's indeed simple. Lets take the example of a cylinder and a box that you want to join together.
+\page partition_explanation Fuse, Partition and Compound usage
 
-\b Fuse
+\tableofcontents
 
-The \b fuse operation will make a <b>single solid</b> from the two given solids :
+It is frequently asked about the difference between the above mentioned operations. It's indeed simple. Lets take the example of a cylinder and a box that you want to join together.
 
-\image html fuse.png
+\section sec1 Fuse
 
-\b Partition
+The \b fuse operation will make a <b>single solid</b> from the two given solids. It allows you to build complex models by putting simple shapes together.
+\image html fuse.png
 
-The \b partition operation will do basically the same but it will <b>keep a face at the frontier between the two solids</b> (in brown on the picture below). 
-This face is shared by the two solids, which means that this face is present only one time in the resulting shape and is a sub-shape of the box and a sub-shape of the cylinder.
+\section sec2 Partition
+The \b partition operation will also allow connecting the two solids but it will <b>keep a face at the frontier</b> (in brown on the picture below). The resulting shape will consist in <b>two connected solids</b> that share 
+a face at their frontier. It means that this face is present only one time in the resulting shape and is a sub-shape of both the box and the cylinder.
 
-This operation allows you to identify different areas in a shape (e.g. different materials) and to ensure a conformal mesh when meshing it later. Indeed the face at the frontier is meshed only one time. 
+\n This operation allows you to identify different areas in a shape (e.g. different materials) and to ensure a <b>conformal mesh</b> when meshing it later. Indeed the face at the frontier is meshed only once. 
 
 \image html partition.png
 
-\b Compound
 
+\section sec3 Compound
 When you build a \b compound by using the build -> compound operation you just make <b>an object that contains the two separate solids</b> like in a "bag".
 The two solids remain unconnected. The compound is just a set of shapes, no more.
 
+\n The compound Allows applying operations to a collection of shapes.
+
 \image html compound2.png
 
+
+
+\note The shapes in the compound can be of different types : edge + shell + vertex ...
+
+\section sec4 Summary
+<ul>
+<li> \b Fuse 
+<ul>
+<li> \a Result : A <b>single solid</b>. </li>
+<li> \a Purpose : Allows building complex models by putting simple shapes together.</li>
+</ul>
+<li> \b Partition
+<ul>
+<li>\a Result : Several <b>connected solids</b> sharing faces.</li>
+<li>\a Purpose : Useful to ensure a conformal mesh of separated areas of your model (fluid / solid , concrete / steel ...)</li>
+</ul>
+<li> \b Compound
+<ul>
+<li>\a Result : Several <b>unconnected objects</b> of any type.</li>
+<li>\a Purpose : Allows applying operations to a collection of shapes.</li>
+</ul>
+</ul>
+
+
 */
\ No newline at end of file