add documentation about "Reduce Study" functionality

This commit is contained in:
mpa 2014-06-24 12:36:49 +04:00
parent adfe6b226a
commit ac61a2cdfc
10 changed files with 62 additions and 2 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.2 KiB

View File

@ -175,7 +175,7 @@ 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_menu.png
\image html tree_popup_menu1.png
<ul>
<li>\b Show - allows to show selected object(s) in OCC 3D Viewer;</li>
@ -183,6 +183,7 @@ the selected object.
in OCC 3D Viewer;</li>
<li><b> Rebuild the tree</b> - allows to rebuild the dependency tree
for selected object(s);</li>
<li>\ref reduce_study_page "Reduce study" - allows to reduce study.</li>
</ul>
Some functionalities are available through right-clicking on

View File

@ -0,0 +1,56 @@
/*!
\page reduce_study_page Reduce Study
The user sometimes needs to keep in the study only some objects that
present the final result(s) of the design operations and to delete all
other objects which do not contribute to these results.
The feature is especially useful when the user designs the whole model
through the GUI and wants to generate simplified "clean" Python dump only
at the end of the model construction with no "useless" objects in the
%GEOM module.
User can open dialog box by selecting desirable object(s) in Object
Browser or OCC Viewer and calling "Reduce study" popup item.
\image html reduce_study_dialog.png
<ul>
<li><b> Objects to be kept</b> - objects will be kept in the study after
applying operation of reduce study. The list of objects being selected by
the user are highlighted in bold font.
\n Moreover user can show and hide object(s) in current OCC Viewer using
"eye" icons near each item of tree. It's possible to click on "eye" icon
in the head of tree in order to show/hide all objects.</li>
<li><b> Objects to be removed</b> - objects will be deleted by the
function if it is applied.</li>
<li><b> Intermediate objects</b> - allows to choose future action with
the objects, being in the operations chains to produce final objects:
<ul>
<li>Keep - object(s) will be kept in the study;</li>
<li>Unpublish - object(s) will be automatically unpublished (hidden)
from the study;</li>
<li>Remove - object(s) will be removed from the study. Since using of
this option can lead to the broken Dump Python, the warning message
will be shown to the user.</li>
</ul>
</li>
<li><b> Sub-objects</b> - 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, all folders,
which will become empty after removal of the unused objects from the
study, will be also removed; otherwise, empty folders will be kept.</li>
<li><b> Soft removal</b> - if this option is checked, operation will just
unpublish the redundant objects from the study instead of their hard removal.
\n Soft removal would keep all the data in the study to give the user
chance to rollback this operation using "Publish Objects" dialog box.</li>
</ul>
*/

View File

@ -66,6 +66,7 @@ geometrical object. TUI Command: <em>sg.DisplayOnly(ID)</em></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
in new 2D View Window.</li>
<li>\subpage reduce_study_page "Reduce study" - allows to reduce study.</li>
<li><b>Dump view</b> - exports an object from the viewer in bmp, png,
jpg or jpeg image format.</li>
<li><b>Change background</b> - allows to redefine the background

View File

@ -1630,6 +1630,7 @@ void GeometryGUI::initialize( CAM_Application* app )
mgr->insert( action( GEOMOp::OpShowDependencyTree ), -1, -1 ); // Show dependency tree
mgr->setRule( action( GEOMOp::OpShowDependencyTree ), clientOCCorVTKorOB + " and selcount>0 and ($component={'GEOM'}) and type='Shape'", QtxPopupMgr::VisibleRule );
mgr->insert( separator(), -1, -1 ); // -----------
mgr->insert( action( GEOMOp::OpReduceStudy ), -1, -1 ); // Reduce Study
mgr->setRule( action( GEOMOp::OpReduceStudy ), clientOCCorVTKorOB + " and selcount>0 and ($component={'GEOM'}) and type='Shape'", QtxPopupMgr::VisibleRule );

View File

@ -686,10 +686,11 @@ void GEOMToolsGUI_ReduceStudyDlg::clickOnOk()
//=================================================================================
// function : clickOnHelp()
// purpose : called when Help button was clicked
// purpose : called when Help button was clicked to open a help page
//=================================================================================
void GEOMToolsGUI_ReduceStudyDlg::clickOnHelp()
{
myApp->onHelpContextModule( "GEOM", "reduce_study_page.html" );
}
GEOMToolsGUI_TreeWidgetItem::GEOMToolsGUI_TreeWidgetItem( QTreeWidget* view, const QStringList &strings,