1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // GEOM GEOMGUI : GUI for Geometry component
24 // File : GEOMBase_Helper.cxx
25 // Author : Sergey ANIKIN, Open CASCADE S.A.S. (sergey.anikin@opencascade.com)
27 #include "GEOMBase_Helper.h"
29 #include "GEOM_Operation.h"
31 #include <GeometryGUI.h>
33 #include <SUIT_Desktop.h>
34 #include <SUIT_Session.h>
35 #include <SUIT_ViewManager.h>
36 #include <SUIT_ViewWindow.h>
37 #include <SUIT_ViewModel.h>
38 #include <SUIT_MessageBox.h>
39 #include <SUIT_OverrideCursor.h>
40 #include <SUIT_ResourceMgr.h>
42 #include <SalomeApp_Module.h>
43 #include <SalomeApp_Application.h>
44 #include <SalomeApp_Study.h>
45 #include <LightApp_SelectionMgr.h>
46 #include <LightApp_DataOwner.h>
47 #include <SalomeApp_Tools.h>
48 #include <SALOME_ListIteratorOfListIO.hxx>
50 #include <SALOME_Prs.h>
52 #include <OCCViewer_ViewModel.h>
53 #include <SVTK_ViewModel.h>
55 #include <TColStd_MapOfInteger.hxx>
56 #include <TCollection_AsciiString.hxx>
57 #include <TColStd_IndexedMapOfInteger.hxx>
59 //To disable automatic genericobj management, the following line should be commented.
60 //Otherwise, it should be uncommented. Refer to KERNEL_SRC/src/SALOMEDSImpl/SALOMEDSImpl_AttributeIOR.cxx
61 #define WITHGENERICOBJ
63 //================================================================
64 // Function : getActiveView
65 // Purpose : Get active view window, returns 0 if no open study frame
66 //================================================================
67 SUIT_ViewWindow* GEOMBase_Helper::getActiveView()
69 SUIT_Study* activeStudy = SUIT_Session::session()->activeApplication()->activeStudy();
71 return SUIT_Session::session()->activeApplication()->desktop()->activeWindow();
77 //================================================================
78 // Function : getGeomEngine
79 // Purpose : Static method
80 //================================================================
81 GEOM::GEOM_Gen_ptr GEOMBase_Helper::getGeomEngine()
83 return GeometryGUI::GetGeomGen();
86 //================================================================
87 // Function : GEOMBase_Helper
89 //================================================================
90 GEOMBase_Helper::GEOMBase_Helper( SUIT_Desktop* desktop )
91 : myDesktop( desktop ), myViewWindow( 0 ), myDisplayer( 0 ), myCommand( 0 ), isPreview( false ),
92 myIsApplyAndClose( false ), myIsOptimizedBrowsing( false ), myIsWaitCursorEnabled( true ),
93 myIsDisableBrowsing(false), myIsDisplayResult(true)
97 //================================================================
98 // Function : ~GEOMBase_Helper
100 //================================================================
101 GEOMBase_Helper::~GEOMBase_Helper()
103 //rnv: Fix for the "IPAL21922 : WinTC5.1.4: incorrect quit salome"
104 if ( !SUIT_Session::session()->activeApplication() || !SUIT_Session::session()->activeApplication()->desktop() )
107 if ( myPreview.size() )
111 SalomeApp_Application* app = (SalomeApp_Application*)(SUIT_Session::session()->activeApplication());
113 GeometryGUI* aGeomGUI = dynamic_cast<GeometryGUI*>( app->module( "Geometry" ) );
115 globalSelection(aGeomGUI->getLocalSelectionMode() , true );
120 if ( !CORBA::is_nil( myOperation ) )
121 myOperation->UnRegister();
124 //================================================================
125 // Function : display
127 //================================================================
128 void GEOMBase_Helper::display( const ObjectList& objList, const bool updateView )
130 ObjectList::const_iterator it;
131 for ( it = objList.begin(); it != objList.end(); it++ ) {
132 display( *it, false );
134 if ( !objList.empty() && updateView )
135 getDisplayer()->UpdateViewer();
138 //================================================================
139 // Function : display
140 // Purpose : Display object.
141 // Important : Object must be already in study
142 //================================================================
143 void GEOMBase_Helper::display( GEOM::GEOM_Object_ptr object, const bool updateView )
145 // Unset color of shape ( this color may be set during preview displaying )
146 // Default color will be used
147 // getDisplayer()->UnsetColor();
148 getDisplayer()->UnsetWidth();
150 MESSAGE("GEOMBase_Helper::display myTexture = "<<getDisplayer()->GetTexture())
152 // Enable activisation of selection
153 getDisplayer()->SetToActivate( true );
156 getDisplayer()->Display( object, updateView );
159 //================================================================
162 //================================================================
163 void GEOMBase_Helper::erase( const ObjectList& objList, const bool updateView )
165 ObjectList::const_iterator it = objList.begin();
166 for ( ; it != objList.end(); it++ ) {
169 if ( !objList.empty() && updateView )
170 getDisplayer()->UpdateViewer();
173 //================================================================
176 //================================================================
177 void GEOMBase_Helper::erase( GEOM::GEOM_Object_ptr object, const bool updateView )
179 if ( !object->_is_nil() ) {
180 QString entry = getEntry( object );
181 getDisplayer()->Erase( new SALOME_InteractiveObject(
182 entry.toLatin1().constData(),
183 "GEOM", strdup( GEOMBase::GetName( object ).toLatin1().constData() ) ), true, updateView );
187 //================================================================
188 // Function : redisplay
190 //================================================================
191 void GEOMBase_Helper::redisplay( const ObjectList& objList,
192 const bool withChildren,
193 const bool updateView )
195 ObjectList::const_iterator it = objList.begin();
196 for ( ; it != objList.end(); it++ ) {
197 redisplay( *it, withChildren, false );
199 if ( !objList.empty() && updateView )
200 getDisplayer()->UpdateViewer();
203 //================================================================
204 // Function : redisplay
206 //================================================================
207 void GEOMBase_Helper::redisplay( GEOM::GEOM_Object_ptr object,
208 const bool withChildren,
209 const bool updateView )
211 if ( !object->_is_nil() ) {
212 // Unset color of shape ( this color may be set during preview displaying )
213 // Default color will be used
214 getDisplayer()->UnsetColor();
215 getDisplayer()->UnsetWidth();
217 // Enable activisation of selection
218 getDisplayer()->SetToActivate( true );
220 QString entry = getEntry( object );
221 getDisplayer()->Redisplay(new SALOME_InteractiveObject
222 (entry.toLatin1().constData(), "GEOM", strdup(GEOMBase::GetName(object).toLatin1().constData())), false);
225 if ( withChildren ) {
226 SalomeApp_Study* aDoc = getStudy();
227 if ( aDoc && aDoc->studyDS() ) {
228 _PTR(Study) aStudy = aDoc->studyDS();
229 CORBA::String_var objStr = SalomeApp_Application::orb()->object_to_string(object);
230 _PTR(SObject) aSObj (aStudy->FindObjectIOR(std::string(objStr.in())));
232 _PTR(ChildIterator) anIt ( aStudy->NewChildIterator( aSObj ) );
233 for ( anIt->InitEx( true ); anIt->More(); anIt->Next() ) {
234 GEOM::GEOM_Object_var aChild = GEOM::GEOM_Object::_narrow
235 (GeometryGUI::ClientSObjectToObject(anIt->Value()));
236 if ( !CORBA::is_nil( aChild ) ) {
237 if ( !aChild->_is_nil() ) {
238 QString entry = getEntry( aChild );
239 getDisplayer()->Redisplay( new SALOME_InteractiveObject(
240 entry.toLatin1().constData(), "GEOM", strdup( GEOMBase::GetName( aChild ).toLatin1().constData() ) ), false );
249 getDisplayer()->UpdateViewer();
252 //================================================================
253 // Function : displayPreview
254 // Purpose : Method for displaying preview based on execute() results
255 //================================================================
256 void GEOMBase_Helper::displayPreview( const bool display,
259 const bool toRemoveFromEngine,
260 const double lineWidth,
261 const int displayMode,
265 erasePreview( update );
271 if ( !isValid( msg ) )
273 erasePreview( update );
278 erasePreview( false );
281 SUIT_OverrideCursor wc;
284 if ( !isWaitCursorEnabled() )
287 if ( !execute( objects ) || !getOperation()->IsDone() ) {
291 for ( ObjectList::iterator it = objects.begin(); it != objects.end(); ++it )
293 GEOM::GEOM_Object_var obj=*it;
294 displayPreview( obj, true, activate, false, lineWidth, displayMode, color );
295 if ( toRemoveFromEngine )
300 catch( const SALOME::SALOME_Exception& e ) {
301 SalomeApp_Tools::QtCatchCorbaException( e );
310 //================================================================
311 // Function : displayPreview
312 // Purpose : Method for displaying preview of resulting shape
313 //================================================================
314 void GEOMBase_Helper::displayPreview( GEOM::GEOM_Object_ptr object,
318 const double lineWidth,
319 const int displayMode,
322 SUIT_ResourceMgr* resMgr = SUIT_Session::session()->resourceMgr();
324 // Set color for preview shape
325 getDisplayer()->SetColor( color == -1 ? Quantity_NOC_VIOLET : color );
327 // set width of displayed shape
328 getDisplayer()->SetWidth( lineWidth == -1 ? resMgr->integerValue("Geometry", "preview_edge_width", -1) : lineWidth );
330 // set display mode of displayed shape
331 int aPrevDispMode = getDisplayer()->SetDisplayMode( displayMode == -1 ? resMgr->integerValue( "Geometry", "display_mode", 0 ) : displayMode );
333 // Disable activation of selection
334 getDisplayer()->SetToActivate( activate );
336 // Make a reference to GEOM_Object
337 CORBA::String_var objStr = SalomeApp_Application::orb()->object_to_string( object );
338 getDisplayer()->SetName( objStr.in() );
341 SALOME_Prs* aPrs = getDisplayer()->BuildPrs( object );
342 if ( aPrs == 0 || aPrs->IsNull() )
346 displayPreview( aPrs, append, update );
348 getDisplayer()->UnsetName();
349 getDisplayer()->UnsetColor();
350 getDisplayer()->SetDisplayMode( aPrevDispMode );
352 // Enable activation of displayed objects
353 getDisplayer()->SetToActivate( true );
356 //================================================================
357 // Function : displayPreview
358 // Purpose : Method for displaying arbitrary preview objects (not limited to shapes)
359 //================================================================
360 void GEOMBase_Helper::displayPreview( const SALOME_Prs* prs,
365 erasePreview( false );
367 // remember current view frame to make correct erase preview later
368 myViewWindow = getActiveView();
370 if ( myViewWindow == 0 )
374 SUIT_ViewManager* aViewManager = myViewWindow->getViewManager();
375 if ( aViewManager->getType() == OCCViewer_Viewer::Type() ||
376 aViewManager->getType() == SVTK_Viewer::Type() )
378 SUIT_ViewModel* aViewModel = aViewManager->getViewModel();
379 SALOME_View* aView = dynamic_cast<SALOME_View*>(aViewModel);
381 aView->Display( prs );
384 // Add prs to the preview list
385 myPreview.push_back( (SALOME_Prs*)prs );
389 getDisplayer()->UpdateViewer();
392 //================================================================
393 // Function : erasePreview
395 //================================================================
396 void GEOMBase_Helper::erasePreview( const bool update )
398 // check view frame where the preview was displayed
399 bool vfOK = checkViewWindow() && myViewWindow;
400 // Iterate through presentations and delete them
401 for ( PrsList::iterator anIter = myPreview.begin(); anIter != myPreview.end(); ++anIter ) {
404 SUIT_ViewManager* aViewManager = myViewWindow->getViewManager();
405 if ( aViewManager->getType() == OCCViewer_Viewer::Type() ||
406 aViewManager->getType() == SVTK_Viewer::Type() )
408 SUIT_ViewModel* aViewModel = aViewManager->getViewModel();
409 SALOME_View* aView = dynamic_cast<SALOME_View*>(aViewModel);
411 aView->Erase( *anIter, true );
423 //================================================================
424 // Function : localSelection
425 // Purpose : Activate selection of objects of a given type
426 // IMPORTANT : Works after localSelection( ... ) method call only
427 //================================================================
428 void GEOMBase_Helper::activate( const int theType )
430 if (!getStudy()) return;
431 _PTR(Study) aStudy = getStudy()->studyDS();
432 _PTR(SComponent) aGeom ( aStudy->FindComponent( "GEOM" ) );
437 _PTR(ChildIterator) anIter ( aStudy->NewChildIterator( aGeom ) );
438 for ( ; anIter->More(); anIter->Next() )
440 _PTR(SObject) aSO ( anIter->Value() );
443 _PTR(SObject) aRefSO;
444 if ( !aSO->ReferencedObject( aRefSO ) )
446 GEOM::GEOM_Object_var anObj = GEOM::GEOM_Object::_narrow
447 (GeometryGUI::ClientSObjectToObject(aSO));
448 if ( !anObj->_is_nil() && anObj->GetType() == theType )
449 aList.Append( new SALOME_InteractiveObject( aSO->GetID().c_str(), "GEOM", aSO->GetName().c_str()) );
454 getDisplayer()->LocalSelection( aList, 0 );
457 //================================================================
458 // Function : localSelection
459 // Purpose : Activate selection of sub-shapes in accordance with mode
460 // theMode is from TopAbs_ShapeEnum
461 //================================================================
462 void GEOMBase_Helper::localSelection( const ObjectList& theObjs, const int theMode )
464 SALOME_ListIO aListOfIO;
466 ObjectList::const_iterator anIter = theObjs.begin();
467 for ( ; anIter != theObjs.end(); ++anIter )
469 GEOM::GEOM_Object_ptr anObj = *anIter;
470 if ( anObj->_is_nil() )
472 QString anEntry = getEntry( anObj );
474 aListOfIO.Append( new SALOME_InteractiveObject(
475 anEntry.toLatin1().constData(), "GEOM", strdup( GEOMBase::GetName( anObj ).toLatin1().constData() ) ) );
478 getDisplayer()->LocalSelection( aListOfIO, theMode );
481 //================================================================
482 // Function : localSelection
483 // Purpose : Activate selection of sub-shapes in accordance with mode
484 // theMode is from TopAbs_ShapeEnum
485 //================================================================
486 void GEOMBase_Helper::localSelection( GEOM::GEOM_Object_ptr obj, const int mode )
488 // If object is null local selection for all objects is activated
489 if ( obj->_is_nil() ) {
490 getDisplayer()->LocalSelection( Handle(SALOME_InteractiveObject)(), mode );
495 objList.push_back( obj );
496 localSelection( objList, mode );
500 //================================================================
501 // Function : globalSelection
502 // Purpose : Activate selection of sub-shapes. Set selection filters
503 // in accordance with mode. theMode is from GEOMImpl_Types
504 //================================================================
505 void GEOMBase_Helper::globalSelection( const int theMode, const bool update )
507 getDisplayer()->GlobalSelection( theMode, update );
510 //================================================================
511 // Function : globalSelection
512 // Purpose : Activate selection of sub-shapes. Set selection filters
513 // in accordance with mode. theMode is from GEOMImpl_Types
514 //================================================================
515 void GEOMBase_Helper::globalSelection( const TColStd_MapOfInteger& theModes,
518 getDisplayer()->GlobalSelection( theModes, update );
521 //================================================================
522 // Function : globalSelection
523 // Purpose : Activate selection of sub-shapes. Set selection filters
524 // in accordance with mode. theMode is from GEOMImpl_Types
525 //================================================================
526 void GEOMBase_Helper::globalSelection( const TColStd_MapOfInteger& theModes,
527 const QList<int>& subShapes,
530 getDisplayer()->GlobalSelection( theModes, update, &subShapes );
533 //================================================================
534 // Function : addInStudy
535 // Purpose : Add object in study
536 //================================================================
537 QString GEOMBase_Helper::addInStudy( GEOM::GEOM_Object_ptr theObj, const char* theName )
542 _PTR(Study) aStudy = getStudy()->studyDS();
543 if ( !aStudy || theObj->_is_nil() )
546 SALOMEDS::Study_var aStudyDS = GeometryGUI::ClientStudyToStudy(aStudy);
548 GEOM::GEOM_Object_ptr aFatherObj = getFather( theObj );
550 SALOMEDS::SObject_var aSO =
551 getGeomEngine()->AddInStudy(aStudyDS, theObj, theName, aFatherObj);
554 if ( !aSO->_is_nil() ) {
555 CORBA::String_var entry = aSO->GetID();
556 anEntry = entry.in();
558 // Each dialog is responsible for this method implementation,
559 // default implementation does nothing
560 restoreSubShapes(aStudyDS, aSO);
566 //================================================================
567 // Function : restoreSubShapes
568 // Purpose : restore tree of argument's sub-shapes under the resulting shape
569 //================================================================
570 void GEOMBase_Helper::restoreSubShapes (SALOMEDS::Study_ptr /*theStudy*/,
571 SALOMEDS::SObject_ptr /*theSObject*/)
573 // do nothing by default
575 // example of implementation in particular dialog:
576 // GEOM::ListOfGO anArgs;
577 // anArgs.length(0); // empty list means that all arguments should be restored
578 // getGeomEngine()->RestoreSubShapesSO(theStudy, theSObject, anArgs,
579 // /*theFindMethod=*/GEOM::FSM_GetInPlace,
580 // /*theInheritFirstArg=*/false);
583 //================================================================
584 // Function : updateObjBrowser
585 // Purpose : Update object browser
586 //================================================================
587 void GEOMBase_Helper::updateObjBrowser() const
589 SalomeApp_Application* app = dynamic_cast<SalomeApp_Application*>(SUIT_Session::session()->activeApplication());
591 CAM_Module* module = app->module( "Geometry" );
592 SalomeApp_Module* appMod = dynamic_cast<SalomeApp_Module*>( module );
594 appMod->updateObjBrowser( true );
599 //================================================================
600 // Function : updateViewer
601 // Purpose : Update active 3D view
602 //================================================================
603 void GEOMBase_Helper::updateViewer()
605 getDisplayer()->UpdateViewer();
608 //================================================================
609 // Function : getStudyId
610 // Purpose : Get study Id
611 //================================================================
612 int GEOMBase_Helper::getStudyId() const
616 anId = getStudy()->id();
620 //================================================================
621 // Function : getStudy
622 // Purpose : Returns the active study. It is recommended to use
623 // this method instead of direct desktop->getActiveStudy() calls
624 //================================================================
625 SalomeApp_Study* GEOMBase_Helper::getStudy() const
627 SUIT_Desktop* aDesktop = getDesktop();
631 QList<SUIT_Application*> anAppList = SUIT_Session::session()->applications();
633 SUIT_Application* anApp = 0;
634 QListIterator<SUIT_Application*> it( anAppList );
635 while ( it.hasNext() )
638 if ( anApp && anApp->desktop() == aDesktop )
642 return dynamic_cast<SalomeApp_Study*>(anApp->activeStudy());
645 //================================================================
646 // Function : getEntry
648 //================================================================
649 QString GEOMBase_Helper::getEntry( GEOM::GEOM_Object_ptr object ) const
651 SalomeApp_Study* study = getStudy();
653 QString objIOR = GEOMBase::GetIORFromObject( object );
654 if ( objIOR != "" ) {
655 _PTR(SObject) SO ( study->studyDS()->FindObjectIOR( objIOR.toLatin1().constData() ) );
657 return QString::fromStdString(SO->GetID());
663 //================================================================
664 // Function : getDisplayer
666 //================================================================
667 GEOM_Displayer* GEOMBase_Helper::getDisplayer()
670 myDisplayer = new GEOM_Displayer( getStudy() );
674 //================================================================
675 // Function : clearShapeBuffer
677 //================================================================
678 void GEOMBase_Helper::clearShapeBuffer( GEOM::GEOM_Object_ptr theObj )
680 GeometryGUI::ClearShapeBuffer(theObj);
683 //================================================================
684 // Function : openCommand
686 //================================================================
687 bool GEOMBase_Helper::openCommand()
690 if ( !getStudy() || hasCommand() )
692 MESSAGE("Getting out from openCommand()")
696 GEOM::GEOM_IOperations_var anOp = GEOM::GEOM_IOperations::_narrow( getOperation() );
697 if ( !anOp->_is_nil() ) {
698 myCommand = new GEOM_Operation( SUIT_Session::session()->activeApplication(), anOp.in() );
704 MESSAGE("anOp->_is_nil() = true")
710 //================================================================
711 // Function : abortCommand
713 //================================================================
714 bool GEOMBase_Helper::abortCommand()
720 delete myCommand; // I don't know where to delete this object here ?
726 //================================================================
727 // Function : commitCommand
729 //================================================================
730 bool GEOMBase_Helper::commitCommand( const char* )
736 delete myCommand; // I don't know where to delete this object here ?
742 //================================================================
743 // Function : hasCommand
745 //================================================================
746 bool GEOMBase_Helper::hasCommand() const
748 return (bool)myCommand;
751 //================================================================
752 // Function : getOperation
754 //================================================================
755 GEOM::GEOM_IOperations_ptr GEOMBase_Helper::getOperation()
757 if ( myOperation->_is_nil() )
758 myOperation = createOperation();
765 //================================================================
766 // Function : checkViewWindow
768 //================================================================
769 bool GEOMBase_Helper::checkViewWindow()
772 QList<SUIT_ViewWindow*> aViewWindowsList = SUIT_Session::session()->activeApplication()->desktop()->windows();
773 QListIterator<SUIT_ViewWindow*> it( aViewWindowsList );
774 while ( it.hasNext() )
776 if ( myViewWindow == it.next() )
784 //================================================================
785 // Function : onAccept
786 // Purpose : This method should be called from dialog's slots onOk() and onApply()
787 // It perfroms user input validation, then it
788 // performs a proper operation and manages transactions, etc.
789 //================================================================
790 bool GEOMBase_Helper::onAccept( const bool publish, const bool useTransaction, bool erasePreviewFlag )
792 SalomeApp_Study* appStudy = dynamic_cast<SalomeApp_Study*>( SUIT_Session::session()->activeApplication()->activeStudy() );
795 MESSAGE("appStudy is empty")
798 _PTR(Study) aStudy = appStudy->studyDS();
800 bool aLocked = (_PTR(AttributeStudyProperties) (aStudy->GetProperties()))->IsLocked();
802 MESSAGE("GEOMBase_Helper::onAccept - ActiveStudy is locked");
803 SUIT_MessageBox::warning ( (QWidget*)SUIT_Session::session()->activeApplication()->desktop(),
804 QObject::tr("WRN_WARNING"),
805 QObject::tr("WRN_STUDY_LOCKED"),
806 QObject::tr("BUT_OK") );
811 if ( !isValid( msg ) ) {
817 erasePreview( false );
822 if ( ( !publish && !useTransaction ) || openCommand() ) {
823 SUIT_OverrideCursor wc;
824 SUIT_Session::session()->activeApplication()->putInfo( "" );
826 if ( !execute( objects ) || !getOperation()->IsDone() ) {
832 addSubshapesToStudy(); // add Sub-shapes if local selection
833 const int nbObjs = objects.size();
834 QStringList anEntryList;
835 int currObj = 1, aNumber = 1;
836 for ( ObjectList::iterator it = objects.begin(); it != objects.end(); ++it, currObj++ ) {
837 GEOM::GEOM_Object_var obj=*it;
839 QString aName = getObjectName(obj);
840 if (aName.isEmpty()) {
841 aName = getNewObjectName(currObj);
844 aName = getPrefix(obj);
846 // Try to find a unique name
847 aName = GEOMBase::GetDefaultName(aName, extractPrefix());
849 // Don't check name uniqueness in case of numerous objects
850 aName = aName + "_" + QString::number(aNumber++);
853 // PAL6521: use a prefix, if some dialog box doesn't reimplement getNewObjectName()
854 if ( aName.isEmpty() )
855 aName = GEOMBase::GetDefaultName( getPrefix( obj ) );
858 anEntryList << addInStudy( obj, aName.toLatin1().constData() );
860 if( isDisplayResult() )
861 display( obj, false );
862 #ifdef WITHGENERICOBJ
863 // obj has been published in study. Its refcount has been incremented.
864 // It is safe to decrement its refcount
865 // so that it will be destroyed when the entry in study will be removed
870 // asv : fix of PAL6454. If publish==false, then the original shape
871 // was modified, and need to be re-cached in GEOM_Client before redisplay
872 clearShapeBuffer( obj );
873 // withChildren=true, updateView=false
874 if( isDisplayResult() )
875 redisplay( obj, true, false );
882 if( SUIT_Application* anApp = SUIT_Session::session()->activeApplication() ) {
883 LightApp_Application* aLightApp = dynamic_cast<LightApp_Application*>( anApp );
885 QString anOpName( typeid(*this).name() );
886 aLightApp->emitOperationFinished( "Geometry", anOpName, anEntryList );
888 if ( !isDisableBrowsing() )
889 aLightApp->browseObjects( anEntryList, isApplyAndClose(), isOptimizedBrowsing() );
891 anApp->putInfo( QObject::tr("GEOM_PRP_DONE") );
900 catch( const SALOME::SALOME_Exception& e ) {
901 SalomeApp_Tools::QtCatchCorbaException( e );
903 MESSAGE("Exception catched")
908 MESSAGE("result ="<<result)
913 //================================================================
914 // Function : showError
915 // Purpose : Shows a message box with infromation about an error taken from getOperation()->GetErrorCode()
916 //================================================================
917 void GEOMBase_Helper::showError()
920 if ( !getOperation()->_is_nil() )
921 msg = QObject::tr( getOperation()->GetErrorCode() );
924 msg = QObject::tr( "GEOM_PRP_ABORT" );
926 SUIT_MessageBox::critical( SUIT_Session::session()->activeApplication()->desktop(),
927 QObject::tr( "GEOM_ERROR_STATUS" ),
929 QObject::tr( "BUT_OK" ) );
932 //================================================================
933 // Function : showError
934 // Purpose : Shows a error message followed by <msg>
935 //================================================================
936 void GEOMBase_Helper::showError( const QString& msg )
938 QString str( QObject::tr( "GEOM_INCORRECT_INPUT" ) );
939 if ( !msg.isEmpty() )
941 SUIT_MessageBox::critical(SUIT_Session::session()->activeApplication()->desktop(), QObject::tr( "GEOM_ERROR" ), str, QObject::tr( "BUT_OK" ) );
944 //////////////////////////////////////////////////////////////////
945 // Virtual methods to be redefined in dialogs
946 //////////////////////////////////////////////////////////////////
948 //================================================================
949 // Function : createOperation
950 // Purpose : Redefine this method to return proper IOperation reference
951 //================================================================
952 GEOM::GEOM_IOperations_ptr GEOMBase_Helper::createOperation()
954 GEOM::GEOM_IOperations_var aNilOp;
955 return aNilOp._retn();
958 //================================================================
959 // Function : isValid
960 // Purpose : Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
961 //================================================================
962 bool GEOMBase_Helper::isValid( QString& )
967 //================================================================
968 // Function : execute
969 // Purpose : This method is called by onAccept().
970 // It should perform the required operation and put all new or modified objects into
971 // <objects> argument.Should return <false> if some error occurs during its execution.
972 //================================================================
973 bool GEOMBase_Helper::execute( ObjectList& objects )
978 //================================================================
979 // Function : getFather
980 // Purpose : This method is called by addInStudy(). It should return a father object
981 // for <theObj> or a nil reference if <theObj> should be published
982 // as a top-level object.
983 //================================================================
984 GEOM::GEOM_Object_ptr GEOMBase_Helper::getFather( GEOM::GEOM_Object_ptr theObj )
986 return GEOM::GEOM_Object::_nil();
989 //================================================================
990 // Function : getObjectName
991 // Purpose : Redefine this method to return proper name for the given object
992 //================================================================
993 QString GEOMBase_Helper::getObjectName(GEOM::GEOM_Object_ptr object) const
998 //================================================================
999 // Function : getNewObjectName
1000 // Purpose : Redefine this method to return proper name for a new object
1001 //================================================================
1002 QString GEOMBase_Helper::getNewObjectName (int) const
1007 //================================================================
1008 // Function : extractPrefix
1009 // Purpose : Redefine this method to return \c true if necessary
1010 // to extract prefix when generating new name for the
1011 // object(s) being created
1012 //================================================================
1013 bool GEOMBase_Helper::extractPrefix() const
1018 //================================================================
1019 // Function : getPrefix
1020 // Purpose : Get prefix for name of created object
1021 //================================================================
1022 QString GEOMBase_Helper::getPrefix( GEOM::GEOM_Object_ptr theObj ) const
1024 if ( !myPrefix.isEmpty() || theObj->_is_nil() )
1027 GEOM::shape_type aType = theObj->GetShapeType();
1031 case GEOM::VERTEX : return QObject::tr( "GEOM_VERTEX" );
1032 case GEOM::EDGE : return QObject::tr( "GEOM_EDGE" );
1033 case GEOM::WIRE : return QObject::tr( "GEOM_WIRE" );
1034 case GEOM::FACE : return QObject::tr( "GEOM_FACE" );
1035 case GEOM::SHELL : return QObject::tr( "GEOM_SHELL" );
1036 case GEOM::SOLID : return QObject::tr( "GEOM_SOLID" );
1037 case GEOM::COMPSOLID: return QObject::tr( "GEOM_COMPOUNDSOLID" );
1038 case GEOM::COMPOUND : return QObject::tr( "GEOM_COMPOUND" );
1039 default : return "";
1043 //================================================================
1044 // Function : getDesktop
1045 // Purpose : Returns myDesktop field. Initialized in constructor,
1046 // usually as dynamic_cast<SUIT_Desktop*>(parentWidget())
1047 //================================================================
1048 SUIT_Desktop* GEOMBase_Helper::getDesktop() const
1053 //================================================================
1054 // Function : selectObjects
1055 // Purpose : Selects list of objects
1056 //================================================================
1057 bool GEOMBase_Helper::selectObjects( ObjectList& objects )
1059 SUIT_DataOwnerPtrList aList;
1060 ObjectList::iterator anIter;
1061 for ( anIter = objects.begin(); anIter != objects.end(); ++anIter )
1063 QString anEntry = getEntry( *anIter );
1064 LightApp_DataOwner* anOwher = new LightApp_DataOwner( anEntry );
1065 aList.append( anOwher );
1068 SUIT_Session* session = SUIT_Session::session();
1069 SalomeApp_Application* app = dynamic_cast<SalomeApp_Application*>( session->activeApplication() );
1073 LightApp_SelectionMgr* aMgr = app->selectionMgr();
1077 aMgr->setSelected( aList, false );
1082 //================================================================
1083 // Function : findObjectInFather
1084 // Purpose : It should return an object if its founded in study or
1085 // return Null object if the object is not founded
1086 //================================================================
1087 GEOM::GEOM_Object_ptr GEOMBase_Helper::findObjectInFather (GEOM::GEOM_Object_ptr theFather,
1088 const QString& theName)
1090 SalomeApp_Application* app =
1091 dynamic_cast< SalomeApp_Application* >( SUIT_Session::session()->activeApplication() );
1092 SalomeApp_Study* appStudy = dynamic_cast<SalomeApp_Study*>( app->activeStudy() );
1093 _PTR(Study) aDStudy = appStudy->studyDS();
1094 QString IOR = GEOMBase::GetIORFromObject( theFather );
1095 _PTR(SObject) SObj ( aDStudy->FindObjectIOR( IOR.toLatin1().constData() ) );
1097 bool inStudy = false;
1098 GEOM::GEOM_Object_var aReturnObject;
1099 for (_PTR(ChildIterator) iit (aDStudy->NewChildIterator( SObj )); iit->More() && !inStudy; iit->Next()) {
1100 _PTR(SObject) child (iit->Value());
1101 QString aChildName = child->GetName().c_str();
1102 if (aChildName == theName) {
1104 CORBA::Object_var corbaObj = GeometryGUI::ClientSObjectToObject(iit->Value());
1105 aReturnObject = GEOM::GEOM_Object::_narrow( corbaObj );
1109 return aReturnObject._retn();
1111 return GEOM::GEOM_Object::_nil();
1114 //================================================================
1115 // Function : findObjectInFather
1116 // Purpose : It should return an object if its founded in study or
1117 // return Null object if the object is not founded
1118 //================================================================
1119 GEOM::GEOM_Object_ptr GEOMBase_Helper::findObjectInFather( GEOM::GEOM_Object_ptr theFather,
1122 GEOM::GEOM_Object_var object;
1125 SalomeApp_Study* study = dynamic_cast<SalomeApp_Study*>( SUIT_Session::session()->activeApplication()->activeStudy() );
1127 _PTR(Study) studyDS = study->studyDS();
1128 QString IOR = GEOMBase::GetIORFromObject( theFather );
1129 _PTR(SObject) sobject( studyDS->FindObjectIOR( IOR.toLatin1().constData() ) );
1131 _PTR(ChildIterator) it( studyDS->NewChildIterator( sobject ) );
1132 for ( ; it->More() && !found; it->Next() ) {
1133 GEOM::GEOM_Object_var cobject = GEOM::GEOM_Object::_narrow( GeometryGUI::ClientSObjectToObject( it->Value() ) );
1134 if ( !CORBA::is_nil( cobject ) ) {
1135 GEOM::ListOfLong_var indices = cobject->GetSubShapeIndices();
1136 int length = indices->length();
1137 for ( int i = 0; i < length && !found; i++ ) {
1138 if ( indices[i] == theIndex ) {
1148 return object._retn();
1151 //================================================================
1152 // Function : addSubshapesToStudy
1153 // Purpose : Virtual method to add sub-shapes if needs
1154 //================================================================
1155 void GEOMBase_Helper::addSubshapesToStudy()
1157 //Impemented in Dialogs, called from Accept method
1160 //================================================================
1161 // Function : getSelected
1162 // Purpose : Get selected object by specified type
1164 // Returns valid object if only one object of the specified type is selected
1165 // (no matter global or local selection is activated). If \a type is TopAbs_SHAPE,
1166 // geometrical object of any valid type is expected.
1168 // \param type type of the object to be obtained from selection
1169 // \return selected geometrical object or nil object if selection is not satisfactory
1170 //================================================================
1171 GEOM::GeomObjPtr GEOMBase_Helper::getSelected( TopAbs_ShapeEnum type )
1173 QList<TopAbs_ShapeEnum> types;
1175 return getSelected( types );
1178 //================================================================
1179 // Function : getSelected
1180 // Purpose : Get selected object by specified types
1182 // Returns valid object if only one object of the specified type is selected
1183 // (no matter global or local selection is activated). The list of allowed
1184 // shape types is passed via \a types. If \a types includes TopAbs_SHAPE,
1185 // geometrical object of any valid type is expected.
1187 // \param types list of allowed shape types for the objects to be obtained from selection
1188 // \return selected geometrical object or nil object if selection is not satisfactory
1189 //================================================================
1190 GEOM::GeomObjPtr GEOMBase_Helper::getSelected( const QList<TopAbs_ShapeEnum>& types )
1192 QList<GEOM::GeomObjPtr> selected = getSelected( types, 1 );
1193 return selected.count() > 0 ? selected[0] : GEOM::GeomObjPtr();
1196 //================================================================
1197 // Function : getSelected
1198 // Purpose : Get selected object(s) by specified type
1200 // Returns list of selected objects if selection satisfies specifies selection options.
1201 // (no matter global or local selection is activated). If \a type is TopAbs_SHAPE,
1202 // geometrical objects of any valid type are expected.
1204 // The \a type parameter specifies allowed type of the object(s) being selected.
1205 // The \a count parameter specifies exact number of the objects to be retrieved from selection.
1206 // The \a strict parameter specifies policy being applied to the selection.
1207 // If \a count < 0, then any number of the selected objects is valid (including 0).
1208 // In this case, if \a strict is \c true (default), all selected objects should satisfy
1209 // the specified \a type.
1210 // If \a count > 0, only specified number of the objects is retrieved from the selection.
1211 // In this case, if \a strict is \c true (default), function returns empty list if total number of selected
1212 // objects does not correspond to the \a count parameter. Otherwise (if \a strict is \c false),
1213 // function returns valid list of objects if at least \a count objects satisfy specified \a type.
1215 // \param type type of the object(s) to be obtained from selection
1216 // \param count number of items to be retrieved from selection
1217 // \param strict selection policy
1218 // \return list of selected geometrical objects or empty list if selection is not satisfactory
1219 //================================================================
1220 QList<GEOM::GeomObjPtr> GEOMBase_Helper::getSelected( TopAbs_ShapeEnum type, int count, bool strict )
1222 QList<TopAbs_ShapeEnum> types;
1224 return getSelected( types, count, strict );
1227 static bool typeInList( TopAbs_ShapeEnum type, const QList<TopAbs_ShapeEnum>& types )
1230 for ( int i = 0; i < types.count() && !ok; i++ )
1231 ok = types[i] == TopAbs_SHAPE || types[i] == type;
1235 //================================================================
1236 // Function : getSelected
1237 // Purpose : Get selected objects by specified types
1239 // Returns list of selected objects if selection satisfies specifies selection options.
1240 // (no matter global or local selection is activated). If \a types includes TopAbs_SHAPE,
1241 // geometrical objects of any valid type are expected.
1243 // The \a types parameter specifies allowed types of the object(s) being selected.
1244 // The \a count parameter specifies exact number of the objects to be retrieved from selection.
1245 // The \a strict parameter specifies policy being applied to the selection.
1246 // If \a count < 0, then any number of the selected objects is valid (including 0).
1247 // In this case, if \a strict is \c true (default), all selected objects should satisfy
1248 // the specified \a type.
1249 // If \a count > 0, only specified number of the objects is retrieved from the selection.
1250 // In this case, if \a strict is \c true (default), function returns empty list if total number of selected
1251 // objects does not correspond to the \a count parameter. Otherwise (if \a strict is \c false),
1252 // function returns valid list of objects if at least \a count objects satisfy specified \a type.
1254 // \param types list of allowed shape types for the objects to be obtained from selection
1255 // \param count number of items to be retrieved from selection
1256 // \param strict selection policy
1257 // \return list of selected geometrical objects or empty list if selection is not satisfactory
1258 //================================================================
1259 QList<GEOM::GeomObjPtr> GEOMBase_Helper::getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict )
1261 SUIT_Session* session = SUIT_Session::session();
1262 QList<GEOM::GeomObjPtr> result;
1264 SalomeApp_Application* app = dynamic_cast<SalomeApp_Application*>( session->activeApplication() );
1266 LightApp_SelectionMgr* selMgr = app->selectionMgr();
1268 SALOME_ListIO selected;
1269 selMgr->selectedObjects( selected );
1270 SALOME_ListIteratorOfListIO it( selected );
1271 bool stopped = false;
1272 for ( ; it.More() && !stopped; it.Next() ) {
1273 Handle(SALOME_InteractiveObject) IO = it.Value();
1274 GEOM::GeomObjPtr object = GEOMBase::ConvertIOinGEOMObject( IO );
1276 TColStd_IndexedMapOfInteger subShapes;
1277 selMgr->GetIndexes( IO, subShapes );
1278 int nbSubShapes = subShapes.Extent();
1279 if ( nbSubShapes == 0 ) {
1281 if ( typeInList( (TopAbs_ShapeEnum)(object->GetShapeType()), types ) ) {
1284 if ( strict && result.count() > count ) {
1288 else if ( !strict && result.count() == count )
1292 else if ( strict ) {
1299 for ( int i = 1; i <= nbSubShapes && !stopped; i++ ) {
1300 int idx = subShapes( i );
1301 GEOM::GeomObjPtr subShape = findObjectInFather( object.get(), idx );
1303 // sub-shape is not yet published in the study
1304 GEOM::ShapesOpPtr shapesOp = getGeomEngine()->GetIShapesOperations( getStudyId() );
1305 subShape.take( shapesOp->GetSubShape( object.get(), idx ) ); // take ownership!
1307 if ( typeInList( (TopAbs_ShapeEnum)(subShape->GetShapeType()), types ) ) {
1310 if ( strict && result.count() > count ) {
1314 else if ( !strict && result.count() == count )
1318 else if ( strict ) {
1331 //================================================================
1332 // Function : setIsApplyAndClose
1333 // Purpose : Set value of the flag indicating that the dialog is
1334 // accepted by Apply & Close button
1335 //================================================================
1336 void GEOMBase_Helper::setIsApplyAndClose( const bool theFlag )
1338 myIsApplyAndClose = theFlag;
1341 //================================================================
1342 // Function : isApplyAndClose
1343 // Purpose : Get value of the flag indicating that the dialog is
1344 // accepted by Apply & Close button
1345 //================================================================
1346 bool GEOMBase_Helper::isApplyAndClose() const
1348 return myIsApplyAndClose;
1351 //================================================================
1352 // Function : setIsOptimizedBrowsing
1353 // Purpose : Set value of the flag switching to optimized
1354 // browsing mode (to select the first published
1356 //================================================================
1357 void GEOMBase_Helper::setIsOptimizedBrowsing( const bool theFlag )
1359 myIsOptimizedBrowsing = theFlag;
1362 //================================================================
1363 // Function : isOptimizedBrowsing
1364 // Purpose : Get value of the flag switching to optimized
1365 // browsing mode (to select the first published
1367 //================================================================
1368 bool GEOMBase_Helper::isOptimizedBrowsing() const
1370 return myIsOptimizedBrowsing;