From f5059c90f8ebf51a684f1d37e3900a2141d6c44e Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 20 Oct 2010 10:19:30 +0000 Subject: [PATCH] Update documentation for 5.1.5 --- doc/salome/gui/GEOM/input/creating_edge.doc | 28 ++++----- .../gui/GEOM/input/creating_filling.doc | 27 ++++----- doc/salome/gui/GEOM/input/index.doc | 3 +- .../GEOM/input/limit_tolerance_operation.doc | 16 ++--- .../input/multi_translation_operation.doc | 6 +- doc/salome/gui/GEOM/input/partition.doc | 60 +++++++++---------- .../GEOM/input/shape_processing_operation.doc | 10 ++-- .../gui/GEOM/input/translation_operation.doc | 4 +- 8 files changed, 76 insertions(+), 78 deletions(-) diff --git a/doc/salome/gui/GEOM/input/creating_edge.doc b/doc/salome/gui/GEOM/input/creating_edge.doc index bc8c79b64..ffbfa69de 100644 --- a/doc/salome/gui/GEOM/input/creating_edge.doc +++ b/doc/salome/gui/GEOM/input/creating_edge.doc @@ -8,8 +8,8 @@ Build > Edge There are two ways to create an edge. In both cases the \b Result will be a \b GEOM_Object (EDGE). -1. You can create an \b Edge by specifying two points (\b Point1 and -\b Point2), being the first and the last vertices of the edge. +Firstly, you can create an \b Edge by specifying two points (\b Point1 and +\b Point2), which are the first and the last vertices of the edge. TUI Command: geompy.MakeEdge(Vertex1, Vertex2)
Arguments: Name + 2 vertices (Vertex1 and Vertex2 are @@ -17,27 +17,27 @@ correspondingly the first and the last vertex of the edge). \image html edge1.png "Create edge by two points" -2. You can create an \b Edge by specifying single wire. +Secondly, you can create an \b Edge by specifying a single wire. In this mode the following use cases are possible: -- All the edges, forming the wire, lie on the single geometrical curve +- All edges that form the wire lie on the same geometrical curve (i.e. curve(edge1) == curve(edge2)). -- The edges forming the wire, lie on the analytical curves of the same -type, for example, segments of line, arcs, etc. In this case, an -algorithm checks the geometrical coincidence of these curves using -some tolerance. If the curves are coinciding in terms of given -tolerance, resulting edge is built as on a single curve. -- The edges forming the wire have the same tangency in the connection +- The edges that form the wire lie on analytical curves of the same +type, for example, segments of line, arcs, etc. In this case, the +algorithm checks geometrical coincidence of these curves using +a certain tolerance. If the curves are coinciding in terms of the given +tolerance, the resulting edge is built as if on a single curve. +- The edges that form the wire have the same tangency in the connection points. In this case the curves are interpolated by the single -b-spline curve with the sufficient precision. The resulting edge will -be then built on this curve. +b-spline curve with sufficient precision. The resulting edge will +be built on this curve. -The case when the edges forming the wire have different tangency in +The case when the edges that form the wire have different tangency in the connection points (sharp bend) is not processed. TUI Command: geompy.MakeEdgeWire(Wire, LinearTolerance, AngularTolerance)
Arguments: Name + 1 wire + Linear Tolerance + Angular Tolerance -(tolerance are used to check coincidence of the edges' underlying curves). +(tolerance values are used to check coincidence of the underlying curves). \image html edge2.png "Create edge from wire" diff --git a/doc/salome/gui/GEOM/input/creating_filling.doc b/doc/salome/gui/GEOM/input/creating_filling.doc index a66bb45f0..5074f4eed 100644 --- a/doc/salome/gui/GEOM/input/creating_filling.doc +++ b/doc/salome/gui/GEOM/input/creating_filling.doc @@ -4,39 +4,38 @@ To generate a \b Filling in the Main Menu select New Entity - > Generation - > Filling -To create a curving face using several edges you need to define the +To create a curvilinear face from several edges you need to define the following parameters: \n Input Compound - the list of edges/wires used for creation -of the surface. Before perform filling algorithm each wire from -compound is converted to one edge created on BSpline curve built using -curves from all edges from wire. +of the surface. To prepare for the filling each wire of the compound +is converted to an edge created on a BSpline curve built using curves +from all edges of the wire. \n \b Minimum and Maximum Degree of equation of the resulting BSpline or Besier curves describing the surface; \n \b Tolerance for \b 2D and for \b 3D - minimum distance between the created surface and the reference edge; -\n Number of -Iterations - defines the maximum number of iterations. The +\n Number of Iterations - defines the maximum number of iterations. The iterations are repeated until the required tolerance is reached. So, a greater number of iterations allows producing a better surface. \n Method - Kind of method to perform filling operation -1. Default - standard behaviour -2. Use edges orientation - orientation of edges are used: if edge is -reversed curve from this edge is reversed before using in filling +1. Default - the standard behaviour. +2. Use edges orientation - the edges orientation is used: if an edge is +reversed, the curve from this edge is reversed before being used by the filling algorithm. -3. Auto-correct edges orientation - change orientation of curves using -minimization of sum of distances between ends points of edges. +3. Auto-correct edges orientation - curves orientation is changed to +minimize the sum of distances between ends points of edges. \n Approximation - if checked, BSpline curves are generated in the process of surface construction (using GeomAPI_PointsToBSplineSurface functionality). By default the surface is created using Besier curves. The usage of Approximation -makes the algorithm work slower, but allows building the surface for -rather complex cases. +slows the algorithm, but allows building the surface for complex cases. \n The \b Result of the operation will be a GEOM_Object (face). \n TUI Command: geompy.MakeFilling(Edges, MinDegree, MaxDegree, Tol2D, Tol3D, NbIter) \n Arguments: Name + 1 List of edges + 7 Parameters -(Min. degree, Max. degree, 2D tolerance, 3D tolerance, Number of iterations, Method, Approximation). +(Min. degree, Max. degree, Number of iterations, 2D tolerance, 3D +tolerance, Number of iterations, Method, Approximation). \image html filling.png diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc index f612e7108..856e03a54 100644 --- a/doc/salome/gui/GEOM/input/index.doc +++ b/doc/salome/gui/GEOM/input/index.doc @@ -23,8 +23,7 @@ various algorithms; Almost all geometry module functionalities are accessible via \subpage geompy_page "Geometry module Python Interface" -\n Have a look also at the - documentation of the GEOM python packages +Also it can be useful to have a look at the \subpage geompypkg_page "documentation on GEOM python packages". \image html image3.png "Example of Geometry module usage for engineering tasks" diff --git a/doc/salome/gui/GEOM/input/limit_tolerance_operation.doc b/doc/salome/gui/GEOM/input/limit_tolerance_operation.doc index 3767c0c99..f7c0b2e84 100644 --- a/doc/salome/gui/GEOM/input/limit_tolerance_operation.doc +++ b/doc/salome/gui/GEOM/input/limit_tolerance_operation.doc @@ -13,25 +13,25 @@ \n The \b Result will be a \b GEOM_Object. -\n This functionality tries to set new value of tolerance for the - given shape. But the final tolerance value depends also on the - initial shape topology (regards existing gaps) in order to obtain - valid resulting shape. +\n This functionality tries to set a new value of tolerance for the + given shape. However, the final tolerance value also depends on the + initial shape topology (takes into consideration the existing gaps) to obtain + a valid resulting shape. \n Example of usage:
    -
  1. Try a partition on objects obj1 and obj2.
    2. +
  2. Partition objects obj1 and obj2.
  3. Partition fails.
  4. Perform Limit Tolerance on objects obj1 and obj2.
    5. -
  5. Try again the partition.
    6. +
  6. Try to partition them again.
See also \ref tui_limit_tolerance "TUI example". \n TUI Command: geompy.LimitTolerance(Shape, Tolerance), where \em Shape is a shape with presumably incorrect tolerance, \em - Tolerance is a desired value of tolerance. + Tolerance is the required tolerance value. -Our TUI Scripts provide you with useful examples of the use of +Our TUI Scripts provide you with useful examples of \ref tui_limit_tolerance "Repairing Operations". */ diff --git a/doc/salome/gui/GEOM/input/multi_translation_operation.doc b/doc/salome/gui/GEOM/input/multi_translation_operation.doc index d33346d1b..7e6d64f46 100644 --- a/doc/salome/gui/GEOM/input/multi_translation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_translation_operation.doc @@ -12,8 +12,8 @@ two directions. \n To produce a Simple Multi Translation (in one direction) you need to indicate an \b Object to be translated, a \b Vector of translation, a \b Step of translation and a Number of Times the -Object should be duplicated. If a curve was selected instead of Vector, -only its first and last vertices will be used to get the vector direction +Object should be duplicated. If a curve has been selected instead of +the Vector, only its first and last vertices will be used to get the vector direction and the dialog preview will display the vector along which the object will be translated. \n TUI Command: geompy.MakeMultiTranslation1D(Shape, Dir, Step, NbTimes) @@ -29,7 +29,7 @@ step value + 1 value (repetition). \n To produce a Double Multi Translation (in two directions) you need to indicate an \b Object to be translated, and, for both axes, a \b Vector of translation, a \b Step of translation and a Number of Times the shape must be duplicated. -If a curve was selected instead of Vectors, only its first and last vertices will be used to get the vector direction +If a curve has been selected instead of the Vector, only its first and last vertices will be used to get the vector direction and the dialog preview will display the vector along which the object will be translated. \n TUI Command: geompy.MakeMultiTranslation2D(Shape, Dir1, diff --git a/doc/salome/gui/GEOM/input/partition.doc b/doc/salome/gui/GEOM/input/partition.doc index db9148d97..c58d6ed63 100644 --- a/doc/salome/gui/GEOM/input/partition.doc +++ b/doc/salome/gui/GEOM/input/partition.doc @@ -6,7 +6,7 @@ To produce a \b Partition in the Main Menu select Operations - > Parti This operation builds a compound by intersection of several shapes with a set of tool objects or with a plane. -The \b Result will be \b GEOM_Object. +The \b Result will be a \b GEOM_Object.

Intersection of two shapes.

@@ -20,7 +20,7 @@ As far as the intersection of two objects can produce any type of geometrical objects, Resulting type box allows choosing the preferrable result, i.e. a solid, a shell, a list of faces, etc. -Resulting type has to be equal or lower than the type of the +The Resulting type has to be equal or lower than the type of the \em Objects. In other words, if the \em Objects don't contain any shape of this type, Partition fails. @@ -28,30 +28,30 @@ shape of this type, Partition fails. type other than the \em Limit. If it is checked, lower dimension objects will be preserved, else they will be lost. -For example, you do a partition of a box (Solid) and a face (Face) -without any tool. If you choose Resulting Type "Solid", you will -obtain a compound of two solids (let's the box will be splitted by the -face on two parts), but if you will also check Keep shapes of lower +For example, you partition a box (Solid) and a face (Face) +without any tool (the box is split in two parts by the shape). If you +choose the Resulting Type "Solid", you will +obtain a compound of two solids, but if you also check Keep shapes of lower type checkbox, you will obtain a compound of two solids and one -face (the face will have a hole where the original face lays inside -the box, see corresponding \ref partition_picture_3 "picture" below). +face (there will be a hole in the resulting face, where the original +face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below). -No sub-shapes intersection (Compounds only) check box affects only input shapes -of the Compound type. If this option is switched off (default -behavior) each input compound will be automatically exploded to the -sub-shapes and intersection between those shapes will be also +No sub-shapes intersection (Compounds only) check box affects +only input shapes of the Compound type. If this option is switched off (default +behavior) each input compound will be automatically exploded into +sub-shapes and the intersection between these shapes will be also computed. If this option is switched on, the intersection between -sub-shapes will be not performed. In this case the Partition algorithm -will work faster, but result might differ from the default behavior. +sub-shapes will not be performed. In this case the Partition algorithm +will work faster, but the result might differ from the default behavior. Advanced option: \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". -\note Partition is a kind of complex operation, result of it depends - on the initial shapes quality. Sometimes, if partition fails, - some healing operations could help. Try Shape Processing - and Limit Tolerance in such cases. See also \ref - tui_limit_tolerance "TUI example" of shape healing. +\note Partition is a complex operation, so its result of it depends + on the quality of the initial shapes. Sometimes, if partition fails, + such healing operations as Shape Processing + and Limit Tolerance can help to attune source shapes to obtain correct result of the Partition. + See also \ref tui_limit_tolerance "TUI example" of shape healing. TUI Command (with sub-shapes intersection): @@ -59,7 +59,7 @@ will work faster, but result might differ from the default behavior. ListOfRemoveInside, Limit, RemoveWebs, ListOfMaterials, KeepNonlimitShapes) -TUI Command (no sub-shapes intersection): +TUI Command (without sub-shapes intersection): geompy.MakePartitionNonSelfIntersectedShape(ListOfShapes, ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs, @@ -68,10 +68,10 @@ ListOfMaterials, KeepNonlimitShapes) Here, - \em ListOfShapes is a list of shapes to be intersected - \em ListOfTools is a list of shapes to intersect the shapes from -ListOfShapes -- \em Limit is a Type of resulting shapes and \em KeepNonlimitShapes -is a flag that allows to preserve standalone shapes of low dimension -(than \em Limit) in the result. +\em ListOfShapes +- \em Limit is a Type of resulting shapes +- \em KeepNonlimitShapes is a flag that allows to preserve standalone +shapes of low dimension (than \em Limit) in the result. - Other parameters are obsolete and kept only for compatibility with previous versions of SALOME. @@ -86,20 +86,20 @@ previous versions of SALOME. TUI Command: -geompy.MakeHalfPartition(Shape, Plane) where -- \em Shape is a source shape to be intersected by \em Plane +geompy.MakeHalfPartition(Shape, Plane), where: +- \em Shape is a source shape to be intersected by the \em Plane - \em Plane is a tool shape, to intersect the \em Shape. -Example: +Examples: \image html partitionsn1.png "Box intersected by a plane" \image html partitionsn2.png "Result of intersection" \anchor partition_picture_3 -\image html partitionsn3.png "Result of intersection of a box and a plane (both as \em Objects, no tools) with Resulting type \em Solid and checked \em Keep \em shapes \em of \em lower \em type" +\image html partitionsn3.png "Result of intersection of a box and a +plane (both as \em Objects, no tools) with the Resulting type \em Solid and checked "Keep shapes of lower type" -Our TUI Scripts provide you with useful examples of the use of -\ref tui_partition "Basic Operations". +Our TUI Scripts provide you with useful examples of \ref tui_partition "Basic Operations". */ diff --git a/doc/salome/gui/GEOM/input/shape_processing_operation.doc b/doc/salome/gui/GEOM/input/shape_processing_operation.doc index 7d7c9a406..5aac5fd14 100644 --- a/doc/salome/gui/GEOM/input/shape_processing_operation.doc +++ b/doc/salome/gui/GEOM/input/shape_processing_operation.doc @@ -15,16 +15,16 @@ is a list of operators ("FixShape", "SplitClosedFaces", etc.), etc), \em Values is a list of values of parameters placed in the same order as in the list of Parameters. -\note Shape Processing is usefull not only on invalid shapes, - but sometimes also on shapes, that are classified as valid by - the Check functionality. Use it, if some operation (for +\note Shape Processing is useful not only on invalid shapes, + but also on the shapes, that are classified as valid by + the Check functionality. Use it, if an operation (for example, Partition) fails. Example of usage:
    -
  1. Try a partition on objects obj1 and obj2.
    2. +
  2. Try to partition objects obj1 and obj2.
  3. Partition fails.
  4. Perform Shape Processing on objects obj1 and obj2.
    5. -
  5. Try again the partition.
    6. +
  6. Try to partition them again.
See also \ref tui_limit_tolerance "TUI example". diff --git a/doc/salome/gui/GEOM/input/translation_operation.doc b/doc/salome/gui/GEOM/input/translation_operation.doc index c36a259a3..98fe6808a 100644 --- a/doc/salome/gui/GEOM/input/translation_operation.doc +++ b/doc/salome/gui/GEOM/input/translation_operation.doc @@ -31,8 +31,8 @@ of the vector. \image html transformation2.png -\n Finally you can define an \b Object and the vector. The object will be translated by the length of the vector. -If a curve was selected instead of vector, only its first and last vertices will be used to get the vector direction +\n Finally you can define an \b Object and a vector. The object will be translated by the length of the vector. +If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction and the dialog preview will display the vector along which the object will be translated. \n TUI Command: geompy.MakeTranslationVector(Object, Vector) \n Activate Distance checkbox and Distance field allow defining the custom distance of translation. -- 2.39.2