From 6e06cc1ccc68f02e704e7e98c3d14031d4555cb6 Mon Sep 17 00:00:00 2001 From: vsr Date: Tue, 7 Dec 2010 14:06:52 +0000 Subject: [PATCH] 0020565: EDF 1045 GEOM : Doc Partition Methodology --- doc/salome/gui/GEOM/Makefile.am | 2 +- .../gui/GEOM/input/common_operation.doc | 22 +++++++++++------- doc/salome/gui/GEOM/input/cut_operation.doc | 22 +++++++++++------- doc/salome/gui/GEOM/input/fuse_operation.doc | 22 +++++++++++------- doc/salome/gui/GEOM/input/index.doc | 2 ++ doc/salome/gui/GEOM/input/partition.doc | 6 +++++ doc/salome/gui/GEOM/input/related_docs.doc | 10 ++++++++ .../gui/GEOM/input/section_operation.doc | 22 +++++++++++------- .../GEOM/input/using_boolean_operations.doc | 10 ++++++-- doc/salome/gui/GEOM/static/SALOME_BOA_PA.pdf | Bin 0 -> 2801689 bytes 10 files changed, 83 insertions(+), 35 deletions(-) create mode 100644 doc/salome/gui/GEOM/input/related_docs.doc create mode 100755 doc/salome/gui/GEOM/static/SALOME_BOA_PA.pdf diff --git a/doc/salome/gui/GEOM/Makefile.am b/doc/salome/gui/GEOM/Makefile.am index 9740ec3ec..02cfc0e08 100755 --- a/doc/salome/gui/GEOM/Makefile.am +++ b/doc/salome/gui/GEOM/Makefile.am @@ -27,7 +27,7 @@ include $(top_srcdir)/adm_local/unix/make_common_starter.am EXTRA_DIST += images input static/footer.html static/doxygen.css guidocdir = $(docdir)/gui/GEOM -guidoc_DATA = images/head.png +guidoc_DATA = images/head.png static/SALOME_BOA_PA.pdf usr_docs: doxyfile_tui doxyfile_py doxyfile echo "===========================================" ; \ diff --git a/doc/salome/gui/GEOM/input/common_operation.doc b/doc/salome/gui/GEOM/input/common_operation.doc index dfefce0df..15a3607ff 100644 --- a/doc/salome/gui/GEOM/input/common_operation.doc +++ b/doc/salome/gui/GEOM/input/common_operation.doc @@ -2,19 +2,25 @@ \page common_operation_page Common -\n To produce a \b Common operation in the Main Menu select Operations - > Boolean - > Common +For detail description of the Boolean operations please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. -\n This operation cuts the common part of two shapes and transforms it into an independent geometrical object. +To produce a \b Common operation in the Main Menu select Operations - > Boolean - > Common -\n The \b Result will be any \b GEOM_Object. -\n TUI Command: geompy.MakeCommon(s1, s2) -\n Arguments: Name + 2 shapes. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +This operation cuts the common part of two shapes and transforms it into an independent geometrical object. + +The \b Result will be any \b GEOM_Object. +TUI Command: geompy.MakeCommon(s1, s2) +Arguments: Name + 2 shapes. +Advanced option: +\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". \image html bool2.png -\n Example: +Example: \image html fusesn1.png "The initial shapes" diff --git a/doc/salome/gui/GEOM/input/cut_operation.doc b/doc/salome/gui/GEOM/input/cut_operation.doc index bab9ca7b8..3eee98514 100644 --- a/doc/salome/gui/GEOM/input/cut_operation.doc +++ b/doc/salome/gui/GEOM/input/cut_operation.doc @@ -2,19 +2,25 @@ \page cut_operation_page Cut -\n To produce a \b Cut operation in the Main Menu select Operations - > Boolean - > Cut +For detail description of the Boolean operations please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. -\n This operation cuts a shape with another one. -\n The \b Result will be any \b GEOM_Object. -\n Arguments: Name + 2 shapes. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +To produce a \b Cut operation in the Main Menu select Operations - > Boolean - > Cut -\n Dialog Box: +This operation cuts a shape with another one. +The \b Result will be any \b GEOM_Object. +Arguments: Name + 2 shapes. +Advanced option: +\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". + +Dialog Box: \image html bool3.png -\n Example: +Example: \image html fusesn1.png "The initial shapes" diff --git a/doc/salome/gui/GEOM/input/fuse_operation.doc b/doc/salome/gui/GEOM/input/fuse_operation.doc index ece199c5c..42026ee99 100644 --- a/doc/salome/gui/GEOM/input/fuse_operation.doc +++ b/doc/salome/gui/GEOM/input/fuse_operation.doc @@ -2,20 +2,26 @@ \page fuse_operation_page Fuse -\n To produce a \b Fuse operation in the Main Menu select +For detail description of the Boolean operations please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. + +To produce a \b Fuse operation in the Main Menu select Operations - > Boolean - > Fuse -\n This operation creates a shape from two shapes. +This operation creates a shape from two shapes. -\n The \b Result will be any \b GEOM_Object. -\n TUI Command: geompy.MakeFuse(s1, s2) -\n Arguments: Name + 2 shapes. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +The \b Result will be any \b GEOM_Object. +TUI Command: geompy.MakeFuse(s1, s2) +Arguments: Name + 2 shapes. +Advanced option: +\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". \image html bool1.png -\n Example: +Example: \image html fusesn1.png "The initial shapes" diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc index 856e03a54..b4368cbcd 100644 --- a/doc/salome/gui/GEOM/input/index.doc +++ b/doc/salome/gui/GEOM/input/index.doc @@ -27,5 +27,7 @@ Also it can be useful to have a look at the \subpage geompypkg_page "documentati \image html image3.png "Example of Geometry module usage for engineering tasks" +There are also \subpage related_docs_page "additional reference documents" +for Geometry module that can be useful. */ diff --git a/doc/salome/gui/GEOM/input/partition.doc b/doc/salome/gui/GEOM/input/partition.doc index c802d7611..446d525af 100644 --- a/doc/salome/gui/GEOM/input/partition.doc +++ b/doc/salome/gui/GEOM/input/partition.doc @@ -2,6 +2,12 @@ \page partition_page Partition +For detail description of the Partition operation please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. + To produce a \b Partition in the Main Menu select Operations - > Partition This operation builds a compound by intersection of several shapes diff --git a/doc/salome/gui/GEOM/input/related_docs.doc b/doc/salome/gui/GEOM/input/related_docs.doc new file mode 100644 index 000000000..fea4ba010 --- /dev/null +++ b/doc/salome/gui/GEOM/input/related_docs.doc @@ -0,0 +1,10 @@ +/*! +\page related_docs_page Related Documents + +Here you can find additional reference documents for Geometry module +that can be useful for reading. + +General Fuse Algorithm, Partition +Algorithm, Boolean Operations Algorithm. Backgrounds. + +*/ diff --git a/doc/salome/gui/GEOM/input/section_operation.doc b/doc/salome/gui/GEOM/input/section_operation.doc index c4f450d30..6dd99f642 100644 --- a/doc/salome/gui/GEOM/input/section_operation.doc +++ b/doc/salome/gui/GEOM/input/section_operation.doc @@ -2,20 +2,26 @@ \page section_opeartion_page Section -\n To produce a \b Section operation in the Main Menu select +For detail description of the Boolean operations please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. + +To produce a \b Section operation in the Main Menu select Operations - > Boolean - > Section -\n This operation creates the section between 2 shapes. +This operation creates the section between 2 shapes. -\n The \b Result will be any \b GEOM_Object (EDGE or WIRE). -\n TUI Command: geompy.MakeSection(s1, s2) -\n Arguments: Name + 2 shapes. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +The \b Result will be any \b GEOM_Object (EDGE or WIRE). +TUI Command: geompy.MakeSection(s1, s2) +Arguments: Name + 2 shapes. +Advanced option: +\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". \image html neo-section.png -\n Example: +Example: \image html fusesn1.png "The initial shapes" diff --git a/doc/salome/gui/GEOM/input/using_boolean_operations.doc b/doc/salome/gui/GEOM/input/using_boolean_operations.doc index c7fd67b75..cfbb5f444 100644 --- a/doc/salome/gui/GEOM/input/using_boolean_operations.doc +++ b/doc/salome/gui/GEOM/input/using_boolean_operations.doc @@ -2,7 +2,13 @@ \page using_boolean_operations_page Using Boolean Operations -\n You can use the following boolean operations for construction of more +For detail description of the Boolean operations please refer to +this document. +It provides a general review of the Partition and Boolean +operations algorithms, describes the usage methodology and highlighs +major limitations of these operations. + +You can use the following boolean operations for construction of more complex geometrical objects (2D & 3D elements):