From ad77350eea51e0ece7ad58938adbb4073ef2aeab Mon Sep 17 00:00:00 2001 From: maintenance team Date: Mon, 22 Jun 2009 12:47:01 +0000 Subject: [PATCH] Update GEOM GUI documentation --- .../gui/GEOM/input/creating_ellipse.doc | 4 ++-- doc/salome/gui/GEOM/input/creating_plane.doc | 4 ++-- doc/salome/gui/GEOM/input/creating_wire.doc | 7 ++++--- doc/salome/gui/GEOM/input/import_export.doc | 20 +++++++++---------- .../input/remove_extra_edges_operation.doc | 8 ++++---- 5 files changed, 22 insertions(+), 21 deletions(-) diff --git a/doc/salome/gui/GEOM/input/creating_ellipse.doc b/doc/salome/gui/GEOM/input/creating_ellipse.doc index b2dace591..8f67658bb 100644 --- a/doc/salome/gui/GEOM/input/creating_ellipse.doc +++ b/doc/salome/gui/GEOM/input/creating_ellipse.doc @@ -16,8 +16,8 @@ corresponds to the OZ axis of the global coordinate system and Major Axis corresponds to the OX axis of the global coordinate system. -\note Actual direction of the major axis vector is defined as - Vmaj' = (Vn * Vmaj) * Vn where \em Vn is a normal vector and +\note The actual direction of the major axis vector is defined as + Vmaj' = (Vn * Vmaj) * Vn, where \em Vn is a normal vector and \em Vmaj is an original vector of the major axis. \n TUI Command (no major axis): geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor) diff --git a/doc/salome/gui/GEOM/input/creating_plane.doc b/doc/salome/gui/GEOM/input/creating_plane.doc index 518d64867..5573f61e4 100644 --- a/doc/salome/gui/GEOM/input/creating_plane.doc +++ b/doc/salome/gui/GEOM/input/creating_plane.doc @@ -26,13 +26,13 @@ of the plane). \image html plane2.png -\n Also, you can define a \b Plane by another \b Plane or Face and a Size of the Plane. +\n Thirdly, you can define a \b Plane by another \b Plane or Face and a Size of the Plane. \n TUI Command: geompy.MakePlaneFace(Face, TrimSize) \n Arguments: Name + 1 face + 1 value (to define the size of the plane). \image html plane3.png -\n Also, you can define a \b Plane by two Vectors. The first vector defines the center point and the direction, +\n Fourthly, you can define a \b Plane by two Vectors. The first vector defines the center point and the direction, the second vector defines the normal to the Plane. \n TUI Command: geompy.MakePlane2Vec(Vec1, Vec2, TrimSize) \n Arguments: Name + 2 vectors + 1 value (to define the size of the plane). diff --git a/doc/salome/gui/GEOM/input/creating_wire.doc b/doc/salome/gui/GEOM/input/creating_wire.doc index 1443599cd..52357774e 100644 --- a/doc/salome/gui/GEOM/input/creating_wire.doc +++ b/doc/salome/gui/GEOM/input/creating_wire.doc @@ -6,9 +6,10 @@ \n You can create a \b Wire from several connected edges and wires by selecting them in the object browser or in the viewer holding Shift -button. Select \b Tolerance which will be used to check -connections. If you use \b Tolerance more than 1e-07, and gap, -covered by this tolerance, is detected, edges will be modified to +button. +\n Select \b Tolerance which will be used to check the +connections. If the \b Tolerance value is more than 1e-07, and a gap +within this tolerance is detected, the corresponding edges will be modified to connect in the middle of the gap. \n The \b Result will be a \b GEOM_Object (WIRE). diff --git a/doc/salome/gui/GEOM/input/import_export.doc b/doc/salome/gui/GEOM/input/import_export.doc index 300650bf3..cedbe93d6 100644 --- a/doc/salome/gui/GEOM/input/import_export.doc +++ b/doc/salome/gui/GEOM/input/import_export.doc @@ -4,7 +4,7 @@ In Geometry module you can import and export geometrical objects from/into BREP, IGES, STEP files. The mechanisms of import and export -are implemented via plug-ins, which gives you the opportunity to +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). @@ -22,23 +22,23 @@ Select the required file and click \b Open. Your file will be imported in the module and its contents (geometrical object) will be displayed in the Object Browser. -\note If type of selected file is IGES and length unit in this file is not -equal to meter following question will be offer to user: - +\note If the selected file is in IGES format and the length is not +expressed in meters, it will be sussested to scale the model into the +metric system: +y types (solid, face, edge and +vertex) for all named shapes \image html iges_unit.png \par -If answer is Yes result will be scaled from file unit to meter. -\note If type of selected file is ACIS (optionally - for users with -special license) and this file contains names for some shapes -following question will be offer to user: +\note If the selected file is in ACIS format (the use of this format +requires licensing) and the file contains names for some shapes, it +will be suggested to create groups by types (solid, face, edge and +vertex) for all named shapes: \image html sat_named_shapes.png \par -If answer is Yes needed groups by types (solid, face, edge and -vertex) for all named shapes will be created. \note It is possible to re-open from the initial file a previously imported shape if the file has been changed on disk. For this, select diff --git a/doc/salome/gui/GEOM/input/remove_extra_edges_operation.doc b/doc/salome/gui/GEOM/input/remove_extra_edges_operation.doc index 9b4a32d36..401e200c3 100644 --- a/doc/salome/gui/GEOM/input/remove_extra_edges_operation.doc +++ b/doc/salome/gui/GEOM/input/remove_extra_edges_operation.doc @@ -7,13 +7,13 @@ \n This operation removes all seam and degenerated edges from a given shape. Its main purpose is healing of solids and compounds to obtain hexahedral solids and compounds of hexahedral solids. -At the same time, it has an option to unite all faces, sharing one -surface. With this option not only hexahedral solids could be obtained. +However, there is an option to unite all faces, sharing one +surface, which allows obaining not only hexahedral solids. \n TUI Command: geompy.RemoveExtraEdges(theShape,theOptimumNbFaces), -there theShape is a compound or a single solid to remove irregular edges from +where theShape is a compound or a single solid and theOptimumNbFaces is an integer parameter, that regulates, -whether the faces, sharing common surface, should be united, or not. +whether the faces, sharing a common surface, should be united. \n Arguments: Name + one shape + a flag. \n Advanced option: \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". -- 2.39.2