From: vsr Date: Wed, 7 May 2014 12:25:27 +0000 (+0400) Subject: Merge branch 'origin/ysn/doc_update_740': update documentation X-Git-Tag: V7_4_0rc1~5^2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=2a2ffeea1e68c5f6721976ed24e53d8609c93e71;p=modules%2Fgeom.git Merge branch 'origin/ysn/doc_update_740': update documentation --- 2a2ffeea1e68c5f6721976ed24e53d8609c93e71 diff --cc doc/salome/gui/GEOM/CMakeLists.txt index 435d60b92,435d60b92..1b8fbf299 --- a/doc/salome/gui/GEOM/CMakeLists.txt +++ b/doc/salome/gui/GEOM/CMakeLists.txt @@@ -34,6 -34,6 +34,7 @@@ ADD_CUSTOM_TARGET(usr_docs ${CMAKE_COMM COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/geomBuilder.py ${CMAKE_SOURCE_DIR}/src/GEOM_SWIG/geomBuilder.py COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/gsketcher.py ${CMAKE_SOURCE_DIR}/src/GEOM_SWIG/gsketcher.py COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/geomtools.py ${CMAKE_SOURCE_DIR}/src/GEOM_PY/geomtools.py ++ COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/sketcher.py ${CMAKE_SOURCE_DIR}/src/GEOM_PY/sketcher.py COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/structelem.py ${CMAKE_SOURCE_DIR}/src/GEOM_PY/structelem/__init__.py COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/parts.py ${CMAKE_SOURCE_DIR}/src/GEOM_PY/structelem/parts.py COMMAND ${PYTHON_EXECUTABLE} ${f} -o tmp/orientation.py ${CMAKE_SOURCE_DIR}/src/GEOM_PY/structelem/orientation.py diff --cc doc/salome/gui/GEOM/input/creating_ellipse.doc index 8f67658bb,2cbe099ab..124e7f384 --- a/doc/salome/gui/GEOM/input/creating_ellipse.doc +++ b/doc/salome/gui/GEOM/input/creating_ellipse.doc @@@ -20,14 -19,14 +19,14 @@@ corresponds to OX axis of the global co Vmaj' = (Vn * Vmaj) * Vn, where \em Vn is a normal vector and \em Vmaj is an original vector of the major axis. - \n TUI Command (no major axis): geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor) -\n TUI Command (with the major axis): geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor) ++\n TUI Command (without the major axis): geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor) \n Arguments: Name + 1 vertex (for the center) + 1 edge (for the direction) + 1 X Radius + 1 Y Radius. - \n TUI Command (use major axis):geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor) -\n TUI Command (without the major axis): geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor) ++\n TUI Command (with the major axis): geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor) \n Arguments: Name + 1 vertex (for the center) + 1 edge (for the normal direction) + 1 X Radius + 1 Y Radius + 1 edge (for the - major axis direction) + major axis direction). \image html ellipse.png diff --cc doc/salome/gui/GEOM/input/creating_sketcher.doc index 7f04b53e2,821886a96..159361772 --- a/doc/salome/gui/GEOM/input/creating_sketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_sketcher.doc @@@ -2,168 -2,112 +2,109 @@@ \page create_sketcher_page 2D Sketcher - The 2D Sketcher allows you to draw 2D shapes on a working plane. You - can create sketches of two types: + The 2D Sketcher allows drawing arbitrary 2D shapes. - - - The \b Result is a \b Wire - - \n Example: - - \image html sketch_example.png - - To create a 2D Sketch: + \image html sketcher_dlg.png -
    -
  1. In the main menu select New Entity -> Basic -> 2D Sketch or click on \image html sketch.png
    2. -\n At first it is necessary to define the reference coordinate system, where the sketch will be created: ++At first it is necessary to define the reference coordinate system, where the sketch will be created: + - The XOY plane of the Global coordinate system is suggested by default (if no plane or planar face is selected when 2D Sketcher is activated). + - If any Local Coordinate Systems have been created in the study earlier, they can be selected as a reference coordinate system in the corresponding list box. + - The \b Arrow button allows selecting a \b plane or a planar face in the viewer or in the object browser as the reference coordinate system for the sketch. The start point will be set in the \b geometric \b center of the face. + - Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects. -
  2. Select the \b plane or the planar face on which to create the sketch. - \note By default the sketch is created on the XOY plane of the global coordinate system. - If Local Coordinate Systems have been created in the study they appear - in the combo-box and can be selected as a reference coordinate system.
    3. -\n It is possible to create sketches of two types: ++It is possible to create sketches of two types: + - \b Profiles made of line segments and \b arcs, or + - \b Rectangles. -
  3. Choose a \b segment or an \b arc element to start a \b profile or choose \b rectangle to draw a rectangle. +

    Creation of a Profile by straight segments

    - \n If you draw a \b profile: + - Choose \b segment radio button to start a \b profile. + -
  4. Select a start point. By default the start point of the curve is located at the point of - origin of the reference coordinate system.
    5. + - Define the start point. By default the start point of the curve is located at the origin of the reference coordinate system. A point in 2D Sketcher can be defined in one of three ways: - - By \b Absolute coordinates. Select \b Absolute radio button in \b Points group, input \b X and \b Y values and click \b Apply button. - - \image html 2dsketch1.png -
  5. Create curve portions and click on \b Apply after each step.
    6. - - By \b Relative coordinates. Select \b Relative radio button in \b Points group, input \b DX and \b DY values and click \b Apply button. - - \image html 2dsketch2.png ++ - By \b Absolute coordinates. Select \b Absolute radio button in \b Points group, input \b X and \b Y values and click \b Apply button: ++ \image html 2dsketch1.png ++ ++ - By \b Relative coordinates. Select \b Relative radio button in \b Points group, input \b DX and \b DY values and click \b Apply button. ++ \image html 2dsketch2.png -
  6. Select either \b Close or Sketch Closure if you want to close the profile before closing the window.
    7. -
- - By \b Selection of an existing point. Select \b Selection radio button in \b Points group, select a point in the viewer or in the object browser and click \b Apply button. - - \image html 2dsketch3.png ++ - By \b Selection of an existing point. Select \b Selection radio button in \b Points group, select a point in the viewer or in the object browser and click \b Apply button. ++ \image html 2dsketch3.png - \n To create a \b Segment: + - Define the next point. Together these two points form the first segment of the sketch. -
    -
  1. In the Element Type part of the dialog box select: -\n Alternatively to the definition by \b Points it is possible to define segments by \b Direction and \Distance. ++Alternatively to the definition by \b Points it is possible to define segments by \b Direction and \b Distance. + + - The \b Direction can be: - - Defined by an \b Angle to the previous segment. - - \image html 2dsketch4.png - - - \b Perpendicular to the previous segment (i.e. the Angle is 90 degrees). - - \image html 2dsketch5.png - - - \b Tangent (collinear) to the previous segment (i.e. the Angle is 0 degrees). - \image html line_icon.png
    2. - \image html 2dsketch6.png - - - Defined by VX-VY vector coordinates. - - \image html 2dsketch7.png ++ - Defined by an \b Angle to the previous segment. ++ \image html 2dsketch4.png ++ ++ - \b Perpendicular to the previous segment (i.e. the Angle is 90 degrees). ++ \image html 2dsketch5.png ++ ++ - \b Tangent (collinear) to the previous segment (i.e. the Angle is 0 degrees). ++ \image html 2dsketch6.png ++ ++ - Defined by VX-VY vector coordinates. ++ \image html 2dsketch7.png + + - The \b Distance can be defined: - - By the absolute segment \b Length or - - By \b DX - the length of segment projection on X-axis. - - By \b DY - the length of segment projection on Y-axis. + -
  2. You can define the segment by either its end point or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be: -
      -
    • Tangent (collinear to the tangent at the last point)
      • -
    • Perpendicular
      • -
    • Defined by an angle
      • -
    • Defined by a vector (Vx, Vy)
      • -
    ++ - By the absolute segment \b Length ++ - By \b DX - the length of segment projection on X-axis. ++ - By \b DY - the length of segment projection on Y-axis. + + - Proceed with creation of the sketch segments and click \b Apply after each step. The drawn segments will be displayed in the viewer. + - Use \b Undo and \b Redo buttons to cancel an erroneously applied segment or to restore it. + - To finalize, click "Close" button to apply the created wire "as is". + - Alternatively, click "Sketch Closure" to close the Sketch by a straight line + from the last created segment to the start point and apply it. -
    3. +

    Creation of a Profile by ark segments

    -
- - \n To create an \b Arc: + If an \b ark radio button is chosen, \b Point or \b Direction define the location of the next point of the sketch, but this point and the previous one are connected by an ark segment. -
    -
  1. In the Element Type part of the dialog box select \image html arc_icon.png
    2. + \image html 2dsketch10.png "Ark segments" + + - By default, None (Tangential) radio button is selected as Additional Parameter, and the arc is \b tangential to the end of the sketch, which means that it is created on two points as a half-circle with radius equal to a half of the distance between these points. -
  2. You can define the segment by either its end point or \b direction \b radius and \b angle.
    3. + \image html 2dsketch12.png - - -
+ - \b Radius radio-button allows creating a more limited arc segment by defining a custom ark radius, which must be greater than half of the distance between the last point and the end point of the arc. + + \image html 2dsketch8.png - \note For the first segment or arc of the sketch the reference direction is the X direction of the reference coordinate system. + - Finally, \b Center radio-button allows explicitly defining the center of the circle. If an arc segment cannot be built on the defined points, a warning is shown. + + \image html 2dsketch9.png + +

Creation of a Rectangle profile

- \n Dialog Box: + \n To draw a \b rectangle, select a \b rectangle radio button. - \image html sketcher_dlg.png + \image html sketcher_dlg2.png - \n Arguments: -
    -
  1. Coordinate system (Existing Local CS or Global CS can be selected)
    2. -
  2. A plane or a planar face to define a new Local Coordinate System -
  3. Element type (segment, arc or rectangle).
    4. -
  4. Destination type (point or direction).
    5. -
  5. Destination point by means of:
    6. - -
  6. Destination direction by means of:
    7. - -
  7. Parameters of an element (for segment : length or target X or Y coordinate value, for arc : radius, angle or center coordinates).
    8. -
- - \b Buttons: - - "Restore" button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all its objects. - \n "Close" button applies the wire, only the red part will be built. - \n "Sketch Closure" will close the Sketch by a straight line - from the last red part and apply it. - - \n To draw a \b rectangle: - -
    -
  1. In the Element Type part of the dialog box select \image html rectangle_icon.png
    2. - -
  2. Draw a rectangle with the mouse directly in the view or fill in the coordinates of two opposite vertices of the rectangle.
    3. -
  3. Apply and Close
    4. -
- - \n Dialog Box: + Draw a rectangle with the mouse directly in the view or input the coordinates of its two opposite vertices in the dialog. - \image html sketcher_dlg2.png +

TUI Commands

- \n Arguments: -
    -
  1. Coordinate system (Existing Local CS or Global CS can be selected)
    2. -
  2. A plane or a planar face to define a new Local Coordinate System -
  3. Element type (segment, arc or rectangle).
    4. -
  4. The X,Y coordinates of two opposite vertices of the rectangle
    5. -
-\n geompy.MakeSketcherOnPlane(Command, WorkingPlane) ++geompy.MakeSketcherOnPlane(Command, WorkingPlane) + This algorithm creates a sketcher (wire or face), following the textual description, passed through the Command argument. The edges of the resulting wire or face will be arcs of circles and/or linear segments. - \n TUI Command: geompy.MakeSketcherOnPlane(Command, WorkingPlane) - \n This algorithm creates a sketcher (wire or face), following the - textual description, passed through the Command argument. The edges of - the resulting wire or face will be arcs of circles and/or linear - segments. - \n \em Command is a string, defining the sketcher by the coordinates of - points in the current LCS. - \n WorkingPlane can be a Local CS, a plane, or a planar face. + - \em Command is a string, defining the sketcher by the coordinates of points in the current LCS. + - WorkingPlane can be a Local CS, a plane, or a planar face. - \n Another way to create the 2D Sketcher in TUI is using Sketcher2D - interface. -\n Another way to create the 2D Sketcher in TUI is using Sketcher2D interface. ++Another way to create the 2D Sketcher in TUI is using Sketcher2D interface. - TUI Command: sk = geompy.Sketcher2D() -\n sk = geompy.Sketcher2D() - returns an instance of Sketcher2D interface sk. ++sk = geompy.Sketcher2D() - returns an instance of Sketcher2D interface sk. - Returns an instance of Sketcher2D interface sk. + \image html sketch_example.png - Use the below examples and see the \ref gsketcher.Sketcher2D "Sketcher2D" - interface documentation for more information. + See the \ref gsketcher.Sketcher2D "Sketcher2D" interface documentation for more information. Our TUI Scripts provide you with useful examples of the use of \ref tui_sketcher_page "2D Sketcher". diff --cc doc/salome/gui/GEOM/input/creating_smoothingsurface.doc index bab830e05,2b2968a52..a4d3fb647 --- a/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc +++ b/doc/salome/gui/GEOM/input/creating_smoothingsurface.doc @@@ -5,31 -5,23 +5,31 @@@ To create a Smoothing Surface in the Main Menu select New Entity - > Advanced - > SmoothingSurface - To create a surface it is necessary to specify the \b Name of the surface, the list of \b Points - from which it is approximated and some plate approximation parameters such as: Max nbr of - Bezier pieces, Max BSpline surface degree and 3D tolerance of initial approximation. - And then press "Apply" or "Apply & Close" button. + \image html smoothingsurface_dlg.png - Advanced options: \ref preview_anchor "Preview" + In this dialog you can specify the following parameters: + - \b Name of the surface; + - the list of \b Points or compounds of points, from which it is approximated; + - Max nbr of Bezier pieces in the resulting surface; + - Max BSpline surface degree of the resulting BSpline surface; -- Max plate criterion value, which is computed as max(0.0001,10*error), where error is a 3D tolerance of the surface. ++- 3D tolerance of initial approximation + - \note The dialog accepts compounds of points as well as single nodes. ++\note 3D tolerance of initial approximation represents a tolerance of ++initial plate surface approximation. If this parameter is equal to 0 (default), ++its value is automatically computed as max(0.0001, 10*error), ++where error is a 3D tolerance of the surface representing a maximal ++distance between computed plate surface and given points. ++ ++Advanced options: \ref preview_anchor "Preview" - The result of the operation will be a GEOM_Object(Surface). + Press "Apply" or "Apply & Close" button to get the resulting GEOM_Object(Surface). TUI Command: geompy.MakeSmoothingSurface(thelPoints, theNbMax, theDegMax, theDMax), where: - - \em thelPoints list of points. Compounds of points are accepted as well - - \em theNbMax maximum number of Bezier pieces in the resulting surface - - \em theDegMax maximum degree of the resulting BSpline surface + - \em thelPoints is a list of points or compounds of points; + - \em theNbMax maximum number of Bezier pieces in the resulting surface; + - \em theDegMax maximum degree; -- \em theDMax specifies maximum value of GeomPlate_PlateG0Criterion . +- \em theDMax specifies 3D tolerance of initial approximation - \note 3D tolerance of initial approximation represents a tolerance of - initial plate surface approximation. If this parameter is equal to 0 (default - value) it is computed. In this case an error of initial plate surface - computation is used as the approximation tolerance. This error represents a - maximal distance between computed plate surface and given points. - - \image html smoothingsurface_dlg.png - Example: \image html smoothingsurface.png diff --cc doc/salome/gui/GEOM/input/get_non_blocks.doc index 1bf4806b3,02aefdc15..79f6ba021 --- a/doc/salome/gui/GEOM/input/get_non_blocks.doc +++ b/doc/salome/gui/GEOM/input/get_non_blocks.doc @@@ -2,22 -2,25 +2,28 @@@ \page get_non_blocks_page Get Non Blocks + + This operation retrieves all non-block solids and non-quadrangular faces from the selected shape. + -A non-block solid is a solid that does not have 6 faces, or has 6 faces, but some of them are not quadrangular). ++A non-block solid is a solid that does not have 6 faces, or has 6 faces, but some of them are not quadrangular. + \image html measures2.png - This operation retrieves all non block solids and faces from the given - shape in two groups: solids and faces separately. + \b Preview option shows non block solids and faces in the viewer. - Two or less groups are published in the Object - Browser under the processed object. An error is raised if - no bad sub-shapes (solids and faces) have been found. + Press \b Apply or Apply and Close button to publish non block solids and faces in the Object + Browser under the processed object. Solids and faces are published separately in two groups. + + If no bad sub-shapes have been found, the corresponding warning is shown. + + \image html measures2a.png \n TUI Command: - geompy.GetNonBlocks(Compound). Returns a tuple of two - GEOM_Objects. The first object is a group of all non block solids - (not having 6 faces, or having 6 faces, but some of them - are not quadrangular). The second object is a group of all non - quadrangular faces. + geompy.GetNonBlocks(Compound). Returns a tuple of two GEOM_Objects. + ++The first object is a group of all non block solids; the second object is a group of all non ++quadrangular faces. + See also a \ref tui_get_non_blocks_page "TUI example". */ diff --cc doc/salome/gui/GEOM/input/manipulate_object.doc index 97383f8f0,a27fdd422..3e12df685 --- a/doc/salome/gui/GEOM/input/manipulate_object.doc +++ b/doc/salome/gui/GEOM/input/manipulate_object.doc @@@ -2,8 -2,7 +2,14 @@@ \page manipulate_object Manipulate GEOM object in the study (module geomtools) - The usage of the geomtools module can be appreciated with this set - of instructions: ++The Python module geomtools provides ++utility functions to handle %GEOM items in SALOME study: ++- add or remove a shape; ++- display or erase a shape in the viewer; ++- completely delete a shape (undisplay, unpublish, and destroy it); ++- manage the selection in the object browser ++ + The usage of geomtools module can be tested with the following set of instructions: \code from salome.geom.geomtools import TEST_createAndDeleteShape @@@ -11,20 -10,14 +17,14 @@@ TEST_createAndDeleteShape( \endcode This test executes the following procedure: - - - Create, publish, and display a cylinder - - Create, publish, and display a sphere - - Create a box, publish it in a folder "boxset", and display it with a - "pink" color. + - Create, publish, and display a cylinder; + - Create, publish, and display a sphere; + - Create a box, publish it in a folder boxset, and display it in pink color. - Erase the sphere from the viewer (the sphere still exists in the study) - - Delete the cylinder (the cylinder is no longer displayed and does - not exist any more, neither in the study nor the GEOM componet. - - At the end of the execution of this test, you should have in the - SALOME session: + - Delete the cylinder. It is no longer displayed and does not exist any more in the study or in the GEOM component. - - the box, in a dedicated folder of the study, and displayed in the - viewer - - the sphere, in the standard place of the study, and not displayed + At outcome of the test execution, the following objects appear in the SALOME session: -- the box located in a dedicated study folder and displayed in the viewer; -- the sphere in the standard place of the study, and not displayed. ++- The box located in a dedicated study folder and displayed in the viewer; ++- The sphere in the standard place of the study, and not displayed. */ diff --cc doc/salome/gui/GEOM/input/python_interface.doc index 2711c4a82,a8fe1e99e..7aaad029d --- a/doc/salome/gui/GEOM/input/python_interface.doc +++ b/doc/salome/gui/GEOM/input/python_interface.doc @@@ -4,31 -4,27 +4,26 @@@ The %GEOM python package essentially contains: - - \subpage geompy_page "Python Interface geomBuilder.py" to perform the following functions: - - Creating geometrical objects - - Importing/exporting geometrical objects - - Transforming geometrical objects - - Using measurement tools - - Field on Geometry - - Utility functions to handle %GEOM items in Salome study (geomtools.py). - See example - \subpage manipulate_object "Manipulate GEOM object in the study". - - add a shape to a study, remove from the study - - display a shape in a viewer, erase the shape from the viewers - - completly delete a shape (undisplay, unpublish, and destroy the shape) - - helper functions to manage the selection in the object browser - - Wrapping functions to help the usage of %GEOM tools: - - a sketcher module to create sketches from the python API (gsketcher.py) - - \subpage struct_elem_visualisation "The visualization of structural elements": a function to create - geometrical 3D representations of mechanical models called - "structural elements" (package \ref structelem.py "structelem") - - The functions are distributed in the python package salome.geom. - The specification of the programming interface of this package - is detailled in the part \subpage api_documentation "Documentation of the programming interface (API)" - of this documentation. - - - \note The main package salome contains other sub-packages that are -- Python Interface \subpage geompy_page "geomBuilder.py" to import/export, create and transform geometrical objects and use measurement tools; -- Utility functions geomtools.py to handle %GEOM items in Salome study: ++- Python Interface \subpage geompy_page "geomBuilder.py" to import/export, ++ create and transform geometrical objects, manage fields, use measurement tools; ++ ++- Utility functions within Python module \subpage manipulate_object "geomtools.py" ++ to handle %GEOM items in SALOME study: + - add or remove a shape; + - display or erase a shape in the viewer; + - completely delete a shape (undisplay, unpublish, and destroy it); - - manage the selection in the object browser - See for example how to \subpage manipulate_object "Manipulate a GEOM object in the study". -- Wrapping functions for %GEOM tools: - - sketcher module to create sketches from the python API (gsketcher.py) -- \subpage struct_elem_visualisation "Visualization of structural elements" function to create - geometrical 3D representations of mechanical models called - "structural elements" (package \ref structelem.py "structelem") ++ - manage the selection in the object browser. ++ ++- \subpage pythonutils_page "Wrapping functions" for %GEOM tools ++ ++- Python package \subpage struct_elem_visualisation "structelem" that provides ++ functions to create geometrical 3D representations of mechanical models called ++ "structural elements" + + The functions are distributed in the python package salome.geom. + Its documentation is mainly generated from the code of source python files. -salome.geom – Package containing the %GEOM python utilities: -- geomtools -- sketcher -- structelem + + \note The main package salome contains other sub-packages that are distributed with the other SALOME modules. For example, the KERNEL module provides the python package salome.kernel and SMESH the package salome.smesh. diff --cc doc/salome/gui/GEOM/input/pythonutils.doc index 000000000,000000000..504874dc3 new file mode 100644 --- /dev/null +++ b/doc/salome/gui/GEOM/input/pythonutils.doc @@@ -1,0 -1,0 +1,11 @@@ ++/*! ++ ++\page pythonutils_page Auxiliary Python API of Geometry module ++ ++Python API of Geometry module includes some additional packages: ++ ++- Sketcher module gsketcher.py to create 2D / 3D sketches ++ ++- Simplified sketcher module sketcher.py (deprecated) ++ ++*/ diff --cc doc/salome/gui/GEOM/input/struct_elem_visualisation.doc index ffeed3878,70cc550cb..78dca8b3f --- a/doc/salome/gui/GEOM/input/struct_elem_visualisation.doc +++ b/doc/salome/gui/GEOM/input/struct_elem_visualisation.doc @@@ -2,8 -2,7 +2,10 @@@ \page struct_elem_visualisation Visualization of structural elements (package structelem) - The usage of the visualization of structural elements can be - appreciated with this set of instructions: ++The Python package structelem contains functions ++to create geometrical 3D representations of mechanical models called "structural elements". ++ + The visualization of structural elements can be tested with the following set of instructions: \code from salome.geom.structelem import TEST_StructuralElement diff --cc src/GEOM_PY/sketcher.py index ca768f569,ca768f569..c301962e0 --- a/src/GEOM_PY/sketcher.py +++ b/src/GEOM_PY/sketcher.py @@@ -18,6 -18,6 +18,15 @@@ # # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # ++ ++## \defgroup simplesketcher sketcher - Simplified sketcher API ++# \{ ++# \details ++# This module provides simplified access to the 2D sketcher functionality of Geometry module. ++# ++# \note This module is deprecated, refer to \ref gsketcher for more details ++# \} ++ """ This module provides the user with a simple python API to realize various sketches from the GEOM text user interface. @@@ -60,6 -60,6 +69,8 @@@ except geompyEnable = False pass ++## ++# \ingroup simplesketcher class Sketcher: __sketch = None diff --cc src/GEOM_SWIG/gsketcher.py index e738c1993,e738c1993..783bfffca --- a/src/GEOM_SWIG/gsketcher.py +++ b/src/GEOM_SWIG/gsketcher.py @@@ -21,7 -21,7 +21,7 @@@ # Author : Julia DOROVSKIKH, Open CASCADE S.A.S. # Module : GEOM_SWIG --## @defgroup sketcher sketcher - Wrapper to help the creation of simple sketches ++## @defgroup sketcher gsketcher - Wrapper to help the creation of simple sketches # @{ # @details # This module provides the user with a simple python API