Merge remote branch 'origin/Doc_update_ver741' into V7_5_BR

This commit is contained in:
vsr 2014-11-10 11:25:00 +03:00
commit 017dbada92
14 changed files with 133 additions and 200 deletions

View File

@ -74,6 +74,7 @@ SET(GOOD_TESTS
min_distance.py min_distance.py
normal_face.py normal_face.py
notebook_geom.py notebook_geom.py
polyline.py
point_coordinates.py point_coordinates.py
primitives_ex01.py primitives_ex01.py
primitives_ex02.py primitives_ex02.py

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

@ -36,11 +36,10 @@ and then displays only the children of the selected object(s).
to change the order (ascending / descending) by clicking the corresponding title bar of the objects list. to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
</li> </li>
<li>\ref dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects <li>\ref dependency_tree_page "Show dependency tree" - shows the dependency tree with parents and children of the selected object
in new 2D View Window.</li> in a new 2D View Window.</li>
<li>\ref reduce_study_page "Reduce study" - allows to reduce study <li>\ref reduce_study_page "Reduce study" - allows reducing the study by removing objects from it.</li>
by automatic removing objects according to user's options.</li>
</ul> </ul>
<h2> Folders </h2> <h2> Folders </h2>

View File

@ -10,8 +10,8 @@ Entity - > Primitives - > Cylinder</b>
\n Firstly, you can define a \b Cylinder by the <b>Base Point</b> (the central \n Firstly, you can define a \b Cylinder by the <b>Base Point</b> (the central
point of the cylinder base), the \b Vector (the axis of the cylinder), point of the cylinder base), the \b Vector (the axis of the cylinder),
and its dimensions: the \b Radius and the \b Height. Also, you can optionally specify and its dimensions: the \b Radius and the \b Height. You can optionally specify
the \b Angle in order to create a portion of cylinder. the \b Angle to create a portion of cylinder.
\n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em> \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em>
\n <b>Arguments:</b> Name + 1 vertex + 1 vector + 2 values \n <b>Arguments:</b> Name + 1 vertex + 1 vector + 2 values
@ -26,8 +26,8 @@ the \b Angle in order to create a portion of cylinder.
\n Secondly, you can define a \b Cylinder by the given \b Radius and \n Secondly, you can define a \b Cylinder by the given \b Radius and
\b Height at the origin of coordinate system. The axis of the cylinder \b Height at the origin of coordinate system. The axis of the cylinder
will be collinear to the OZ axis of the coordinate system. will be collinear to the OZ axis of the coordinate system.
Similarly to first constructor, you can optionally specify the \b Angle Similarly to the first constructor, you can optionally specify the \b Angle
in order to create a portion of cylinder. to create a portion of cylinder.
\n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em> \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em>
\n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and

View File

@ -26,11 +26,11 @@ sub-shapes of a given Type and returns a List of IDs of
sub-shapes.</li> sub-shapes.</li>
<li><em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a <li><em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a
shape on sub-shapes of a given type and sorts them taking into account shape on sub-shapes of a given type and sorts them taking into account
their gravity centers, to provide stable order of sub-shapes. their gravity centers, to provide a stable order of sub-shapes.
It returns a list of sub-shapes.</li> It returns a list of sub-shapes.</li>
<li><em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes <li><em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes
a shape on sub-shapes of a given type and sorts them taking into a shape on sub-shapes of a given type and sorts them taking into
account their gravity centers, to provide stable order of sub-shapes. account their gravity centers, to provide a stable order of sub-shapes.
It returns a List of IDs of sub-shapes.</li> It returns a List of IDs of sub-shapes.</li>
<li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain <li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
a compound of sub-shapes of the Shape, selected by they indices in a a compound of sub-shapes of the Shape, selected by they indices in a

View File

@ -9,93 +9,68 @@ To create a <b>2D Polyline</b> select in the main menu <b>New Entity -> Basic -
\image html polyline_dlg.png \image html polyline_dlg.png
A polyline represents a section or a set of sections. Each section is constructed from a sequence of 2D points A polyline represents a section or a set of sections. Each section is constructed from a sequence of 2D points
connected either by linear setgments or an interpolation curve. Every section has its own attributes: connected by either linear segments or an interpolation curve. Every section has its own attributes:
- \b Name, - \b Name,
- \b Type (Polyline or Spline), - \b Type (Polyline or Spline),
- \b Closed flag. - \b Closed flag.
A Polyline created represents a shape that lies on the XOY plane. It can have the following types: A created Polyline represents a shape that lies on the XOY plane. Its type can be one of the following:
- \b Vertex for a single section with only 1 point. - \b Vertex for a single section with only 1 point.
- \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline. - \b Wire for a single section with 2 or more points. A Wire can have multiple edges for more then 2 points if the section type is Polyline. A single edge in the resulting wire is obtained for a Spline or Polyline with 2 points.
A single edge in the result wire is obtained for a Spline or Polyline with 2 points.
- \b Compound of Wires and/or Vertices if there are several sections. - \b Compound of Wires and/or Vertices if there are several sections.
For the moment only one reference coordinate system for polyline creation is supported. The XOY plane of the <b>Global coordinate system</b> For the moment only one reference coordinate system for polyline creation is supported, which is the XOY plane of the <b>Global coordinate system</b>.
is suggested. Implementation of another reference coordinate system is a subject of further development of this functionality. \b Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects.
Restore button orientates the viewer correspondingly to the chosen working plane and fits the scene to show all objects.
For the moment this button works with only one plane. For the moment this button works with only one plane.
It is possible to import a shape in this dialog using <b>Import polyline</b> selection button. To do it an imported object should satisfy conditions It is possible to import a shape in this dialog using <b>Import polyline</b> selection button. An imported object should meet the conditions for polyline shapes mentioned above. If a valid shape is selected, when the dialog is opened, it is initialized by this shape.
for polyline shapes mentioned above. If a valid shape is selected, when dialog is opened, it is initialized by this shape. Though the shape can be on any plane, the imported polyline will be defined on XOY plane only due to the limitation.
Though the shape can be on any plane, an imported polyline will be defined on XOY plane only due to the limitation.
The group \b Sections in this dialog represents the Polyline construction framework. Its toolbar has the following operations: The group \b Sections in this dialog represents the Polyline construction framework.
- \b Undo
- \b Redo
- <b>Insert new section</b>
- <b>Addition mode</b>
- <b>Modification mode</b> - not implemented
- <b>Detection mode</b> - not implemented
- \b Remove
- <b>Join selected sections</b>
<b>Undo/Redo</b> buttons allows to undo/redo changes of the polyline. The buttons <b>Undo</b> and <b>Redo</b> allow to undo or redo the changes of the polyline.
<b>Insert new section</b> button opens a dialog that allows to add a new section: <b>Insert new section</b> button opens the corresponding dialog:
\image html polyline_dlg_add_section.png \image html polyline_dlg_add_section.png
In this dialog it is possible to choose: In this dialog it is possible to choose:
- \b Name of section - \b Name of section;
- \b Type of section - \b Type of section;
- \b Closed flag - Set \b Closed flag.
To create a new section \b Add button should be clicked. \b Cancel button is used to cancel this operation. To create a new section, click \b Add button. \b Cancel button is used to cancel this operation.
After clicking \b Add button a new section is appeared on the list. Its name supplemented by its type and closedness After clicking \b Add button a new section appears in the list. Its name is generated automatically depending on its type, closed or opened state and the number of points (equal to 0 after creation).
information (see icon) and the number of points (equal to 0 after creation).
To modify section parameters it is possible to double-click on a section in the list. In this case the following dialog appears: To modify section parameters, double-click on a section in the list. In this case the following dialog appears:
\image html polyline_dlg_edit_section.png \image html polyline_dlg_edit_section.png
To apply modifications the button \b Ok should be clicked. To apply the modifications, click \b Ok button.
<b>Addition mode</b> allows to add points to a section. It is necessary to select a particular section in a list of sections <b>Addition mode</b> allows adding points to a section. Select a particular section in the list of sections
and make some mouse clicks in the viewer. A section preview is recomputed after each click. and left-click in the viewer to add new nodes to the section. A section preview is recomputed after each click.
<b>Modification mode</b> and <b>Detection mode</b> are not implemented for the moment. <b>Modification mode</b> and <b>Detection mode</b> are not implemented for the moment.
\b Remove button allows to remove a section. It is available if all modes are deactivated and one section is selected. \b Remove button allows removing a section. It is available if all modes are deactivated and one section is selected.
<b>Join selected sections</b> button is available in modification mode if two or more sections are selected. It is used to <b>Join selected sections</b> button is available in modification mode if two or more sections are selected. It is used to
merge several sections into the first one from selection list. Joined section has parameters of the first selected one. Points of merge several sections into the first one from the selection list. The points of the merged sections are appended at the end of the list of points of the first section.
the other sections are appended at the end of the list of the first section points.
Some actions are available via popup menu by right mouse button click. Some actions are available via the context menu activated by right mouse button click.
- <b>Join all sections</b> - joins all defined sections into the first one.
- \b Join - joins two or more selected sections.
- <b>Clear all</b> - removes all selected sections.
- <b>Set closed</b> - sets \b Closed flag for all selected section.
- <b>Set open</b> - unset \b Closed flag for all selected sections.
- <b>Set polyline</b> - sets the type of all selected sections to Polyline.
- <b>Set spline</b> - set the type of all selected sections to Spline.
If all modes are deactivated: Different actions are available depending on the mode and selection.
- <b>Join all sections</b> - join all defined sections into the first one.
- \b Join - join sections. Available if two or more sections are selected.
In <b>Addition mode</b>:
- <b>Join all sections</b> - join all defined sections into the first one.
In <b>Modification mode</b>:
- <b>Join all sections</b> - join all defined sections into the first one.
- \b Join - join sections. Available if two or more sections are selected.
- <b>Clear all</b> - remove all sections. Available if at least one section is selected.
- <b>Set closed</b> - set all selected section's Closed flag. Available if at least one section is selected.
- <b>Set open</b> - reset all selected section's Closed flag. Available if at least one section is selected.
- <b>Set polyline</b> - set all selected section's type to Polyline. Available if at least one section is selected.
- <b>Set spline</b> - set all selected section's type to Spline. Available if at least one section is selected.
In <b>Detection mode</b>:
- <b>Join all sections</b> - join all defined sections into the first one.
- \b Join - join sections. Available if two or more sections are selected.
<h2>TUI Commands</h2> <h2>TUI Commands</h2>
To create the 2D polyline in TUI Polyline2D interface is used. To create the 2D polyline in TUI Polyline2D interface is used.
<em>pl = geompy.Polyline2D()</em> - returns an instance of Polyline2D interface <i>pl</i>. <em>pl = geompy.Polyline2D()</em> - returns an instance of Polyline2D interface <i>pl</i>.
@ -103,5 +78,5 @@ To create the 2D polyline in TUI Polyline2D interface is used.
See the \ref gsketcher.Polyline2D "Polyline2D" interface documentation for more information. See the \ref gsketcher.Polyline2D "Polyline2D" interface documentation for more information.
Our <b>TUI Scripts</b> provide you with useful examples of the use of Our <b>TUI Scripts</b> provide you with useful examples of the use of
\ref tui_polyline_page "2D Polyline". \ref tui_creation_polyline "2D Polyline".
*/ */

View File

@ -14,11 +14,11 @@ In this dialog you can specify the following parameters:
- <b>Max BSpline surface degree</b> of the resulting BSpline surface; - <b>Max BSpline surface degree</b> of the resulting BSpline surface;
- <b>3D tolerance of initial approximation</b> - <b>3D tolerance of initial approximation</b>
\note <b>3D tolerance of initial approximation</b> represents a tolerance of \note <b>3D tolerance of the initial approximation</b> represents the tolerance of
initial plate surface approximation. If this parameter is equal to 0 (default), 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>, 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 where <em>error</em> is the 3D tolerance of the surface representing the maximal
distance between computed plate surface and given points. distance between the computed plate surface and given points.
<b>Advanced options:</b> \ref preview_anchor "Preview" <b>Advanced options:</b> \ref preview_anchor "Preview"
@ -28,7 +28,7 @@ Press "Apply" or "Apply & Close" button to get the resulting <em>GEOM_Object(Sur
- \em thelPoints is a list of points or compounds of points; - \em thelPoints is a list of points or compounds of points;
- \em theNbMax maximum number of Bezier pieces in the resulting surface; - \em theNbMax maximum number of Bezier pieces in the resulting surface;
- \em theDegMax maximum degree; - \em theDegMax maximum degree;
- \em theDMax specifies 3D tolerance of initial approximation - \em theDMax specifies 3D tolerance of the initial approximation.
Example: Example:

View File

@ -13,23 +13,20 @@
\anchor dependency_tree_general_description_anchor <h2>General description</h2> \anchor dependency_tree_general_description_anchor <h2>General description</h2>
In order to better understand the relations between the %GEOM You can display the ascendants and descendants of object(s) in a tree structure to better understand the relations between the %GEOM
objects in a study the user has a possibility to display the objects in a study .
ascendants and descendant of the object(s) in a family tree.
User can build the dependency tree by selecting desirable object To build the dependency tree, select the necessary object or objects (multiple
in Object Browser or OCC Viewer and calling "Show dependency tree" selection is supported) in the Object Browser or OCC Viewer and call "Show dependency tree" context menu item.
popup item. It will open a new or clear the existing "Dependency
Tree" view window (only one view is supported) and display a
dependency tree for the selected object or objects (multiple
selection is supported). Also user can rebuild the tree if to select
some object(s) right in the "Dependency Tree" view and call
"Rebuild the tree" popup menu item.
\image html tree_example.png \image html tree_example.png
User can change all necessary parameters of Dependency Tree Viewer
in \ref pref_dependency_tree "Preferences". "Dependency Tree" view window will display the dependency tree for the selected object.
It is also possible to select an object(s) directly in the "Dependency Tree" view and to rebuild the tree by selecting
"Rebuild the tree" context menu item.
All necessary parameters of Dependency Tree Viewer can be edited in the \ref pref_dependency_tree "Preferences".
<hr> <hr>
\anchor dependency_tree_nodes_anchor <h2>Nodes</h2> \anchor dependency_tree_nodes_anchor <h2>Nodes</h2>
@ -37,62 +34,48 @@ in \ref pref_dependency_tree "Preferences".
Tree nodes in the Dependency Viewer are named according to the study Tree nodes in the Dependency Viewer are named according to the study
names of the corresponding objects. names of the corresponding objects.
Non-published objects are shown in the tree as "unpublished" and All nodes have fixed size, so long names are cut; the full object name can be seen in the tooltip
colored in special color. when the cursor is hovered over the node.
All nodes have the fixed size, so the long names are cut and shown
with ellipsis; full name of the object can be seen in the tooltip
if to keep the cursor over the node.
"Dependency Tree" view supports the following states of nodes: "Dependency Tree" view supports the following states of nodes:
<ul><li><b>Main node</b> - node of main object(s), which were selected in Object <ul><li><b>Main node</b> - corresponds to the main object(s) selected in Object
Browser, OCC Viewer or Dependency Tree Viewer in order to build the Browser, OCC Viewer or Dependency Tree Viewer;</li></ul>
dependency tree;</li></ul>
\image html tree_main_node.png \image html tree_main_node.png
<ul><li><b>Default node</b> - node of published in study object, which participate in building of <ul><li><b>Default node</b> - ascendant or descendant node of the dependency tree corresponding to an object published in the study;</li></ul>
dependency tree as ascendant or descendant;</li></ul>
\image html tree_default_node.png \image html tree_default_node.png
<ul><li><b>Unpublished node</b> - the same as "Default node", but <ul><li><b>Unpublished node</b> - corresponds to an object that was not published in the study;</li></ul>
corresponding object was not published in study;</li></ul>
\image html tree_unpublished_node.png \image html tree_unpublished_node.png
<ul><li><b>Highlighted node</b> - the state of node when mouse <ul><li><b>Highlighted node</b> - the state of a node when the mouse cursor is hovered over it;</li></ul>
cursor is over it;</li></ul>
\image html tree_highlighted_node.png \image html tree_highlighted_node.png
<ul><li><b>Selected node</b> - the state of node when user <ul><li><b>Selected node</b> - the state of node when the user clicks the left mouse button it.</li></ul>
clicks the left mouse button on node.</li></ul>
\image html tree_selected_node.png \image html tree_selected_node.png
<hr> <hr>
\anchor dependency_tree_links_anchor <h2>Links</h2> \anchor dependency_tree_links_anchor <h2>Links</h2>
Dependency Tree Viewer shows oriented links between nodes to Dependency Tree Viewer shows oriented links between nodes to
represent dependency direction. Viewer supports the following states represent the dependency direction. The viewer supports the following states of links:
of links:
<ul><li><b>Unidirectional link</b> - shows that A object depends on <ul><li><b>Unidirectional link</b> - shows that object B depends on object A;</li></ul>
B object;</li></ul>
\image html tree_unidir_link.png \image html tree_unidir_link.png
<ul><li><b>Bidirectional link</b> - shows that A object depends on <ul><li><b>Bidirectional link</b> - shows that object B depends on
B object and, at the same time, B object depends on object A and, at the same time, object A depends on object B;</li></ul>
A object;</li></ul>
\image html tree_bidir_link.png \image html tree_bidir_link.png
<ul><li><b>Self-dependency link</b> - shows that object depends on <ul><li><b>Self-dependency link</b> - shows that an object depends on itself;</li></ul>
itself;</li></ul>
\image html tree_selfdep_link.png \image html tree_selfdep_link.png
<ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of <ul><li><b>Cyclic dependency links</b> - shows cyclic dependency of some nodes.</li></ul>
some nodes.</li></ul>
\image html tree_cycldep_link.png \image html tree_cycldep_link.png
<hr> <hr>
\anchor dependency_tree_operations_anchor <h2>Operations</h2> \anchor dependency_tree_operations_anchor <h2>Viewer Operations</h2>
The dependency tree of a chosen %GEOM object is displayed in The dependency tree of a chosen %GEOM object is displayed in
the dedicated 2D view window. the dedicated 2D view window.
@ -105,8 +88,7 @@ mouse button.
\image tree_tool_bar \image tree_tool_bar
<b>Dump View</b> - exports an object from the viewer in bmp, png or <b>Dump View</b> - exports the current scene in bmp, png or jpeg image format.
jpeg image format.
\image html tree_view_dump.png \image html tree_view_dump.png
<b>Fit all</b> - scales the presentation so that it could fit within <b>Fit all</b> - scales the presentation so that it could fit within
@ -140,38 +122,32 @@ levels to be shown in the dependency tree.
<ul> <ul>
<li>Level 1 corresponds to the parents and children of the selected <li>Level 1 corresponds to the parents and children of the selected
object(s);</li> object(s);</li>
<li>Level 2 is Level 1 plus the grand-parents and grand-children <li>Level 2 adds the grand-parents and grand-children
of the selected object(s);</li> of the selected object(s);</li>
<li>etc...</li> <li>etc...</li>
</ul> </ul>
<b>Display ascendants</b> - allows user to control the displaying <b>Display ascendants</b> - allows showing/hiding the ascendants.
of ascendants.
\image html tree_disp_ascendants.png \image html tree_disp_ascendants.png
<b>Display descendants</b> - allows user to control the displaying <b>Display descendants</b> - allows showing/hiding the descendants.
of descendants.
\image html tree_disp_descendants.png \image html tree_disp_descendants.png
<b>Move nodes</b> - enables/disables of moving the nodes. <b>Move nodes</b> -if checked, it is possible to move nodes in the viewer.
\image html tree_move_nodes.png \image html tree_move_nodes.png
<b>Update</b> - allows user to update a dependency tree model and the view. <b>Update</b> - updates the dependency tree view, reflecting changes introduced in the hierarchy.
\image html tree_button_update.png \image html tree_button_update.png
<hr> <hr>
\anchor dependency_tree_navigation_anchor <h2>Navigation</h2> \anchor dependency_tree_navigation_anchor <h2>Selection and Shortcuts</h2>
Dependency Tree 2D Viewer supports the following navigation mode:
<ul> <ul>
<li>rectangle selection in this mode is performed by the left mouse <li>It is possible to select multiple nodes in the view by rectangle selection or by clicking nodes when \b Shift button
button</li>;
<li>multiple selection is available when \b Shift button
is pressed.</li> is pressed.</li>
</ul> </ul>
Also, holding \b Ctrl key with pressed mouse buttons performs Holding \b Ctrl key with pressed mouse buttons performs
the following view transformations: the following view transformations:
<ul> <ul>
<li>Ctrl + left mouse button - zooming;</li> <li>Ctrl + left mouse button - zooming;</li>
@ -179,33 +155,23 @@ the following view transformations:
</ul> </ul>
<hr> <hr>
\anchor dependency_tree_popup_menu_anchor <h2>Popup Menu</h2> \anchor dependency_tree_popup_menu_anchor <h2>Context Menu</h2>
After the object has appeared in the Dependency Tree 2D Viewer, The following operations are available from the context menu of the selected object.
user can select it with left mouse click to change its presentation
parameters and get access to other useful options by right-clicking on
the selected object.
\image html tree_popup_menu1.png \image html tree_popup_menu1.png
<ul> <ul>
<li>\b Show - allows to show selected object(s) in OCC 3D Viewer;</li> <li>\b Show - shows the selected object(s) in OCC 3D Viewer;</li>
<li><b> Show Only</b> - allows to show only selected object(s) <li><b> Show Only</b> - shows only the selected object(s) in OCC 3D Viewer;</li>
in OCC 3D Viewer;</li> <li><b> Rebuild the tree</b> - rebuilds the dependency tree
<li><b> Rebuild the tree</b> - allows to rebuild the dependency tree
for selected object(s);</li> for selected object(s);</li>
<li>\ref reduce_study_page "Reduce study" - allows to reduce study.</li> <li>\ref reduce_study_page "Reduce study" - allows reducing the study.</li>
</ul>
Some functionalities are available through right-clicking on
the viewer background:
\image html tree_popup_menu2.png \image html tree_popup_menu2.png
Dependency Tree 2D Viewer background can be customized using the <li>It is also possible to customize the background of Dependency Tree 2D Viewer using the
"Change background" popup menu command that opens standard corresponding context menu command.</li>
"Select Color" dialog box: </ul>
\image html selectcolor.png
*/ */

View File

@ -4,10 +4,9 @@
\anchor pref_settings <h2>Settings</h2> \anchor pref_settings <h2>Settings</h2>
In the \b Geometry module you can set preferences for visualisation of In the \b Geometry module you can set preferences for visualization of
geometrical figures, which can be used in later sessions with this module. geometrical figures, which can be used in later sessions with this module.
There is also a special group of preferences controlling input
precision for floating-point data.
\image html pref15.png \image html pref15.png
@ -67,7 +66,7 @@ of values set in spin boxes.</li>
</ul> </ul>
<ul> <ul>
<li><b>Dimensions (Measurements)</b></li> <li><b>Dimensions (Measurements)</b> - a group of preferences controlling the presentation of dimensions.</li>
<ul> <ul>
<li><b>Color</b> - allows to define color for persistent dimension presentations.</li> <li><b>Color</b> - allows to define color for persistent dimension presentations.</li>
<li><b>Line width</b> - allows to define pixel width of dimension lines.</li> <li><b>Line width</b> - allows to define pixel width of dimension lines.</li>
@ -91,7 +90,8 @@ By default <b>Along U</b> and <b>Along V</b> are null and isolines are not drawn
</ul> </ul>
<ul> <ul>
<li><b>Input fields precision</b></li> <li><b>Input fields precision</b> - a group of preferences controlling input
precision for floating-point data.</li>
<ul> <ul>
<li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li> <li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
<li><b>Angular precision</b> - allows to adjust input precision of angles.</li> <li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
@ -147,32 +147,29 @@ system immediately after the module activation.</li>
\anchor pref_dependency_tree <h2>Dependency Tree</h2> \anchor pref_dependency_tree <h2>Dependency Tree</h2>
Also user can set preferences for visualisation of <b>Dependency Tree</b> in 2D Viewer. This tab groups preferences for visualization of <b>Dependency Tree</b> in the 2D Viewer.
\image html pref_dep_tree.png \image html pref_dep_tree.png
<ul> <ul>
<li><b>General</b></li> <li><b>General</b></li>
<ul> <ul>
<li><b>Hierarchy type</b> - allows to choose default displaying mode of dependency tree.</li> <li><b>Hierarchy type</b> - allows to choose the default display mode of the dependency tree.</li>
<li><b>Possibility to move nodes</b> - enable/disable the possibility of moving nodes by default.</li> <li><b>Possibility to move nodes</b> - enables/disables the possibility of moving nodes by default.</li>
</ul> </ul>
</ul> </ul>
<ul> <ul>
<li><b>Color</b></li> <li><b>Color</b></li>
<ul> <ul>
<li><b>Background color</b> - allows to select default background color.</li> <li><b>Background color</b> - allows to select the default background color.</li>
<li><b>Default node color</b> - allows to select default node color.</li> <li><b>Default node color</b> - allows to select the default node color.</li>
<li><b>Main node color</b> - allows to select default main node color.</li> <li><b>Main node color</b> - allows to select the default main node color.</li>
<li><b>Unpublished node color</b> - allows to select default node color <li><b>Unpublished node color</b> - allows to select the default node color for unpublished objects.</li>
for unpublished objects.</li> <li><b>Selected node color</b> - allows to select the default selected node color.</li>
<li><b>Selected node color</b> - allows to select default selected node color.</li> <li><b>Default arrow color</b> - allows to select the default arrow color.</li>
<li><b>Default arrow color</b> - allows to select default arrow color.</li> <li><b>Highlighted arrow color</b> - allows to select the default highlighted arrow color.</li>
<li><b>Highlighted arrow color</b> - allows to select default highlighted <li><b>Selected arrow color</b> - allows to select the default selected arrow color.</li>
arrow color.</li>
<li><b>Selected arrow color</b> - allows to select default selected
arrow color.</li>
</ul> </ul>
</ul> </ul>

View File

@ -31,6 +31,7 @@ provided by Geometry module.
<li>\ref tui_working_with_groups_page</li> <li>\ref tui_working_with_groups_page</li>
<li>\ref tui_building_by_blocks_page</li> <li>\ref tui_building_by_blocks_page</li>
<li>\ref tui_sketcher_page</li> <li>\ref tui_sketcher_page</li>
<li>\ref tui_3dsketcher_page</li>
<li>\ref tui_advanced_geom_objs_page</li> <li>\ref tui_advanced_geom_objs_page</li>
</ul> </ul>
<li>\subpage tui_viewing_geom_objs_page</li> <li>\subpage tui_viewing_geom_objs_page</li>

View File

@ -2,55 +2,52 @@
\page reduce_study_page Reduce Study \page reduce_study_page Reduce Study
The user sometimes needs to keep in the study only some objects that It can be sometimes necessary to keep in the study only the objects that
present the final result(s) of the design operations and to delete all present the final result(s) of the design operations and to delete all
other objects which do not contribute to these results. other objects, which do not contribute to these results.
The feature is especially useful when the user designs the whole model This is especially useful when the model is designed using the GUI
through the GUI and wants to generate simplified "clean" Python dump only and it is necessary to generate a simplified "clean" Python dump without "useless" objects
at the end of the model construction with no "useless" objects in the at the end of the model construction.
%GEOM module.
User can open dialog box by selecting desirable object(s) in Object This feature can be activated by selecting the desirable object(s) in Object
Browser or OCC Viewer and calling "Reduce study" popup item. Browser or OCC Viewer and calling "Reduce study" context item.
\image html reduce_study_dialog.png \image html reduce_study_dialog.png
<ul> <ul>
<li><b> Objects to be kept</b> - objects that will be kept in the study after <li><b> Objects to be kept</b> - objects that will be kept in the study after
applying operation of reduce study. The list of objects being selected by applying reduce study operation. The objects selected by
the user are highlighted in bold font.</li> the user are highlighted in bold font.</li>
<li><b> Objects to be removed</b> - objects that will be deleted.</li> <li><b> Objects to be removed</b> - objects that will be deleted.</li>
\note Mentioned views provide possibility to show/hide object(s) in \note It is possible to show/hide object(s) in the
current Viewer using "eye" icon near each item of tree. Also user can current Viewer using "eye" icon next to each tree item.
show/hide ALL objects in tree by clicking "eye" icon in the head of tree view. ALL objects in the tree can be shown/hidden by clicking the "eye" icon in the head of the tree view.
<li><b> Intermediate objects</b> group box allows choosing what should be done with the objects that are used to produce the selected object(s):
<li><b> Sub-objects</b> group box allows choosing the same operations for
sub-objects of the selected object(s).</li>
<li><b> Intermediate objects</b> group box allows to choose an action
that will be performed with the objects that took part in the operations
chain to produce the selected object(s):
<ul> <ul>
<li>Keep - object(s) will be kept in the study;</li> <li>Keep - object(s) will be kept in the study;</li>
<li>Unpublish - object(s) will be unpublished (hidden) from the study;</li> <li>Unpublish - object(s) will be unpublished (hidden) from the study;</li>
<li>Remove - object(s) will be removed from the study. \note Since use of <li>Remove - object(s) will be removed from the study. \note Since use of
this option can lead to the broken Dump Python script, the warning message this option can cause a broken Dump Python script, the warning message
will be shown at the operation commiting to confirm/reject removing is shown confirm/reject removing intermediate objects.</li>
intermediate objects.</li>
</ul> </ul>
</li> </li>
<li><b> Sub-objects</b> group box allows to choose the same operations for
sub-objects of selected item(s): keep, unpublish or remove.</li>
<li><b> Remove empty folders</b> - if this option is checked, then all folders, <li><b> Remove empty folders</b> - if this option is checked, all folders,
which will become empty after removing unused objects from the study, which will become empty after removing unused objects from the study,
will be also removed; otherwise, empty folders will be kept.</li> will be also removed; otherwise, empty folders will be kept.</li>
<li><b> Soft removal</b> - if this option is checked, operation will just <li><b> Soft removal</b> - if this option is checked, the operation will
unpublish the redundant objects from the study instead of their hard delete. unpublish the redundant objects from the study instead of deleting them.
\n Soft removal would keep all the data in the study to give the user a \n So, soft removal keeps all data in the study to give the user a
chance to revert this operation using \ref publish_hidden_objects chance to revert this operation using \ref publish_hidden_objects
"Publish Objects" dialog box.</li> "Publish Objects" dialog box.</li>

View File

@ -38,4 +38,8 @@
<br><h2>Creation of a Local Coordinate System</h2> <br><h2>Creation of a Local Coordinate System</h2>
\tui_script{basic_geom_objs_ex09.py} \tui_script{basic_geom_objs_ex09.py}
\anchor tui_creation_polyline
<br><h2>Creation of 2D Polyline</h2>
\tui_script{polyline.py}
*/ */

View File

@ -1,6 +0,0 @@
/*!
\page tui_polyline_page 2D Polyline
\tui_script{polyline.py}
*/

View File

@ -64,10 +64,9 @@ geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></li>
<li><b>Show all dimensions</b> - shows all of the persistent dimensions created for the selected geometrical object.</li> <li><b>Show all dimensions</b> - shows all of the persistent dimensions created for the selected geometrical object.</li>
<li><b>Hide all dimensions</b> - hides all of the persistent dimensions created for the selected geometrical object.</li> <li><b>Hide all dimensions</b> - hides all of the persistent dimensions created for the selected geometrical object.</li>
<li>\subpage dependency_tree_page "Show dependency tree" - shows dependency tree of selected objects <li>\subpage dependency_tree_page "Show dependency tree" - shows the dependency tree with parents and children of the selected object
in new 2D View Window.</li> in a new 2D View Window.</li>
<li>\subpage reduce_study_page "Reduce study" - allows to reduce study <li>\subpage reduce_study_page "Reduce study" - allows reducing the study by removing objects from it.</li>
by automatic removing objects according to user's options.</li>
<li><b>Dump view</b> - exports an object from the viewer in bmp, png, <li><b>Dump view</b> - exports an object from the viewer in bmp, png,
jpg or jpeg image format.</li> jpg or jpeg image format.</li>
<li><b>Change background</b> - allows to redefine the background <li><b>Change background</b> - allows to redefine the background