]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Common update of Salome GUI documentation V5_1_0rc1
authormaintenance team <salome-mnt@opencascade.com>
Thu, 13 Nov 2008 10:22:41 +0000 (10:22 +0000)
committermaintenance team <salome-mnt@opencascade.com>
Thu, 13 Nov 2008 10:22:41 +0000 (10:22 +0000)
doc/salome/gui/GEOM/images/geomcreategroup.png
doc/salome/gui/GEOM/input/creating_circle.doc
doc/salome/gui/GEOM/input/creating_disk.doc
doc/salome/gui/GEOM/input/creating_ellipse.doc
doc/salome/gui/GEOM/input/creating_extrusion.doc
doc/salome/gui/GEOM/input/creating_squareface.doc
doc/salome/gui/GEOM/input/import_export.doc
doc/salome/gui/GEOM/input/working_with_groups.doc

index ea1e533ee93bda4c8c85b9e321844345db08a0b2..1682ae431902cf37d7828577302e40495b61c3b7 100755 (executable)
Binary files a/doc/salome/gui/GEOM/images/geomcreategroup.png and b/doc/salome/gui/GEOM/images/geomcreategroup.png differ
index 7b0442a3ae21b7a146e1e7817e7c98a58d19f86e..787f06cf2d404f9c3bbea49ef106b9ce68d2b9b8 100644 (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
index 821198c43121067187d645f8e33b0a6f886bea8d..064ea0abb4f785206aff607892267e0c22dfb0bf 100755 (executable)
@@ -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
index 8d9fdc6f2d57ec70af912ec9b1e60b96d4ad0e26..2023d2cdf1b2789fc36ff3e05042384a62783ad2 100644 (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
index 70cc6edb0d15d0d3ab612e66b4fa87df26e4bf8e..6cc92388cb0980d68a744fa1093005f65828d1d4 100644 (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.
index effcc67e534875f7d79e4b9787d2e6509a575a9d..15db5f23fc28960844f97aa57d9305770da7cea0 100755 (executable)
@@ -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).
 
index 25eb1ae6741d219c2ea9fef59d1018962df38715..1cd5cc459c38372d9d2fd2c707153484dbd36d37 100644 (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
 
index a2ef93fc9be3d2b0c71203179a3066d434649bb0..5c924b3ec9092178b0706721af597f9e6cacb870 100644 (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>