From: ysn Date: Mon, 25 May 2015 09:45:48 +0000 (+0300) Subject: Help Update for V76 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=refs%2Fheads%2FHelpUpdateV76;p=modules%2Fgeom.git Help Update for V76 --- diff --git a/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc b/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc index 187cefbcd..92d6c31a1 100644 --- a/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc +++ b/doc/salome/gui/GEOM/input/add_point_on_edge_operation.doc @@ -10,25 +10,24 @@ This operation is available in OCC Viewer only. The \b Result will be a \b GEOM_Object. -\n Location of a new vertex on a selected edge can be defined two ways: +\n The location of a new vertex on the selected edge can be defined in two ways:
    -
  1. We can specify a position (ranging from 0.0 to 1.0) of the - vertex on the selected edge either by length or by parameter. +
  2. By specifying the position (ranging from 0.0 to 1.0) by length or by parameter.

    TUI Command: geompy.DivideEdge(Shape, EdgeID, Value, IsByParameter)

      -
    • \em Shape is a shape which contains an edge to be divided
      • +
    • \em Shape is a shape, which contains an edge to be divided;
    • \em EdgeID is the ID of the edge to be divided, if it is = -1, - then \em Shape should be an edge itself.
      • + then \em Shape should be an edge itself;
    • \em Value is a value of parameter on edge or length parameter, - depending on \em IsByParameter.
      • -
    • \em IsByParameter is a boolean flag, specifying operation mode: - - \c True: \em Value is treated as a curve parameter [0..1] - - \c False: \em Value is treated as a length parameter [0..1]
      • + depending on \em IsByParameter; +
    • \em IsByParameter is a boolean flag, specifying the operation mode: + - \c True: \em Value is treated as a curve parameter; [0..1] + - \c False: \em Value is treated as a length parameter. [0..1]
    \b Arguments: Name + 1 Edge + 1 Value setting the position of - the point according to one of the selected modes. + the point according to the selected mode. The difference between "by parameter" and "by length" modes becomes apparent on the edges with irregular parametrization (for example, @@ -41,15 +40,15 @@ The \b Result will be a \b GEOM_Object. \image html repair8.png \n\n
    3. -
  3. We can select several points that will be projected to the selected +
  4. By selecting several points that will be projected to the selected edge to find the location of new vertices.

    - TUI Command: geompy.DivideEdgeByPoint(Shape, Edge, Points) + TUI Command: geompy.DivideEdgeByPoint(Shape, Edge, Points):

      -
    • \em Shape is a shape which contains an edge to be divided
      • -
    • \em Edge is an edge to be divided (or it's ID, if it is = -1, - then \em Shape should be an edge itself).
      • -
    • \em Points is a list of points to project to \a Edge.
      • +
    • \em Shape is a shape, which contains an edge to be divided;
      • +
    • \em Edge is an edge to be divided (or its ID, if it is = -1, + then \em Shape should be an edge itself);
      • +
    • \em Points is a list of points to be projected to the \a Edge.
    \b Arguments: Name + 1 Edge + 1 or more Points. diff --git a/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc b/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc index 7151dcff7..d903fc1ba 100644 --- a/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc +++ b/doc/salome/gui/GEOM/input/check_compound_of_blocks.doc @@ -8,10 +8,10 @@ This operation checks whether a shape is a compound of glued blocks. To be considered as a compound of blocks, the given shape must satisfy the following conditions: -- Each element of the compound should be a Block (6 quadrangle faces); -- Each quadrangle face is a face that has 1 wire with 4 edges. If there are -more than 4 edges in a single wire and C1 continuity mode is switched on, -a face is quadrangular if it has 4 bounds of C1 continuity. +- Each element of the compound should be a Block, i.e. have 6 quadrangle faces; +- Each quadrangle face should have one wire with four edges. If there are +more than four edges in a single wire and C1 continuity mode is switched on, +a face is quadrangular if it has four bounds with C1 continuity. - Blocks can be connected only via an entire quadrangle face or an entire edge; - The compound should be connected; - Each couple of connecting quadrangle faces should be glued. @@ -20,7 +20,7 @@ a face is quadrangular if it has 4 bounds of C1 continuity. In this dialog: - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser. -- Use C1 criterion - option that shitches on/off the C1 continuity mode. +- Use C1 criterion - option switches on/off the C1 continuity mode. - Angular Tolerance - angular tolerance to check C1 continuity between neighbor edges in a wire. - \b Errors list informs of possible errors, for example: - Not a block; diff --git a/doc/salome/gui/GEOM/input/check_self_intersections.doc b/doc/salome/gui/GEOM/input/check_self_intersections.doc index 8cf4d57bf..41658151a 100644 --- a/doc/salome/gui/GEOM/input/check_self_intersections.doc +++ b/doc/salome/gui/GEOM/input/check_self_intersections.doc @@ -9,17 +9,14 @@ This operation checks the topology of the selected shape to detect self-intersec In this dialog: - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser. -- Level of check - The combo box that allows to set the level of checking shape on self-interference. - It defines which interferferences will be checked. Default value is "All interferences". -- Compute self-intersections button computes self-interferences. -- \b Summary section contains the general report if the object has self-intersections and/or if errors are occured during computation. -- \b Self-intersections list contains the list of self-intersections detected. -Select the intersection(s) to show Sub-shapes in the field to the right. -- \b Apply and Apply and Close buttons are used to store interferences selected in the "Self-intersections" list box in the study for further analysis. -If no any interference is selected, all interferences are published in the study. Each interference is published as a child -compound of the source shape and contains a couple of intersecting sub-shapes. - -\note This tool is useful for detection of shapes, not suitable for +- Level of check - combo box allows setting the level of self-interference checking. It defines, which interferences will be checked. The default value is "All interferences". +- Compute self-intersections button performs the computation. +- \b Summary section contains the general report about self-intersections of the object and/or errors that occurred during the computation. +- \b Self-intersections list contains the list of detected self-intersections. Select the intersection to show Sub-shapes in the field to the right. +- \b Apply and Apply and Close buttons store the interferences selected in the Self-intersections list box in the study for further analysis. +If no interferences are selected, all of them are published in the study. Each interference is published as a child compound of the source shape and contains a couple of intersecting sub-shapes. + +\note This tool is useful for detection of shapes that are not suitable as arguments of Boolean operations and Partition algorithm. For more information about Partition and Boolean Operations Algorithms and their limitations refer to this document. diff --git a/doc/salome/gui/GEOM/input/creating_complex_obj.doc b/doc/salome/gui/GEOM/input/creating_complex_obj.doc index 1fbb1d6a2..01b6eb85f 100644 --- a/doc/salome/gui/GEOM/input/creating_complex_obj.doc +++ b/doc/salome/gui/GEOM/input/creating_complex_obj.doc @@ -15,10 +15,8 @@ axis, creating a body of revolution.
  5. \subpage create_extrusion_alongpath_page "Extrude an object along a path", creating a more complex trajectory object.
  6. \subpage create_pipe_path_page "Restore Path" of a pipe-like shape.
    7. -
  7. \subpage create_thickness_page "Thickness" operation that allows to add a thickness to objects.
    8. - -
  8. \subpage create_groups_page "Generate Groups". -This cross-operation functionality allows creation of groups for certain generation operations.
    9. +
  9. \subpage create_thickness_page "Add thickness" to objects.
    10. +
  10. \subpage create_groups_page "Generate Groups" for certain generation operations.
    11. New entity -> Advanced sub-menu allows creating new geometric diff --git a/doc/salome/gui/GEOM/input/creating_explode.doc b/doc/salome/gui/GEOM/input/creating_explode.doc index c25b719ae..693773973 100644 --- a/doc/salome/gui/GEOM/input/creating_explode.doc +++ b/doc/salome/gui/GEOM/input/creating_explode.doc @@ -16,7 +16,7 @@ obtain from it. The \b Result of the operation will be a List of \b GEOM_Objects (vertexes, edges, wires, faces, shells or solids). -Available choices in the Sub Shapes Type combo box depend on the type +The choices available in the Sub Shapes Type combo box depend on the type of selected Main Object: - \b Compound: to extract compounds; - \b Compsolid: to extract compsolids; @@ -29,72 +29,70 @@ of selected Main Object: - \b Shape: to extract top-level contents of the compound shape; - \b Flat: to extract "flat" contents of the compound shape. -Note: "flat" contents means top-level simple-type sub-shapes extracted from -the compound object recursively (i.e. there is no compounds in the result). -For example, if a compound C1 contains a solid S1 and another compound C2 that -contains solids S2 and S3 (see picture below): +Note: "flat" contents means that top-level simple-type sub-shapes are extracted from +the compound object recursively (i.e. there are no compounds in the result). + +Let us take, for example, compound C1 that contains solid S1 and another compound C2 that +contains solids S2 and S3 (see the picture below): - Explode operation with \b Shape type given as parameter will return S1 and C2; - Explode operation with \b Flat type given as parameter will return S1, S2 and S3. \image html flat_contents.png Switching on Select Sub-shapes check box allows manual selection of sub-shapes -to be extracted from the main object. In this mode the user can select sub-shapes +to be extracted from the main object. In this mode it is possible to select sub-shapes directly in 3D viewer. When Select Sub-shapes check box is switched on, additional \b Filter controls -allow to automatically pick up entites which satisfy specified threshold value(s). -The numerical functor for each sub-shape that is compared with threshold value(s) -is computed according to the shape's topological properties: -- length for edges and wires -- area for faces and shells -- volume for solids, compounds, compsolids +allow to automatically pick up entities, which satisfy the specified threshold value(s). +The numerical functor for each sub-shape that is compared with the threshold value(s) +is computed according to the topological properties of the shape: +- length for edges and wires; +- area for faces and shells; +- volume for solids, compounds and compsolids. Filtering capabilities are not available for vertices. -In order to filter out some entities: -- Activate one or two filtering controls by switching on corresponding check boxes; -- Select required threshold comparator type; the following choices are available: +To filter out some entities it is necessary to do the following: +- Activate one or two filtering controls by switching on the corresponding check boxes; +- Select the required threshold comparator type; the following choices are available: - Less Than or Equal or Less Than for the first comparator; - Greater Than or Equal or Greater Than for the second comparator; -- Enter required threshold value (values); +- Enter the required threshold value (values); - Press \b Apply button in the \b Filter group. -The entities which satisfy entered filtering parameters will be automatically highlighted +The entities, which correspond to the entered filtering parameters, will be automatically highlighted in the 3D viewer. Using TUI Commands you can perform this operation in a variety of ways: - geompy.ExtractShapes(Shape, Type, isSorted) explodes a Shape into sub-shapes of a given Type and returns a List of sub-shapes. - This method does not return the Shape itself if it matches the - Type. -- geompy.SubShapeAll(Shape, Type) explodes a Shape on + This method does not return the Shape itself if it matches the Type. +- geompy.SubShapeAll(Shape, Type) explodes a Shape into sub-shapes of a given Type and returns a List of sub-shapes. -- geompy.SubShapeAllIDs(Shape, Type) explodes a Shape on - sub-shapes of a given Type and returns a List of IDs of - sub-shapes. +- geompy.SubShapeAllIDs(Shape, Type) explodes a Shape into sub-shapes of a given Type and returns a List of IDs of sub-shapes. - geompy.SubShapeAllSortedCentres(Shape, Type) explodes a - shape on sub-shapes of a given type and sorts them taking into account + shape into sub-shapes of a given type and sorts them taking into account their gravity centers, to provide a stable order of sub-shapes. It returns a list of sub-shapes. - geompy.SubShapeAllSortedCentresIDs(Shape, Type) explodes - a shape on sub-shapes of a given type and sorts them taking into + a shape into sub-shapes of a given type and sorts them taking into account their gravity centers, to provide a stable order of sub-shapes. It returns a List of IDs of sub-shapes. - geompy.SubShape(Shape, Type, ListOfInd) allows to obtain - a compound of sub-shapes of the Shape, selected by they indices in a + a compound of sub-shapes of the Shape, selected by their indexes in a list of all sub-shapes of the given Type. Each index is in the range [1, Nb_Sub-Shapes_Of_Given_Type]. - geompy.SubShapeSortedCentres(Shape, Type, ListOfInd) allows to obtain a compound of sub-shapes of the Shape, selected by - they indices in sorted list of all sub-shapes of the given Type. Each + their indexes in a sorted list of all sub-shapes of the given Type. Each index is in the range [1, Nb_Sub-Shapes_Of_Given_Type] Arguments: 1 SHAPE + 1 type of SubShape. Example: -\image html explode.png "A box, exploded into faces" +\image html explode.png "A box exploded into faces" */ diff --git a/doc/salome/gui/GEOM/input/creating_surface_from_face.doc b/doc/salome/gui/GEOM/input/creating_surface_from_face.doc index 6034ed5e3..a707dc64e 100644 --- a/doc/salome/gui/GEOM/input/creating_surface_from_face.doc +++ b/doc/salome/gui/GEOM/input/creating_surface_from_face.doc @@ -4,10 +4,10 @@ To create a Surface From Face in the Main Menu select New Entity - > Basic - > Surface From Face -\n This function takes some face as input parameter and creates new -GEOM_Object, i.e. topological shape by extracting underlying surface -of the source face and limiting it by the Umin, Umax, Vmin, Vmax -parameters of the source face (in the parametrical space). +\n This function takes a face at input and creates a new +GEOM_Object, i.e. topological shape by extracting the underlying surface +of the source face and limiting it by the Umin, Umax, Vmin and Vmax +parameters of the source face (in the parametric space). \n \ref restore_presentation_parameters_page "Advanced options". diff --git a/doc/salome/gui/GEOM/input/creating_thickness_page.doc b/doc/salome/gui/GEOM/input/creating_thickness_page.doc index 140c02fc1..88dfc221e 100644 --- a/doc/salome/gui/GEOM/input/creating_thickness_page.doc +++ b/doc/salome/gui/GEOM/input/creating_thickness_page.doc @@ -2,26 +2,28 @@ \page create_thickness_page Thickness Construction -To add a \b Thickness to a shape in the Main Menu select New Entity - > Generation - > Thickness -\n -It is possible to create a Solid from a Face or a Shell by applying a -\b Thickness. To do it you should define an \b Object that is a Face or a -Shell, \b Thickness and to define the thickness direction by means of -Thicken towards the inside check box. +To add \b Thickness to a shape in the Main Menu select New Entity - > Generation - > Thickness. + +Switch between adding thickness to a Face (Shell) or a Solid using radio buttons. + +Firstly, \b Thickness can be applied to a Face or a Shell to create a Solid. \image html thickness.png +It is necessary to define an \b Object (Face or Shell) and the value of \b Thickness. +Thicken towards the inside check box allows changing the thickness direction. + Example: \image html thickness_result.png "Thickness of Shell" -It is possible to apply \b Thickness to a Solid. The result of this operation -is the hollowed Solid. To do it you should define an \b Object that is a Solid, -\b Faces to be removed from result, \b Thickness and the thickness direction by -means of Thicken towards the inside check box. +Secondly, the \b Thickness can be applied to a Solid to create a hollowed Solid. \image html thicksolid.png +It is necessary to define a Solid \b Object \b Faces to be removed from the result and \b Thickness. +Thicken towards the inside check box allows changing the thickness direction. + Example: \image html thicksolid_result.png "Thickness of Solid" @@ -36,8 +38,8 @@ Modifies a shape to make it a thick solid. Arguments: Name + 1 shape (face, shell or solid) + thickness + the list of face IDs. -\n If the shape is face or shell the list of face IDs is not used. -The thickness can be positive or negative for thicken towards the inside. +\n If the shape is a face or a shell the list of face IDs is not used. +The thickness can be positive or negative for thickening towards the inside. \n\n Advanced options \ref preview_anchor "Preview" Our TUI Scripts provide you with useful examples of creation of diff --git a/doc/salome/gui/GEOM/input/dependency_tree.doc b/doc/salome/gui/GEOM/input/dependency_tree.doc index 2f07c9bd3..b8346eec7 100644 --- a/doc/salome/gui/GEOM/input/dependency_tree.doc +++ b/doc/salome/gui/GEOM/input/dependency_tree.doc @@ -34,7 +34,7 @@ All necessary parameters of Dependency Tree Viewer can be edited in the \ref pre Tree nodes in the Dependency Viewer are named according to the study names of the corresponding objects. -All nodes have fixed size, so long names are cut; the full object name can be seen in the tooltip +All nodes have fixed size, so long names are cut; the full object name can be seen in the tool-tip when the cursor is hovered over the node. "Dependency Tree" view supports the following states of nodes: @@ -61,11 +61,11 @@ Browser, OCC Viewer or Dependency Tree Viewer; Dependency Tree Viewer shows oriented links between nodes to represent the dependency direction. The viewer supports the following states of links: - + \image html tree_unidir_link.png - + \image html tree_bidir_link.png diff --git a/doc/salome/gui/GEOM/input/display_mode.doc b/doc/salome/gui/GEOM/input/display_mode.doc index 7ba535184..af842ccf1 100644 --- a/doc/salome/gui/GEOM/input/display_mode.doc +++ b/doc/salome/gui/GEOM/input/display_mode.doc @@ -29,7 +29,7 @@ functionality for all objects in the current view via the main menu \n TUI Command: gg.setVectorsMode(ID, Bool) -\n Also it is possible to show the vertices of the selected +\n It is possible to show the vertices of the selected shape. For this, choose in the context menu of the shape Display mode -> Show Vertices, or apply this functionality for all objects in the current view via the main menu @@ -40,10 +40,9 @@ functionality for all objects in the current view via the main menu \n TUI Command: gg.setVerticesMode(ID, Bool) -\n Moreover user can show the name of the selected -shape. For this, choose in the context menu of the shape +\n To show the name of the selected shape, choose in its context menu Display mode -> Show Name, or apply this -functionality for all objects in the current view via the main menu +functionality for all objects in the current view via the main menu option View -> Display Mode -> Show/Hide Name. \image html name_mode.png diff --git a/doc/salome/gui/GEOM/input/extension_operation.doc b/doc/salome/gui/GEOM/input/extension_operation.doc index 605ff176f..dd2ad27fa 100644 --- a/doc/salome/gui/GEOM/input/extension_operation.doc +++ b/doc/salome/gui/GEOM/input/extension_operation.doc @@ -1,25 +1,20 @@ /*! -\page extension_operation_page Extension of an Edge or a Face +\page extension_operation_page Extension -\n To produce an \b Extension in the Main Menu select -Operations - > Transformation - > Extension +\n To produce an \b Extension of an Edge or a Face select in the Main Menu +Operations - > Transformation - > Extension. The type of extension is defined using the radio buttons. -\n This operation resizes an \b Edge by means of first - and last parameters modification or a \b Face by means of modification - of minimal and maximal U- and V-Parameters. \n -\ref restore_presentation_parameters_page "Advanced options". +Firstly it is possible to resize an \b Edge by modifying its first +and last parameters -The type of extension is defined using the radio buttons. +\image html extension1.png "Edge Extension" -Firstly it is possible to resize an \b Edge. \n TUI Command: geompy.ExtendEdge(theEdge, theMin, theMax), where \em theEdge the input edge to be resized, \em theMin the minimal parameter value, \em theMax the maximal parameter value. \n Arguments: Name + Object (Edge) + 2 values (Min and Max Parameters). -\image html extension1.png "Extension of an Edge" - \n Example: \image html extend_edge_example.png "Original edge (white) and extended edge" @@ -28,8 +23,12 @@ parameter value, \em theMax the maximal parameter value. negative, the input Edge is extended, otherwise it is shrinked by \b theMin parameter. If \b theMax is greater than 1, the Edge is extended, otherwise it is shrinked by \b theMax parameter. + +Secondly it is possible to resize a \b Face by modifying its +minimal and maximal U- and V-Parameters. -Secondly it is possible to resize a \b Face. + \image html extension2.png "Face Extension" + \n TUI Command: geompy.ExtendFace(theFace, theUMin, theUMax, theVMin, theVMax), where \em theFace the input face to be resized, \em theUMin the minimal U-Parameter value, \em theUMax the maximal U-Parameter @@ -38,18 +37,16 @@ V-Parameter value. \n Arguments: Name + Object (Face) + 4 values (Min and Max U- and V-Parameters). -\image html extension2.png "Extension of a Face" \n Example: -\image html extend_face_example.png "The original face (gray) and a result - face shrinked along U-Direction and extended along V-Direction" +\image html extend_face_example.png "The original face (gray) and a result face shrinked along U-Direction and extended along V-Direction" \note The input Face U- and V-Parameters range is [0, 1]. If \b theUMin parameter is negative, the input Face is extended, otherwise it is - shrinked along U-Direction by \b theUMin parameter. If theUMax is + shrinked along U-Direction by \b theUMin parameter. If \b theUMax is greater than 1, the Face is extended, otherwise it is shrinked along - U-Direction by \b theUMax parameter. So as for \b theVMin, \b theVMax + U-Direction by \b theUMax parameter. The same applies to \b theVMin, \b theVMax and V-Direction of the input Face. Our TUI Scripts provide you with useful examples of the use of diff --git a/doc/salome/gui/GEOM/input/fast_intersection.doc b/doc/salome/gui/GEOM/input/fast_intersection.doc index 4de27fc29..65dc8148b 100644 --- a/doc/salome/gui/GEOM/input/fast_intersection.doc +++ b/doc/salome/gui/GEOM/input/fast_intersection.doc @@ -1,11 +1,11 @@ /*! \page fast_intersection_page Fast intersection -This operation checks whether or not two selected shapes are overlapped. +This operation checks if two selected shapes are overlapped. This tool is useful for fast detection of intersections and gaps. In contrast to Boolean Operations, Partition and Detect Self-intersection -algorithms that compute topological intersections, this algoritm computes +algorithms that compute topological intersections, this algorithm computes intersections by generating tessellation (triangulation) of the source shapes and detecting overlapping of resulting meshes. High performance is achieved through the use of existing triangulation of faces. @@ -22,28 +22,27 @@ and their limitations refer to this document. - Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is in the viewer to navigate between selectable objects. - Press left mouse button to select an appropriate object to the dialog box. -. + For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter of the GUI module's documentation. In this dialog: -- \b Object 1 - first checked object. \b Selection button allows picking it in the viewer or in the object browser. -- \b Object 2 - second checked object. \b Selection button allows picking it in the viewer or in the object browser. +- Object 1 and Object 2 the checked objects. \b Selection button allows picking them in the viewer or in the object browser. - Deflection coefficient specifies the quality of shapes tessellation. - Detect gaps - when switched on, allows detecting gaps between shapes. -- Tolerance - specifies a distance between shapes used for detecting gaps. +- Tolerance - specifies the distance between shapes used for detecting gaps. - Compute intersections - press this button to compute interferences. - Sub-shapes of Object 1 - list of sub-shapes from the first source shape that localize the intersection. - Sub-shapes of Object 2 - list of sub-shapes from the second source shape that localize the intersection. - \b Apply and Apply and Close buttons are used to store selected intersected shapes in the study for further analysis (see below). -\note Quality of the result depends on the quality of triangulation. Changing a value of the deflection coefficient -parameter can strongly affect the result. On the other hand, small values of deflection coefficient might lead to +\note The result quality depends on the quality of triangulation. Changing the value of the deflection coefficient +parameter can strongly affect the result. However, small values of the deflection coefficient might lead to some performance loss of the algorithm, as number of triangles of the tesselation mesh depends on this parameter. -It is possible to store sub-shapes selected by the user in the study, for the further analysis. +Press Apply and Close or \b Apply button to store the selected sub-shapes in the study for further analysis. The selection will be published as a compound containing intersected sub-shapes from both source objects. TUI Command: geompy.FastIntersect(theShape1, theShape2, theTolerance = 0.0, theDeflection = 0.001), \n diff --git a/doc/salome/gui/GEOM/input/glue_edges_operation.doc b/doc/salome/gui/GEOM/input/glue_edges_operation.doc index eb7d2377c..2b5c8a981 100644 --- a/doc/salome/gui/GEOM/input/glue_edges_operation.doc +++ b/doc/salome/gui/GEOM/input/glue_edges_operation.doc @@ -17,7 +17,7 @@ given tolerance value. \n TUI Command:

    geompy.MakeGlueEdges( theShapes, theTolerance ), -\n where \em theShapes is either a list or compound of shapes to be +\n where \em theShapes is a list or compound of shapes to be glued, and \em theTolerance is a maximum distance between two edges, which can be considered as coincident. @@ -41,12 +41,12 @@ The selected edges will be marked in white. theTolerance is a maximum distance between two edges, which can be considered as coincident. The \b Result will be a list of \b GEOM_Objects (edges), containing one sub-shape per each detected set of - coincident sub-shapes. For example if there are two coincident edges -in selected shapes, the result list contains one of the two coincident edges. + coincident sub-shapes. For example, if there are two coincident edges +in the selected shapes, the result list contains one of the two coincident edges. geompy.MakeGlueEdgesByList( theShapes, theTolerance, theEdges ), -\n where \em theShape is either a list or compound of shapes to be glued, \em - theTolerance is a maximum distance between two edges, which can +\n where \em theShape is a list or compound of shapes to be glued, +\em theTolerance is a maximum distance between two edges, which can be considered as coincident, \em theEdges is a list of edges to be glued. diff --git a/doc/salome/gui/GEOM/input/glue_faces_operation.doc b/doc/salome/gui/GEOM/input/glue_faces_operation.doc index 8f020115b..c6a6fa021 100644 --- a/doc/salome/gui/GEOM/input/glue_faces_operation.doc +++ b/doc/salome/gui/GEOM/input/glue_faces_operation.doc @@ -41,12 +41,12 @@ The selected faces will be marked in white. When the faces are glued their edges are glued as well. By default, other edges are not glued. To force gluing of all edges, check Glue all coincident edges -checkbox. +check-box. \n TUI Commands: geompy.GetGlueFaces( theShapes, theTolerance ), -\n where \em theShapes is either a list or compound of shapes to be glued, \em +\n where \em theShapes is a list or compound of shapes to be glued, \em theTolerance is a maximum distance between two faces, which can be considered as coincident. The \b Result will be a list of \b GEOM_Objects (faces), containing one sub-shape per each detected set of diff --git a/doc/salome/gui/GEOM/input/import_export.doc b/doc/salome/gui/GEOM/input/import_export.doc index 890ce97e6..80bf98a8d 100644 --- a/doc/salome/gui/GEOM/input/import_export.doc +++ b/doc/salome/gui/GEOM/input/import_export.doc @@ -25,7 +25,7 @@ Our TUI Scripts provide you with useful examples of the use of To import geometrical objects from a BREP, IGES, STEP or STL file: \par -From the \b File menu choose Import/\, where \ is a name +From the \b File menu choose Import\, where \ is a name of desirable format. In the Import \ dialog box select the file to import and press \b Open. The file will be imported in the module and its contents (geometrical object) will be displayed in the Object Browser. diff --git a/doc/salome/gui/GEOM/input/inspect_object_operation.doc b/doc/salome/gui/GEOM/input/inspect_object_operation.doc index 40cc4c027..0650bd47b 100755 --- a/doc/salome/gui/GEOM/input/inspect_object_operation.doc +++ b/doc/salome/gui/GEOM/input/inspect_object_operation.doc @@ -12,11 +12,11 @@ In this dialog: - Click on the "selection" button and select an object to inspect in the Object Browser or in the viewer. - Show/hide sub-shape(s) in the 3D viewer, by pressing “eye” icon in the first column of the tree view. - Show/hide all sub-shapes in the 3D viewer, by pressing “eye” icon in the first column of the tree view header. -- Rename selected sub-shape by double-clicking on the item or pressing key. -- Show selected sub-shape(s) in the 3D viewer by pressing Show Selected button. -- Show selected sub-shape(s) in the 3D viewer and erase all currently shown objects by pressing Show Only Selected button. -- Hide selected sub-shape(s) from the 3D viewer by pressing Hide Selected button. -- Publish selected sub-shapes in the study, by pressing Publish Selected button. +- Rename the selected sub-shape by double-clicking on the item or pressing key. +- Show the selected sub-shape(s) in the 3D viewer by pressing Show Selected button. +- Show the selected sub-shape(s) in the 3D viewer and erase all currently shown objects by pressing Show Only Selected button. +- Hide the selected sub-shape(s) from the 3D viewer by pressing Hide Selected button. +- Publish the selected sub-shapes in the study, by pressing Publish Selected button. - Close dialog box, by pressing Close button. */ diff --git a/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc b/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc index be0c5aa27..88e4d9fbd 100644 --- a/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc +++ b/doc/salome/gui/GEOM/input/projection_on_cylinder_operation.doc @@ -14,12 +14,11 @@ To make a projection it is necessary to define: - \b Object to be projected. It can be either a planar wire or a face; - \b Radius of the cylinder; - Starting angle from the cylinder's X axis around Z axis. This is -the angle of the projection starting. -- Length angle in which to project the total length of -the wire. If it is unchecked the projection is not scaled and natural +the angle of the projection start. +- Length angle where the total length of +the wire should be projected. If it is unchecked the projection is not scaled and the natural wire length is kept for the projection. - -\ref restore_presentation_parameters_page "Advanced options". +- \ref restore_presentation_parameters_page "Advanced options". \image html proj_on_cyl_dlg.png @@ -29,8 +28,8 @@ wire length is kept for the projection. \n TUI Command: geompy.MakeProjectionOnCylinder(theObject, theRadius, theStartAngle=0.0, theAngleLength=-1.0), -where \em theObject is a shape which has to be projected, \em theRadius -is a cylinder radius, \em theStartAngle the starting angle of projection in +where \em theObject is a shape to be projected, \em theRadius +is a cylinder radius, \em theStartAngle is the starting angle of projection in radians, \em theAngleLength the projection length angle in radians. The \em Result will be a \em GEOM_Object. diff --git a/doc/salome/gui/GEOM/input/sewing_operation.doc b/doc/salome/gui/GEOM/input/sewing_operation.doc index 0008dc80a..9d293dec4 100644 --- a/doc/salome/gui/GEOM/input/sewing_operation.doc +++ b/doc/salome/gui/GEOM/input/sewing_operation.doc @@ -3,18 +3,18 @@ \page sewing_operation_page Sewing \b Sewing operation allows uniting several faces (possibly contained -in a shell, solid or compound) into one shell while geometrically +in a shell, solid or compound) into one shell. Geometrically coincident (within a specified tolerance) edges (or parts of edges) of different faces are replaced by one edge thus producing a shell of faces with shared boundaries.

    This operation is similar to New Entity - > Build - > Shell operation, the difference is that with \b Sewing you can specify the -tolerance and can get a non-manifold result.

    -Possibility to create a non-manifold shell can be used e.g. to create a +tolerance and get a non-manifold result.

    +The possibility to create a non-manifold shell can be used e.g. to create a shell forming several closed domains and then to create several solids with shared boundaries from this shell. -\note Geometrically coincident faces (or part of faces) won't be +\note Geometrically coincident faces (or parts of faces) will not be replaced by one face during \b Sewing. To produce a \b Sewing operation in the Main Menu select Repair - > Sewing. diff --git a/doc/salome/gui/GEOM/input/shape_processing_operation.doc b/doc/salome/gui/GEOM/input/shape_processing_operation.doc index c92d48b8c..643c70638 100644 --- a/doc/salome/gui/GEOM/input/shape_processing_operation.doc +++ b/doc/salome/gui/GEOM/input/shape_processing_operation.doc @@ -56,22 +56,22 @@ merge with neighboring edges.

  11. 3D Tolerance (DropSmallEdges.Tolerance3d) - defines minimum possible distance between two parallel edges.
    12. -
  12. Drop Small Solids (DropSmallSolids) - either removes small +
  13. Drop Small Solids (DropSmallSolids) - removes small solids or merges them with neighboring ones.
    14. If the both tolerances are activated a solid is considered small if -it meets the both criteria. +it meets both criteria.
  14. Split Angle (SplitAngle) - splits faces based on conical surfaces, surfaces of revolution and cylindrical surfaces in segments using a certain angle.
    15. diff --git a/doc/salome/gui/GEOM/input/shared_shapes.doc b/doc/salome/gui/GEOM/input/shared_shapes.doc index 802fc45a1..23d94d2f0 100755 --- a/doc/salome/gui/GEOM/input/shared_shapes.doc +++ b/doc/salome/gui/GEOM/input/shared_shapes.doc @@ -15,22 +15,22 @@ Shared Shapes. The following dialog box will appear. In this dialog: - Name is the base name of the resulting shapes. -- Shapes are the shapes to fing shared sub-shapes of. +- Shapes are the shapes whose shared sub-shapes should be found. - Sub-shapes Type is the type of required sub-shapes. - Shared by all option specifies what type of shared sub-shapes should be checked: - - \b On: causes to search sub-shapes from the first input shape shared with all other input shapes; - - \b Off: causes to search sub-shapes shared between couples of input shapes. + - \b On: searches for sub-shapes from the first input shape shared with all other input shapes; + - \b Off: searches for sub-shapes shared between couples of input shapes. \note For the case when "Shared by all" option is switched off - if an input list of shapes -contains single compound, the sub-shapes shared between all possible couples of its top-level shapes -are searched; otherwise, only sub-shapes that are shared between first input shape and all rest input -shapes are searched. +contains a single compound, the sub-shapes shared between all possible couples of its top-level shapes +are searched for; otherwise, only sub-shapes that are shared between the first input shape and +all other input shapes are searched. Advanced options: \ref preview_anchor "Preview" TUI Command: geompy.GetSharedShapesMulti( Shapes, Type ), -
    where \em Shapes is a list or compound of shapes to fing shared sub- -shapes of and \em Type is the type of required sub-shapes. +
    where \em Shapes is a list or compound of shapes, whose shared sub- +shapes should be found and \em Type is the type of required sub-shapes. Our TUI Scripts provide you with useful examples of the use of Get Shared Shapes functionality: diff --git a/doc/salome/gui/GEOM/input/size_models_range.doc b/doc/salome/gui/GEOM/input/size_models_range.doc index 5f77a22e3..07eeaf1f9 100644 --- a/doc/salome/gui/GEOM/input/size_models_range.doc +++ b/doc/salome/gui/GEOM/input/size_models_range.doc @@ -2,39 +2,33 @@ \page size_models_range Sizes of Models in Salome -\tableofcontents +In Salome and Open CASCADE Technology (OCCT), which is a modeling core +of Salome %GEOM module, any model has its location in the 3D-space and size. + +This document defines the range of values (tolerances, locations +and sizes) that should be taken into account for any 3D model design. -This document determines the range of numbers (tolerances, locations -and sizes) that are to be taken into account for any 3D model design -in Salome. Although it is not obligatory to create models within this range, -algorithms can fail or return unexpected result in this case. - -This document refers mainly to Open CASCADE Technology (OCCT). However it -concerns Salome as well as OCCT is a modeling core of Salome %GEOM module. - -Any model in 3D-space has its location and sizes. The last two things in Salome -and OCCT are represented by the double precision floating point numbers. - -The goal of the document is to define the range of numbers that can be used in -modeling algorithms provided by Salome and Open CASCADE Technology. +It is not obligatory to create models within this range, +however, algorithms can fail or return unexpected results if the +recommendations are not followed. \section sec1 Maximal Size of the Model -The Maximal Size of the model is a number defined as the maximal diameter of +The Maximal Size of the model corresponds to the maximal diameter of enclosed sphere built for the model. In OCCT any model has a location defined -relative the absolute origin. Thus the maximal diameter above should be built +relatively to the absolute origin. Thus the maximal diameter should be built taking into account the model itself and its location. -In Open CASCADE there are two tolerances: Tolerance Confusion (TolC) +In OCCT there are two tolerances: Tolerance Confusion (TolC) and Tolerance Angular (TolA) (see OCCT Precision package for more details). -These values are used for geometric comparisons. They are not used inside -low-level algorithms (intersection for e.g.), where more precise values are -used instead. The value TolC guarantees that the error associated with -the computations for given geometric entity is not greater than TolC. +These values are used for geometric comparisons. However, they are not used inside +low-level algorithms (e.g. intersection), where more precise values are +used instead. The value guarantees TolC that the error associated with +the computations for a given geometric entity is not greater than TolC. -- TolC - precision value when checking coincidence of two points +- TolC - precision value used to check the coincidence of two points [by default 1.e-7]; -- TolA - precision value when checking the equality of two angles +- TolA - precision value used to check the equality of two angles [by default 1.e-12]. For more information on tolerance definition please see @@ -43,8 +37,8 @@ that are due to modeling errors or inaccuracies of tolerance usage please refer to Chapter 9.2.2 of the same document. To provide robust geometric modeling the computations should be consistent, -i.e. the one tolerance value should be used for all computations. To provide -consistent computations the values TolC and TolA should be consistent: +i.e. the one tolerance value should be used for all computations. Thus, the +TolC and TolA values should be consistent: 
    Smax = TolC / TolA             (1)
    @@ -56,16 +50,16 @@ In accordance with (1) the Maximal Size for the Model is [by default]: \section sec2 Minimal Size of the Model -The Minimal Size of the Model is defined as maximal diameter of enclosed +The Minimal Size of the Model is defined as the maximal diameter of enclosed sphere built for the smallest BRep entity of the Model. -All models in Open CASCADE Technology are represented using double precision +All models in OCCT are represented using double precision floating point numbers. This representation contains approximately 14-16 significant digits. -From the experience of using it is considered that the least four significant +From the experience, it is considered that the last four significant digits contain rounding-off errors occurring during the computation. So -(taking in account the worst cases), there are ten reliable significant digits +(taking into account the worst cases), there are ten reliable significant digits for double precision floating point numbers. Having the estimation it is possible to compute the value of the Minimal size of the model: @@ -78,7 +72,7 @@ In accordance with (2) for the default value it will be [by default]: \section sec3 Full Range of Sizes The values Smax (2), Smin (4) are theoretical. Taking into -account the practical purposes of improving the reliability the lower limit +account the practical purposes of improving the reliability, the lower limit should be restricted by one order. Thus, the full Range of Sizes of the Models is: diff --git a/doc/salome/gui/GEOM/input/transfer_data.doc b/doc/salome/gui/GEOM/input/transfer_data.doc index b34b34f31..87a64860f 100644 --- a/doc/salome/gui/GEOM/input/transfer_data.doc +++ b/doc/salome/gui/GEOM/input/transfer_data.doc @@ -21,24 +21,23 @@ In this dialog: -To copy data click on \b Apply or Apply and Close button. As the result -it is possible to see how many names and materials are copied as well as -maximum number of names and materials available for copying. This information is -provided on the following message box: +To copy the data click on \b Apply or Apply and Close button. +It is possible to see how many names and materials are copied as well as +the maximum number of names and materials available for copying. This information is +provided in the following message box: \image html transfer_data2.png "Transfer Data Information" diff --git a/doc/salome/gui/GEOM/input/whatis.doc b/doc/salome/gui/GEOM/input/whatis.doc index fad70f01c..15780a976 100644 --- a/doc/salome/gui/GEOM/input/whatis.doc +++ b/doc/salome/gui/GEOM/input/whatis.doc @@ -5,16 +5,16 @@ This operation provides the list of types and quantities of all topological entities, composing the selected geometrical object. -For the \em COMPOUND or \em COMPSOLID shape, additionally the information about -"flat" content is shown - a number of "simple" top-level shapes enclosed into the compound. +The information about \em COMPOUND or \em COMPSOLID shapes additionally shows +"flat" content - the number of "simple" top-level shapes enclosed into the compound. \image html measures8.png \note This dialog supports navigation through the selectable objects (in OCC 3D viewer only): -- Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is +- Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when the input focus is in the viewer to navigate between selectable objects. - Press left mouse button to select an appropriate object to the dialog box. -. + For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter of the GUI module's documentation. diff --git a/doc/salome/gui/GEOM/input/working_with_groups.doc b/doc/salome/gui/GEOM/input/working_with_groups.doc index 36a0d49a3..2ca5154dc 100644 --- a/doc/salome/gui/GEOM/input/working_with_groups.doc +++ b/doc/salome/gui/GEOM/input/working_with_groups.doc @@ -81,24 +81,24 @@ creation of other groups), or skip it by clicking \b Close button. \n The Result of the operation will be a \b GEOM_Object. -The \b Filter controls allow to automatically pick up entites which satisfy specified +The \b Filter controls allow to automatically pick up entities, which satisfy specified threshold value(s). The numerical functor for each sub-shape that is compared with threshold value(s) is computed according to the shape's topological properties: -- length for edges and wires -- area for faces and shells -- volume for solids, compounds, compsolids +- length for edges and wires; +- area for faces and shells; +- volume for solids, compounds, compsolids. Filtering capabilities are not available for vertices. In order to filter out some entities: -- Activate one or two filtering controls by switching on corresponding check boxes; -- Select required threshold comparator type; the following choices are available: +- Activate one or two filtering controls by switching on the corresponding check boxes; +- Select the required threshold comparator type; the following choices are available: - Less Than or Equal or Less Than for the first comparator; - Greater Than or Equal or Greater Than for the second comparator; -- Enter required threshold value (values); +- Enter the required threshold value (values); - Press \b Apply button in the \b Filter group. -The entities which satisfy entered filtering parameters will be automatically highlighted +The entities, which satisfy the entered filtering parameters, will be automatically highlighted in the 3D viewer. \n TUI Command: geompy.CreateGroup(MainShape,