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
+++ /dev/null
-/*! \r
-\r
-\page add_dimension_page Add Dimension\r
-\r
-\image html add_dimension.png\r
-\r
-The dialog is opened from \ref managing_dimensions_page "Manage Dimensions" dialog when "Add" button is clicked.\r
-This dialog allows creating measurement dimension for the selected geometrical object.\r
-The following types of dimensions can be constructed:\r
-<ul>\r
-<li>Length.</li>\r
-<li>Diameter.</li>\r
-<li>Angle.</li>\r
-</ul>\r
-\r
-Being constructed, the dimension is positioned by application such that the user is able to see it from the most appropriate angle of view.\r
-The application selects one of the best matching planes allowed for the dimension. If extending the dimension by increasing length of flyouts\r
-make sense, then the application extends the flyouts for a default value specified on the \ref geometry_preferences_page "geometry preference dialog".\r
-\r
-Once constructed, the geometrical properties of dimension preview (flyout, plane) become interactively editable in OCC viewer.\r
-For the description of interactive operations please refer to corresponding section at \ref managing_dimensions_page "Manage Dimensions" page.\r
-\r
-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.\r
-In order to construct the dimension, the selected geometry should met the following conditions:\r
-<ul>\r
-<li>Edge length - only the line edges are accepted. E.g. constructed from line segment, on two points.</li>\r
-<li>Two points - any two points.</li>\r
-<li>Parallel edges - only the parallel line edges are accepted.</li>\r
-</ul>\r
-\r
-The diameter dimension can be constructed for the following geometry types:\r
-<ul>\r
-<li>Arc and circle. The selected geometry should be an arc, a circular edge or a circular face.</li>\r
-<li>Sphere, cylinder, cone, torus.</li>\r
-</ul>\r
-\r
-The angle dimension can be constructed in two ways: as angle between two edges, as angle by three points.\r
-The following conditions should be met:\r
-<ul>\r
-<li>Two edges. The edges should be located in same plane.\r
-<li>Three points. Any three points, with the second point being the center of the angle.\r
-</ul>\r
-\r
-*/\r
\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 <b>vectors</b>, the angle is computed in
- accordance with their orientations, otherwise the minimum angle
- is computed.
+\image html angle.png
+
+If both objects are <b>vectors</b>, the angle is computed in accordance with their orientations, otherwise the minimum angle is computed.
\n <b>TUI Command:</b> <em>geompy.GetAngle(shape1, shape2),</em> where
Shape1 and Shape2 are shapes between which the angle is computed.
See also a \ref tui_angle_page "TUI example".
-\image html angle.png
+
*/
\ No newline at end of file
/*!
+\page arranging_study_objects_page Viewing objects in the Object Browser
-\page arranging_study_objects_page Arranging objects in study
+<h2> Context Menu </h2>
-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 <br>
-To create a folder select "Create folder" popup menu item for root "Geometry" object or another folder.
+<ul>
+<li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
-\image html arranging2.png "Creation of folder"
+<li><b>Conceal child items</b> / <b>Disclose child items</b> - hides / shows child
+sub-objects in the Object Browser, if the selected geometric object has
+child objects. When some child objects are hidden, the name of the
+parent object is highlighted with bold font.</li>
-"Drag&Drop" mechanism was integrated to arrange objects.
+<li><b>Show Only Children</b> - erases from the current viewer all objects
+and then displays only the children of the selected object(s).
+</li>
-\image html arranging3.png "Moving object into folder"
+<li><b>Unpublish</b> - hides the selected geometric object from the Object Browser
+ and erases it from all viewers. To publish unpublished geometric objects select in the
+ context menu of the <b>Geometry</b> root object <b>Publish...</b> item.
+ The following dialog box will appear
-\note Only two categories of objects can be moved into folder:
-<ul>
-<li> geometrical model(s) under root "Geometry" item or under any folder
-<li> folder(s)
+ \image html publish_dlg.png <br>
+
+ Switch the check-box near the appropriate object and
+ click <b>Publish</b> or <b>Publish And Close</b> button.
+
+ "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all
+ unpublished objects are sorted by name in ascending order. It is possible
+ to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
+</li>
</ul>
-If geometrical object has more than one child sub-object, then there is a possibility to sort these children in ascending order. To use sort functionality select "Sort children" popup menu item for the parent object.
+<h2> Folders </h2>
-\image html geom_sort.png "Sorting of sub-objects"
+In the Object Browser it is possible to classify geometrical objects into folders.
+
+To create a folder select <b> Create folder</b> item in the context menu of the root \b Geometry Object Browser item or in another folder.
+
+The objects can be added into folders by drag and drop
+
+\note Only two categories of objects can be moved into folder:
+- geometrical model(s) under root "Geometry" item or under any folder;
+- another folder.
+
+If a geometrical object has more than one child sub-object, it is possible to sort them in ascending order by selecting <b>Sort children</b> context menu item of the parent object.
Our <b>TUI Scripts</b> provide you with useful examples of
\ref tui_arranging_study_objects "Arranging objects in study".
+<h2>Information Window</h2>
+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
+
+- <b>Creation operation</b> 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.
+
*/
\page basic_prop_page Basic Properties
-Returns the properties (Length, Surface & Volume) for the selected
+This operation returns Length, Surface and Volume properties for the selected
geometrical object.
-<b>Result:</b> Display Length, Surface & Volume in the form of
-Python Tuple.
+\image html neo-basicprop.png
+
\n<b>TUI Command:</b> <em>geompy.BasicProperties(Shape),</em> where
\em Shape is a shape whose properties are inquired.
See also a \ref tui_basic_properties_page "TUI example".
-\image html neo-basicprop.png
-
*/
\ No newline at end of file
\page boundaries_page Check Free Boundaries
-Detects and highlights wires and edges that are not shared between
-two faces and are considered a shape's boundary.
-<br>Creates corresponding objects and publishes them into the study on
-"Apply" or "Apply and Close".
+This operation detects and highlights the free boundaries of the selected object.
+
+Free boundaries are wires and edges that are not shared between two faces.
+
+\image html repair9.png
+
+The information about the number of closed and open free boundaries is also provided.
+
+Press \b Apply or <b>Apply and Close</b> button to publish the corresponding wires or edges in the study.
+
+\image html repair9a.png "Free boundary of a compound"
<b>TUI Command:</b> <em>(NoError, ClosedWires, OpenWires) =
geompy.GetFreeBoundary(Shape),</em> where \em Shape is a shape to be
See also a \ref tui_free_boundaries_page "TUI example".
-\image html repair9.png
+
*/
\page bounding_box_page Bounding Box
-Displays the bounding box dimensions for the selected
-geometrical object and creates the corresponding box shape on "Apply".
+This operation performs precise computation of bounding box for the selected geometrical object and displays its dimensions.
\image html measures5.png
-\note This functionallity performs precise computation of bounding box.
+The coordinates of two corners of its bounding box are shown in the table.
+
+Press \b Apply or <b>Apply and Close</b> button to publish the bounding \b Box in the study.
\n <b>TUI Commands:</b> <em>[Xmin,Xmax, Ymin,Ymax, Zmin,Zmax] = geompy.BoundingBox(Shape, precise)</em>,
<em>BBox = geompy.MakeBoundingBox(Shape, precise)</em>, where \em Shape
\page build_by_blocks_page Building by blocks
-<h2>Introduction</h2>
-
-Below are some general notions about blocks:
-
A block is a an elementary geometric solid that has specific
-geometric constraints oriented for meshing. In the hexahedral case,
-blocks have 6 faces and each face has 4 edges.
-
-Tetrahedral Block - is a block with constraints for tetrahedral
-meshing.
-
-Hexahedral Block - is a block with constraints for hexahedral meshing.
-
-Block Compound - is a compound composed of blocks only.
-
-Some functionalities that allow building blocks easily are available from the main menu via <em>New
-Entity / Blocks</em>.
+geometric constraints oriented for meshing.
+- Tetrahedral Block - is a block with constraints for tetrahedral
+meshing. It has 4 faces and 3 edges on each face.
+- Hexahedral Block - is a block with constraints for hexahedral meshing.
+It has 6 faces and each 4 edges on each face.
+- Block Compound - is a compound composed of blocks only.
+
+The functionalities that allow building blocks are available from the main menu via <b>New
+Entity / Blocks</b> item.
<ul>
<li>\subpage create_quadrangle_face_page "Quadrangle face"</li>
\page center_mass_page Center of Mass
-Calculates and returns the coordinates of the gravity center for
+This operation calculates and returns the coordinates of the gravity center for
the selected geometrical object.
-<b>Result:</b> GEOM_Object (vertex).
+\image html measures3.png
+
+Press \b Apply or <b>Apply and Close</b> button to publish the \b Point in the study.
+
\n <b>TUI Command:</b> <em> geompy.MakeCDG(Shape),</em> where \em Shape is
the shape for which a center of gravity is computed.
See also a \ref tui_center_of_mass_page "TUI example".
-\image html measures3.png
*/
\ No newline at end of file
\page check_compound_of_blocks_page Check Compound of Blocks
-Checks whether a shape is a compound of glued blocks. To be
-considered as a compound of blocks, the given shape must satisfy the
+This operation checks whether a shape is a compound of glued blocks.
+
+\image html measures10.png
+
+To be considered as a compound of blocks, the given shape must satisfy the
following conditions:
-<ul>
-<li>Each element of the compound should be a Block (6 faces and 12 edges);</li>
-<li>Blocks can be connected only via an entire quadrangle face or an entire edge;</li>
-<li>The compound should be connected;</li>
-<li>Each couple of connecting quadrangle faces should be glued.</li>
-</ul>
-
-\n Informs of the following possible errors:
-<ul>
-<li>not a block;</li>
-<li>not glued;</li>
-<li>not connected;</li>
-<li>extra or degenerated edge.</li>
-</ul>
-
-\n <b>Result:</b> Boolean; highlight in the viewer.
+- Each element of the compound should be a Block (6 faces and 12 edges);
+- 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.
+
+
+In this dialog:
+
+- \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
+- \b Errors list informs of possible errors, for example:.
+ - Not a block;
+ - Not glued;
+ - Not connected;
+ - Extra or degenerated edge.
+- <b>Incriminated Sub-shapes</b> field outputs the list of sub-shapes that cause problem. It is possible to select them in the list and publish in the study for further analysis by clicking \b Apply or <b>Apply and Close</b> button.
+
+
\n <b>TUI Command:</b>
<em>geompy.CheckCompoundOfBlocks(Compound).</em> Checks if the shape
is a valid compound of blocks. If it is true, then the validity flag
See also a \ref tui_check_compound_of_blocks_page "TUI example".
-\image html measures10.png
*/
\ No newline at end of file
\page check_self_intersections_page Detect Self-intersections
-\n Checks the topology of the selected shape to detect self-intersections.
- Returns True if there are no self-intersections. Reports pairs of
- intersected sub-shapes, if there are any.
+This operation checks the topology of the selected shape to detect self-intersections.
+
+\image html measures11.png
+
+In this dialog:
+
+- \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
+- \b Errors list contains the list of intersections. Select the intersection to show <b>Incriminated Sub-shapes</b> in the field to the right.
+
\note This tool is useful for detection of shapes, not suitable for
arguments of Boolean operations and Partition algorithm.
See also a \ref tui_check_self_intersections_page "TUI example".
-\image html measures11.png
*/
\ No newline at end of file
\page check_shape_page Check Shape
-\n Checks the topology of the selected geometrical object and returns
-True if it is valid. Check also geometry checkbox allows to test the
-geometry as well.
+\n This operation checks the topology of the selected geometrical object and returns
+True if it is valid.
+
+\image html measures9.png
+
+In this dialog:
+
+- \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
+- <b>Check also geometry</b> option allows testing the geometry of the object as well.
+- \b Errors list informs of possible errors.
+- <b>Incriminated Sub-shapes</b> field outputs the list of sub-shapes that cause problem. It is possible to select them in the list and publish in the study for further analysis by clicking \b Apply or <b>Apply and Close</b> button.
-\n <b>Result:</b> Boolean; highlight in the viewer.
\n <b>TUI Commands:</b>
+
<UL>
+
<LI>
<em>geompy.CheckShape(theShape, theIsCheckGeom = 0, theReturnStatus = 0),</em> \n
where \n
\em theIsCheckGeom is the flag that tells if geometry should be checked also.\n
\em theReturnStatus is the flag that can have the following values:
<UL>
-<LI>0 - Means that if theShape is invalid, a description of problem is printed.
-IsValid status is returned.</LI>
-<LI>1 - Means that IsValid status and the description of problem are returned.</LI>
-<LI>2 - Means that IsValid status and the list of error data are returned.</LI>
+<LI>0 - if theShape is invalid, a description of problem is printed.
+\em IsValid status is returned.</LI>
+<LI>1 - \em IsValid status and the description of problem are returned.</LI>
+<LI>2 - \em IsValid status and the list of error data are returned.</LI>
</UL>
</LI>
+
<LI>
<em>geompy.PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0),</em> \n
where \n
-\em theShape Shape that was checked. \n
-\em theShapeErrors the shape errors obtained by CheckShape. \n
+\em theShape is the shape checked for validity. \n
+\em theShapeErrors are the shape errors obtained by CheckShape. \n
\em theReturnStatus is the flag that can have the following values:
<UL>
-<LI>0 - Means that a description of problem is printed.
-IsValid status is returned.</LI>
-<LI>1 - Means that the description of problem is returned.</LI>
+<LI>0 - the problem description is printed and \em IsValid status is returned.</LI>
+<LI>1 - the problem description is returned.</LI>
</UL>
</LI>
</UL>
+
See also a \ref tui_check_shape_page "TUI example".
-\image html measures9.png
*/
\ No newline at end of file
\image html 3dsketch_dlg.png
The first point of a sketch can be defined by \b Absolute coordinates X, Y and Z.
-When the first point is defined, it is possible to add straight segments.
-Each segment will start at the end point of the previous segment or at the
-first point of the sketch, if there are no validated segments.
+After this, it is possible to add straight segments.
-The way of segment construction can be selected by the <b>Coordinates Type</b>
-radio buttons.
+Each segment starts at the end point of the previous segment or at the first point of the sketch, if there are no validated segments.
-To validate a segment and to proceed with the definition of the next
-one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
-respectively, remove or restore the last segment in the wire.
+The second point of a segment can be defined in two different ways depending on the selected <b>Coordinates Type</b> radio buttons:
-\n <b>"Sketch Validation"</b> button applies the wire, built by the
-user, "as is".
-\n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
-the start to the end point and applies it.
-
-A segment can be defined by:
-- <b>Cartesian coordinates</b> of its second end, which can be either:
- - \b Absolute coordinates X, Y and Z, or
- - \b Relative coordinates DX, DY and DZ with
- respect to the previous applied point,
-
-- <b>Angular coordinates</b> of its second end specified by:
-<ul>
- <li> the \b Length of the segment and an \b Angle in the chosen plane (OXY for example) in \b Relative mode.
- The angle is then relative to a local coordinate system with the last point of the sketch as origin. </li>
+By <b>Cartesian coordinates</b> , which can be either:
+- \b Absolute coordinates \b X, \b Y and \b Z, or
+- \b Relative coordinates \b DX, \b DY and \b DZ with respect to the previous applied point,
+
+By <b>Angular coordinates</b>, which include:
+- the \b Length of the segment and an \b Angle in the chosen plane (OXY for example) in \b Relative mode. The angle is then relative to a local coordinate system with the last point of the sketch as origin. </li>
- \image html 3dsketch_angle_rel.png
+\image html 3dsketch_angle_rel.png
- <li> the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode </li>
+- the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode
- \image html 3dsketch_angle_abs.png
+\image html 3dsketch_angle_abs.png
- In both angular modes you can additionally specify the following:
-
- <li> the second \b Angle (latitude) </li>
-
- \image html 3dsketch_2angles_rel.png
-
- or
+In both angular modes you can additionally specify the following:
+- the second \b Angle (latitude)
+
+\image html 3dsketch_2angles_rel.png
- <li> the \b Height </li>
+- the \b Height
- \image html 3dsketch_angle_height_rel.png
+\image html 3dsketch_angle_height_rel.png
+To validate a segment and to proceed with the definition of the next
+one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
+respectively, remove or restore the last segment in the wire.
+
+\n <b>Sketch Validation</b> button applies the wire, built by the
+user, "as is".
+\n <b>Sketch Closure</b> closes the Sketch by a straight line from
+the start to the end point and applies it.
-</ul>
+<h2>TUI Commands</h2>
-<b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
+<em>geompy.Make3DSketcher( [ PointsList ] )</em>
This algorithm creates a wire from the list of real values, which
define absolute XYZ coordinates of points. The Result of the operation
will be a \b GEOM_Object.
\n Another way to create the 3D Sketcher in TUI is using Sketcher3D
interface.
-<b>TUI Command:</b> <em>sk = geompy.Sketcher3D()</em>
+<em>sk = geompy.Sketcher3D()</em>
-Returns an instance of Sketcher3D interface <i>sk</i>.
+Returns an instance of Sketcher3D interface <em>sk</em>.
Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
interface documentation for more information.
-Our <b>TUI Scripts</b> provide you with useful examples of the use of
+<b>TUI Scripts</b> provide you with useful examples of the use of
\ref tui_3dsketcher_page "3D Sketcher".
*/
\note The parameters <b>Center</b>, <b>Vector</b> and <b>Major Axis</b>
are optional. By default it is presumed that the <b>Center</b> point
is located at the origin of the global coordinate system, the \b Vector
-corresponds to the OZ axis of the global coordinate system and <b>Major Axis</b>
-corresponds to the OX axis of the global coordinate system.
-
+corresponds to OZ axis of the global coordinate system and <b>Major Axis</b>
+corresponds to OX axis of the global coordinate system.
\note The actual direction of the major axis vector is defined as
<EM> Vmaj' = (Vn * Vmaj) * Vn</em>, where \em Vn is a normal vector and
\em Vmaj is an original vector of the major axis.
-\n <b>TUI Command (no major axis):</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em>
+\n <b>TUI Command (without the major axis):</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em>
\n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
the direction) + 1 X Radius + 1 Y Radius.
-\n <b>TUI Command (use major axis):</b><em>geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor)</em>
+\n <b>TUI Command (with the major axis):</b> <em>geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor)</em>
\n <b>Arguments:</b> 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
There are 2 algorithms to create a \b Line in the 3D space.
The Result of each operation will be a GEOM_Object (edge).
-\n Firstly you can define a \b Line through \b Point1 and \b Point2,
+\n Firstly you can define a \b Line by \b Point1 and \b Point2,
which are the points through which the \b Line passes.
\n <b>TUI Command:</b> <em>geompy.MakeLineTwoPnt(Point1, Point2)</em>
\n <b>Arguments:</b> Name + 2 vertices.
is extrapolated along its curve (except for bezier and b-spline
curves).
The <b>Start Point</b> defines the direction for the length
-calculation (if not defined, the first vertex of
-Edge is used, else the vertex of Edge closest to StartPoint is used).
+calculation (if not defined, the first vertex of the
+Edge is used, else the vertex of the Edge, which is closest to the Start Point).
\n <b>TUI Command:</b> <em>geompy.MakeVertexOnCurveByLength(Edge,Length,StartPoint=None).</em>
\n <b>Arguments:</b> Name + 1 edge + 1 Length + 1 Point.
projected point.
\image html point3_2.png
-\n Fourthly, we can define a point(s) by intersection of two \b Lines or \b Wires (or a Wire and a Line).
-If they intersect only once, a point will be created. If there are several intersections, a compound of
-points will be created. The type of the selected object (Line or Wire) can be changed in the popup menu,
-after clicking the corresponding selection button. (see the picture below)
+\n Fourthly, we can define a point by intersection of two \b Lines or \b Wires (or a Wire and a Line).
+If they intersect only once, a point will be created. If there are several intersections, a compound of points will be created. The type of the selected object (Line or Wire) can be changed in the popup menu, after clicking the corresponding selection button.
\n <b>TUI Command:</b> <em>geompy.MakePointOnLinesIntersection(myLine1,myWire1).</em>
\n <b>Arguments:</b> Name + 2 1D objects
\image html point4.png
-\n Finally, we can define a point by a \b Face and
-Two <b> Parameters: U </b> and \b V
-indicating its position on the Face, ranging from 0.0 to 1.0. For example, (0.5; 0.5) means that the
-point is located in the middle of the face.
+\n Finally, we can define a point located on a \b Face.
+The position of the point on it can be defined in one of two ways:
+
+- by two <b> Parameters: U </b> and \b V, ranging from 0.0 to 1.0. For example, (0.5; 0.5) means that the point is located in the middle of the face.
\n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurface(myFace,myUParameter,myVParameter).</em>
-\n <b>Arguments:</b> Name + 1 face + 2 Parameters defining the
-position of the point on the given face.
+\n <b>Arguments:</b> Name + 1 face + 2 Parameters defining the position of the point on the given face.
\image html point5.png
-Alternatively, it is possible to define 3D coordinates of the point projected on the given face.
+- by three coordinates of the point projected on the given face.
\n <b>TUI Command:</b> <em>geompy.MakeVertexOnSurfaceByCoord(myFace,X,Y,Z).</em>
-\n <b>Arguments:</b> Name + 1 face + 3 coordinate values
-to project point on the given face.
+\n <b>Arguments:</b> Name + 1 face + 3 coordinate values to project point on the given face.
\image html point5_2.png
\image html points.png "Points by edge and parameter and by coordinates"
-Our <b>TUI Scripts</b> provide you with useful examples of creation of
-\ref tui_creation_point "Basic Geometric Objects".
+Our <b>TUI Scripts</b> provide you with useful examples of creation of \ref tui_creation_point "Basic Geometric Objects".
*/
\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.
-<ul>
-<li> \b Profile made of connected curves of 2 types: <b>line segments</b> and \b arcs.
+To create a <b>2D Sketch</b> select in the main menu <b>New Entity -> Basic -> 2D Sketch</b>.
-\b or
-
-<li> \b Rectangle
-</ul>
-
-The \b Result is a \b Wire
-
-\n <b>Example:</b>
-
-\image html sketch_example.png
-
-To create a <b> 2D Sketch</b>:
+\image html sketcher_dlg.png
-<ol>
-<li>In the main menu select <b>New Entity -> Basic -> 2D Sketch</b> or click on \image html sketch.png </li>
+At first it is necessary to define the reference coordinate system, where the sketch will be created:
+- The XOY plane of the <b>Global coordinate system</b> is suggested by default (if no plane or planar face is selected when <b>2D Sketcher</b> 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 <b>planar face</b> 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.
+- <b>Restore</b> button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects.
-<li> Select the \b plane or the <b>planar face</b> 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.</li>
+It is possible to create sketches of two types:
+- \b Profiles made of <b>line segments</b> and \b arcs, or
+- \b Rectangles.
-<li> Choose a \b segment or an \b arc element to start a \b profile or choose \b rectangle to draw a rectangle.
+<h2>Creation of a Profile by straight segments</h2>
-\n If you draw a \b profile:
+- Choose \b segment radio button to start a \b profile.
-<li> Select a start point. By default the start point of the curve is located at the point of
-origin of the reference coordinate system.</li>
+- 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:
-<li> Create curve portions and click on \b Apply after each step.</li>
+ - 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
-<li> Select either \b Close or <b>Sketch Closure</b> if you want to close the profile before closing the window.</li>
-</ol>
+ - 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.
-<ol>
-<li> In the <b>Element Type</b> part of the dialog box select:
+Alternatively to the definition by \b Points it is possible to define segments by \b Direction and \b Distance.
+
+- The \b Direction can be:
-\image html line_icon.png </li>
+ - 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 <b>VX-VY</b> vector coordinates.
+ \image html 2dsketch7.png
+
+- The \b Distance can be defined:
-<li> You can define the segment by either its <b>end point</b> or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be:
- <ul>
- <li> Tangent (collinear to the tangent at the last point)</li>
- <li> Perpendicular</li>
- <li> Defined by an angle</li>
- <li> Defined by a vector (Vx, Vy)</li>
- </ul>
+ - 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 <b>"Close"</b> button to apply the created wire "as is".
+- Alternatively, click <b>"Sketch Closure"</b> to close the Sketch by a straight line
+from the last created segment to the start point and apply it.
-</li>
+<h2>Creation of a Profile by ark segments </h2>
-</ol>
-
-\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.
-<ol>
-<li> In the <b>Element Type</b> part of the dialog box select \image html arc_icon.png </li>
+\image html 2dsketch10.png "Ark segments"
+
+- By default, <b>None (Tangential)</b> radio button is selected as <b>Additional Parameter</b>, 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.
-<li> You can define the segment by either its <b>end point</b> or \b direction \b radius and \b angle. </li>
+\image html 2dsketch12.png
-<ul>
- <li>In case of an end point the arc can be built in three different ways:</li>
- <ul>
- <li>From the end point only. The arc is \b tangential to the end of the sketch.</li>
- <li>From the end point and a \b radius. (The radius must be greater than half of the distance between the last point and the end point of the arc).</li>
- <li>From the \b center of the circle and the end point. The constraint on the center is first taken into account.
- The destination point is only used to define the angle of the arc and won't lie on the arc in the general case.</li>
- </ul>
-
- <li>The direction is defined relatively to the tangent at the last point of the sketch. It can be:</li>
-
- <ul>
- <li>Tangent (colinear to the tangent at the last point)</li><
- <li>Perpendicular</li>
- <li>Defined by an angle</li>
- <li>Defined by a vector (Vx, Vy)</li>
- </ul>
-</ul>
-
-</ol>
+- \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
+
+<h2>Creation of a Rectangle profile</h2>
-\n <b>Dialog Box:</b>
+\n To draw a \b rectangle, select a \b rectangle radio button.
-\image html sketcher_dlg.png
+\image html sketcher_dlg2.png
-\n <b>Arguments:</b>
-<ol>
-<li>Coordinate system (Existing Local CS or Global CS can be selected)</li>
-<li>A plane or a planar face to define a new Local Coordinate System
-<li>Element type (segment, arc or rectangle).</li>
-<li>Destination type (point or direction).</li>
-<li>Destination point by means of:</li>
-<ul>
-<li>absolute coordinates X,Y;</li>
-<li>relative coordinates DX, DY (with respect to the current point);</li>
-<li>selection of an existing point.</li>
-</ul>
-<li>Destination direction by means of:</li>
-<ul>
-<li>angle between the new segment and the previous one;</li>
-<li>perpendicular to the previous segment (same as previous, but the angle
-is predefined and is equal to 90 degrees);</li>
-<li>tangent to the previous segment;</li>
-<li>vector components DX, DY.</li>
-</ul>
-<li>Parameters of an element (for segment : length or target X or Y coordinate value, for arc : radius, angle or center coordinates).</li>
-</ol>
-
-\b Buttons:
-
-<b>"Restore"</b> button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all its objects.
-\n <b>"Close"</b> button applies the wire, only the red part will be built.
-\n <b>"Sketch Closure"</b> will close the Sketch by a straight line
-from the last red part and apply it.
-
-\n To draw a \b rectangle:
-
-<ol>
-<li> In the <b>Element Type</b> part of the dialog box select \image html rectangle_icon.png </li>
-
-<li> Draw a rectangle with the mouse directly in the view or fill in the coordinates of two opposite vertices of the rectangle.</li>
-<li> <b>Apply and Close</b> </li>
-</ol>
-
-\n <b>Dialog Box:</b>
+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
+<h2>TUI Commands</h2>
-\n <b>Arguments:</b>
-<ol>
-<li>Coordinate system (Existing Local CS or Global CS can be selected)</li>
-<li>A plane or a planar face to define a new Local Coordinate System
-<li>Element type (segment, arc or rectangle).</li>
-<li>The X,Y coordinates of two opposite vertices of the rectangle</li>
-</ol>
+<em>geompy.MakeSketcherOnPlane(Command, WorkingPlane)</em>
+This algorithm creates a sketcher (wire or face), following the textual description, passed through the <i>Command</i> argument. The edges of the resulting wire or face will be arcs of circles and/or linear segments.
-\n <b>TUI Command:</b> <em>geompy.MakeSketcherOnPlane(Command, WorkingPlane)</em>
-\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 <em>WorkingPlane</em> 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.
+- <em>WorkingPlane</em> 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.
+Another way to create the 2D Sketcher in TUI is using Sketcher2D interface.
-<b>TUI Command:</b> <em>sk = geompy.Sketcher2D()</em>
+<em>sk = geompy.Sketcher2D()</em> - returns an instance of Sketcher2D interface <i>sk</i>.
-Returns an instance of Sketcher2D interface <i>sk</i>.
+\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 <b>TUI Scripts</b> provide you with useful examples of the use of
\ref tui_sketcher_page "2D Sketcher".
To create a <b> Smoothing Surface</b> in the <b>Main Menu</b> select <b>New Entity - >
Advanced - > SmoothingSurface </b>
-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: <b>Max nbr of
-Bezier pieces</b>, <b>Max BSpline surface degree</b> and <b>3D tolerance of initial approximation</b>.
-And then press "Apply" or "Apply & Close" button.
+\image html smoothingsurface_dlg.png
-<b>Advanced options:</b> \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;
+- <b>Max nbr of Bezier pieces</b> in the resulting surface;
+- <b>Max BSpline surface degree</b> of the resulting BSpline surface;
+- <b>3D tolerance of initial approximation</b>
-\note The dialog accepts compounds of points as well as single nodes.
+\note <b>3D tolerance of initial approximation</b> represents a tolerance of
+initial plate surface approximation. If this parameter is equal to 0 (default),
+its value is automatically computed as <em> max(0.0001, 10*error)</em>,
+where <em>error</em> is a 3D tolerance of the surface representing a maximal
+distance between computed plate surface and given points.
+
+<b>Advanced options:</b> \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 <em>GEOM_Object(Surface)</em>.
<b>TUI Command:</b> <em>geompy.MakeSmoothingSurface(thelPoints, theNbMax, theDegMax, theDMax)</em>, 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 3D tolerance of initial approximation
-\note <b>3D tolerance of initial approximation</b> 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
\page free_faces_page Check Free Faces
-Emphasizes by the red color all free faces of a given shape in the 3D Viewer.
-A free face is a face which is not shared between several sub-shapes of the shape.
+This operation highlights in red all free faces of the selected shape in the 3D Viewer.
+
+A free face is a face, which is not shared between several sub-shapes of the shape.
+
+\image html repair10.png
<b>TUI Command:</b> <em>GetFreeFacesIDs(Shape),</em> where \em Shape is
a shape to be checked.
-See also a \ref tui_free_faces_page "TUI example".
+\image html repair10a.png
-\image html repair10.png
+See also a \ref tui_free_faces_page "TUI example".
*/
\ No newline at end of file
\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.
+
\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 <b>Apply and Close</b> 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 <b>TUI Command:</b>
-<em>geompy.GetNonBlocks(Compound).</em> 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.
+<em>geompy.GetNonBlocks(Compound).</em> 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".
It is possible to easily set parameters via the variables predefined in
\subpage using_notebook_geom_page "SALOME notebook".
-Also, there is a possibility to customize an
-\subpage arranging_study_objects_page "arrangement of the geometrical objects in the SALOME study".
Geometry module preferences are described in the
\subpage geometry_preferences_page section of SALOME Geometry Help.
\page inertia_page Inertia
-Returns the axial moments of inertia for the selected geometrical object.
-
-\n <b>Result:</b> Displays the matrix of the own moments of inertia and
-the relative moments of inertia in the form of Python Tuple
- <center>(I11, I12, I13,</center>
- <center>I21, I22, I23,</center>
- <center>I31, I32, I33,</center>
- <center>Ix, Iy, Iz).</center>
+This operation returns the axial moments of inertia for the selected geometrical object.
+
+\image html measures4.png
+
+The table displays:
+- 3*3 matrix of its own moments of inertia (in rows <b> 1:1, 2:1</b> and <b>3:1</b>) and
+- the relative moments of inertia (in row <b>IX & IY & IZ</b>)
+
\n <b>TUI Command:</b> <em>geompy.Inertia(Shape),</em> where \em Shape is
a shape for which the own matrix of inertia and the relative moments of inertia are
returned.
See also a \ref tui_inertia_page "TUI example".
-\image html measures4.png
+
*/
\ No newline at end of file
\r
\page managing_dimensions_page Manage Dimensions\r
\r
-\image html dimensions_preview.png\r
-\r
-Dimensions of sub-elements can be measured for a geometrical object representing a shape. \r
-There are three types of dimensions available\r
-<ul>\r
-<li>Length.</li>\r
-<li>Diameter.</li>\r
-<li>Angle.</li>\r
-</ul>\r
-\r
-Measurement units and group of presentation attributes for the measurement dimensions can be seen and changed from the \ref geometry_preferences_page "geometry preference dialog".\r
+<b> Manage Dimensions </b> functionality allows showing in the viewer the measured dimensions of sub-elements of a geometrical object (shape). \r
\r
-The application entities, representing the dimensions, are associated with the geometrical object for which its elements are measured. The dimensions follow their associated object on show/hide, transformation and deletion operations.\r
+\image html dimensions_preview.png\r
\r
-Each dimension instance has its <i>local visibility</i> flag intended for showing/hiding it among other dimensions of the associated object.\r
+It can be accessed from the main menu via <b>Measures -> Dimensions -> Manage Dimensions </b>\r
\r
\image html manage_dimensions.png\r
\r
-This dialog allows managing list of dimensions for the selected geometrical object.\r
-It shows the list and provides dimension creation and removal, modification of name and visibility, along with the interactive modification of dimension's geometrical properties.\r
+<b>List of Dimensions</b>\r
\r
-The list view groups dimension objects by their type: "Distances", "Diameters", "Angles". This view allows selection of the dimensions and lets user to change the dimension's name and visibility.\r
+This dialog provides the list of dimensions shown in the view for the selected geometrical <b>Object</b>. The list items are sorted by dimension type: <b>Distance</b>, <b>Diameter</b> and <b>Angle</b>. \r
\r
-The buttons located at the right side of the dialog have the following purposes:\r
+It is possible to show/hide a dimension in the view by checking on/off the box to the left of its name. \r
+\r
+The buttons to the right of the list provide the following operations:\r
<ul>\r
-<li>"Add" - opens \ref add_dimension_page "Add Dimension" dialog for interactive specification of a new dimension for the selected object.</li>\r
-<li>"Remove" - removes selected instance of dimension.</li>\r
-<li>"Show All" / "Hide All" - turn on/off local visibility flags of all dimensions presented in the list.</li>\r
+<li>"Add" - opens \ref add_dimension_page "Add Dimension" dialog to define a new fly-out.</li>\r
+<li>"Remove" - removes the selected item from the list.</li>\r
+<li>"Show All" / "Hide All" - shows/hides all dimensions existing in the list.</li>\r
</ul>\r
\r
-\image html interact_with_dimensions.png\r
+<b>Add a Dimension</b>\r
+\r
+To add a new dimension to the object presentation, click <b>Add</b> button in the <b>Manage Dimensions</b> dialog. \r
\r
-Geometrical properties of the selected dimension become interactively editable in viewer.\r
-When hovering with mouse, the element of dimension become highlighted.\r
-This means that the element is ready for interactive operations.\r
+\image html add_dimension.png\r
\r
-The following interactive operations are allowed:\r
+The following dimensions can be shown:\r
+\r
+<ul>\r
+<li> <b>Length.</b> There are three possible types of length dimensions: \r
<ul>\r
-<li>Modification of flyout length. By dragging the flyout with left mouse button the user is allowed to change its length without changing its plane (direction).</li>\r
-<li>Modification of flyout length & plane (direction). If dimension is viewed at least slightly from side, then dragging the flyout with holding <i>ctrl</i> key additionally enables modification of the flyout plane.</li>\r
-<li>Modification of label alignment. By dragging the label the user is allowed to change its alignment. </li>\r
+<li> <b>Edge length</b> - shows the length of the edge selected in the viewer. Only line edges, i.e. line segments built on two points are accepted. </li>\r
+<li> <b>Two points </b> - shows the distance between two points selected in the viewer.</li>\r
+<li> <b>Parallel edges</b> - shows the distance between two parallel line edges.</li>\r
</ul>\r
+</li>\r
+\r
+<li> <b>Diameter </b> of an an arc, a circular edge or face, a sphere, a cylinder, a cone or a torus.</li> \r
+\r
+<li> <b>Angle.</b> The angle dimension can be defined in one of two possible ways : </li>\r
\r
-The following horizontally aligned positions can be specified:\r
<ul>\r
-<li>Left. Label is located outside of the left flyout line.</li>\r
-<li>Right. Label is located outside of the right flyout line.</li>\r
-<li>Center. Label is centered among of the flyout lines.</li>\r
+<li>By selecting <b>Two edges</b> located in the same plane.</li>\r
+<li>By selecting <b>Three points</b>. The second point is in the corner of the angle.</li>\r
+</ul>\r
</ul>\r
\r
-The following vertically aligned positions can be specified:\r
+<b>Modification of Dimension properties</b>\r
+\r
+The default properties of dimension text and line, such as font color, line width, measurement units, etc. can be defined from the \ref geometry_preferences_page "Geometry preferences".\r
+\r
+It is also possible to change the geometrical properties of the selected dimension interactively in the viewer. \r
+\r
+When hovering with mouse, the text and line become highlighted, which means that the dimension is ready for interactive operations.\r
+\r
+\image html interact_with_dimensions.png\r
+\r
+The following operations are possible:\r
<ul>\r
-<li>On flyout line. The label is located at the side of flyout line, which is farther from the measured geometry.</li>\r
-<li>Under flyout line. The label is located at the side of flyout line, which is closer to the measured geometry.</li>\r
-<li>In center of flyout line.</li>\r
+<li>To change the fly-out of a dimension text without changing its plane (direction), drag it by mouse with left mouse button pressed.</li>\r
+<li>To change both the fly-out and the plane (direction) of a dimension text, drag the flyout by mouse with both <i>ctrl</i> key and additionally enables modification of the flyout plane.</li>\r
+<li>To modify the location of the dimension text correspondingly to the dimension line, drag it by mouse. The text can be aligned horizontally or vertically and located on the line, under it or in its center.</li>\r
</ul>\r
\r
-All of the modifications to the dimensions, until applied, are temporary. The "Apply" and "Apply and Close" buttons save the changes.\r
+All modifications of the dimensions are temporary. The "Apply" and "Apply and Close" buttons save the changes.\r
+\r
\r
*/\r
\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 <a href="geompy_doc/group__geomtools.html">geomtools</a> 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 <em>geomtools</em> module can be tested with the following set of instructions:
\code
from salome.geom.geomtools import 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 <em>boxset</em>, and display it in <em>pink</em> 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.
*/
\page min_distance_page Minimum Distance
-Returns the minimum distance between two geometrical objects and
-the coordinates of the vector of distance and shows the distance in
-the viewer.
-
-\note The query for minimum distance can find one or more
-solutions, or even an infinite set of solutions. All
-found solutions are listed in a dedicated combo-box. When one of the found solutions is selected, the presentation is displayed in the
-OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with the
-corresponding values. If no solutions have been found, the message "No
-solution found" is shown.
-
-\note The currently used OCCT algorithm finds a finite number of
-solutions even if an infinite set of solutions exists.
+This operation returns the minimum distance between two geometrical objects.
\image html distance.png
-\n On \b Apply or <b>Apply and Close</b> a set of closest
-points, corresponding to all found solutions is created.
+The query for minimum distance can find one or more solutions, or even an infinite set of solutions.
+However, the currently used OCCT algorithm finds a finite number of
+solutions even if an infinite set of solutions exists.
+
+Select one of the found solutions in the \b Solution list to display it in the Viewer show values corresponding to this solution in the following fields:
+- \b Length - the distance value;
+- \b DX, \b DY and \b DZ the vector coordinates.
+
+Press \b Apply or <b>Apply and Close</b> button to create a set of closest
+points, corresponding to all found solutions.
<b>TUI Commands:</b>
\n<em>aDist = geompy.MinDistance(Shape1, Shape2),</em>
\n<em>[aDist, DX, DY, DZ] = geompy.MinDistanceComponents(Shape1, Shape2),</em>
\n<em>[nbSols, (x11, y11, z11, x21, y21, z21, ...)] = geompy.ClosestPoints(Shape1, Shape2),</em>
-\n where \em Shape1 and \em Shape2 are shapes between which the minimal
+\n where \em Shape1 and \em Shape2 are the shapes, between which the minimal
distance is computed.
See also a \ref tui_min_distance_page "TUI example".
\page normal_page Normal to a Face
-\n Calculates the normal vector to the selected \b Face. The \b Point
-is a point of the \b Face, where the Normal should be calculated.
+This operation calculates the normal vector to the selected \b Face.
-\n <b>TUI Command:</b> <em>geompy.GetNormal(Face, OptionalPoint = None),</em> where \em Face is
-the face to define normale of and \em OptionalPoint is the point to compute the normal at.
-If the point is not given, the normale is calculated at the center of mass.
+\image html normaletoface.png
+
+- \b Face is the face whose Normal should be calculated.
+- \b Point is a point on this face. If the point is not given, the normal is calculated at the center of mass.
+
+Press \b Apply or <b>Apply and Close</b> button to publish the \b Normal \b Vector in the study.
+
+\n <b>TUI Command:</b> <em>geompy.GetNormal(Face, OptionalPoint = None)</em>.
See also a \ref tui_normal_face_page "TUI example".
-\image html normaletoface.png
*/
\page point_coordinates_page Point Coordinates
-Returns the coordinates of a point.
+This operation returns XYZ coordinates of the selected point.
+
+\image html measures1.png
-<b>Result:</b> Point coordinates (X, Y, Z) in 3D space in the form of Python Tuple.
\n<b>TUI Command:</b> <em>geompy.PointCoordinates(Point),</em>
where \em Point is a point whose coordinates are inquired.
See also a \ref tui_point_coordinates_page "TUI example".
-\image html measures1.png
*/
\ No newline at end of file
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, 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.
+
+- \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 <em>salome.geom.</em>
+Its documentation is mainly generated from the code of source python files.
+
+\note The main package <em>salome</em> 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.
--- /dev/null
+/*!
+
+\page pythonutils_page Auxiliary Python API of Geometry module
+
+Python API of Geometry module includes some additional packages:
+
+- Sketcher module <a href="geompy_doc/group__sketcher.html">gsketcher.py</a> to create 2D / 3D sketches
+
+- Simplified sketcher module <a href="geompy_doc/group__simplesketcher.html">sketcher.py</a> (deprecated)
+
+*/
\ No newline at end of file
\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 <a href="geompy_doc/group__structelem.html">structelem</a> 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
TEST_StructuralElement()
\endcode
-This creates the geometrical objects displayed in the study below:
+This creates geometrical objects displayed in the study below:
\image html salome-geom-structuralelements.png
\page tolerance_page Tolerance
-\n Returns the maximum and the minimum tolerance for the selected
+This operation returns the maximum and the minimum tolerance for the selected
geometrical object.
-\n <b>Result:</b> Displays the tolerance values (FaceMinTol,
-FaceMaxTol, EgdeMinTol, EgdeMaxTol, VertexMinTol, VertexMaxTol).
+\image html new-tolerance.png
+
+The table displays \b Min and \b Max tolerance values for \b Face, \b Edge and \b Vertex tolerance.
+
\n <b>TUI Command:</b> <em>geompy.Tolerance(Shape),</em> where \em Shape
is a shape for which minimal and maximal tolerances are returned.
See also a \ref tui_tolerance_page "TUI example".
-\image html new-tolerance.png
*/
\ No newline at end of file
<li>\subpage min_distance_page "Min. distance"</li>
<li>\subpage angle_page "Angle"</li>
<li>\subpage tolerance_page "Tolerance"</li>
+<li>\subpage managing_dimensions_page "Dimensions"</li>
<li>\subpage whatis_page "WhatIs"</li>
</ul>
<li>\subpage check_self_intersections_page "Detect Self-intersections"</li>
</ul>
-\n Or to measure dimensions of the shape elements:
-
-<ul>
-<li>\subpage managing_dimensions_page "Manage Dimensions"</li>
-<li>\subpage add_dimension_page "Add Dimension"</li>
-</ul>
-
\n Our <b>TUI Scripts</b> show how to use
\ref tui_measurement_tools_page "Measurement Tools" with <b>TUI
commands</b>.
\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 <b>OCC 3D Viewer</b>.
+See the corresponding topic about the \subpage arranging_study_objects_page "Operations available in the Object Browser for Geometry module".
+
<b>OCC 3D Viewer</b> is described in the documentation on <b>GUI
module</b>.
<li><b>Select Only</b> provides a filter for exclusive selection of objects of a certain type.</li>
</ul>
-The following commands appear in the Object Browser context menu
-under certain conditions:
-
-\image html ob_popup_menu.png <br>
-
-<ul>
-<li>\ref work_with_groups_page "Create Group" - allows creating groups of geometrical objects.</li>
-
-<li><b>Conceal child items</b> / <b>Disclose child items</b> - hides / shows child
-sub-objects in the Object Browser, if the selected geometric object has
-child objects. When some child objects are hidden, the name of the
-parent object is hilghlighted with bold font.</li>
-
-<li><b>Show Only Children</b> - erases from the current viewer all objects
-and then displays only the children of the selected object(s).
-</li>
-
-<li><b>Unpublish</b> - unpublishes the selected geometric object from the Object Browser
- and erase it from all viewers. To publish unpublished geometric objects select in the
- context menu of the <b>Geometry</b> root object <b>Publish...</b> item.
- The following dialog box will appear
-
- \image html publish_dlg.png <br>
-
- Switch the checkbox near the appropriate object and
- click <b>Publish</b> or <b>Publish And Close</b> button.
-
- "Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all
- unpublished objects are sorted by name in ascending order. It is possible
- to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
-</li>
-</ul>
-
-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
-- <b>Creation operation</b> 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.
*/
\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 <b>TUI Command:</b> <em>geompy.WhatIs(Shape),</em> where \em Shape is a
shape from which a description is returned.
-See also a \ref tui_whatis_page "TUI example".
-
-\image html measures8.png
+\n <b>Kind of Shape</b> field characterizes the
+whole shape. If there is no additional information about the
+shape, <b>Basic Properties</b> button is disabled, otherwise it
+provides information about center and dimensions of the shape.
-\n <b>Kind of Shape</b> field characterises the
-whole shape. If there is no additional information available for the
-shape, <b>Basic Properties</b> 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 <b>TUI Command:</b> <em>geompy.KindOfShape(Shape),</em> 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
#
# 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.
geompyEnable = False
pass
+##
+# \ingroup simplesketcher
class Sketcher:
__sketch = None
# 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
