diff --git a/doc/salome/gui/GEOM/CMakeLists.txt b/doc/salome/gui/GEOM/CMakeLists.txt index 435d60b92..1b8fbf299 100644 --- a/doc/salome/gui/GEOM/CMakeLists.txt +++ b/doc/salome/gui/GEOM/CMakeLists.txt @@ -34,6 +34,7 @@ ADD_CUSTOM_TARGET(usr_docs ${CMAKE_COMMAND} -E make_directory tmp 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 --git a/doc/salome/gui/GEOM/images/2dsketch1.png b/doc/salome/gui/GEOM/images/2dsketch1.png new file mode 100644 index 000000000..627cfd87e Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch1.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch10.png b/doc/salome/gui/GEOM/images/2dsketch10.png new file mode 100644 index 000000000..23875a86c Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch10.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch12.png b/doc/salome/gui/GEOM/images/2dsketch12.png new file mode 100644 index 000000000..1473afab7 Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch12.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch2.png b/doc/salome/gui/GEOM/images/2dsketch2.png new file mode 100644 index 000000000..af204f7dd Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch2.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch3.png b/doc/salome/gui/GEOM/images/2dsketch3.png new file mode 100644 index 000000000..a213951bf Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch3.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch4.png b/doc/salome/gui/GEOM/images/2dsketch4.png new file mode 100644 index 000000000..8ba105146 Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch4.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch5.png b/doc/salome/gui/GEOM/images/2dsketch5.png new file mode 100644 index 000000000..ec083016e Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch5.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch6.png b/doc/salome/gui/GEOM/images/2dsketch6.png new file mode 100644 index 000000000..5f93eeb50 Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch6.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch7.png b/doc/salome/gui/GEOM/images/2dsketch7.png new file mode 100644 index 000000000..7bb862180 Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch7.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch8.png b/doc/salome/gui/GEOM/images/2dsketch8.png new file mode 100644 index 000000000..97da458db Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch8.png differ diff --git a/doc/salome/gui/GEOM/images/2dsketch9.png b/doc/salome/gui/GEOM/images/2dsketch9.png new file mode 100644 index 000000000..2895a3b09 Binary files /dev/null and b/doc/salome/gui/GEOM/images/2dsketch9.png differ diff --git a/doc/salome/gui/GEOM/images/measures2a.png b/doc/salome/gui/GEOM/images/measures2a.png new file mode 100644 index 000000000..3068f49b1 Binary files /dev/null and b/doc/salome/gui/GEOM/images/measures2a.png differ diff --git a/doc/salome/gui/GEOM/images/repair10a.png b/doc/salome/gui/GEOM/images/repair10a.png new file mode 100644 index 000000000..b603303de Binary files /dev/null and b/doc/salome/gui/GEOM/images/repair10a.png differ diff --git a/doc/salome/gui/GEOM/images/repair9a.png b/doc/salome/gui/GEOM/images/repair9a.png new file mode 100644 index 000000000..e1230ba90 Binary files /dev/null and b/doc/salome/gui/GEOM/images/repair9a.png differ diff --git a/doc/salome/gui/GEOM/input/add_dimension.doc b/doc/salome/gui/GEOM/input/add_dimension.doc deleted file mode 100644 index 691132280..000000000 --- a/doc/salome/gui/GEOM/input/add_dimension.doc +++ /dev/null @@ -1,44 +0,0 @@ -/*! - -\page add_dimension_page Add Dimension - -\image html add_dimension.png - -The dialog is opened from \ref managing_dimensions_page "Manage Dimensions" dialog when "Add" button is clicked. -This dialog allows creating measurement dimension for the selected geometrical object. -The following types of dimensions can be constructed: - - -Being constructed, the dimension is positioned by application such that the user is able to see it from the most appropriate angle of view. -The application selects one of the best matching planes allowed for the dimension. If extending the dimension by increasing length of flyouts -make sense, then the application extends the flyouts for a default value specified on the \ref geometry_preferences_page "geometry preference dialog". - -Once constructed, the geometrical properties of dimension preview (flyout, plane) become interactively editable in OCC viewer. -For the description of interactive operations please refer to corresponding section at \ref managing_dimensions_page "Manage Dimensions" page. - -The legnth dimension can be constructed in three ways: as length on edge, as length between two points and as length between two parallel lines. -In order to construct the dimension, the selected geometry should met the following conditions: - - -The diameter dimension can be constructed for the following geometry types: - - -The angle dimension can be constructed in two ways: as angle between two edges, as angle by three points. -The following conditions should be met: - - -*/ diff --git a/doc/salome/gui/GEOM/input/angle.doc b/doc/salome/gui/GEOM/input/angle.doc index 17e6c94de..0a3e46b7d 100644 --- a/doc/salome/gui/GEOM/input/angle.doc +++ b/doc/salome/gui/GEOM/input/angle.doc @@ -2,11 +2,11 @@ \page angle_page Angle -Returns the angle between two lines or linear edges in degrees. +This operation returns the angle in degrees between two lines or linear edges. -\note If both arguments are vectors, the angle is computed in - accordance with their orientations, otherwise the minimum angle - is computed. +\image html angle.png + +If both objects are vectors, the angle is computed in accordance with their orientations, otherwise the minimum angle is computed. \n TUI Command: geompy.GetAngle(shape1, shape2), where Shape1 and Shape2 are shapes between which the angle is computed. @@ -15,6 +15,6 @@ which returns the value of angle in radians. See also a \ref tui_angle_page "TUI example". -\image html angle.png + */ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc b/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc index ebbe7f440..8821198e3 100644 --- a/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc +++ b/doc/salome/gui/GEOM/input/arranging_study_objects_page.doc @@ -1,31 +1,68 @@ /*! +\page arranging_study_objects_page Viewing objects in the Object Browser -\page arranging_study_objects_page Arranging objects in study +

Context Menu

-The possibility to classify the geometrical objects by moving it into early created container (folder) was introduced to Geometry module. +Newly created or imported geometrical objects are listed in the Object Browser. +The following commands appear in the Object Browser context menu under certain conditions: -\image html arranging1.png "Objects classified in folders" +\image html ob_popup_menu.png
-To create a folder select "Create folder" popup menu item for root "Geometry" object or another folder. + -\n Or to measure dimensions of the shape elements: - - - \n Our TUI Scripts show how to use \ref tui_measurement_tools_page "Measurement Tools" with TUI commands. diff --git a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc index b6b5a4f4e..38246c570 100644 --- a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc +++ b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc @@ -2,9 +2,11 @@ \page view_geom_obj_page Viewing geometrical objects -Newly created geometrical objects are automatically displayed in +Newly created or imported geometrical objects are added as items in the Object Browser and displayed in the OCC 3D Viewer. +See the corresponding topic about the \subpage arranging_study_objects_page "Operations available in the Object Browser for Geometry module". + OCC 3D Viewer is described in the documentation on GUI module. @@ -76,47 +78,6 @@ on the viewer background:
  • Select Only provides a filter for exclusive selection of objects of a certain type.
    • -The following commands appear in the Object Browser context menu -under certain conditions: -\image html ob_popup_menu.png
    - - - -At the bottom of the Object Browser, there is \b Information -window providing some information on a selected geometric object: - -\image html creation_op_info.png Information window - -- Creation operation shows a name of the operation -used to create the selected object. -- The table below lists \b Parameters used to create the -selected object and their \b Values. */ diff --git a/doc/salome/gui/GEOM/input/whatis.doc b/doc/salome/gui/GEOM/input/whatis.doc index faa183032..5763a6fb4 100644 --- a/doc/salome/gui/GEOM/input/whatis.doc +++ b/doc/salome/gui/GEOM/input/whatis.doc @@ -2,26 +2,24 @@ \page whatis_page What Is ? -General information about the selected geometrical object is the -list of types and quantities of all topological entities, composing -the shape. +This operation provides the list of types and quantities of all topological entities, composing +the selected geometrical object. + +\image html measures8.png \n TUI Command: geompy.WhatIs(Shape), where \em Shape is a shape from which a description is returned. -See also a \ref tui_whatis_page "TUI example". +\n Kind of Shape field characterizes the +whole shape. If there is no additional information about the +shape, Basic Properties button is disabled, otherwise it +provides information about center and dimensions of the shape. -\image html measures8.png - -\n Kind of Shape field characterises the -whole shape. If there is no additional information available for the -shape, Basic Properties button will be disabled, otherwise it -will show a dialog with information about -dimensions, position, orientation and other parameters of the shape. +\image html measures8a.png \n TUI Command: geompy.KindOfShape(Shape), where \em Shape is a shape from which a description is returned. -\image html measures8a.png +See also a \ref tui_whatis_page "TUI example". */ \ No newline at end of file diff --git a/src/GEOM_PY/sketcher.py b/src/GEOM_PY/sketcher.py index ca768f569..c301962e0 100644 --- a/src/GEOM_PY/sketcher.py +++ b/src/GEOM_PY/sketcher.py @@ -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 +69,8 @@ except: geompyEnable = False pass +## +# \ingroup simplesketcher class Sketcher: __sketch = None diff --git a/src/GEOM_SWIG/gsketcher.py b/src/GEOM_SWIG/gsketcher.py index e738c1993..783bfffca 100644 --- a/src/GEOM_SWIG/gsketcher.py +++ b/src/GEOM_SWIG/gsketcher.py @@ -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