src/HYDRO_tests/TestViewer.cxx

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #include <TestViewer.h>
  20 #include <HYDROData_Tool.h>
  21 #include <OCCViewer_ViewManager.h>
  22 #ifdef WIN32
  23   #pragma warning ( disable: 4251 )
  24 #endif
  25 #include <OCCViewer_ViewPort3d.h>
  26 #ifdef WIN32
  27   #pragma warning ( disable: 4251 )
  28 #endif
  29 #include <OCCViewer_ViewModel.h>
  30 #ifdef WIN32
  31   #pragma warning ( disable: 4251 )
  32 #endif
  33 #include <OCCViewer_ViewWindow.h>
  34 #ifdef WIN32
  35   #pragma warning ( disable: 4251 )
  36 #endif
  37 #include <AIS_Shape.hxx>
  38 #include <AIS_ColorScale.hxx>
  39 #include <Prs3d_PointAspect.hxx>
  40 #include <TopoDS_Iterator.hxx>
  41 #include <QDir>
  42 #include <QPainter>
  43 #include <QHash>
  44 #include <TopExp_Explorer.hxx>
  45 #include <TopoDS.hxx>
  46 #include <Prs3d_IsoAspect.hxx>
  47
  48 #include <GEOMUtils.hxx>
  49 #include <TopTools_ListOfShape.hxx>
  50 #include <TopTools_ListIteratorOfListOfShape.hxx>
  51
  52 #ifdef WIN32
  53   #pragma warning ( default: 4251 )
  54 #endif
  55
  56 #include <cppunit/TestAssert.h>
  57
  58 OCCViewer_ViewManager* TestViewer::myViewManager = 0;
  59 OCCViewer_ViewWindow* TestViewer::myViewWindow = 0;
  60 QString TestViewer::myKey = "";
  61
  62 OCCViewer_ViewManager* TestViewer::viewManager()
  63 {
  64   if( myViewManager )
  65     return myViewManager;
  66
  67   myViewManager = new OCCViewer_ViewManager( 0, 0 );
  68   OCCViewer_Viewer* aViewer = new OCCViewer_Viewer( true );
  69
  70   aViewer->setTrihedronSize( 100, true );
  71   aViewer->setInteractionStyle( 0 );
  72   aViewer->setZoomingStyle( 1 );
  73
  74   myViewManager->setViewModel( aViewer );
  75   myViewWindow = dynamic_cast<OCCViewer_ViewWindow*>( myViewManager->createViewWindow() );
  76
  77   return myViewManager;
  78 }
  79
  80 OCCViewer_Viewer* TestViewer::viewer()
  81 {
  82   return dynamic_cast<OCCViewer_Viewer*>( viewManager()->getViewModel() );
  83 }
  84
  85 OCCViewer_ViewWindow* TestViewer::viewWindow()
  86 {
  87   viewManager(); //to create the view if it was not created earlier
  88   return myViewWindow;
  89 }
  90
  91 Handle(AIS_InteractiveContext) TestViewer::context()
  92 {
  93   return viewer()->getAISContext();
  94 }
  95
  96 QColor TestViewer::GetColor(int i)
  97 {
  98   static QVector<QColor> aCV;
  99   if( aCV.isEmpty() )
 100   {
 101     aCV  << QColor(0,0,255)
 102          << QColor(0,255,0)
 103          << QColor(255,0,0)
 104          << QColor(255,255,20)
 105          << QColor(20,255,255)
 106          << QColor(100,100,20)
 107          << QColor(10,100,150);
 108   }
 109   if (i < aCV.size())
 110     return aCV[i];
 111   else
 112   {
 113     QColor TestColor = aCV[i % aCV.size()];
 114     QColor NewColor((TestColor.red() + i * 41) % 256,
 115       (TestColor.green() + i * 13) % 256,
 116       (TestColor.blue() + i * 23) % 256);
 117     return NewColor;
 118   }
 119 }
 120
 121 void TestViewer::eraseAll( bool isUpdate )
 122 {
 123   context()->CloseLocalContext( -1, Standard_False );
 124   context()->EraseAll( isUpdate );
 125 }
 126
 127 void TestViewer::show( const Handle(AIS_InteractiveObject)& theObject,
 128                        int theMode, int theSelectionMode, bool isFitAll, const char* theKey )
 129 {
 130   QString aNewKey = theKey;
 131   if( !aNewKey.isEmpty() )
 132   {
 133     myKey = aNewKey;
 134     eraseAll( false );
 135   }
 136
 137   if( theSelectionMode > 0 )
 138   {
 139     context()->OpenLocalContext();
 140     context()->Display( theObject, theMode, theSelectionMode );
 141     context()->Activate( theObject, theSelectionMode, Standard_True );
 142   }
 143   else
 144     context()->Display( theObject, theMode, theSelectionMode );
 145
 146   if( isFitAll )
 147   {
 148     viewWindow()->onTopView();
 149     viewWindow()->onFitAll();
 150   }
 151 }
 152
 153 void TestViewer::show( const TopoDS_Shape& theShape, int theMode, bool isFitAll, const QColor& theColor,
 154   int theUIANb, int theVIANb)
 155 {
 156   Handle(AIS_Shape) aShape = new AIS_Shape( theShape );
 157   if( theShape.ShapeType()==TopAbs_VERTEX )
 158     aShape->Attributes()->PointAspect()->SetTypeOfMarker( Aspect_TOM_X );
 159   if (theShape.ShapeType()==TopAbs_FACE)
 160   {
 161     context()->DefaultDrawer()->UIsoAspect()->SetNumber(theUIANb);
 162     context()->DefaultDrawer()->VIsoAspect()->SetNumber(theVIANb);
 163     Handle_Prs3d_Drawer aDrawer = aShape->Attributes();
 164     aDrawer->UIsoAspect()->SetNumber(theUIANb);
 165     aDrawer->VIsoAspect()->SetNumber(theVIANb);
 166   }
 167   aShape->SetMaterial( Graphic3d_NOM_PLASTIC );
 168   aShape->SetColor( HYDROData_Tool::toOccColor( theColor ) );
 169   context()->Display( aShape, theMode, 0, Standard_False );
 170
 171   if( isFitAll )
 172   {
 173     viewWindow()->onTopView();
 174     viewWindow()->onFitAll();
 175   }
 176 }
 177 void TestViewer::show( const TopoDS_Shape& theShape, int theMode, bool isFitAll, const char* theKey,
 178                        int theUIANb, int theVIANb)
 179 {
 180   QString aNewKey = theKey;
 181   if( !aNewKey.isEmpty() )
 182   {
 183     eraseAll( false );
 184     myKey = aNewKey;
 185   }
 186
 187   if( theShape.IsNull() )
 188     return;
 189
 190   int i = 0;
 191   //show all faces first
 192   TopTools_ListOfShape aListOfFaces;
 193   TopExp_Explorer aFE( theShape, TopAbs_FACE );
 194   for( ; aFE.More(); aFE.Next() )
 195     aListOfFaces.Append(aFE.Current());
 196   GEOMUtils::SortShapes(aListOfFaces);
 197   TopTools_ListIteratorOfListOfShape aLF(aListOfFaces);
 198   for( ; aLF.More(); aLF.Next(), i++)
 199     show( aLF.Value(), theMode, false, GetColor(i), theUIANb, theVIANb );
 200
 201   //show all independent wires
 202   TopTools_ListOfShape aListOfWires;
 203   TopExp_Explorer aWE( theShape, TopAbs_WIRE, TopAbs_FACE );
 204   for( ; aWE.More(); aWE.Next() )
 205     aListOfWires.Append(aWE.Current());
 206   GEOMUtils::SortShapes(aListOfWires);
 207   TopTools_ListIteratorOfListOfShape aLW(aListOfWires);
 208   for( ; aLW.More(); aLW.Next(), i++)
 209     show( aLW.Value(), theMode, false, GetColor(i) );
 210
 211   //show all independent edges
 212   TopTools_ListOfShape aListOfEdges;
 213   TopExp_Explorer anEE( theShape, TopAbs_EDGE, TopAbs_WIRE );
 214   for( ; anEE.More(); anEE.Next())
 215     aListOfEdges.Append(anEE.Current());
 216   GEOMUtils::SortShapes(aListOfEdges);
 217   TopTools_ListIteratorOfListOfShape aLE(aListOfEdges);
 218   for( ; aLE.More(); aLE.Next(), i++)
 219     show( aLE.Value(), theMode, false, GetColor(i) );
 220
 221   if( isFitAll )
 222   {
 223     viewWindow()->onTopView();
 224     viewWindow()->onFitAll();
 225   }
 226 }
 227
 228 /*void TestViewer::ShowShape(const TopoDS_Shape& theShape, int theMode, int& i)
 229 {
 230   if( theShape.ShapeType()==TopAbs_SHELL )
 231   {
 232     TopoDS_Iterator anIt( theShape );
 233     for( ; anIt.More(); anIt.Next())
 234     {
 235       show( anIt.Value(), theMode, false, GetColor(i) );
 236       i++;
 237     }
 238   }
 239   else if (theShape.ShapeType()==TopAbs_FACE ||
 240            theShape.ShapeType()==TopAbs_WIRE ||
 241            theShape.ShapeType()==TopAbs_EDGE ||
 242            theShape.ShapeType()==TopAbs_VERTEX )
 243   {
 244     show( theShape, theMode, false, GetColor(i) );
 245     i++;
 246   }
 247 }*/
 248
 249 bool AreImagesEqual( const QImage& theImage1, const QImage& theImage2, double theTolerance )
 250 {
 251   if( theImage1.isNull() || theImage2.isNull() )
 252     return theImage1.isNull() == theImage2.isNull();
 253
 254   if( theImage1.size() != theImage2.size() )
 255     return false;
 256
 257   int aBytesCount = theImage1.byteCount();
 258   const uchar *aBytes1 = theImage1.constBits();
 259   const uchar *aBytes2 = theImage2.constBits();
 260   int aBytesCountE = 0;
 261   for( int i=0; i<aBytesCount; i++ )
 262     if( aBytes1[i] != aBytes2[i] )
 263       aBytesCountE++;
 264
 265   if ((double)aBytesCountE / (double)aBytesCount > theTolerance)
 266     return false;
 267
 268   return true;
 269 }
 270
 271 bool TestViewer::AssertImages( QString& theMessage, const QImage* theImage, const char* theCase )
 272 {
 273   QImage anActualImage;
 274   if( theImage )
 275     anActualImage = *theImage;
 276   else
 277     anActualImage = viewWindow()->dumpView();
 278
 279   const bool SWAP_RGB_ORDER = true;
 280   if( SWAP_RGB_ORDER )
 281   {
 282     // A temporary patch for bug in SALOME/OCC dump; the result image contains swapped RGB colors
 283     anActualImage = anActualImage.rgbSwapped();
 284   }
 285
 286
 287   if( theCase )
 288     myKey = theCase;
 289
 290   QString anExpectedRefFilePath = qgetenv( "HYDRO_ROOT_DIR" ) + "/bin/salome/test/HYDRO";
 291   anExpectedRefFilePath += "/" + myKey + ".png";
 292   QImage anExpectedRefImage;
 293   anExpectedRefImage.load( anExpectedRefFilePath );
 294
 295   if( AreImagesEqual( anActualImage, anExpectedRefImage, 0.001 ) )
 296   {
 297     theMessage = "";
 298     return true;
 299   }
 300
 301   QString aPath = QDir::tempPath() + "/" + myKey + ".png";
 302   anActualImage.save( aPath );
 303   //std::cout << anActualImage.width() << "x" << anActualImage.height() << std::endl;
 304   theMessage = "The viewer contents does not correspond to the reference image: " + myKey;
 305
 306   QImage aDiff( anExpectedRefImage.width(), anExpectedRefImage.height(), QImage::Format_ARGB32 );
 307   QPainter aPainter( &aDiff );
 308   aPainter.drawImage( 0, 0, anExpectedRefImage );
 309   aPainter.setCompositionMode( QPainter::RasterOp_SourceXorDestination );
 310   aPainter.drawImage( 0, 0, anActualImage );
 311
 312   QString aDiffFilePath = QDir::tempPath() + "/" + myKey + "_diff.png";
 313   aDiff.save( aDiffFilePath );
 314
 315   anExpectedRefImage.save( QDir::tempPath() + "/" + myKey + "_1.png");
 316
 317   return false;
 318 }
 319
 320 Handle(AIS_ColorScale) TestViewer::colorScale()
 321 {
 322   static Handle(AIS_ColorScale) aColorScale = new AIS_ColorScale();
 323
 324   return aColorScale;
 325 }
 326
 327 void TestViewer::showColorScale( bool isShow )
 328 {
 329   Handle(AIS_ColorScale) aColorScale = colorScale();
 330   if( aColorScale.IsNull() )
 331     return;
 332
 333   Standard_Real anXPos = 0.05;
 334   Standard_Real anYPos = 0.1;
 335   Standard_Real aWidth = 0.2;
 336   Standard_Real aHeight = 0.5;
 337   Standard_Integer aTextHeight = 14;
 338   Standard_Integer aNbIntervals = 30;
 339
 340   aColorScale->SetXPosition( anXPos );
 341   aColorScale->SetYPosition( anYPos );
 342   aColorScale->SetWidth( aWidth );
 343   aColorScale->SetHeight( aHeight );
 344   aColorScale->SetTextHeight( aTextHeight );
 345   aColorScale->SetNumberOfIntervals( aNbIntervals );
 346
 347   aColorScale->SetTitle( "test" );
 348   aColorScale->SetRange( 0, 1 );
 349
 350   aColorScale->SetToUpdate();
 351
 352   if( isShow )
 353   {
 354     if( !context()->IsDisplayed( aColorScale ) )
 355       context()->Display( aColorScale );
 356   }
 357   else
 358   {
 359     if( context()->IsDisplayed( aColorScale ) )
 360       context()->Erase( aColorScale );
 361   }
 362 }
 363
 364 bool TestViewer::ColorScaleIsDisplayed()
 365 {
 366   return context()->IsDisplayed( colorScale() );
 367 }
 368
 369 void TestViewer::select( int theViewX, int theViewY )
 370 {
 371   Handle(V3d_View) aView = myViewWindow->getViewPort()->getView();
 372   context()->MoveTo( theViewX, theViewY, aView );
 373   context()->Select();
 374 }
 375
 376 QString GetLine( QFile& theFile, bool isUtf8 )
 377 {
 378   QByteArray aLineData = theFile.readLine();
 379   QString aLine;
 380   if( isUtf8 )
 381     aLine = QString::fromUtf8( aLineData );
 382   else
 383     aLine = aLineData;
 384   return aLine;
 385 }
 386
 387 bool TestViewer::areScriptsEqual( const QString& theBaseName,
 388                                   bool isExpectedUtf8,
 389                                   bool isActualUtf8,
 390                                   int theLinesToOmit,
 391                                   QString& theMsg )
 392 {
 393   QString anExpectedRefFilePath = qgetenv( "HYDRO_ROOT_DIR" ) + "/bin/salome/test/HYDRO";
 394   anExpectedRefFilePath += "/" + theBaseName;
 395
 396   QString anActualFilePath = QDir::tempPath() + "/" + theBaseName;
 397
 398   QFile anExpected( anExpectedRefFilePath );
 399   QFile anActual( anActualFilePath );
 400   if( !anExpected.open( QFile::ReadOnly | QFile::Text ) ||
 401       !anActual.open  ( QFile::ReadOnly | QFile::Text ) )
 402     return false;
 403
 404   for( int i=0; i<theLinesToOmit; i++ )
 405     anExpected.readLine();
 406
 407   bool isEqual = true;
 408   int i = 1;
 409   while( !anExpected.atEnd() && isEqual )
 410   {
 411     QString anExpectedLine = GetLine( anExpected, isExpectedUtf8 );
 412     QString anActualLine = GetLine( anActual, isActualUtf8 );
 413     isEqual = anExpectedLine == anActualLine;
 414     if( !isEqual )
 415       theMsg = QString( "line %1\nActual: %2\nExpected: %3" ).arg( i ).arg( anActualLine ).arg( anExpectedLine );
 416     i++;
 417   }
 418
 419   if( isEqual )
 420     isEqual = anActual.atEnd();
 421
 422   anExpected.close();
 423   anActual.close();
 424
 425   return isEqual;
 426 }
 427
 428 void TestViewer::setKey( const QString& theKey )
 429 {
 430   myKey = theKey;
 431 }