From: maintenance team Date: Thu, 13 Nov 2008 10:22:41 +0000 (+0000) Subject: Common update of Salome GUI documentation X-Git-Tag: V5_1_0rc1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=3f8dbc26f727160982af5ab866ece45ecb29b499;p=modules%2Fgeom.git Common update of Salome GUI documentation --- diff --git a/doc/salome/gui/GEOM/images/geomcreategroup.png b/doc/salome/gui/GEOM/images/geomcreategroup.png index ea1e533ee..1682ae431 100755 Binary files a/doc/salome/gui/GEOM/images/geomcreategroup.png and b/doc/salome/gui/GEOM/images/geomcreategroup.png differ diff --git a/doc/salome/gui/GEOM/input/creating_circle.doc b/doc/salome/gui/GEOM/input/creating_circle.doc index 7b0442a3a..787f06cf2 100644 --- a/doc/salome/gui/GEOM/input/creating_circle.doc +++ b/doc/salome/gui/GEOM/input/creating_circle.doc @@ -15,8 +15,8 @@ Radius) \n Arguments: Name + 1 vertex (for the center) + 1 edge (for the direction) + Radius. -\note Passing None as Center Point means Origin of global -coordinate system, passing None as \b Vector means OZ axis of global +\note By default it is presumed that the Center Point 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 diff --git a/doc/salome/gui/GEOM/input/creating_disk.doc b/doc/salome/gui/GEOM/input/creating_disk.doc index 821198c43..064ea0abb 100755 --- a/doc/salome/gui/GEOM/input/creating_disk.doc +++ b/doc/salome/gui/GEOM/input/creating_disk.doc @@ -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 Main Menu select New Entity - > Primitives - > Disk \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 TUI Command: geompy.MakeDiskR(Radius, Orientation) \n Arguments: 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 Center Point, a \b -Vector giving the circle's normal and a \b Radius. +Vector defining the normal of a circle and a \b Radius. \n TUI Command: geompy.MakeDiskPntVecR(Point, Vector, Radius) \n Arguments: Name + 1 vertex (for the center) + 1 edge (for diff --git a/doc/salome/gui/GEOM/input/creating_ellipse.doc b/doc/salome/gui/GEOM/input/creating_ellipse.doc index 8d9fdc6f2..2023d2cdf 100644 --- a/doc/salome/gui/GEOM/input/creating_ellipse.doc +++ b/doc/salome/gui/GEOM/input/creating_ellipse.doc @@ -12,8 +12,8 @@ Vector giving its normal, and its Major & Minor Radiuses. \n Arguments: Name + 1 vertex (for the center) + 1 edge (for the direction) + 1 X Radius + 1 Y Radius. -\note Passing None as Center Point means Origin of global -coordinate system, passing None as \b Vector means OZ axis of global +\note By default it is presumed that the Center Point 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 diff --git a/doc/salome/gui/GEOM/input/creating_extrusion.doc b/doc/salome/gui/GEOM/input/creating_extrusion.doc index 70cc6edb0..6cc92388c 100644 --- a/doc/salome/gui/GEOM/input/creating_extrusion.doc +++ b/doc/salome/gui/GEOM/input/creating_extrusion.doc @@ -37,7 +37,7 @@ shell) serving as base object + 2 vertices. \n Finally, you can define the \b Extrusion by the Base Shape and the DX, DY, DZ Vector\n Both Directions checkbox allows extruding the -source objects forward and backward also. +source objects both forward and backward. \n TUI Command: geompy.MakePrismDXDYDZ(Base, dx, dy, dz) \n Arguments: Name + 1 shape (vertex, edge, planar wire, face or shell) serving as base object + 3 axis directions. diff --git a/doc/salome/gui/GEOM/input/creating_squareface.doc b/doc/salome/gui/GEOM/input/creating_squareface.doc index effcc67e5..15db5f23f 100755 --- a/doc/salome/gui/GEOM/input/creating_squareface.doc +++ b/doc/salome/gui/GEOM/input/creating_squareface.doc @@ -1,33 +1,34 @@ /*! -\page create_squareface_page Face +\page create_squareface_page Square Face -To create a \b Disk in the Main Menu select New Entity - > +A primitive called Square Face is a square plane of certain dimensions and orientation + +To create a \b Square Face in the Main Menu select New Entity - > Primitives - > Face -\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 TUI Command: geompy.MakeFaceHW(Height, Width, Orientation) \n Arguments: 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 TUI Command: geompy.MakeFaceObjHW(Vector, Height, Width) -\n Arguments: Name + 1 Vector (normale to the center) + 2 doubles (to +\n Arguments: 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 Object Type 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 Object Type 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 TUI Command: geompy.MakeFaceObjHW(Face, Height, Width) \n Arguments: Name + 1 Face + 2 parameters (to describe a face sizes). diff --git a/doc/salome/gui/GEOM/input/import_export.doc b/doc/salome/gui/GEOM/input/import_export.doc index 25eb1ae67..1cd5cc459 100644 --- a/doc/salome/gui/GEOM/input/import_export.doc +++ b/doc/salome/gui/GEOM/input/import_export.doc @@ -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 Object Browser. -\note You can re-open ones imported shape from the initial file, if -the file has been changed on disk. Use for that item -Reload From Disk 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 +Reload From Disk 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 diff --git a/doc/salome/gui/GEOM/input/working_with_groups.doc b/doc/salome/gui/GEOM/input/working_with_groups.doc index a2ef93fc9..5c924b3ec 100644 --- a/doc/salome/gui/GEOM/input/working_with_groups.doc +++ b/doc/salome/gui/GEOM/input/working_with_groups.doc @@ -21,20 +21,20 @@ In this Menu: