ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2024-12-29 10:50:35 +05:00
Code Issues Packages Projects Releases Wiki Activity

Common update of Salome GUI documentation

Browse Source
This commit is contained in:
maintenance team 2008-11-13 10:22:41 +00:00
parent 4b1b07bbae
commit 3f8dbc26f7
8 changed files with 40 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/salome/gui/GEOM/images/geomcreategroup.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 30 KiB

4
doc/salome/gui/GEOM/input/creating_circle.doc
View File

@ -15,8 +15,8 @@ Radius)</em>
\n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
the direction) + Radius.
\note Passing None as <b>Center Point</b> means Origin of global
coordinate system, passing None as \b Vector means OZ axis of global
\note By default it is presumed that the <b>Center Point</b> is located at the Origin of the global
coordinate system, and the \b Vector corresponds to OZ axis of the global
coordinate system.
\image html circle1.png

13
doc/salome/gui/GEOM/input/creating_disk.doc
View File

@ -2,25 +2,26 @@
\page create_disk_page Disk
A primitive called disk is a round plane with a certain radius and orientation
To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
Primitives - > Disk</b>
\n There are 3 algorithms to create a \b Disk in 3D space.
\n The \b Result of each operation will be a GEOM_Object (face).
\n Firstly, you can create a \b Disk by the given radius at the origin
of coordinates. You can define the axis of the disk by the orientation
group buttons. There are three options to create an object in OXY, OYZ or OZX Planes.
\n Firstly, you can create a \b Disk at the origin
of coordinates defining its radius and selecting the orientation of its axis with radio
buttons (OXY, OYZ or OZX).This
means that the Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
\n <b>TUI Command:</b> <em>geompy.MakeDiskR(Radius, Orientation)</em>
\n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
orientation).
\n The orientation can be defined by "1", "2" or "3" values. This
means that Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
\image html disk1.png
\n Secondly, you can define a \b Disk by a <b>Center Point</b>, a \b
Vector giving the circle's normal and a \b Radius.
Vector defining the normal of a circle and a \b Radius.
\n <b>TUI Command:</b> <em>geompy.MakeDiskPntVecR(Point, Vector,
Radius)</em>
\n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for

4
doc/salome/gui/GEOM/input/creating_ellipse.doc
View File

@ -12,8 +12,8 @@ Vector giving its normal, and its <b>Major & Minor Radiuses</b>.
\n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
the direction) + 1 X Radius + 1 Y Radius.
\note Passing None as <b>Center Point</b> means Origin of global
coordinate system, passing None as \b Vector means OZ axis of global
\note By default it is presumed that the <b>Center Point</b> is located at the Origin of the global
coordinate system, and the \b Vector corresponds to OZ axis of the global
coordinate system.
\image html ellipse.png

2
doc/salome/gui/GEOM/input/creating_extrusion.doc
View File

@ -37,7 +37,7 @@ shell) serving as base object + 2 vertices.
\n Finally, you can define the \b Extrusion by the <b>Base Shape</b>
and the <b>DX, DY, DZ</b> Vector\n
<b>Both Directions</b> checkbox allows extruding the
source objects forward and backward also.
source objects both forward and backward.
\n <b>TUI Command:</b> <em>geompy.MakePrismDXDYDZ(Base, dx, dy, dz)</em>
\n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
shell) serving as base object + 3 axis directions.

31
doc/salome/gui/GEOM/input/creating_squareface.doc
View File

@ -1,33 +1,34 @@
/*!
\page create_squareface_page Face
\page create_squareface_page Square Face
To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
A primitive called <b>Square Face</b> is a square plane of certain dimensions and orientation
To create a \b Square Face in the <b>Main Menu</b> select <b>New Entity - >
Primitives - > Face</b>
\n There are 2 algorithms to create a \b Face in 3D space.
\n There are 2 algorithms to create a \b Square \b Face in the 3D space.
\n The \b Result of each operation will be a GEOM_Object (Face).
\n Firstly, you can create a \b Face by the given height and width at the origin
of coordinates. You can define the axis of the face by the orientation
group buttons. There are three options to create a face in OXY, OYZ or OZX Planes.
\n Firstly, you can create a \b Face at the origin
of coordinates defining its boundaries by the height and the width and its axis by the orientation
radio buttons (OXY, OYZ or OZX).This
means that the Square Face will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
\n <b>TUI Command:</b> <em>geompy.MakeFaceHW(Height, Width, Orientation)</em>
\n <b>Arguments:</b> Name + 3 values (Dimensions at origin: heigth, width and
orientation).
\n The orientation can be defined by "1", "2" or "3" values. This
means that the Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
\image html face1.png
\n Secondly, you can define a \b Face by a \b Vector giving the face's normal to the center and
\b Heigth and Width sizes.
\n Secondly, you can define a \b Face by Heigth and Width sizes and an \b Edge defining the normal to the center of the face.
\n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Vector, Height, Width)</em>
\n <b>Arguments:</b> Name + 1 Vector (normale to the center) + 2 doubles (to
\n <b>Arguments:</b> Name + 1 Vector (normal to the center) + 2 doubles (to
describe a face sizes).
\n You can also create face from another selected face. Just turn the <b>Object Type</b> button
to condition \b Face, then you can select a face object and set new values of
Height and Width for the newly face. The created face will lie in the plane
of the selected face.
\n It is also possible to create a Square Face from another selected face. For this, switch the <b>Object Type</b> button
to \b Face, then select a face object and set the values of
Height and Width for the new face. The created face will lie in the plane of the selected face.
\n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Face, Height, Width)</em>
\n <b>Arguments:</b> Name + 1 Face + 2 parameters (to describe a face sizes).

10
doc/salome/gui/GEOM/input/import_export.doc
View File

@ -22,11 +22,11 @@ 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 <b>Object Browser</b>.
\note You can re-open ones imported shape from the initial file, if
the file has been changed on disk. Use for that item
<b>Reload From Disk</b> from context menu of imported
shape. Reloaded shape will have the same representation parameters
like before this operation.
\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
<b>Reload From Disk</b> in the context menu of the imported
shape. The reloaded shape will have the same representation parameters
as before this operation.
\image html geomimport_reopen.png

14
doc/salome/gui/GEOM/input/working_with_groups.doc
View File

@ -21,20 +21,20 @@ In this Menu:
<ul>
<li><b>Shape Type</b> radio button defines the type of elements for the
group (points, wires, faces, shells or solids).</li>
<li><b>Group Name</b> - here you can enter the name of the group, by
<li><b>Group Name</b> - allows defining the name of the group, by
default, it is Group_n.</li>
<li>Then, using the "Select" button, select the <b>Main Shape</b> (a
geometrical object on which the group will be created). </li>
<li> <b>Main Shape Selection restriction</b> button group lets you restrict the range
of group elements you operate with.
<ul><li> <b>No restriction</b> button enables work with all sub-shapes of the Main
<li> <b>Main Shape Selection restriction</b> button group allows limiting the range
of available group elements,
<ul><li> <b>No restriction</b> button enables all sub-shapes of the Main
Shape.</li>
<li><b>Geometrical parts of the Second Shape</b> restricts the range of accessible
elements to those sub-shapes of the Main Shape that geometrically
elements to the sub-shapes of the Main Shape that geometrically
coincide with the <b>Second Shape</b>.</li>
<li><b>Only Sub-Shapes of the Second Shape</b> restricts the range of
accessible elements to those sub-shapes of the Main Shape that
are sub-shapes of <b>Second Shape</b>. This is useful because
accessible elements to the sub-shapes of the Main Shape that
are sub-shapes of the <b>Second Shape</b>. This is useful because
sometimes purely geometrical coincidence is not enough and it
is necessary to work with shapes, which actually belong both
to the main and the second shape.</li>