From 72cb85eb5f520e1cdad469247e9e3aa1faeb61b9 Mon Sep 17 00:00:00 2001 From: maintenance team Date: Fri, 20 Feb 2009 13:50:52 +0000 Subject: [PATCH] Update GEOM documentation --- .../gui/GEOM/input/creating_3dsketcher.doc | 25 +++++++++++++------ doc/salome/gui/GEOM/input/creating_box.doc | 3 --- .../input/creating_extrusion_alongpath.doc | 23 +++++++++-------- .../gui/GEOM/input/creating_geom_objects.doc | 4 +++ doc/salome/gui/GEOM/input/geompy.doc | 2 +- 5 files changed, 35 insertions(+), 22 deletions(-) diff --git a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc index bb914ea55..31b410749 100755 --- a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc @@ -8,18 +8,29 @@ To create a 3D Sketch, select in the main menu New Entity -> 3D Sketch. \image html 3dsketch2.png -The position of each coordinates can be defined by absolute coordinates X, Y, Z or -by relative coordinates DX, DY, DZ with respect to the previous Applied point. -Type of coordinates can be selected by the Coordinates Type radio buttons. -\n "Sketch Validation" button applies the wire, only red part will be built by "Sketch Validation". -\n "Sketch Closure" will close the Sketch by straight line from last red part and apply it. -To make a closed wire using the TUI command, the first and the last point shoul +In this dialog it is possible to define the coordinates of the points. + +The position of each point can be defined by \b Absolute coordinates X, Y, Z or +by \b Relative coordinates DX, DY, DZ with respect to the previous Applied point. +The type of coordinates can be selected by the Coordinates Type +radio buttons. + +To add the point in the list of points and to proceed with the +definition of the next point, click Apply button. \b Undo and +\b Redo buttons, respectively, remove or restore the last point in the list. + +\n "Sketch Validation" button applies the wire, built by the +user, "as is". +\n "Sketch Closure" closes the Sketch by a straight line from +the start to the end point and applies it. + +To make a closed wire using the TUI command, the first and the last point should have the same coordinates. The Result of the operation will be a \b GEOM_Object. TUI Command: geompy.Make3DSketcher( [ PointsList ] ) -This algorithm creates a wire, from the list of real values which define XYZ +This algorithm creates a wire from the list of real values, which define XYZ coordinates of points. Example: diff --git a/doc/salome/gui/GEOM/input/creating_box.doc b/doc/salome/gui/GEOM/input/creating_box.doc index 817088463..7df825189 100644 --- a/doc/salome/gui/GEOM/input/creating_box.doc +++ b/doc/salome/gui/GEOM/input/creating_box.doc @@ -30,10 +30,7 @@ accessible only via \b TUI commands. this way you don't need to create them in advance). \n TUI Command: geompy.MakeBox(x1,y1,z1,x2,y2,z2) \n Arguments: Name + X, Y and Z coordinates of both points. -\note You can also use variables defined in the SALOME \b NoteBook -to specify any numerical parameters of the box. -\image html box3.png Example: diff --git a/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc b/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc index 7095d2e59..1178fd1e6 100644 --- a/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc +++ b/doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc @@ -9,10 +9,10 @@ Object (vertex, edge, planar wire, face or shell), which will be extruded and the Path Object (edge or wire) along which the Base Object will be extruded. \n In this mode the default pipe generation algorithm is used. The pipe -is created in such a way that the angle between the normal vector to -the base shape and the tangent to the path wire at any point of the -given path is kept constant. -\n Check Box Select unpublished edges - if checked, allows to select an edge of any other shape as the path object. +is created so that the angle between the normal vector to +the base shape and the tangent to the path wire remains constant at any point of the +given path. +\n Select unpublished edges checkbox - if checked, allows to select an edge of any other shape as the path object. \n The \b Result of the operation will be a GEOM_Object (edge, face, shell, solid or compsolid). @@ -25,17 +25,18 @@ definition of the path. Example: -\image html pipe_wire_edgesn.png "Extrusion of wire" +\image html pipe_wire_edgesn.png "Extrusion of a wire" \n Secondly, you can define the Base Object (edge, planar wire or face), which will be extruded, the Path Object (edge or wire) along which the Base -Object will be extruded and the Vector (edge or wire). +Object will be extruded and the BiNormal Vector (edge or +wire). + \n In contrast to the default mode, in this mode the pipe is generated -in such a way that the angle between the normal vector to the base -shape and the BiNormal vector given as the third argument is kept -constant. -\n Check Box Select unpublished edges - if checked, allows to select an edge of any other shape as the path object. +to preserve the constant angle between the normal vector to the base +shape and the BiNormal vector given as the third argument. +\n Select unpublished edges checkbox - if checked, allows to select an edge of any other shape as the path object. \n The \b Result of the operation will be a GEOM_Object (edge, face, shell, solid or compsolid). @@ -49,7 +50,7 @@ BiNormal direction to perform the extrusion. Example: -\image html pipebinormalsn.png "Extrusion of face with BiNormal parameter" +\image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter" Our TUI Scripts provide you with useful examples of creation of \ref tui_creation_pipe "Complex Geometric Objects". diff --git a/doc/salome/gui/GEOM/input/creating_geom_objects.doc b/doc/salome/gui/GEOM/input/creating_geom_objects.doc index ae5dfb8c7..8074dc657 100644 --- a/doc/salome/gui/GEOM/input/creating_geom_objects.doc +++ b/doc/salome/gui/GEOM/input/creating_geom_objects.doc @@ -24,4 +24,8 @@ into sub-objects of lower dimension.
  • create \subpage create_adv_obj_page "Advanced geometrical objects" - edges, wires, shells...
    • +\note It is possible to use the variables defined in the SALOME \b NoteBook + to specify the numerical parameters for creation of any object. + + */ diff --git a/doc/salome/gui/GEOM/input/geompy.doc b/doc/salome/gui/GEOM/input/geompy.doc index dc4829487..c1133470e 100644 --- a/doc/salome/gui/GEOM/input/geompy.doc +++ b/doc/salome/gui/GEOM/input/geompy.doc @@ -22,7 +22,6 @@ provided by Geometry module.
  • \ref tui_working_with_groups_page
  • \ref tui_building_by_blocks_page
  • \ref tui_sketcher_page
    • -
  • \ref tui_3dsketcher_page
  • \ref tui_advanced_geom_objs_page
  • \subpage tui_transformation_page
    • @@ -34,6 +33,7 @@ provided by Geometry module.
  • \ref tui_repairing_operations_page
  • \subpage tui_measurement_tools_page
    • +
  • \subpage tui_3dsketcher_page
  • \subpage tui_swig_examples_page