From 4dea5a1c19a11ee548f5a230ebca79851d6c2f50 Mon Sep 17 00:00:00 2001 From: vsr Date: Thu, 12 Dec 2013 13:54:19 +0000 Subject: [PATCH] Update documentation --- doc/salome/gui/GEOM/images/isos.png | Bin 0 -> 1360 bytes .../gui/GEOM/input/common_operation.doc | 36 +++++++----- .../input/creating_extrusion_alongpath.doc | 20 +++---- .../gui/GEOM/input/creating_isoline.doc | 27 ++++++--- .../GEOM/input/creating_smoothingsurface.doc | 13 ++--- doc/salome/gui/GEOM/input/cut_operation.doc | 37 +++++++----- doc/salome/gui/GEOM/input/export_xao.doc | 21 ------- doc/salome/gui/GEOM/input/fuse_operation.doc | 46 ++++++++------- .../gui/GEOM/input/geometry_preferences.doc | 32 +++++------ doc/salome/gui/GEOM/input/import_export.doc | 2 + doc/salome/gui/GEOM/input/import_xao.doc | 8 --- doc/salome/gui/GEOM/input/index.doc | 13 ++--- doc/salome/gui/GEOM/input/material.doc | 19 +++--- doc/salome/gui/GEOM/input/partition.doc | 54 ++++++++---------- .../gui/GEOM/input/remove_webs_operation.doc | 6 +- .../gui/GEOM/input/repairing_operations.doc | 6 +- .../gui/GEOM/input/section_operation.doc | 32 ++++++----- .../gui/GEOM/input/sewing_operation.doc | 28 ++++----- .../gui/GEOM/input/union_faces_operation.doc | 21 +++---- .../GEOM/input/using_boolean_operations.doc | 16 +++--- .../GEOM/input/using_measurement_tools.doc | 7 ++- .../gui/GEOM/input/viewing_geom_obj.doc | 12 ++-- doc/salome/gui/GEOM/input/xao_format.doc | 20 ++++++- 23 files changed, 242 insertions(+), 234 deletions(-) create mode 100644 doc/salome/gui/GEOM/images/isos.png delete mode 100644 doc/salome/gui/GEOM/input/export_xao.doc delete mode 100644 doc/salome/gui/GEOM/input/import_xao.doc diff --git a/doc/salome/gui/GEOM/images/isos.png b/doc/salome/gui/GEOM/images/isos.png new file mode 100644 index 0000000000000000000000000000000000000000..86433e164693dbeb7aef0434573da477182d6024 GIT binary patch literal 1360 zcmV-W1+V&vP)lWN&vMLu_Glb2=bVbS-mrVqtJ_ zY-wX*bZKvHhgL;V0000TbVXQnRB3cGULDIyoTpY>8k*wEi z^DD2+uh=RY2ObWT)nm4?Z*h4nGUvedtIL>pgUe&bI2e;Awz4f0oJbQhRCb`GiGP4N zP}0N;)k?xFX+i`V3Io00i(Mb!!1k-_Iwsc8bTnaQY&Hn%6N{_lWOoSaKtrLF0{%23 zIx;bKKu9kp)+f9Ul=ge4jaw*W@3a&@2OhL(B9;TCK@%JLk}ykCCL)HyKqHgg=2WD< zgPiOpY)+%b!I;=x>=h&wo`-YWuP*8?o2yf~0);{;C3o3~;Nn1@L&0h3U?zZZAkO;3 zn81cYg>?g%Xf+*8pf=Ho1BG`t=Jgr7gZ6i0UZ06HT@q&DGJ$n~T3TT-(X#`E!UU=$ z2s9l{0Gr5A7Lv}|dpc8F3+)V`$$LByD>X);DM!y+bjtOU}FLp3cz)3F`MjAn~v)9 zvTo4H&X93Bs_bLv%FNddW&&6eyqAu&8xu7pY;!=}#X5lvh1_K$f_6}IX=)Q}>BtpQ z6R1!Ch9I4Z9!kP2M7>kEl3?9Cai|Dc655-wAsX238zSHC(%miss?0nN6iiHDZyX6z zC=38hge(dER5j7zl(3viU2Kz6La;l4;id!>zVk%mB_YH-(PTPu#ok1wqx~>8(Re!Y z#LPsdqXRMPV!H~3JXPogt2eZG)}^=?yA!RZ!AK_B?#fu66uk*!R~BNjGo;mYG=bxFai93gonZa*aY^*5oGCYz)oZw z9MpeZ&gu=V@Fy~6NtmU!i9S2jCDb#Ko1I>#hKZi1gyr~}$da%eM-y2RcEaUeY$xf6 z`d)0NqrI_wX4hRh;+*XA4Xpz)+hxC^2FJ+m(4cP}ogiL!piXh1W#$>1YDuZcMy`U-eh!iwST^KsZo{dM9is zJm4HC6fpr$M{o^7Vxn^g3erUV{WasIc^oL6o+`wqK_I(qB-7CxRp$w8hx+id{>nSh z#i>G{xE(0%pDGkWgLv<gfq)FwJ{pb+gS z7^4n8_TfNbjEPc8R}K^|6CH-a0Lx_e4ix;ULg_$(^-h|O?oz`u zuv3N7!34l>ccp__s-7y84ql<&sY0pYb!wa{ln$2QIN6m_?!I|lygeLG75b1GcEROT zp>(hZ#=qT_4)(^(L^?PSn^T2S!{J2z6}9$A6D*KE$L`& literal 0 HcmV?d00001 diff --git a/doc/salome/gui/GEOM/input/common_operation.doc b/doc/salome/gui/GEOM/input/common_operation.doc index b317eed99..804fcfafb 100644 --- a/doc/salome/gui/GEOM/input/common_operation.doc +++ b/doc/salome/gui/GEOM/input/common_operation.doc @@ -2,29 +2,38 @@ \page common_operation_page Common -To produce a \b Common operation in the Main Menu select Operations - > Boolean - > Common +\b Common operation cuts the common part of a list of shapes and transforms it into an independent geometrical object. -This operation cuts the common part of a list of shapes and transforms it into an independent geometrical object. +To produce it, select in the main menu Operations - > Boolean - > Common. -The \b Result will be a \b GEOM_Object. +\image html bool2.png "Common dialog" -TUI Command: geompy.MakeCommonList(theShapesList, checkSelfInte)\n -Arguments: Name + a list of shapes + an optional flag for self-intersection check.\n -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +In this dialog: +- Input or accept the default \b Name of the resulting shape. +- Click the arrow button and select in the Object Browser or in the Viewer the Objects the common part which of should be found. +- Activate the corresponding check-box if you wish to Detect Self-intersections +- Activate \ref restore_presentation_parameters_page "Advanced options" if required. +- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object). -\image html bool2.png "Common dialog" -\note This algorithm doesn't find all types of self-intersections. It is tuned +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". + + +This operation can be performed using a TUI Command: + +geompy.MakeCommonList(theShapesList, checkSelfInte) + +Arguments: Name + a list of shapes + an optional flag for self-intersection check. + +There is also a special TUI Command for the Common operation on two shapes : -For a particular case with two shapes for the Common operation there is the following TUI command: +geompy.MakeCommon(s1, s2, checkSelfInte) -TUI Command: geompy.MakeCommon(s1, s2, checkSelfInte)\n Arguments: Name + 2 shapes + an optional flag for self-intersection check. Example: @@ -38,8 +47,7 @@ Our TUI Scripts provide you with useful examples of the use of More details -For a detailed description of the Boolean operations please refer to -this document. +Please, refer to this document for a detailed description of Boolean operations. It provides a general review of the Partition and Boolean operations algorithms, describes the usage methodology and highlights major limitations of these operations. diff --git a/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc b/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc index 468be8824..8c5430232 100644 --- a/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc +++ b/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc @@ -54,32 +54,30 @@ BiNormal direction to perform the extrusion. \image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter" -\n Third, to create a shape by extrusion of the profile shapes along the path shape, -you can define the Base Objects (edges, planar wires, faces or shells), which will be extruded, -the Locations (vertices that specify locations on the Path Object corresponding to the -specified Base Objects; list of the Locations should be either empty or of the same -length as list of Base Objects) and the Path Object (edge or wire) along which the -Base Object will be extruded. +\n Thirdly, it is possible to additionally select profiles of the pipe object to be built. For this, you can define the following parameters: +- Base Object or a list of objects (edges, planar wires, faces or shells), which will be extruded; +- Locations - a vertex or a list of vertices that specify the locations of extruded Base Objects on the resulting Path Object. The number of Base Objects should be equal to the number of Locations. +- Path Object (edge or wire), along which the Base Object will be extruded. Additional controls: -- With contact checkbox - if checked, the section is translated to be in contact with the spine. -- With correction checkbox - if checked, the section is rotated to be orthogonal to the spine +- If With contact is checked, the section is translated in contact with the spine. +- If With correction is checked, the section is rotated to be orthogonal to the spine tangent in the corresponding point. -\n The \b Result of the operation will be a GEOM_Object (shell or solid). +\n The \b Result of the operation will be a shell or a solid. \n TUI Command: geompy.MakePipeWithDifferentSections(baseShape, locations, pathShape, withContact, withCorrection) \n Arguments: Name + list of shapes (edges, planar wires, faces or shells) serving as base object + list of locations (vertices) on the path corresponding specified list of the shapes + 1 shape (edge or wire) for definition of the path + -2 bool parameters (withContact, withCorrection). +2 Boolean parameters (withContact, withCorrection). \n Advanced options \ref preview_anchor "Preview" \image html pipe3.png Example: -\image html pipe3_init.png "Initial objects" +\image html pipe3_init.png "Base objects and Location vertices" \image html pipe3_res.png "Extrusion of the profile shapes along the path shape" diff --git a/doc/salome/gui/GEOM/input/creating_isoline.doc b/doc/salome/gui/GEOM/input/creating_isoline.doc index 2aac337f1..c69418547 100644 --- a/doc/salome/gui/GEOM/input/creating_isoline.doc +++ b/doc/salome/gui/GEOM/input/creating_isoline.doc @@ -2,21 +2,30 @@ \page create_isoline_page Isoline -To create an \b Isoline in the Main Menu select New Entity - > -Basic - > Isoline +\b Isoline is a 3D curve built on a bounded face limited by [Umin, Umax] and [Vmin, Vmax] +values of U and V parameters. For all points of the isoline U or V parameter value is constant. -\n The \b Result of this operation will be a GEOM_Object. -It may be either an edge or a compound of several edges. - -\n You can define an Isoline by a \b Face, \b Type and \b Parameter. -\n TUI Command: geompy.MakeIsoline(theFace, IsUIsoline, theParameter) -\n Arguments: Name + Face + Type (True for U-Isoline; False for V-Isoline) + Parameter. +To create an \b Isoline of a face in the Main Menu select New Entity - > Basic - > Isoline. \image html isoline1.png +In this dialog: +- Input or accept the default \b Name of the resulting shape. +- Click the arrow button and select in the Object Browser or in the Viewer the \b Face, for which the Isoline is built. +- Select along which coordinate: \b U-Isoline or \b V-Isoline the Isoline is built; +- Set \b Parameter (ranging from 0 to 1), which defines the proportion, at which a face is divided by the isoline. +If Parameter=0.5, the isoline is a median. +- Press "Apply" or "Apply & Close" button to get the result (an edge or a compound of several edges). + +This operation can be performed using a TUI Command: + +geompy.MakeIsoline(theFace, IsUIsoline, theParameter) + +Arguments: Name + Face + Type (True for U-Isoline; False for V-Isoline) + Parameter. + Example: -\image html isoline2.png "Isoline on face" +\image html isoline2.png "Isoline on a rectangle face" Our TUI Scripts provide you with useful examples of creation of \ref tui_creation_curve "Basic Geometric Objects". diff --git a/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc b/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc index 5f899eef4..a4b42cee3 100644 --- a/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc +++ b/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc @@ -1,18 +1,15 @@ /*! -\page create_smoothingsurface_page SmoothingSurface +\page create_smoothingsurface_page Smoothing Surface -To create a \b SmoothingSurface in the Main Menu select New Entity - > +To create a Smoothing Surface in the Main Menu select New Entity - > Advanced - > SmoothingSurface -Specify the parameters of the SmoothingSurface object creation in the opened dialog -box and press "Apply" or "Apply & Close" button. -Result of each operation will be a GEOM_Object. +Specify the \b Name of the surface and the list of \b Points, from which it is approximated and press "Apply" or "Apply & Close" button. -TUI Command: geompy.MakeSmoothingSurface(lPoints) +The result of the operation will be a GEOM_Object(Surface). -Arguments: -- \b Points - list of points +TUI Command: geompy.MakeSmoothingSurface(Points) \image html smoothingsurface_dlg.png diff --git a/doc/salome/gui/GEOM/input/cut_operation.doc b/doc/salome/gui/GEOM/input/cut_operation.doc index f4050a318..30235d6de 100644 --- a/doc/salome/gui/GEOM/input/cut_operation.doc +++ b/doc/salome/gui/GEOM/input/cut_operation.doc @@ -2,29 +2,37 @@ \page cut_operation_page Cut -To produce a \b Cut operation in the Main Menu select Operations - > Boolean - > Cut +\b Cut operation cuts a shape with a list of other shapes. -This operation cuts a shape with a list of other shapes. - -The \b Result will be a \b GEOM_Object. - -TUI Command: geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte)\n -Arguments: Name + a main shape + a list of other shapes + an optional flag for self-intersection check.\n -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +To produce it, select in the main menu Operations - > Boolean - > Cut \image html bool3.png "Cut dialog" -\note This algorithm doesn't find all types of self-intersections. It is tuned +In this dialog: +- Input or accept the default \b Name of the resulting shape. +- Click the arrow button and select in the Object Browser or in the Viewer the Main Object, which will be cut by tool objects. +- Select the Tool objects, which will cut the main object. +- Activate the corresponding check-box if you wish to Detect Self-intersections . +- Activate \ref restore_presentation_parameters_page "Advanced options" if required. +- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object). + +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". -For a particular case with two shapes (object and tool) for the Cut operation there is the following TUI command: +This operation can be performed using a TUI Command: + +geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte) + +Arguments: Name + a main shape + a list of other shapes + an optional flag for self-intersection check. + +There is also a special TUI Command: for the Cut operation on two shapes (object and tool) : + +geompy.MakeCut(s1, s2, checkSelfInte) -TUI Command: geompy.MakeCut(s1, s2, checkSelfInte)\n Arguments: Name + the object + the tool + an optional flag for self-intersection check. Example: @@ -38,8 +46,7 @@ Our TUI Scripts provide you with useful examples of the use of More details -For a detailed description of the Boolean operations please refer to -this document. +Please refer to this document for a detailed description of Boolean operations. It provides a general review of the Partition and Boolean operations algorithms, describes the usage methodology and highlights major limitations of these operations. diff --git a/doc/salome/gui/GEOM/input/export_xao.doc b/doc/salome/gui/GEOM/input/export_xao.doc deleted file mode 100644 index 5d1748f66..000000000 --- a/doc/salome/gui/GEOM/input/export_xao.doc +++ /dev/null @@ -1,21 +0,0 @@ -/*! - -\page export_xao_page Export XAO - -To export a shape in the \b XAO format, in the Main Menu select New Entity -> -Import / Export -> Export XAO - -Specify the parameters of the Export XAO dialog box and press "Apply" or "Apply & Close" button. - - -TUI Command: geompy.MakeExportXAO(Shape, FileName, Groups, Fields) - -Arguments: -- \b Shape - The shape to export -- \b FileName - The name of the file to create -- \b Groups - The list of groups to export -- \b Fields - The list of fields to export - -\image html exportxao_dlg.png - -*/ diff --git a/doc/salome/gui/GEOM/input/fuse_operation.doc b/doc/salome/gui/GEOM/input/fuse_operation.doc index a2779fb00..95dc6ce06 100644 --- a/doc/salome/gui/GEOM/input/fuse_operation.doc +++ b/doc/salome/gui/GEOM/input/fuse_operation.doc @@ -2,30 +2,36 @@ \page fuse_operation_page Fuse -To produce a \b Fuse operation in the Main Menu select -Operations - > Boolean - > Fuse. +\b Fuse operation creates one shape from a list of shapes. -This operation creates one shape from a list of shapes. - -The \b Result will be a \b GEOM_Object. - -TUI Command: geompy.MakeFuseList(theShapesList, checkSelfInte)\n -Arguments: Name + a list of shapes + an optional flag for self-intersection check.\n -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +To produce it, select in the Main Menu Operations - > Boolean - > Fuse. \image html bool1.png "Fuse dialog" -\note This algorithm doesn't find all types of self-intersections. It is tuned +In this dialog: +- Input or accept the default \b Name of the resulting shape. +- Click the arrow button and select in the Object Browser or in the Viewer the Objects to be fused. +- Activate the corresponding check-box if you wish to Detect Self-intersections . +- Activate \ref restore_presentation_parameters_page "Advanced options" if required. +- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object). + +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". + +This operation can be performed using a TUI Command: + +geompy.MakeFuseList(theShapesList, checkSelfInte) -For a particular case with two shapes to be fused there is the following TUI command: +Arguments: Name + a list of shapes + an optional flag for self-intersection check. + +There is also a special TUI Command for \b Fuse operation on two shapes : + +geompy.MakeFuse(s1, s2, checkSelfInte) -TUI Command: geompy.MakeFuse(s1, s2, checkSelfInte)\n Arguments: Name + 2 shapes + an optional flag for self-intersection check. Example: @@ -38,13 +44,13 @@ Our TUI Scripts provide you with useful examples of the use of \ref tui_fuse "Boolean Operations". More details -
    -
  • For a detailed description of the Boolean operations please refer to -this document. + +Please, refer to this document for a detailed description of Boolean operations. + It provides a general review of the Partition and Boolean operations algorithms, describes the usage methodology and highlights -major limitations of these operations.
    • -
  • Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"
    • -
+major limitations of these operations. + +Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?" */ diff --git a/doc/salome/gui/GEOM/input/geometry_preferences.doc b/doc/salome/gui/GEOM/input/geometry_preferences.doc index 81090266a..bfce50129 100644 --- a/doc/salome/gui/GEOM/input/geometry_preferences.doc +++ b/doc/salome/gui/GEOM/input/geometry_preferences.doc @@ -44,32 +44,32 @@ predefined materials.
  • Isolines width - allows to define default width of the isolines.
  • Preview edges width - allows to define width of the edges for preview.
  • Measures line width - allows to define lines width of measurements tools.
    • -
  • Automatic bring to front - when option is ON: the objects selected by the user will be automatically -made "top-level".
    • +
  • Automatic bring to front - when the option is on, the objects selected by the user automatically become "top-level".
      • -
    • Number of isolines
      • - this submenu allows to specify the -number of isolines along the axes of coordinates: -
        -
      • Along U -
      • Along V -
      +
    • Number of isolines - allows to specify the number of isolines along Along U and Along V coordinate axes. They are shown on each selected face. For example: + +\image html isos.png + +This preference is not related with Create Isoline operation. +By default Along U and Along V are null and isolines are not drawn.
      • +
    • Input fields precision
        • -
      • Length precision - allows to ajust input precision of coordinates and dimensions.
        • -
      • Angular precision - allows to ajust input precision of angles.
        • -
      • Length tolerance precision - allows to ajust input precision of tolerance of coordinates and dimensions.
        • -
      • Angular tolerance precision - allows to ajust input precision of tolerance of angles.
        • -
      • Weight precision - allows to ajust input precision of weight and mass.
        • -
      • Density precision - allows to ajust input precision of density.
        • -
      • Parametric precision - allows to ajust input precision of parametric values.
        • -
      • Parametric tolerance precision - allows to ajust input precision of tolerance in parametric space.
        • +
      • Length precision - allows to adjust input precision of coordinates and dimensions.
        • +
      • Angular precision - allows to adjust input precision of angles.
        • +
      • Length tolerance precision - allows to adjust input precision of tolerance of coordinates and dimensions.
        • +
      • Angular tolerance precision - allows to adjust input precision of tolerance of angles.
        • +
      • Weight precision - allows to adjust input precision of weight and mass.
        • +
      • Density precision - allows to a just input precision of density.
        • +
      • Parametric precision - allows to adjust input precision of parametric values.
        • +
      • Parametric tolerance precision - allows to adjust input precision of tolerance in parametric space.
    diff --git a/doc/salome/gui/GEOM/input/import_export.doc b/doc/salome/gui/GEOM/input/import_export.doc index 775be618f..ccc5c6a7e 100644 --- a/doc/salome/gui/GEOM/input/import_export.doc +++ b/doc/salome/gui/GEOM/input/import_export.doc @@ -8,6 +8,8 @@ are implemented via plug-ins, which gives the opportunity to expand the range of available formats by adding more plug-ins (for example, CATIA 5). +The \subpage xao_format_page "import and export of shapes in XAO format" is implemented differently. + To import geometrical objects from a BREP, IGES, STEP, ACIS or STL file: \par diff --git a/doc/salome/gui/GEOM/input/import_xao.doc b/doc/salome/gui/GEOM/input/import_xao.doc deleted file mode 100644 index 58ddfd11e..000000000 --- a/doc/salome/gui/GEOM/input/import_xao.doc +++ /dev/null @@ -1,8 +0,0 @@ -/*! - -\page import_xao_page Import XAO - -To import a shape in the \b XAO format, in the Main Menu select New Entity -> -Import / Export -> Import XAO - -*/ diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc index 7a9035091..820250c2b 100644 --- a/doc/salome/gui/GEOM/input/index.doc +++ b/doc/salome/gui/GEOM/input/index.doc @@ -14,17 +14,14 @@ - \subpage transform_geom_obj_page "transformation of geometrical objects" using various algorithms; - \subpage repairing_operations_page "optimization of geometrical objects"; -- viewing \subpage geometrical_obj_prop_page "geometrical object properties" - and other information about geometrical objects using +- viewing information about geometrical objects using \subpage using_measurement_tools_page "measurement tools"; - \subpage pictures_page "designing shapes from pictures"; -- easily setting parameters via the variables predefined in - \subpage using_notebook_geom_page "SALOME notebook". - -The possibility to classify the created geometrical objects by moving it into early created container (folder) is detailed on -\subpage arranging_study_objects_page section. -XAO format describing a shape with its topology, groups and fields is detailed on \subpage xao_format_page section. +It is possible to easily set parameters via the variables predefined in + \subpage using_notebook_geom_page "SALOME notebook". +Also, there is a possibility to customize an +\subpage arranging_study_objects_page "arrangement of the geometrical objects in the SALOME study." Geometry module preferences are described in the \subpage geometry_preferences_page section of SALOME Geometry Help. diff --git a/doc/salome/gui/GEOM/input/material.doc b/doc/salome/gui/GEOM/input/material.doc index 59a022351..d67becaaa 100644 --- a/doc/salome/gui/GEOM/input/material.doc +++ b/doc/salome/gui/GEOM/input/material.doc @@ -1,6 +1,6 @@ /*! -\page material_page Material properties +\page material_page Material
    • \ref material_general_description_anchor "General Description"
      • @@ -16,12 +16,11 @@ be changed in the future versions of SALOME Geometry module. You can change the material properties of the selected shape(s) in -the dedicated dialog box. This dialog box can be invoked from the -context popup menu. The layout of context menu can be customized via +the context menu dialog. The layout of context menu can be customized via "Show predefined materials in popup menu" preferences option. If this option is switched off, only "Material properties" item will be shown in the popup menu. If this option is on (by default), "Material -properties" item in the popup menu will open a submenu with list of predefined +properties" item in the popup menu will open a sub-menu with a list of predefined materials: \image html hide_predef_material.png @@ -44,9 +43,9 @@ the materials is different: - shape presentation in OCC and VTK viewers is not fully identical; - some material attributes can affect the presentation in a different way. -\anchor material_opengl_model_anchor

      OpenGL ligthing model

      +\anchor material_opengl_model_anchor

      OpenGL lighting model

      -The material is specifed by several attributes of the lighting +The material is specified by several attributes of the lighting model. More details can be found in the documentation related to the OpenGL programming, for example, here: http://www.glprogramming.com/red/chapter05.html. @@ -54,7 +53,7 @@ In the OpenGL lighting model, the light in a scene comes from several light sources; the light sources have an effect only when there are surfaces that absorb and reflect light. Each surface is assumed to be composed of a material with various properties. A material might emit -its own light (like headlights on an automobile), it might scatter +its own light (like headlights of a vehicle), it might scatter some incoming light in all directions, and it might reflect a portion of the incoming light in a preferential direction like a mirror or other shiny surface. @@ -120,7 +119,7 @@ predefined and custom. models are specified by the user and can be modified at any moment. -
    • The widgets to the right allow modifyng different properties of the material model: +
    • The widgets to the right allow modifying different properties of the material model: - \b Ambient color and coefficient (floating point value between 0 and 1) - \b Diffuse color and coefficient (floating point value between 0 and 1) - \b Specular color and coefficient (floating point value between 0 and 1) @@ -143,7 +142,7 @@ to change the name of material model.
      • \image html material.png In addition to the functionality of Materials library, this -dialog provides objects selection mechanizm and \b Color property. +dialog provides objects selection mechanism and \b Color property. If the material model is specified as a \em physical (\em Gold, for example), the shape color (more precisely its \em ambient color) @@ -151,7 +150,7 @@ cannot be modified. If you assign a physical material model to the shape, the "Color" menu item will not be available in the popup menu. If the model is non-physical (\em artificial), the color can be changed -to any appopriate one, only other attributes will be constant. In the +to any appropriate one, only other attributes will be constant. In the dialog box you will be able to modify the color of the shape via the "Color" button. "Ambient color" button will be disabled to signalize that this attribute of the model is ignored. Also, it will be possible diff --git a/doc/salome/gui/GEOM/input/partition.doc b/doc/salome/gui/GEOM/input/partition.doc index 13b09a791..30ac52bbe 100644 --- a/doc/salome/gui/GEOM/input/partition.doc +++ b/doc/salome/gui/GEOM/input/partition.doc @@ -2,15 +2,11 @@ \page partition_page Partition -
        -
      • For a detailed 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 highlights -major limitations of these operations.
        • - -
      • Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"
        • -
      +For a detailed 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 highlights +major limitations of these operations. + +Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?" To produce a \b Partition in the Main Menu select Operations - > Partition @@ -28,7 +24,7 @@ Resulting Type of shape. As far as the intersection of two objects can produce any type of geometrical objects, Resulting type box allows choosing the -preferrable result, i.e. a solid, a shell, a list of faces, etc. +preferable result, i.e. a solid, a shell, a list of faces, etc. The Resulting type has to be equal or lower than the type of the \em Objects. In other words, if the \em Objects don't contain any @@ -47,28 +43,27 @@ face (there will be a hole in the resulting face, where the original face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below). No sub-shapes intersection (Compounds only) check box affects -only input shapes of the Compound type. If this option is switched off (default -behavior) each input compound will be automatically exploded into -sub-shapes and the intersection between these shapes will be also -computed. If this option is switched on, the intersection between -sub-shapes will not be performed. In this case the Partition algorithm -will work faster, but the result might differ from the default behavior. - -Detect Self-intersections check box is used to check arguments -self-intersections. If this option is switched on (default behavior) -each input shape is checked for self-intersection. In case of its detection -the operation is aborted. If this option is switched off, the partition -algorithm is performed without self-intersection checks. - -\note This algorithm doesn't find all types of self-intersections. It is tuned +only input shapes of the Compound type. +- If this option is switched off (default behavior) each input compound will be automatically +exploded into sub-shapes and the intersection between these shapes will be also computed. +- If this option is switched on, the intersection between sub-shapes will not be performed. +In this case the Partition algorithm will work faster, but the result might differ from the +default behavior. + +Detect Self-intersections check box is used to check self-intersection of arguments. +- If this option is switched on (by default), each input shape is checked for self-intersection. +If self-intersection is detected, the operation is aborted. +- If this option is switched off, the partition algorithm is performed without self-intersection +checks. + +\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 please use \ref check_self_intersections_page "Detect Self-intersection tool". - Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +- Activate \ref restore_presentation_parameters_page "Advanced options" if required. \note Partition is a complex operation, so its result of it depends on the quality of the initial shapes. Sometimes, if partition fails, @@ -95,7 +90,7 @@ Here, - \em Limit is a Type of resulting shapes - \em KeepNonlimitShapes is a flag that allows to preserve standalone shapes of low dimension (than \em Limit) in the result. -- \em checkSelfInte is a flag that tells if the arguments should +- \em checkSelfInte is a flag that indicates if the arguments should be checked for self-intersection prior to the operation. - Other parameters are obsolete and kept only for compatibility with previous versions of SALOME. @@ -106,15 +101,14 @@ previous versions of SALOME. Arguments: Name + 1 shape to be intersected + 1 cutting plane. -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +Activate \ref restore_presentation_parameters_page "Advanced options" if required. TUI Command: geompy.MakeHalfPartition(Shape, Plane, checkSelfInte), where: - \em Shape is a source shape to be intersected by the \em Plane - \em Plane is a tool shape, to intersect the \em Shape. -- \em checkSelfInte is a flag that tells if the arguments should +- \em checkSelfInte is a flag that indicates if the arguments should be checked for self-intersection prior to the operation. Examples: diff --git a/doc/salome/gui/GEOM/input/remove_webs_operation.doc b/doc/salome/gui/GEOM/input/remove_webs_operation.doc index 8c91ae20b..26ab2efb1 100644 --- a/doc/salome/gui/GEOM/input/remove_webs_operation.doc +++ b/doc/salome/gui/GEOM/input/remove_webs_operation.doc @@ -6,7 +6,7 @@ Repair - > Remove internal faces. \n This operation removes all shared faces from a compound to obtain -one or more bigger solids from the set of smaller solids. +one or more bigger solids from a set of smaller solids. \image html remove_webs.png @@ -15,8 +15,8 @@ one or more bigger solids from the set of smaller solids. \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". \note Only shared faces will be removed. Coincident but not shared -faces will stay as is, use GlueFaces or MakePartition before -RemoveInternalFaces if you need to remove them. +faces will stay as is, use Glue Faces or Partition before +Remove Internal Faces if you need to remove them. \n TUI Command: geompy.RemoveInternalFaces(theCompound), where theCompound is a compound of solids. diff --git a/doc/salome/gui/GEOM/input/repairing_operations.doc b/doc/salome/gui/GEOM/input/repairing_operations.doc index 4cbb1ed1b..d0559d764 100644 --- a/doc/salome/gui/GEOM/input/repairing_operations.doc +++ b/doc/salome/gui/GEOM/input/repairing_operations.doc @@ -26,15 +26,15 @@ splits an edge in two.
    • \subpage change_orientation_operation_page "Change orientation" - reverses the normals of the selected faces.
    • \subpage remove_webs_operation_page "Remove internal faces" - -rebuilds the topology of a compound of solids by removing of the faces -that are shared by several solids.
      • +rebuilds the topology of a compound of solids by removing the faces +are shared by several solids.
    • \subpage remove_extra_edges_operation_page "Remove extra edges" - removes seam and degenerated edges from the given shape.
    • \subpage fuse_edges_operation_page "Fuse Collinear Edges within a Wire" - removes selected vertices from a given wire in case if adjacent edges are C1 continuous.
    • \subpage union_faces_operation_page "Union faces" - -unites all faces sharing one surface on a given shape.
      • +unites on a given shape all faces sharing the same surface.
    */ diff --git a/doc/salome/gui/GEOM/input/section_operation.doc b/doc/salome/gui/GEOM/input/section_operation.doc index b5909be83..0b741eed4 100644 --- a/doc/salome/gui/GEOM/input/section_operation.doc +++ b/doc/salome/gui/GEOM/input/section_operation.doc @@ -2,26 +2,31 @@ \page section_opeartion_page Section -To produce a \b Section operation in the Main Menu select -Operations - > Boolean - > Section +\b Section operation creates an edge or a wire representing the intersection of surfaces of two shapes. -This operation creates the section between 2 shapes. - -The \b Result will be any \b GEOM_Object (EDGE or WIRE). - -TUI Command: geompy.MakeSection(s1, s2, checkSelfInte)\n -Arguments: Name + 2 shapes + an optional flag for self-intersection check.\n -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +To produce it, select in the main menu Operations - > Boolean - > Section \image html neo-section.png "Section dialog" -\note This algorithm doesn't find all types of self-intersections. It is tuned +In this dialog: +- Input or accept the default \b Name of the resulting shape. +- Click the arrow button and select in the Object Browser or in the Viewer the intersecting Objects. +- Activate the corresponding check-box if you wish to Detect Self-intersections . +- Activate \ref restore_presentation_parameters_page "Advanced options" if required. +- Press "Apply" or "Apply & Close" button to get the result (EDGE or WIRE). + +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". + +This operation can be performed using a TUI Command: + +geompy.MakeSection(s1, s2, checkSelfInte) + +Arguments: Name + 2 shapes + an optional flag for self-intersection check. Example: @@ -34,8 +39,7 @@ Our TUI Scripts provide you with useful examples of the use of More details -For a detailed description of the Boolean operations please refer to -this document. +Please refer to this document for a detailed description of Boolean operations. It provides a general review of the Partition and Boolean operations algorithms, describes the usage methodology and highlights major limitations of these operations. diff --git a/doc/salome/gui/GEOM/input/sewing_operation.doc b/doc/salome/gui/GEOM/input/sewing_operation.doc index 2af3989cd..18d95e881 100644 --- a/doc/salome/gui/GEOM/input/sewing_operation.doc +++ b/doc/salome/gui/GEOM/input/sewing_operation.doc @@ -2,26 +2,28 @@ \page sewing_operation_page Sewing -\n To produce a \b Sewing operation in the Main Menu select Repair - > Sewing. +To produce a \b Sewing operation in the Main Menu select Repair - > Sewing. -\n It is possible to sew only compounds of faces or shells. +The \b Result will be a \b GEOM_Object. -\n The \b Result will be a \b GEOM_Object. +\image html repair6.png -\n TUI Command: geompy.MakeSewing(ListOfShape, Precision, AllowNonManifold=False), - where \em ListOfShape is list of faces or shells to be sewed, \em Precision is a -precision for sewing, \em AllowNonManifold flag that allows non-manifold sewing. +In this dialog: +- Click on the "Arrow" button and select in the Object Browser or in the viewer one or more \b Shapes (faces or shells) to be sewn. +- Activate Allow Non Manifold check-box to produce non-manifold sewing, if required. +- Define precision for sewing in \b Tolerance field. +- Activate Detect Free boundaries button to display the number of free boundaries in the shape: +\image html neo-detect2.png +- Click \b Apply or Apply and Close button. -\image html repair6.png +This operation can be also launched using a TUI Command: -\n Arguments: Name + 1 or more shapes + 1 value (sew -precision). -\n \b Detect button allows to display the number of free boundaries in -your shape: +geompy.MakeSewing(ListOfShape, Precision, AllowNonManifold=False), -\image html neo-detect2.png +where \em ListOfShape is a list of faces or shells to be sewn, \em Precision is a +precision for sewing, \em AllowNonManifold is a flag that allows non-manifold sewing. -\n Example: +Example: \image html image112.png "The initial faces" diff --git a/doc/salome/gui/GEOM/input/union_faces_operation.doc b/doc/salome/gui/GEOM/input/union_faces_operation.doc index 65cbd4307..802f2213e 100755 --- a/doc/salome/gui/GEOM/input/union_faces_operation.doc +++ b/doc/salome/gui/GEOM/input/union_faces_operation.doc @@ -2,20 +2,21 @@ \page union_faces_operation_page Union Faces -\n To Union Faces in the Main Menu select -Repair - > Union Faces. -\n This operation unites all faces sharing one surface on a given -shape. +This operation unites on a given shape all faces sharing the same surface. -\n TUI Command: geompy.UnionFaces(theShape), -where theShape is a compound or a single solid. -\n Arguments: Name + one shape + a flag. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +To Union Faces in the Main Menu select Repair - > Union Faces. \image html union_faces.png -\n Example: +In this dialog: +- Click on the "Arrow" button and select in the Object Browser or in the viewer one or more \b Shapes (compounds or single solids). +- If necessary, activate \ref restore_presentation_parameters_page "Advanced Transformation Options". +- Click \b Apply or Apply and Close button. + +This operation can be also launched using a TUI Command: geompy.UnionFaces(theShape), +where theShape is a compound or a single solid. + +Example: \image html union_faces1.png
    Shape with not united faces
    diff --git a/doc/salome/gui/GEOM/input/using_boolean_operations.doc b/doc/salome/gui/GEOM/input/using_boolean_operations.doc index 26b90020e..74acd1e8b 100644 --- a/doc/salome/gui/GEOM/input/using_boolean_operations.doc +++ b/doc/salome/gui/GEOM/input/using_boolean_operations.doc @@ -2,10 +2,10 @@ \page using_boolean_operations_page Boolean Operations -For detail description of the Boolean operations please refer to +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 highlighs +operations algorithms, describes the usage methodology and highlights major limitations of these operations. You can use the following boolean operations for construction of more @@ -44,7 +44,7 @@ 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). @@ -60,17 +60,17 @@ argument and \em Shape2 is the second argument of Common 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 tells whether arguments should be checked for -self-intersection prior to an operation. Its default value is \em False which +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 these shapes are +an operation is performed on not self-intersected shapes as they are not valid for boolean operations. -\note This algorithm doesn't find all types of self-intersections. It is tuned +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". Our TUI Scripts provide you with useful examples of the use of diff --git a/doc/salome/gui/GEOM/input/using_measurement_tools.doc b/doc/salome/gui/GEOM/input/using_measurement_tools.doc index 513f6077f..238b12a08 100644 --- a/doc/salome/gui/GEOM/input/using_measurement_tools.doc +++ b/doc/salome/gui/GEOM/input/using_measurement_tools.doc @@ -1,9 +1,10 @@ /*! -\page using_measurement_tools_page Measuring objects properties +\page using_measurement_tools_page Object properties -\n Measurement tools in GEOM are necessary for getting different data -concerning created or imported geometrical objects : +\n The key property of an object is its \subpage geometrical_obj_prop_page "Geometrical Type" + +\n There are also various Measurement tools for getting data about created or imported geometrical objects :
    • \subpage point_coordinates_page "Point coordinates"
      • diff --git a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc index a5882fcfb..774dbaac2 100644 --- a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc +++ b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc @@ -101,10 +101,9 @@ and then displays only the children of the selected object(s). Switch the checkbox near the appropriate object and click Publish or Publish And Close button. - "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. All - unpublished objects are by default sorted by the name in ascending order. It is possible - to change order of sorting (ascending / descending) by clicking the corresponding title - bar of the objects list. + "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all + unpublished objects are sorted by name in ascending order. It is possible + to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
    @@ -115,8 +114,7 @@ window providing some information on a selected geometric object: - Creation operation shows a name of the operation used to create the selected object. -- In a table under Creation operation, \b Parameter and \b -Value are a name and a value of a parameter used to create the -selected object. +- The table below lists \b Parameters used to create the +selected object and their \b Values. */ diff --git a/doc/salome/gui/GEOM/input/xao_format.doc b/doc/salome/gui/GEOM/input/xao_format.doc index b5c60a92d..00d810973 100644 --- a/doc/salome/gui/GEOM/input/xao_format.doc +++ b/doc/salome/gui/GEOM/input/xao_format.doc @@ -1,10 +1,24 @@ /*! -\page xao_format_page The XAO format +\page xao_format_page Import and export of shapes in XAO format XAO is a file format which describes a shape with its topology, groups and fields. -- \subpage export_xao_page "Export" -- \subpage import_xao_page "Import" +To import a shape in the \b XAO format, in the Main Menu select New Entity -> +Import / Export -> Import XAO. + +To export a shape in the \b XAO format, in the Main Menu select New Entity -> +Import / Export -> Export XAO. + +\image html exportxao_dlg.png + +In this dialog: +- Click the arrow button and select in the Object Browser or in the Viewer the Shape to be exported. +- Input the File name to create a new file or click browse button to save in an existing file. +- Select the \b Groups of the chosen shape to be exported. +- Select the \b Fields of the chosen shape to be exported. +- Press "Apply" or "Apply & Close" button to get the result. + +It also possible to export a shape using the TUI Command: geompy.MakeExportXAO(Shape, FileName, Groups, Fields) */ -- 2.39.2