From: rnc <rnc@opencascade.com>
Date: Fri, 15 Jun 2012 13:22:56 +0000 (+0000)
Subject: added a "first steps" part in GEOM documentation with a first entry about differences... 
X-Git-Tag: V6_6_0a1~115
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=5ac53b11a185b389bb7ee2b1f02e5bd6759b5ddc;p=modules%2Fgeom.git

added a "first steps" part in GEOM documentation with a first entry about differences between fuse compound and partition
---

diff --git a/doc/salome/gui/GEOM/images/compound2.png b/doc/salome/gui/GEOM/images/compound2.png
new file mode 100644
index 000000000..f49c63e06
Binary files /dev/null and b/doc/salome/gui/GEOM/images/compound2.png differ
diff --git a/doc/salome/gui/GEOM/images/fuse.png b/doc/salome/gui/GEOM/images/fuse.png
new file mode 100644
index 000000000..968ccee1e
Binary files /dev/null and b/doc/salome/gui/GEOM/images/fuse.png differ
diff --git a/doc/salome/gui/GEOM/images/partition.png b/doc/salome/gui/GEOM/images/partition.png
new file mode 100644
index 000000000..7cb037293
Binary files /dev/null and b/doc/salome/gui/GEOM/images/partition.png differ
diff --git a/doc/salome/gui/GEOM/input/first_steps_guide.doc b/doc/salome/gui/GEOM/input/first_steps_guide.doc
new file mode 100644
index 000000000..17ca4e8c5
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/first_steps_guide.doc
@@ -0,0 +1,12 @@
+/*!
+
+\page first_steps_guide First steps in GEOM
+
+You can find here some useful information to start working with GEOM
+
+<ul>
+<li>\subpage partition_explanation "Partition, compounds and boolean operations" </li>
+</ul>
+
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc
index 7b87f72da..26928aaac 100644
--- a/doc/salome/gui/GEOM/input/index.doc
+++ b/doc/salome/gui/GEOM/input/index.doc
@@ -4,6 +4,9 @@
 
 \image html geomscreen.png
 
+If you are a new user some general information about GEOM usage are given here:
+\subpage first_steps_guide
+
 \b Geometry module of SALOME is destined for: 
 - \subpage import_export_geom_obj_page "import and export of geometrical models"
   in IGES, BREP and STEP formats;
diff --git a/doc/salome/gui/GEOM/input/partition_explanation.doc b/doc/salome/gui/GEOM/input/partition_explanation.doc
new file mode 100644
index 000000000..ad6c24c5b
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/partition_explanation.doc
@@ -0,0 +1,27 @@
+/*!\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.
+
+\section Fuse
+
+The \b fuse operation will make a <b>single solid</b> from the two given solids :
+
+\image html fuse.png
+
+\section Partition
+
+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.
+
+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. 
+
+\image html partition.png
+
+\section 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.
+
+\image html compound2.png
+
+*/
\ No newline at end of file