From bbf5ec60ee3ee80900da00d86aad7b1d33eab4d5 Mon Sep 17 00:00:00 2001 From: inv Date: Wed, 12 May 2010 06:27:31 +0000 Subject: [PATCH] Update GEOM documentation --- doc/salome/gui/GEOM/input/creating_lcs.doc | 10 +++---- .../gui/GEOM/input/creating_pipetshape.doc | 30 +++++++++---------- doc/salome/gui/GEOM/input/deflection.doc | 4 +-- .../input/geometrical_object_properties.doc | 15 +++++----- doc/salome/gui/GEOM/input/index.doc | 8 +++-- .../input/restore_presentation_parameters.doc | 17 ++++++----- .../gui/GEOM/input/viewing_geom_obj.doc | 2 +- 7 files changed, 45 insertions(+), 41 deletions(-) diff --git a/doc/salome/gui/GEOM/input/creating_lcs.doc b/doc/salome/gui/GEOM/input/creating_lcs.doc index 2516af99d..0188c76ba 100644 --- a/doc/salome/gui/GEOM/input/creating_lcs.doc +++ b/doc/salome/gui/GEOM/input/creating_lcs.doc @@ -26,8 +26,8 @@ of the LCS are calculated automatically basing on the selected object. coordinates of origin by a point and axes directions by a line or a vector. \n TUI command: geompy.MakeMarkerPntTwoVec(Center, VectorX, -VectorY) where Center is a point specified the coordinate system location, -VectorX is a derection of OX axis and VectorY direction of OY axis. +VectorY) where Center is the origin of the coordinate system, +VectorX is the direction of OX axis and VectorY is the direction of OY axis. \n Arguments: Name + 1 point of origin + X axis direction, Y axis direction. \image html neo-localcs3.png @@ -40,6 +40,6 @@ and in 3D viewer. \image html image145.png "Local Coordinate System" -TUI Script provide you with useful example of creation of -\ref tui_creation_lcs "Local Coordinate System". -*/ \ No newline at end of file +TUI Script provides you with a useful example of +\ref tui_creation_lcs "Local Coordinate System" creation. +*/ diff --git a/doc/salome/gui/GEOM/input/creating_pipetshape.doc b/doc/salome/gui/GEOM/input/creating_pipetshape.doc index 823bc3eb9..d66250295 100644 --- a/doc/salome/gui/GEOM/input/creating_pipetshape.doc +++ b/doc/salome/gui/GEOM/input/creating_pipetshape.doc @@ -5,23 +5,23 @@ To create a \b PipeTShape in the Main Menu select New Entity - > Advanced - > PipeTShape -Specify the parameters of the PipeTShape object creation in the opened dialog +Specify the parameters of the PipeTShape object in the opened dialog box and press "Apply" or "Apply & Close" button. -Result of each operation will be a GEOM_Object. +The result of the operation will be a GEOM_Object. TUI Command: geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None) Arguments: -- \b R1 - Radius of main T-shape pipe. -- \b W1 - Thickness of main T-shape pipe. -- \b L1 - Length of main T-shape pipe. -- \b R2 - Radius of incident T-shape pipe. -- \b W2 - Thickness of incident T-shape pipe. -- \b L2 - Length of incident T-shape pipe. -- \b HexMesh - If True, the shape is splitted in blocks (suitable for hexaedral mesh). -- \b P1 - First junction point of main pipe (GEOM Vertex). -- \b P2 - Second junction point of main pipe (GEOM Vertex). -- \b P3 - Junction point of incident pipe (GEOM Vertex). +- \b R1 - Radius of the main T-shape pipe. +- \b W1 - Thickness of the main T-shape pipe. +- \b L1 - Length of the main T-shape pipe. +- \b R2 - Radius of the incident T-shape pipe. +- \b W2 - Thickness of the incident T-shape pipe. +- \b L2 - Length of the incident T-shape pipe. +- \b HexMesh - If True, the shape is splitted into blocks (suitable for hexaedral mesh). +- \b P1 - First junction point of the main pipe (GEOM Vertex). +- \b P2 - Second junction point of the main pipe (GEOM Vertex). +- \b P3 - Junction point of the incident pipe (GEOM Vertex). \image html pipetshape_dlg.png @@ -33,8 +33,8 @@ A Pipe T-Shape can be created with a chamfer at the junction of the main and the TUI Command: geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None) -Arguments are the same as normal Pipe T-Shape plus: -- \b H - Height of the chamfer along incident pipe. +The arguments are the same as of the normal Pipe T-Shape plus: +- \b H - Height of the chamfer along the incident pipe. - \b W - Width of the chamfer along the main pipe. Example: @@ -45,7 +45,7 @@ A Pipe T-Shape can be created with a fillet at the junction of the main and the TUI Command: geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None) -Arguments are the same as normal Pipe T-Shape plus: +The arguments are the same as of the normal Pipe T-Shape plus: - \b RF - Radius of the fillet. Example: diff --git a/doc/salome/gui/GEOM/input/deflection.doc b/doc/salome/gui/GEOM/input/deflection.doc index b2f419a94..1d523f3b4 100644 --- a/doc/salome/gui/GEOM/input/deflection.doc +++ b/doc/salome/gui/GEOM/input/deflection.doc @@ -2,8 +2,8 @@ \page deflection_page Deflection -\n In this menu you can change the deviation coefficient of the -shape. Smaller coefficient provides better quality of the shape in the +\n In this menu you can change the deflection coefficient of the +shape. The less is the coefficient the better is the quality of the shape in the viewer. \n Arguments: 1 floating point value (deviation coefficient). diff --git a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc index 78de472cd..e323c6932 100644 --- a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc +++ b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc @@ -8,7 +8,7 @@ The Type property of the geometrical object specifies the way the object has been created. It is an integer identifier that -has predefined value depending on the function type used for the +has a predefined value depending on the function type used for the object creation. The type of the object can be retrieved using the \b %GetType() function of the \b GEOM_Object interface. @@ -70,10 +70,9 @@ The possible values of the geometrical objects are listed in the table below: Also geompy.py module provides a helper function ShapeIdToType() -that allows converting of the geometrical object type id value -to its string representation. +that allows converting the geometrical object id value to its string representation. -For example: +For example, the output of the following code: \code import geompy box = geompy.MakeBoxDXDYDZ(10,10,10) @@ -81,12 +80,12 @@ type = geompy.ShapeIdToType(box.GetType()) print type \endcode -The above code prints "BOX" value. +will be the "BOX" value. GetShapeType function: The ShapeType property specifies the geometrical object in terms of -its topology nature. +its topologic nature. The possible values are defined in the GEOM namespace: { COMPOUND, COMPSOLID, SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }
@@ -94,7 +93,7 @@ SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }
This type can be retrieved using the \b %GetShapeType() function of the \b GEOM_Object interface. -Example code: +For example: \code import geompy import GEOM @@ -103,6 +102,6 @@ type = box.GetShapeType() print type == GEOM.SOLID \endcode -This code prints "True". +The result is "True". */ diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc index d1485ef14..d28e8c343 100644 --- a/doc/salome/gui/GEOM/input/index.doc +++ b/doc/salome/gui/GEOM/input/index.doc @@ -13,9 +13,11 @@ using a wide range of functions;
  • \subpage transform_geom_obj_page "transformation of geometrical objects" using various algorithms;
  • \subpage repairing_operations_page "optimization of geometrical objects";
    • -
  • \subpage geometrical_obj_prop_page "Geometrical object properties".
    • -
  • \subpage using_measurement_tools_page "provision of information about geometrical objects".
    • -
  • \subpage using_notebook_geom_page.
    • +
  • viewing \subpage geometrical_obj_prop_page "geometrical object properties".
    • +
  • and other information about geometrical objects using + \subpage using_measurement_tools_page "measurement tools".
    • +
  • easily setting parameters via the variables predefined in + \subpage using_notebook_geom_page "Salome notebook".
    • Almost all geometry module functionalities are accessible via diff --git a/doc/salome/gui/GEOM/input/restore_presentation_parameters.doc b/doc/salome/gui/GEOM/input/restore_presentation_parameters.doc index 4cb9aa916..4fdffcd79 100644 --- a/doc/salome/gui/GEOM/input/restore_presentation_parameters.doc +++ b/doc/salome/gui/GEOM/input/restore_presentation_parameters.doc @@ -1,8 +1,10 @@ /*! -\page restore_presentation_parameters_page Restore presentation parameters and a tree of subshapes +\page restore_presentation_parameters_page Advanced Transformation Options -\n This functionality allows the operation result to inherit colour +
    Set presentation parameters and subshapes from arguments
    + +\n This option allows the operation result to inherit colour and subshapes from its arguments. \n To activate this functionality, check in "Set @@ -38,7 +40,7 @@ operation arguments and their published subshapes. The resulting shape has a default colour, but its subshapes inherit colors corresponding to arguments and their subshapes. -\image html restore-ss-viewer-after.png "Thev resulting shape" +\image html restore-ss-viewer-after.png "The resulting shape" Please, note that when the resulting shape corresponds to one @@ -51,12 +53,13 @@ inherited subshapes depend on the arguments. \image html restore-ss-OB.png +\n You can also call this functionality from your python scripts. +See our TUI Scripts for \ref tui_restore_prs_params "example". +
    Add prefix to names of restored subshapes
    -Add prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored subshapes. +This option allows adding the prefix "from_" to the names of +restored sub-shapes, and the prefix "from_subshapes_of_" to the names of partially restored subshapes. By default this option is On. -\n You can also call this functionality from your python scripts. -See our TUI Scripts for \ref tui_restore_prs_params "example". - */ diff --git a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc index b6e5b97ba..39a4f9035 100644 --- a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc +++ b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc @@ -28,7 +28,7 @@ transparency of geometrical objects.
  • \subpage isolines_page "Isos" - allows to change the number of isolines displayed within a shape.
  • \subpage deflection_page "Deflection" - allows to change the -deviation coefficient of a shape.
    • +deflection coefficient of a shape.
  • \subpage point_marker_page "Point Marker" - allows to change the representation of geometrical vertices.
  • Auto color / Disable auto color - activates the auto color -- 2.39.2