]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Update GEOM documentation
authormaintenance team <salome-mnt@opencascade.com>
Fri, 20 Feb 2009 13:50:52 +0000 (13:50 +0000)
committermaintenance team <salome-mnt@opencascade.com>
Fri, 20 Feb 2009 13:50:52 +0000 (13:50 +0000)
doc/salome/gui/GEOM/input/creating_3dsketcher.doc
doc/salome/gui/GEOM/input/creating_box.doc
doc/salome/gui/GEOM/input/creating_extrusion_alongpath.doc
doc/salome/gui/GEOM/input/creating_geom_objects.doc
doc/salome/gui/GEOM/input/geompy.doc

index bb914ea55ec7bc192dfd45b787f5abea9d5259c9..31b4107498713ed11ed5be28d4f80f1eb20cd127 100755 (executable)
@@ -8,18 +8,29 @@ To create a 3D Sketch, select in the main menu <em>New Entity -> 3D Sketch</em>.
 
 \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 <b>Coordinates Type</b> radio buttons.
-\n <b>"Sketch Validation"</b> button applies the wire, only red part will be built by "Sketch Validation".
-\n <b>"Sketch Closure"</b> 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 <b>Coordinates Type</b>
+radio buttons.
+
+To add the point in the list of points and to proceed with the
+definition of the next point, click <b>Apply</b> button. \b Undo and
+\b Redo buttons, respectively, remove or restore the last point in the list.
+
+\n <b>"Sketch Validation"</b> button applies the wire, built by the
+user, "as is".
+\n <b>"Sketch Closure"</b> 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.
 
 <b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
-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.
 
 <b>Example:</b>
index 8170884635ad207ffc90704ef4418b8bd16579b0..7df825189eff9480ae3b0a9f7c55a149ceeb5886 100644 (file)
@@ -30,10 +30,7 @@ accessible only via \b TUI commands.
 this way you don't need to create them in advance).
 \n <b>TUI Command:</b> <em>geompy.MakeBox(x1,y1,z1,x2,y2,z2)</em>
 \n <b>Arguments:</b> 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
 
 <b>Example:</b>
 
index 7095d2e59b56f858d7fa0e4925aa419efc8f6d35..1178fd1e6005206d9c790c5ef88157de1cc147a5 100644 (file)
@@ -9,10 +9,10 @@ Object</b> (vertex, edge, planar wire, face or shell), which will be extruded
 and the <b>Path Object</b> (edge or wire) along which the <b>Base 
 Object</b> will be extruded.
 \n In this mode the default pipe generation algorithm is used. The pipe
-is created in such a way that the <b>angle between the normal vector</b> to
-the base shape <b>and the tangent to the path</b> wire at any point of the
-given path <b>is kept constant</b>.
-\n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
+is created so that the <b>angle between the normal vector</b> to
+the base shape <b>and the tangent to the path</b> wire remains constant at any point of the
+given path.
+\n <b>Select unpublished edges</b> 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.
 
 <b>Example:</b>
 
-\image html pipe_wire_edgesn.png "Extrusion of wire"
+\image html pipe_wire_edgesn.png "Extrusion of wire"
 
 \n Secondly, you can define the <b>Base
 Object</b> (edge, planar wire or face), which will be extruded, 
 the <b>Path Object</b> (edge or wire) along which the <b>Base 
-Object</b> will be extruded and the <b>Vector</b> (edge or wire).
+Object</b> will be extruded and the <b>BiNormal Vector</b> (edge or
+wire).
+
 \n In contrast to the default mode, in this mode the pipe is generated
-in such a way that the <b>angle between the normal vector</b> to the base
-shape <b>and the BiNormal vector</b> given as the third argument <b>is kept
-constant</b>.
-\n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
+to preserve the constant <b>angle between the normal vector</b> to the base
+shape <b>and the BiNormal vector</b> given as the third argument.
+\n <b>Select unpublished edges</b> 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.
 
 <b>Example:</b>
 
-\image html pipebinormalsn.png "Extrusion of face with BiNormal parameter"
+\image html pipebinormalsn.png "Extrusion of face with BiNormal parameter"
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_pipe "Complex Geometric Objects".
index ae5dfb8c7b50db5ab09c2b7df1b27bc7db3c238b..8074dc657a384dbef77192f6dcd9566c949e5984 100644 (file)
@@ -24,4 +24,8 @@ into sub-objects of lower dimension.</li>
 <li>create \subpage create_adv_obj_page "Advanced geometrical objects" - edges, wires, shells...</li>
 </ul>
 
+\note It is possible to use the variables defined in the SALOME \b NoteBook
+ to specify the numerical parameters for creation of any object.
+
+
 */
index dc48294873f7174452dfa2d3434baa780f4f0b39..c1133470eb65893b1df3b814cda72e41b2c4bc15 100644 (file)
@@ -22,7 +22,6 @@ provided by Geometry module.
     <li>\ref tui_working_with_groups_page</li>
     <li>\ref tui_building_by_blocks_page</li>
     <li>\ref tui_sketcher_page</li>
-    <li>\ref tui_3dsketcher_page</li>
     <li>\ref tui_advanced_geom_objs_page</li>
   </ul>
   <li>\subpage tui_transformation_page</li>
@@ -34,6 +33,7 @@ provided by Geometry module.
     <li>\ref tui_repairing_operations_page</li>
   </ul>
   <li>\subpage tui_measurement_tools_page</li>
+  <li>\subpage tui_3dsketcher_page</li>
   <li>\subpage tui_swig_examples_page</li>
   <ul>
     <li>\ref tui_test_others_page</li>