From: vsr Date: Thu, 12 Dec 2013 13:54:19 +0000 (+0000) Subject: Update documentation X-Git-Tag: V7_3_0~4 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=4dea5a1c19a11ee548f5a230ebca79851d6c2f50;p=modules%2Fgeom.git Update documentation --- diff --git a/doc/salome/gui/GEOM/images/isos.png b/doc/salome/gui/GEOM/images/isos.png new file mode 100644 index 000000000..86433e164 Binary files /dev/null and b/doc/salome/gui/GEOM/images/isos.png differ 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 - +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".
    • 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 */ 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 : @@ -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) */