From 9351fe0dfa570db0b1411ea63e7becb12a913944 Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 17 Apr 2013 15:23:36 +0000 Subject: [PATCH] Update documentation for 7.2.0 --- doc/salome/gui/GEOM/input/bounding_box.doc | 8 ++++---- doc/salome/gui/GEOM/input/creating_curve.doc | 6 +++--- doc/salome/gui/GEOM/input/geompy_migration.doc | 14 +++++++------- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/salome/gui/GEOM/input/bounding_box.doc b/doc/salome/gui/GEOM/input/bounding_box.doc index 75b7c7eaf..99bd0538f 100644 --- a/doc/salome/gui/GEOM/input/bounding_box.doc +++ b/doc/salome/gui/GEOM/input/bounding_box.doc @@ -2,21 +2,21 @@ \page bounding_box_page Bounding Box -Shows the dimensions of the bounding box for the selected -geometrical object. Creates corresponding shape (box) on "Apply". +Displays the bounding box dimensions for the selected +geometrical object and creates the corresponding box shape on "Apply". \image html measures5.png \note To take into account any possible shape distortion that affects the resulting bounding box, the algorithm enlarges -the bounding box to the maximum deflection value of +the bounding box to the maximum deflection value of faces (by iterating through all faces of a shape). This functionallity is implemented in such a way to have a satisfactory performance. \n TUI Commands: [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax] = geompy.BoundingBox(Shape), BBox = geompy.MakeBoundingBox(Shape), where \em Shape -is the shape for which a bounding box is computed. +is the shape for which the bounding box is computed. See also a \ref tui_bounding_box_page "TUI example". diff --git a/doc/salome/gui/GEOM/input/creating_curve.doc b/doc/salome/gui/GEOM/input/creating_curve.doc index 29cbbc8d1..4c70ca156 100644 --- a/doc/salome/gui/GEOM/input/creating_curve.doc +++ b/doc/salome/gui/GEOM/input/creating_curve.doc @@ -70,9 +70,9 @@ closed edge.
  • If Reorder vertices taking into account distances is checked, the interpolation algorithm does not follow the order of vertices but searches for the closest vertex.
    • -
  • Tangents are two vectors, defining direction of curve at -its ends. Both or none vectors must be set. This option available only -if two above check boxes are not checked. +
  • Tangents are two vectors, defining the direction at the ends of the +curve. It is necessary to set both vectors or none. This option is available only +if both above check boxes are not checked.
    • diff --git a/doc/salome/gui/GEOM/input/geompy_migration.doc b/doc/salome/gui/GEOM/input/geompy_migration.doc index b15985ef8..fcac5fb05 100644 --- a/doc/salome/gui/GEOM/input/geompy_migration.doc +++ b/doc/salome/gui/GEOM/input/geompy_migration.doc @@ -2,15 +2,15 @@ \page geompy_migration_page Modifying Geometry Python scripts from SALOME 6 and before -\n With SALOME 7.2, the Python interface for Geometry has been slightly modified to offer new functionality: +\n In SALOME 7.2, the Python interface for Geometry has been slightly modified to offer new functionality: -\n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with all functionality. -\n A compatibility mode allows old scripts to work in almost all cases, but with a warning. +\n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with full functionality. +\n The compatibility mode allows old scripts to work in almost all cases, but with a warning. Salome initialisation must always be done as shown below \n (salome_init() can be invoked safely several times): @@ -20,12 +20,12 @@ salome.salome_init() \endcode Geometry initialisation is modified. -\n old mode: +\n the old mode: \code import geompy geompy.init_geom(theStudy) \endcode -new mode: +\n the new mode: \code import GEOM from salome.geom import geomBuilder @@ -36,8 +36,8 @@ geompy = geomBuilder.New(salome.myStudy) Of course, from geompy import * is no more possible. \n You have to explicitely write geompy.some_method(). -\n Some variables are no longer in namespace geompy.GEOM but in namespace GEOM. -\n All the occurences of geompy.GEOM. can be replaced by GEOM.. +\n Some variables have been transferred from the namespace geompy.GEOM to the namespace GEOM. +\n All occurrences of geompy.GEOM. can be replaced by GEOM.. \n For instance: \code param_polyline = geompy.MakeCurveParametric("t", "sin(t)", "cos(t)", 0., 100., 100, geompy.GEOM.Polyline, theNewMethod=True)