src/ATOMSOLVGUI/ATOMSOLVGUI.cxx

   1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "ATOMSOLVGUI.h"
  21 #include "ATOMSOLVGUI_DataModel.h"
  22 #include "ATOMSOLVGUI_Displayer.h"
  23 #include "ATOMSOLVGUI_Selection.h"
  24 #include "ATOMSOLVGUI_TransparencyDlg.h"
  25
  26 #include <ATOMSOLV_version.h>
  27
  28 #include <SUIT_MessageBox.h>
  29 #include <SUIT_ResourceMgr.h>
  30 #include <SUIT_Session.h>
  31 #include <SUIT_Desktop.h>
  32 #include <SUIT_ViewManager.h>
  33
  34 #include <QtxPopupMgr.h>
  35
  36 #include <SalomeApp_Application.h>
  37 #include <SalomeApp_Study.h>
  38
  39 #include <LightApp_DataOwner.h>
  40 #include <LightApp_SelectionMgr.h>
  41 #include <LightApp_Preferences.h>
  42
  43 #include <SVTK_ViewModel.h>
  44 #include <SVTK_ViewWindow.h>
  45 #include <SALOME_Actor.h>
  46
  47 #include <SALOME_LifeCycleCORBA.hxx>
  48
  49 // QT includes
  50 #include <qinputdialog.h>
  51 #include <qaction.h>
  52 #include <qcolordialog.h>
  53 #include <qstringlist.h>
  54
  55 // VTK includes
  56 #include <vtkActorCollection.h>
  57 #include <vtkRenderer.h>
  58
  59 #include <utilities.h>
  60
  61 ATOMSOLV_ORB::ATOMSOLV_Gen_var ATOMSOLVGUI::myEngine = ATOMSOLV_ORB::ATOMSOLV_Gen::_nil();
  62
  63 // Constructor
  64 ATOMSOLVGUI::ATOMSOLVGUI() :
  65   SalomeApp_Module( "ATOMSOLV" )
  66 {
  67 }
  68
  69 // Initialize a reference to the module's engine
  70 void ATOMSOLVGUI::InitATOMSOLVGen( SalomeApp_Application* app )
  71 {
  72   if ( !app )
  73     myEngine = ATOMSOLV_ORB::ATOMSOLV_Gen::_nil();
  74   else {
  75     Engines::EngineComponent_var comp = app->lcc()->FindOrLoad_Component( "FactoryServer", "ATOMSOLV" );
  76     ATOMSOLV_ORB::ATOMSOLV_Gen_ptr atomGen = ATOMSOLV_ORB::ATOMSOLV_Gen::_narrow(comp);
  77     ASSERT( !CORBA::is_nil( atomGen ) );
  78     myEngine = atomGen;
  79   }
  80 }
  81
  82 // Gets an reference to the module's engine
  83 ATOMSOLV_ORB::ATOMSOLV_Gen_var ATOMSOLVGUI::GetATOMSOLVGen()
  84 {
  85   if ( CORBA::is_nil( myEngine ) ) {
  86     SUIT_Application* suitApp = SUIT_Session::session()->activeApplication();
  87     SalomeApp_Application* app = dynamic_cast<SalomeApp_Application*>( suitApp );
  88     InitATOMSOLVGen( app );
  89   }
  90   return myEngine;
  91 }
  92
  93 // Module's initialization
  94 void ATOMSOLVGUI::initialize( CAM_Application* app )
  95 {
  96   SalomeApp_Module::initialize( app );
  97
  98   InitATOMSOLVGen( dynamic_cast<SalomeApp_Application*>( app ) );
  99
 100   SUIT_Desktop* aParent = app->desktop();
 101   SUIT_ResourceMgr* aResourceMgr = app->resourceMgr();
 102
 103   // create actions
 104   QPixmap aPixmap = aResourceMgr->loadPixmap( "ATOMSOLV",tr( "ICON_IMPORT_DATA" ) );
 105   createAction( RetrieveData, tr( "TLT_RETRIEVE_DATA" ), QIcon( aPixmap ), tr( "MEN_RETRIEVE_DATA" ),
 106                 tr( "STS_RETRIEVE_DATA" ), 0, aParent, false, this, SLOT( OnRetrieveData() ) );
 107   aPixmap = aResourceMgr->loadPixmap( "ATOMSOLV",tr( "ICON_PROCESS_DATA" ) );
 108   createAction( ProcessData, tr( "TLT_PROCESS_DATA" ), QIcon( aPixmap ), tr( "MEN_PROCESS_DATA" ),
 109                 tr( "STS_PROCESS_DATA" ), 0, aParent, false, this, SLOT( OnProcessData() ) );
 110
 111   // create menus
 112   int aMenuId = createMenu( tr( "MEN_ATOMSOLV" ), -1, -1, 30 );
 113   createMenu( RetrieveData, aMenuId, 10 );
 114   createMenu( ProcessData, aMenuId, 10 );
 115
 116   // create toolbars
 117   int aToolId = createTool ( tr( "TOOL_ATOMSOLV" ), QString( "AtomSolv" ) );
 118   createTool( RetrieveData, aToolId );
 119   createTool( ProcessData, aToolId );
 120
 121   // custom actions handled by displayer (display, erase, display mode, etc.)
 122   aPixmap = aResourceMgr->loadPixmap( "ATOMSOLV",tr( "ICON_DISPLAY" ) );
 123   createAction( Display, tr( "TLT_DISPLAY" ), QIcon( aPixmap ), tr( "MEN_DISPLAY" ),
 124                 tr( "STS_DISPLAY" ), 0, aParent, false, this, SLOT( OnDisplayerCommand() ) );
 125   aPixmap = aResourceMgr->loadPixmap( "ATOMSOLV",tr( "ICON_ERASE" ) );
 126   createAction( Erase, tr( "TLT_ERASE" ), QIcon( aPixmap ), tr( "MEN_ERASE" ),
 127                 tr( "STS_ERASE" ), 0, aParent, false, this, SLOT( OnDisplayerCommand() ) );
 128   createAction( Shading, tr( "TLT_SHADING" ), QIcon(), tr( "MEN_SHADING" ),
 129                 tr( "STS_SHADING" ), 0, aParent, true, this, SLOT( OnDisplayerCommand() ) );
 130   createAction( Wireframe, tr( "TLT_WIREFRAME" ), QIcon(), tr( "MEN_WIREFRAME" ),
 131                 tr( "STS_WIREFRAME" ), 0, aParent, true, this, SLOT( OnDisplayerCommand() ) );
 132   createAction( PointsMode, tr( "TLT_POINTSMODE" ), QIcon(), tr( "MEN_POINTSMODE" ),
 133                 tr( "STS_POINTSMODE" ), 0, aParent, true, this, SLOT( OnDisplayerCommand() ) );
 134   createAction( Color, tr( "TLT_COLOR" ), QIcon(), tr( "MEN_COLOR" ),
 135                 tr( "STS_COLOR" ), 0, aParent, false, this, SLOT( OnDisplayerCommand() ) );
 136   createAction( Transparency, tr( "TLT_TRANSPARENCY" ), QIcon(), tr( "MEN_TRANSPARENCY" ),
 137                 tr( "STS_TRANSPARENCY" ), 0, aParent, false, this, SLOT( OnDisplayerCommand() ) );
 138
 139   QtxPopupMgr* mgr = popupMgr();
 140   mgr->insert( action( Display ), -1, 0 );
 141   mgr->insert( action( Erase ), -1, 0 );
 142   int dispmodeId = mgr->insert(  tr( "MEN_DISPLAY_MODE" ), -1, -1 ); // display mode menu
 143   mgr->insert( action(  PointsMode ), dispmodeId, -1 );
 144   mgr->insert( action(  Wireframe ), dispmodeId, -1 );
 145   mgr->insert( action(  Shading ), dispmodeId, -1 );
 146   mgr->insert( action( Color ), -1, 0 );
 147   mgr->insert( action( Transparency ), -1, 0 );
 148
 149   mgr->setRule( action( Display ), "true in $canBeDisplayed and activeModule='ATOMSOLV' and !isVisible" );
 150   mgr->setRule( action( Erase ), "true in $canBeDisplayed and activeModule='ATOMSOLV' and isVisible" );
 151   mgr->setRule( action( PointsMode ), "client='VTKViewer' and selcount>0 and isVisible" );
 152   mgr->setRule( action( Wireframe ), "client='VTKViewer' and selcount>0 and isVisible" );
 153   mgr->setRule( action( Shading ), "client='VTKViewer' and selcount>0 and isVisible" );
 154   mgr->setRule( action( Color ), "client='VTKViewer' and selcount>0 and isVisible" );
 155   mgr->setRule( action( Transparency ), "client='VTKViewer' and selcount>0 and isVisible" );
 156
 157   mgr->setRule( action( PointsMode ), "$displaymode={'Points'}", QtxPopupMgr::ToggleRule );
 158   mgr->setRule( action( Wireframe ), "$displaymode={'Wireframe'}", QtxPopupMgr::ToggleRule );
 159   mgr->setRule( action( Shading ), "$displaymode={'Surface'}", QtxPopupMgr::ToggleRule );
 160 }
 161
 162 // Module's engine IOR
 163 QString ATOMSOLVGUI::engineIOR() const
 164 {
 165   CORBA::String_var anIOR = getApp()->orb()->object_to_string( GetATOMSOLVGen() );
 166   return QString( anIOR.in() );
 167 }
 168
 169 // Module's activation
 170 bool ATOMSOLVGUI::activateModule( SUIT_Study* theStudy )
 171 {
 172   bool bOk = SalomeApp_Module::activateModule( theStudy );
 173
 174   setMenuShown( true );
 175   setToolShown( true );
 176
 177   return bOk;
 178 }
 179
 180 // Module's deactivation
 181 bool ATOMSOLVGUI::deactivateModule( SUIT_Study* theStudy )
 182 {
 183   setMenuShown( false );
 184   setToolShown( false );
 185
 186   return SalomeApp_Module::deactivateModule( theStudy );
 187 }
 188
 189 // Study closed callback
 190 void ATOMSOLVGUI::studyClosed( SUIT_Study* theStudy )
 191 {
 192   if ( theStudy ) {
 193     ATOMSOLV_ORB::ATOMSOLV_Gen_var engine = GetATOMSOLVGen();
 194     ATOMSOLV_ORB::TMoleculeList lst;
 195     lst.length( 0 );
 196     engine->setData( lst );
 197   }
 198
 199   SalomeApp_Module::studyClosed( theStudy );
 200 }
 201
 202 // Default windows
 203 void ATOMSOLVGUI::windows( QMap<int, int>& theMap ) const
 204 {
 205   theMap.insert( SalomeApp_Application::WT_ObjectBrowser, Qt::LeftDockWidgetArea );
 206 #ifndef DISABLE_PYCONSOLE
 207   theMap.insert( SalomeApp_Application::WT_PyConsole,     Qt::BottomDockWidgetArea );
 208 #endif
 209 }
 210
 211 // Default view managers
 212 void ATOMSOLVGUI::viewManagers( QStringList& theViewMgrs ) const
 213 {
 214   theViewMgrs.append( SVTK_Viewer::Type() );
 215 }
 216
 217 // Create custom data model
 218 CAM_DataModel* ATOMSOLVGUI::createDataModel()
 219 {
 220   return new ATOMSOLVGUI_DataModel( this );
 221 }
 222
 223 // Create custom selection object
 224 LightApp_Selection* ATOMSOLVGUI::createSelection() const
 225 {
 226   return new ATOMSOLVGUI_Selection();
 227 }
 228
 229 /*! Returns list of entities of selected objects. */
 230 void ATOMSOLVGUI::selected( QStringList& entries, const bool multiple )
 231 {
 232   LightApp_SelectionMgr* mgr = getApp()->selectionMgr();
 233   if( !mgr )
 234     return;
 235
 236   SUIT_DataOwnerPtrList anOwnersList;
 237   mgr->selected( anOwnersList );
 238
 239   for ( int i = 0; i < anOwnersList.size(); i++ )
 240   {
 241     const LightApp_DataOwner* owner = dynamic_cast<const LightApp_DataOwner*>( anOwnersList[ i ].get() );
 242     QStringList es = owner->entry().split( "_" );
 243     if ( es.count() > 1 && es[ 0 ] == "ATOMSOLVGUI" && es[ 1 ] != "root" )
 244     {
 245       if ( !entries.contains( owner->entry() ) )
 246         entries.append( owner->entry() );
 247       if( !multiple )
 248         break;
 249     }
 250   }
 251 }
 252
 253 // Action slot
 254 void ATOMSOLVGUI::OnRetrieveData()
 255 {
 256   ATOMSOLV_ORB::ATOMSOLV_Gen_var engine = GetATOMSOLVGen();
 257   SalomeApp_Application* app = getApp();
 258   if ( !CORBA::is_nil( engine ) && app ) {
 259     Engines::EngineComponent_var comp = app->lcc()->FindOrLoad_Component( "FactoryServerPy","ATOMGEN" );
 260     ATOMGEN_ORB::ATOMGEN_Gen_var atomGen = ATOMGEN_ORB::ATOMGEN_Gen::_narrow( comp );
 261     SalomeApp_Study* appStudy = dynamic_cast<SalomeApp_Study*>( app->activeStudy() );
 262     if ( !CORBA::is_nil( atomGen ) && appStudy ) {
 263       // in case current study is not loaded by ATOMGEN component - call Load on it
 264       if ( _PTR( Study ) studyDS = appStudy->studyDS() ) {
 265         if ( _PTR( SComponent ) atomGenSComp = studyDS->FindComponent( "ATOMGEN" ) ) {
 266           _PTR( StudyBuilder ) builder = studyDS->NewBuilder();
 267           std::string atomGenIOR = app->orb()->object_to_string( atomGen );
 268           builder->LoadWith( atomGenSComp, atomGenIOR );
 269         }
 270       }
 271
 272       // retrieve data from ATOMGEN
 273       ATOMGEN_ORB::MoleculeList_var inData = atomGen->getData();
 274
 275       // "convert" Molecules to TMolecules, set default temperature of '0'
 276       const int n = inData->length();
 277       ATOMSOLV_ORB::TMoleculeList_var outData = new ATOMSOLV_ORB::TMoleculeList();
 278       outData->length( n );
 279       for ( int i = 0; i < n; i++ ) {
 280         ATOMSOLV_ORB::TMolecule_var tmol = new ATOMSOLV_ORB::TMolecule();
 281         tmol->molecule = ATOMGEN_ORB::Molecule::_duplicate( inData[i] );
 282         tmol->temperature = 0;
 283         outData[ i ] = tmol;
 284       }
 285
 286       engine->setData( outData );
 287
 288       app->updateObjectBrowser();
 289     }
 290   }
 291 }
 292
 293 // Action slot
 294 void ATOMSOLVGUI::OnProcessData()
 295 {
 296   ATOMSOLV_ORB::ATOMSOLV_Gen_var engine = GetATOMSOLVGen();
 297   SalomeApp_Application* app = getApp();
 298   if ( !CORBA::is_nil( engine ) && app ) {
 299     // call processData on engine
 300     engine->processData();
 301     // update data objects in object browser
 302     updateObjBrowser();
 303     // redisplay atoms that are already displayed (as their temperature changed..)
 304     ViewManagerList vmans;
 305     getApp()->viewManagers( SVTK_Viewer::Type(), vmans );
 306     for ( QList<SUIT_ViewManager*>::iterator it = vmans.begin(); it != vmans.end(); ++it ) {
 307       QVector<SUIT_ViewWindow*> views = (*it)->getViews();
 308       for ( int i = 0; i < views.size(); i++ ) {
 309         if ( SVTK_ViewWindow* svtkView = dynamic_cast<SVTK_ViewWindow*>( views[ i ] ) ) {
 310           vtkActorCollection* actors = svtkView->getRenderer()->GetActors();
 311           actors->InitTraversal();
 312           while ( vtkActor* actor = actors->GetNextActor() )
 313             if ( SALOME_Actor* salomeActor = SALOME_Actor::SafeDownCast( actor ) )
 314               if ( salomeActor->hasIO() ) {
 315                 //                  printf( " -- must redisplay actor salomeActor: %s\n", salomeActor->getIO()->getEntry() );
 316                 ATOMSOLVGUI_Displayer().updateActor( salomeActor );
 317               }
 318         }
 319       }
 320     }
 321   }
 322 }
 323
 324 // Action slot
 325 void ATOMSOLVGUI::OnDisplayerCommand()
 326 {
 327   const QObject* obj = sender();
 328   if ( obj && obj->inherits( "QAction" ) ) {
 329     const int id = actionId ( (QAction*)obj );
 330     switch ( id ) {
 331     case Display : {
 332       QStringList entries;
 333       selected ( entries, true );
 334       ATOMSOLVGUI_Displayer d;
 335       for ( QStringList::const_iterator it = entries.begin(), last = entries.end(); it != last; it++ )
 336         d.Display( it->toLatin1(), /*updateviewer=*/false, 0 );
 337       d.UpdateViewer();
 338     } break;
 339     case Erase   : {
 340       QStringList entries;
 341       selected ( entries, true );
 342       ATOMSOLVGUI_Displayer d;
 343       for ( QStringList::const_iterator it = entries.begin(), last = entries.end(); it != last; it++ )
 344         d.Erase( *it, /*forced=*/true, /*updateViewer=*/false, 0 );
 345       d.UpdateViewer();
 346     } break;
 347     case Shading   : {
 348       QStringList entries;
 349       selected ( entries, true );
 350       ATOMSOLVGUI_Displayer().setDisplayMode( entries, "Surface" );
 351     } break;
 352     case Wireframe   : {
 353       QStringList entries;
 354       selected ( entries, true );
 355       ATOMSOLVGUI_Displayer().setDisplayMode( entries, "Wireframe" );
 356     } break;
 357     case PointsMode   : {
 358       QStringList entries;
 359       selected ( entries, true );
 360       ATOMSOLVGUI_Displayer().setDisplayMode( entries, "Points" );
 361     } break;
 362     case Color   : {
 363       QStringList entries;
 364       selected ( entries, true );
 365       QColor initialColor( "white" );
 366       if ( entries.count() == 1 )
 367         initialColor = ATOMSOLVGUI_Displayer().getColor( entries[ 0 ] );
 368       QColor color = QColorDialog::getColor( initialColor, getApp()->desktop() );
 369       if ( color.isValid() )
 370         ATOMSOLVGUI_Displayer().setColor( entries, color );
 371     } break;
 372     case Transparency   : {
 373       QStringList entries;
 374       selected ( entries, true );
 375       ATOMSOLVGUI_TransparencyDlg( getApp()->desktop(), entries ).exec();
 376     } break;
 377     default: printf( "ERROR: Action with ID = %d was not found in ATOMSOLVGUI\n", id ); break;
 378     }
 379   }
 380 }
 381
 382 // returns a custom displayer object
 383 LightApp_Displayer* ATOMSOLVGUI::displayer()
 384 {
 385   return new ATOMSOLVGUI_Displayer();
 386 }
 387
 388 // create preferences for ATOMSOLV component
 389 void ATOMSOLVGUI::createPreferences()
 390 {
 391   int tabId = addPreference( tr( "ATOMSOLV_PREFERENCES" ) );
 392   int groupId = addPreference( tr( "PRESENTATION_PREF_GROUP" ), tabId );
 393
 394   setPreferenceProperty( groupId, "columns", 1 );
 395
 396   // Representation mode preference
 397   int dispModeId = addPreference( tr( "DISPLAY_MODE_PREF" ), groupId,
 398                                   LightApp_Preferences::Selector, "ATOMSOLV", "Representation" );
 399   QList<QVariant> intDispModes;
 400   QStringList strDispModes;
 401   intDispModes.append( 0 ); strDispModes.append( tr( "MEN_POINTSMODE" ) );
 402   intDispModes.append( 1 ); strDispModes.append( tr( "MEN_WIREFRAME" ) );
 403   intDispModes.append( 2 ); strDispModes.append( tr( "MEN_SHADING" ) );
 404
 405   setPreferenceProperty( dispModeId, "strings", strDispModes );
 406   setPreferenceProperty( dispModeId, "indexes", intDispModes );
 407
 408   // Radius preference
 409   int radisusId = addPreference( tr( "RADIUS_PREF" ), groupId,
 410                                  LightApp_Preferences::DblSpin, "ATOMSOLV", "Radius" );
 411   setPreferenceProperty( radisusId, "min", .001 );
 412   setPreferenceProperty( radisusId, "max", 1000 );
 413   setPreferenceProperty( radisusId, "precision", 3 );
 414 }
 415
 416 // preferences of changed: update the corresponding values
 417 void ATOMSOLVGUI::preferencesChanged( const QString& group, const QString& param )
 418 {
 419   if ( group == "ATOMSOLV" && param == "Representation" )
 420     ATOMSOLVGUI_Displayer::setDefaultRepresentation( getApp()->resourceMgr()->integerValue( group, param ) );
 421   else if ( group == "ATOMSOLV" && param == "Radius" )
 422     ATOMSOLVGUI_Displayer::setDefaultRadius( getApp()->resourceMgr()->doubleValue( group, param ) );
 423 }
 424
 425
 426 // Export the module
 427 extern "C" {
 428   ATOMSOLVGUI_EXPORT
 429   CAM_Module* createModule()
 430   {
 431     return new ATOMSOLVGUI();
 432   }
 433   ATOMSOLVGUI_EXPORT
 434   char* getModuleVersion()
 435   {
 436     return (char*)ATOMSOLV_VERSION_STR;
 437   }
 438 }