Update GEOM GUI documentation

This commit is contained in:
maintenance team 2009-06-22 12:47:01 +00:00
parent aaa5aa61bb
commit ad77350eea
5 changed files with 22 additions and 21 deletions

View File

@ -16,8 +16,8 @@ corresponds to the OZ axis of the global coordinate system and <b>Major Axis</b>
corresponds to the OX axis of the global coordinate system. corresponds to the OX axis of the global coordinate system.
\note Actual direction of the major axis vector is defined as \note The actual direction of the major axis vector is defined as
<EM> Vmaj' = (Vn * Vmaj) * Vn</em> where \em Vn is a normal vector and <EM> Vmaj' = (Vn * Vmaj) * Vn</em>, where \em Vn is a normal vector and
\em Vmaj is an original vector of the major axis. \em Vmaj is an original vector of the major axis.
\n <b>TUI Command (no major axis):</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em> \n <b>TUI Command (no major axis):</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em>

View File

@ -26,13 +26,13 @@ of the plane).
\image html plane2.png \image html plane2.png
\n Also, you can define a \b Plane by another \b Plane or <b>Face</b> and a <b>Size of the Plane</b>. \n Thirdly, you can define a \b Plane by another \b Plane or <b>Face</b> and a <b>Size of the Plane</b>.
\n <b>TUI Command:</b> <em>geompy.MakePlaneFace(Face, TrimSize)</em> \n <b>TUI Command:</b> <em>geompy.MakePlaneFace(Face, TrimSize)</em>
\n <b>Arguments:</b> Name + 1 face + 1 value (to define the size of the plane). \n <b>Arguments:</b> Name + 1 face + 1 value (to define the size of the plane).
\image html plane3.png \image html plane3.png
\n Also, you can define a \b Plane by two Vectors. The first vector defines the center point and the direction, \n Fourthly, you can define a \b Plane by two Vectors. The first vector defines the center point and the direction,
the second vector defines the normal to the Plane. the second vector defines the normal to the Plane.
\n <b>TUI Command:</b> <em>geompy.MakePlane2Vec(Vec1, Vec2, TrimSize)</em> \n <b>TUI Command:</b> <em>geompy.MakePlane2Vec(Vec1, Vec2, TrimSize)</em>
\n <b>Arguments:</b> Name + 2 vectors + 1 value (to define the size of the plane). \n <b>Arguments:</b> Name + 2 vectors + 1 value (to define the size of the plane).

View File

@ -6,9 +6,10 @@
\n You can create a \b Wire from several connected edges and wires by \n You can create a \b Wire from several connected edges and wires by
selecting them in the object browser or in the viewer holding Shift selecting them in the object browser or in the viewer holding Shift
button. Select \b Tolerance which will be used to check button.
connections. If you use \b Tolerance more than 1e-07, and gap, \n Select \b Tolerance which will be used to check the
covered by this tolerance, is detected, edges will be modified to connections. If the \b Tolerance value is more than 1e-07, and a gap
within this tolerance is detected, the corresponding edges will be modified to
connect in the middle of the gap. connect in the middle of the gap.
\n The \b Result will be a \b GEOM_Object (WIRE). \n The \b Result will be a \b GEOM_Object (WIRE).

View File

@ -4,7 +4,7 @@
In Geometry module you can import and export geometrical objects In Geometry module you can import and export geometrical objects
from/into BREP, IGES, STEP files. The mechanisms of import and export from/into BREP, IGES, STEP files. The mechanisms of import and export
are implemented via plug-ins, which gives you the opportunity to are implemented via plug-ins, which gives the opportunity to
expand the range of available formats by adding more plug-ins (for expand the range of available formats by adding more plug-ins (for
example, CATIA 5). example, CATIA 5).
@ -22,23 +22,23 @@ Select the required file and click \b Open. Your file will be imported in
the module and its contents (geometrical object) will be displayed in the module and its contents (geometrical object) will be displayed in
the <b>Object Browser</b>. the <b>Object Browser</b>.
\note If type of selected file is IGES and length unit in this file is not \note If the selected file is in IGES format and the length is not
equal to meter following question will be offer to user: expressed in meters, it will be sussested to scale the model into the
metric system:
y types (solid, face, edge and
vertex) for all named shapes
\image html iges_unit.png \image html iges_unit.png
\par \par
If answer is <b>Yes</b> result will be scaled from file unit to meter.
\note If type of selected file is ACIS (optionally - for users with \note If the selected file is in ACIS format (the use of this format
special license) and this file contains names for some shapes requires licensing) and the file contains names for some shapes, it
following question will be offer to user: will be suggested to create groups by types (solid, face, edge and
vertex) for all named shapes:
\image html sat_named_shapes.png \image html sat_named_shapes.png
\par \par
If answer is <b>Yes</b> needed groups by types (solid, face, edge and
vertex) for all named shapes will be created.
\note It is possible to re-open from the initial file a previously imported shape if \note It is possible to re-open from the initial file a previously imported shape if
the file has been changed on disk. For this, select the file has been changed on disk. For this, select

View File

@ -7,13 +7,13 @@
\n This operation removes all seam and degenerated edges from a given \n This operation removes all seam and degenerated edges from a given
shape. Its main purpose is healing of solids and compounds to obtain shape. Its main purpose is healing of solids and compounds to obtain
hexahedral solids and compounds of hexahedral solids. hexahedral solids and compounds of hexahedral solids.
At the same time, it has an option to unite all faces, sharing one However, there is an option to unite all faces, sharing one
surface. With this option not only hexahedral solids could be obtained. surface, which allows obaining not only hexahedral solids.
\n <b>TUI Command:</b> <em>geompy.RemoveExtraEdges(theShape,theOptimumNbFaces)</em>, \n <b>TUI Command:</b> <em>geompy.RemoveExtraEdges(theShape,theOptimumNbFaces)</em>,
there <em>theShape</em> is a compound or a single solid to remove irregular edges from where <em>theShape</em> is a compound or a single solid
and <em>theOptimumNbFaces</em> is an integer parameter, that regulates, and <em>theOptimumNbFaces</em> is an integer parameter, that regulates,
whether the faces, sharing common surface, should be united, or not. whether the faces, sharing a common surface, should be united.
\n <b>Arguments:</b> Name + one shape + a flag. \n <b>Arguments:</b> Name + one shape + a flag.
\n <b>Advanced option:</b> \n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".