Update GEOM documentation

This commit is contained in:
maintenance team 2009-02-20 13:50:52 +00:00
parent de35f4e2a3
commit 72cb85eb5f
5 changed files with 35 additions and 22 deletions

View File

@ -8,18 +8,29 @@ To create a 3D Sketch, select in the main menu <em>New Entity -> 3D Sketch</em>.
\image html 3dsketch2.png \image html 3dsketch2.png
The position of each coordinates can be defined by absolute coordinates X, Y, Z or In this dialog it is possible to define the coordinates of the points.
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. The position of each point can be defined by \b Absolute coordinates X, Y, Z or
\n <b>"Sketch Validation"</b> button applies the wire, only red part will be built by "Sketch Validation". by \b Relative coordinates DX, DY, DZ with respect to the previous Applied point.
\n <b>"Sketch Closure"</b> will close the Sketch by straight line from last red part and apply it. The type of coordinates can be selected by the <b>Coordinates Type</b>
To make a closed wire using the TUI command, the first and the last point shoul 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. have the same coordinates.
The Result of the operation will be a \b GEOM_Object. The Result of the operation will be a \b GEOM_Object.
<b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em> <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. coordinates of points.
<b>Example:</b> <b>Example:</b>

View File

@ -30,10 +30,7 @@ accessible only via \b TUI commands.
this way you don't need to create them in advance). 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>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. \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> <b>Example:</b>

View 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 and the <b>Path Object</b> (edge or wire) along which the <b>Base
Object</b> will be extruded. Object</b> will be extruded.
\n In this mode the default pipe generation algorithm is used. The pipe \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 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 at any point of the the base shape <b>and the tangent to the path</b> wire remains constant at any point of the
given path <b>is kept constant</b>. given path.
\n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. \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, \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
solid or compsolid). solid or compsolid).
@ -25,17 +25,18 @@ definition of the path.
<b>Example:</b> <b>Example:</b>
\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 <b>Base \n Secondly, you can define the <b>Base
Object</b> (edge, planar wire or face), which will be extruded, Object</b> (edge, planar wire or face), which will be extruded,
the <b>Path Object</b> (edge or wire) along which the <b>Base 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 \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 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 <b>is kept shape <b>and the BiNormal vector</b> given as the third argument.
constant</b>. \n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object.
\n Check Box <b>Select unpublished edges</b> - 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, \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
solid or compsolid). solid or compsolid).
@ -49,7 +50,7 @@ BiNormal direction to perform the extrusion.
<b>Example:</b> <b>Example:</b>
\image html pipebinormalsn.png "Extrusion of face with BiNormal parameter" \image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter"
Our <b>TUI Scripts</b> provide you with useful examples of creation of Our <b>TUI Scripts</b> provide you with useful examples of creation of
\ref tui_creation_pipe "Complex Geometric Objects". \ref tui_creation_pipe "Complex Geometric Objects".

View 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> <li>create \subpage create_adv_obj_page "Advanced geometrical objects" - edges, wires, shells...</li>
</ul> </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.
*/ */

View File

@ -22,7 +22,6 @@ provided by Geometry module.
<li>\ref tui_working_with_groups_page</li> <li>\ref tui_working_with_groups_page</li>
<li>\ref tui_building_by_blocks_page</li> <li>\ref tui_building_by_blocks_page</li>
<li>\ref tui_sketcher_page</li> <li>\ref tui_sketcher_page</li>
<li>\ref tui_3dsketcher_page</li>
<li>\ref tui_advanced_geom_objs_page</li> <li>\ref tui_advanced_geom_objs_page</li>
</ul> </ul>
<li>\subpage tui_transformation_page</li> <li>\subpage tui_transformation_page</li>
@ -34,6 +33,7 @@ provided by Geometry module.
<li>\ref tui_repairing_operations_page</li> <li>\ref tui_repairing_operations_page</li>
</ul> </ul>
<li>\subpage tui_measurement_tools_page</li> <li>\subpage tui_measurement_tools_page</li>
<li>\subpage tui_3dsketcher_page</li>
<li>\subpage tui_swig_examples_page</li> <li>\subpage tui_swig_examples_page</li>
<ul> <ul>
<li>\ref tui_test_others_page</li> <li>\ref tui_test_others_page</li>