src/HYDROGUI/HYDROGUI_VTKPrsDisplayer.cxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #include "HYDROGUI_VTKPrsDisplayer.h"
  24
  25 #include "HYDROGUI_DataModel.h"
  26 #include "HYDROGUI_Module.h"
  27 #include "HYDROGUI_VTKPrs.h"
  28 #include "HYDROGUI_VTKPrsBathymetryDriver.h"
  29 #include "HYDROGUI_VTKPrsShapeDriver.h"
  30 #include "HYDROGUI_Tool.h"
  31
  32 #include "HYDROData_Tool.h"
  33 #include <SVTK_ViewModel.h>
  34 #include <SVTK_ViewWindow.h>
  35 #include <SALOME_ListIO.hxx>
  36 #include <SALOME_ListIteratorOfListIO.hxx>
  37 #include <SALOME_InteractiveObject.hxx>
  38 #include <SUIT_ViewManager.h>
  39 #include <SUIT_Accel.h>
  40
  41 #include <vtkLookupTable.h>
  42 #include <vtkRenderer.h>
  43 #include <vtkTextProperty.h>
  44 #include <vtkWindow.h>
  45 #include <vtkActor2DCollection.h>
  46
  47 #include <QVector>
  48
  49 #define NB_COLORS 32
  50
  51 // Saturation of blue
  52 //#define HUE_START 0.69
  53 //#define HUE_END   0.41
  54 //#define SATURATION_START 1.0
  55 //#define SATURATION_END   0.4
  56
  57 #define HUE_START 0.7
  58 #define HUE_END   0.0
  59 #define SATURATION_START 1.0
  60 #define SATURATION_END   1.0
  61
  62 HYDROGUI_VTKPrsDisplayer::HYDROGUI_VTKPrsDisplayer( HYDROGUI_Module* theModule )
  63 : HYDROGUI_AbstractDisplayer( theModule ), myDriver( NULL ), myShapeDriver( NULL )
  64 {
  65 }
  66
  67 HYDROGUI_VTKPrsDisplayer::~HYDROGUI_VTKPrsDisplayer()
  68 {
  69 }
  70
  71 void HYDROGUI_VTKPrsDisplayer::SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
  72                                       const int theViewerId )
  73 {
  74   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
  75   if( !aViewer )
  76   {
  77     HYDROGUI_VTKPrs* anObjShape;
  78     for ( int i = 1, n = theObjs.Length(); i <= n; i++ )
  79     {
  80       Handle(HYDROData_Entity) anObj = theObjs.Value( i );
  81       if( !anObj.IsNull() )
  82       {
  83         anObjShape = module()->getObjectVTKPrs( (size_t)aViewer, anObj );
  84         if ( anObjShape )
  85         {
  86           anObjShape->setIsToUpdate( true );
  87         }
  88       }
  89     }
  90   }
  91 }
  92
  93 void HYDROGUI_VTKPrsDisplayer::EraseAll( const int theViewerId )
  94 {
  95   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
  96   if( aViewer )
  97   {
  98     aViewer->EraseAll( true );
  99     module()->removeViewVTKPrs( (size_t)aViewer );
 100     EraseScalarBar( theViewerId );
 101   }
 102 }
 103
 104 void HYDROGUI_VTKPrsDisplayer::EraseScalarBar( const int theViewerId, const bool theIsDelete )
 105 {
 106   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
 107   if( aViewer )
 108   {
 109     if ( myScalarBars.contains( (size_t)aViewer ) )
 110     {
 111       SUIT_ViewManager* aViewMgr = dynamic_cast<SUIT_ViewManager*>( aViewer->getViewManager() );
 112       if ( aViewMgr && aViewMgr->getViewsCount() > 0 )
 113       {
 114         SVTK_ViewWindow* aView = dynamic_cast<SVTK_ViewWindow*>( aViewMgr->getActiveView() );
 115         if ( aView )
 116         {
 117           vtkScalarBarActor* aScalarBar = myScalarBars[ (size_t)aViewer ];
 118           if ( aView->getRenderer()->HasViewProp( aScalarBar ) )
 119           {
 120             aView->getRenderer()->RemoveActor2D( aScalarBar );
 121           }
 122         }
 123       }
 124       if ( theIsDelete )
 125       {
 126         myScalarBars.remove( (size_t)aViewer );
 127       }
 128     }
 129   }
 130 }
 131
 132 void HYDROGUI_VTKPrsDisplayer::Erase( const HYDROData_SequenceOfObjects& theObjs,
 133                                 const int theViewerId )
 134 {
 135   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
 136   if( aViewer )
 137   {
 138     HYDROGUI_VTKPrs* aPrs;
 139     for ( int i = 1, n = theObjs.Length(); i <= n; i++ )
 140     {
 141       Handle(HYDROData_Entity) anObj = theObjs.Value( i );
 142       if( anObj.IsNull() )
 143         continue;
 144
 145       aPrs = module()->getObjectVTKPrs( (size_t)aViewer, anObj );
 146       if ( aPrs )
 147       {
 148         aViewer->Erase( aPrs, true );
 149       }
 150       if ( anObj->IsRemoved() )
 151       {
 152         module()->removeObjectVTKPrs( (size_t)aViewer, anObj );
 153       }
 154     }
 155   }
 156 }
 157
 158 void HYDROGUI_VTKPrsDisplayer::Display( const HYDROData_SequenceOfObjects& theObjs,
 159                                         const int theViewerId,
 160                                         const bool theIsForced,
 161                                         const bool theDoFitAll)
 162 {
 163   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
 164   if( aViewer )
 165   {
 166     // Hide colors legend bar
 167     SVTK_ViewWindow* aView = dynamic_cast<SVTK_ViewWindow*>(
 168       aViewer->getViewManager()->getActiveView() );
 169     vtkScalarBarActor* aScalarBar = 0;
 170     if ( aView )
 171     {
 172       if ( !myScalarBars.contains( (size_t)aViewer ) )
 173       {
 174         createScalarBar( (size_t)aViewer );
 175       }
 176       aScalarBar = myScalarBars[ (size_t)aViewer ];
 177
 178       if ( aView->getRenderer()->HasViewProp( aScalarBar ) )
 179       {
 180         aView->getRenderer()->RemoveActor2D( aScalarBar );
 181       }
 182     }
 183
 184     // Invalidate global Z range
 185     double anInvalidRange[2] = { HYDROGUI_VTKPrs::InvalidZValue(), HYDROGUI_VTKPrs::InvalidZValue() };
 186     SetZRange( (size_t)aViewer, anInvalidRange );
 187
 188     int anInvalidZ = HYDROGUI_VTKPrs::InvalidZValue();
 189     bool isChanged = false;
 190     bool isScalarBarNeeded = false;
 191     HYDROGUI_VTKPrs* aPrs;
 192     for ( int i = 1, n = theObjs.Length(); i <= n; i++ )
 193     {
 194       Handle(HYDROData_Entity) anObj = theObjs.Value( i );
 195       if( !anObj.IsNull() )
 196       {
 197         bool anIsVisible = module()->isObjectVisible( (size_t)aViewer, anObj );
 198         aPrs = module()->getObjectVTKPrs( (size_t)aViewer, anObj );
 199
 200         bool anIsInserted = ( aPrs != 0 );
 201         if( anIsVisible && ( !aPrs || aPrs->getIsToUpdate() || theIsForced ) )
 202         {
 203           if( HYDROGUI_VTKPrsDriver* aDriver = getDriver( (size_t)aViewer, anObj ) )
 204           {
 205             if( aDriver->Update( anObj, aPrs ) && aPrs && !anIsInserted )
 206             {
 207               module()->setObjectVTKPrs( (size_t)aViewer, anObj, aPrs );
 208             }
 209           }
 210         }
 211
 212         if( aPrs )
 213         {
 214           if ( anIsVisible )
 215           {
 216             if ( aPrs->needScalarBar() )
 217             {
 218               // Extend the global Z range if necessary
 219               double* aGlobalRange = GetZRange( (size_t)aViewer );
 220               double* aRange = aPrs->getInternalZRange();
 221               bool anIsUpdate = false;
 222               if ( aRange[0] < aGlobalRange[0] || ValuesEquals( aGlobalRange[0], anInvalidZ ) )
 223               {
 224                 aGlobalRange[0] = aRange[0];
 225                 anIsUpdate = true;
 226               }
 227               if ( aRange[1] > aGlobalRange[1] || ValuesEquals( aGlobalRange[1], anInvalidZ ) )
 228               {
 229                 aGlobalRange[1] = aRange[1];
 230                 anIsUpdate = true;
 231               }
 232
 233               if ( anIsUpdate )
 234               {
 235                 module()->updateVTKZRange( (size_t)aViewer, aGlobalRange );
 236               }
 237             }
 238
 239             aViewer->Display( aPrs );
 240             isScalarBarNeeded = isScalarBarNeeded || aPrs->needScalarBar();
 241
 242           }
 243           else
 244           {
 245             aViewer->Erase( aPrs );
 246           }
 247           isChanged = true;
 248         }
 249       }
 250     }
 251
 252     if ( aView )
 253     {
 254       if ( isChanged && isScalarBarNeeded && aScalarBar )
 255       {
 256         // Show colors legend bar
 257           aView->getRenderer()->AddActor2D( aScalarBar );
 258       }
 259
 260       // Refresh the view
 261       if ( theDoFitAll )
 262       {
 263         // Repaint is done inside OnFitAll()
 264         aView->onAccelAction( SUIT_Accel::ZoomFit );
 265       }
 266       else if ( isChanged )
 267       {
 268         aView->Repaint();
 269       }
 270     }
 271   }
 272 }
 273
 274 void HYDROGUI_VTKPrsDisplayer::purgeObjects( const int theViewerId )
 275 {
 276   SVTK_Viewer* aViewer = module()->getVTKViewer( theViewerId );
 277   if( aViewer )
 278   {
 279     SALOME_ListIO aListIO;
 280     aViewer->GetVisible( aListIO );
 281
 282     HYDROGUI_VTKPrs* aPrs;
 283     SALOME_ListIteratorOfListIO anIter( aListIO );
 284     for( ; anIter.More(); anIter.Next() )
 285     {
 286       Handle(SALOME_InteractiveObject) aPrsObj = anIter.Value();
 287       if ( !aPrsObj.IsNull() )
 288       {
 289         Handle(HYDROData_Entity) anOwnerObj =
 290           module()->getDataModel()->objectByEntry( aPrsObj->getEntry() );
 291         if ( !anOwnerObj.IsNull() && anOwnerObj->IsRemoved() )
 292         {
 293           aPrs = module()->getObjectVTKPrs( (size_t)aViewer, anOwnerObj );
 294           if ( aPrs )
 295           {
 296             aViewer->Erase( aPrs );
 297           }
 298           module()->removeObjectVTKPrs( (size_t)aViewer, anOwnerObj );
 299         }
 300       }
 301     }
 302   }
 303 }
 304
 305 HYDROGUI_VTKPrsDriver* HYDROGUI_VTKPrsDisplayer::getDriver( const int theViewId, const Handle(HYDROData_Entity)& theObj )
 306 {
 307   HYDROGUI_VTKPrsDriver* aDriver = NULL;
 308   ObjectKind aKind = theObj->GetKind();
 309   if( theObj->GetKind() == KIND_BATHYMETRY )
 310   {
 311     if ( !myDriver )
 312     {
 313       myDriver = new HYDROGUI_VTKPrsBathymetryDriver( myScalarBars[ theViewId ] );
 314     }
 315     aDriver = myDriver;
 316   }
 317   else
 318   {
 319     if ( !myShapeDriver )
 320     {
 321       myShapeDriver = new HYDROGUI_VTKPrsShapeDriver( myScalarBars[ theViewId ] );
 322     }
 323     aDriver = myShapeDriver;
 324   }
 325
 326   return aDriver;
 327 }
 328
 329 QString HYDROGUI_VTKPrsDisplayer::GetType() const
 330 {
 331   return SVTK_Viewer::Type();
 332 }
 333
 334 void HYDROGUI_VTKPrsDisplayer::SetZRange( const int theViewId, double theRange[] )
 335 {
 336   myScalarBars[ theViewId ]->GetLookupTable()->SetRange( theRange );
 337 }
 338
 339 double* HYDROGUI_VTKPrsDisplayer::GetZRange( const int theViewId ) const
 340 {
 341   return myScalarBars[ theViewId ]->GetLookupTable()->GetRange();
 342 }
 343
 344 void HYDROGUI_VTKPrsDisplayer::createScalarBar( const int theViewId )
 345 {
 346   if ( !myScalarBars.contains( theViewId ) )
 347   {
 348     // The invalid value is used to identify the case when the table range is not initialized yet.
 349     double anInvalidValue = HYDROGUI_VTKPrs::InvalidZValue();
 350     vtkLookupTable* aTable = vtkLookupTable::New();
 351     aTable->SetHueRange( HUE_START, HUE_END );
 352     aTable->SetSaturationRange( SATURATION_START, SATURATION_END );
 353     aTable->SetTableRange( anInvalidValue, anInvalidValue );
 354     aTable->SetValueRange( 1.0, 1.0 );
 355     aTable->SetAlphaRange( 1.0, 1.0 );
 356     aTable->SetNumberOfColors( NB_COLORS );
 357     aTable->Build();
 358     vtkSmartPointer<vtkScalarBarActor> aScalarBar = vtkScalarBarActor::New();
 359     aScalarBar->SetLookupTable( aTable );
 360     aScalarBar->SetNumberOfLabels( NB_COLORS * 0.75 );
 361     aScalarBar->SetWidth( aScalarBar->GetWidth() / 1.5 );
 362     aScalarBar->SetTextureGridWidth( aScalarBar->GetTextureGridWidth() * 4. );
 363     aTable->Delete();
 364     myScalarBars.insert( theViewId, aScalarBar );
 365   }
 366 }