Salome HOME
refs #716: blinking land cover map on show/hide other objects
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_OCCDisplayer.cxx
index 51dfa2f38e6a04d08a3132b10cae89a69c08e8d2..b7505b0c0d19a980056972e8ba9df22c9b1ffa2a 100644 (file)
@@ -1,12 +1,8 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
-//
-// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-//
+// Copyright (C) 2014-2015  EDF-R&D
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 #include "HYDROGUI_DataModel.h"
 #include "HYDROGUI_Module.h"
-#include "HYDROGUI_Tool.h"
-#include "HYDROGUI_Shape.h"
+#include "HYDROGUI_Tool2.h"
+#include <HYDROGUI_ShapeImage.h>
+#include <HYDROGUI_ShapeBathymetry.h>
+#include <HYDROGUI_ShapeLandCoverMap.h>
+#include "HYDROGUI_Operation.h"
+#include "HYDROGUI_DataObject.h"
+#include "HYDROGUI_ZLayers.h"
+
+#include <HYDROData_Bathymetry.h>
+#include <HYDROData_Image.h>
+#include <HYDROData_LandCoverMap.h>
+#include <HYDROData_StricklerTable.h>
 
 #include <AIS_InteractiveContext.hxx>
 #include <AIS_ListIteratorOfListOfInteractive.hxx>
 #include <AIS_ListOfInteractive.hxx>
 
+#include <Aspect_ColorScale.hxx>
+
+#include <TColStd_SequenceOfInteger.hxx>
+
+#include <LightApp_Application.h>
+#include <SUIT_Study.h>
+
 #include <OCCViewer_ViewManager.h>
 #include <OCCViewer_ViewModel.h>
 #include <OCCViewer_ViewWindow.h>
+#include <OCCViewer_ViewPort3d.h>
 
 HYDROGUI_OCCDisplayer::HYDROGUI_OCCDisplayer( HYDROGUI_Module* theModule )
 : HYDROGUI_AbstractDisplayer( theModule )
 {
+  myToUpdateColorScale = false;
 }
 
 HYDROGUI_OCCDisplayer::~HYDROGUI_OCCDisplayer()
@@ -65,6 +80,46 @@ void HYDROGUI_OCCDisplayer::SetToUpdate( const HYDROData_SequenceOfObjects& theO
   }
 }
 
+int HYDROGUI_OCCDisplayer::AddPreviewZLayer( OCCViewer_ViewManager* theMgr )
+{
+  int aLayer = -1;
+  OCCViewer_Viewer* aViewer = theMgr->getOCCViewer();
+  if ( !aViewer )
+    return aLayer;
+
+  aLayer = CreateTopZLayer( aViewer->getViewer3d() );
+  
+  // Hilight presentation should be on top
+  Handle(AIS_InteractiveContext) aCtx = aViewer->getAISContext();
+  if( !aCtx.IsNull() ) {
+    int aTopLayer = CreateTopZLayer( aViewer->getViewer3d() );
+    if ( aTopLayer > 0 ) {
+      UpdateZLayersOfHilightPresentationsOfDisplayedObjects( aCtx, aTopLayer );
+    }
+  }
+
+  return aLayer;
+}
+
+void HYDROGUI_OCCDisplayer::RemoveZLayer( OCCViewer_ViewManager* theMgr,
+                                          const int theLayer )
+{
+  if ( theLayer < 0 )
+    return;
+
+  OCCViewer_Viewer* aViewer = theMgr->getOCCViewer();
+  if ( !aViewer )
+    return;
+
+  // Get existing Z layers
+  TColStd_SequenceOfInteger anExistingZLayers;
+  aViewer->getViewer3d()->GetAllZLayers( anExistingZLayers );
+  int aNbLayers = anExistingZLayers.Length();
+  
+  if ( theLayer < aNbLayers )
+    aViewer->getViewer3d()->RemoveZLayer( theLayer );
+}
+
 void HYDROGUI_OCCDisplayer::EraseAll( const int theViewerId )
 {
   OCCViewer_Viewer* aViewer = module()->getOCCViewer( theViewerId );
@@ -72,6 +127,7 @@ void HYDROGUI_OCCDisplayer::EraseAll( const int theViewerId )
     return;
 
   module()->removeViewShapes( (size_t)aViewer );
+  UpdateColorScale( aViewer );
 }
 
 void HYDROGUI_OCCDisplayer::Erase( const HYDROData_SequenceOfObjects& theObjs,
@@ -89,6 +145,10 @@ void HYDROGUI_OCCDisplayer::Erase( const HYDROData_SequenceOfObjects& theObjs,
 
     module()->removeObjectShape( (size_t)aViewer, anObj );
   }
+  aViewer->update();
+  if ( !module()->isLandCoversScalarMapModeOn( (size_t)aViewer ) ) {
+    UpdateColorScale( aViewer );
+  }
 }
 
 HYDROGUI_Shape* HYDROGUI_OCCDisplayer::createShape( const int                             theViewerId,
@@ -99,17 +159,20 @@ HYDROGUI_Shape* HYDROGUI_OCCDisplayer::createShape( const int
   if ( theContext.IsNull() || theObject.IsNull() )
     return aResShape;
 
-  ObjectKind anObjectKind = theObject->GetKind();
-  if ( anObjectKind != KIND_IMAGE &&
-       anObjectKind != KIND_POLYLINEXY &&
-       anObjectKind != KIND_IMMERSIBLE_ZONE &&
-       anObjectKind != KIND_REGION &&
-       anObjectKind != KIND_ZONE &&
-       anObjectKind != KIND_OBSTACLE &&
-       anObjectKind != KIND_PROFILE )
+  if ( !HYDROGUI_Tool::IsObjectHasPresentation( theObject, OCCViewer_Viewer::Type() ) )
     return aResShape;
 
-  aResShape = new HYDROGUI_Shape( theContext, theObject );
+  if( theObject->IsKind( STANDARD_TYPE( HYDROData_Image ) ) )
+    aResShape = new HYDROGUI_ShapeImage( theContext, Handle_HYDROData_Image::DownCast( theObject ) );
+  else if( theObject->IsKind( STANDARD_TYPE( HYDROData_Bathymetry ) ) )
+    aResShape = new HYDROGUI_ShapeBathymetry( this, theContext, Handle_HYDROData_Bathymetry::DownCast( theObject ) );
+  else if( theObject->IsKind( STANDARD_TYPE( HYDROData_LandCoverMap ) ) ) {
+    bool isScalarMode = module()->isLandCoversScalarMapModeOn( theViewerId );
+    aResShape = new HYDROGUI_ShapeLandCoverMap( this, theContext, Handle_HYDROData_LandCoverMap::DownCast( theObject ), -1, isScalarMode );
+  }
+  else
+    aResShape = new HYDROGUI_Shape( theContext, theObject );
+
   module()->setObjectShape( theViewerId, theObject, aResShape );
 
   return aResShape;
@@ -120,52 +183,121 @@ void HYDROGUI_OCCDisplayer::Display( const HYDROData_SequenceOfObjects& theObjs,
                                      const bool                         theIsForced,
                                      const bool theDoFitAll )
 {
+  // Get OCC viewer by id
   OCCViewer_Viewer* aViewer = module()->getOCCViewer( theViewerId );
   if( !aViewer )
     return;
 
+  // Get interactive context
   Handle(AIS_InteractiveContext) aCtx = aViewer->getAISContext();
   if( aCtx.IsNull() )
     return;
 
-  for ( int i = 1, n = theObjs.Length(); i <= n; i++ )
-  {
-    Handle(HYDROData_Entity) anObj = theObjs.Value( i );
-    if ( anObj.IsNull() || anObj->IsRemoved() )
-      continue;
-
-    HYDROGUI_Shape* anObjShape = module()->getObjectShape( (size_t)aViewer, anObj );
-
-    if ( !anObjShape || anObjShape->getIsToUpdate() || theIsForced )
-    {
-      if ( !anObjShape )
-        anObjShape = createShape( (size_t)aViewer, aCtx, anObj );
+  // Get the document
+  Handle(HYDROData_Document) aDoc = HYDROData_Document::Document( module()->getStudyId() );
+  if ( !aDoc )
+    return;
+  
+  // Assign Z layer indexes to the objects
+  aDoc->Show( theObjs );
+
+  // Sort objects by display order ( needed for Z layers assignment only )
+  HYDROData_SequenceOfObjects anUnorderedToDisplay = theObjs;
+  HYDROData_SequenceOfObjects anOrderedToDisplay;
+  HYDROData_SequenceOfObjects anAllOrderedObjects = aDoc->GetObjectsLayerOrder();
+
+  HYDROData_SequenceOfObjects::Iterator anAllOrderedIter( anAllOrderedObjects );
+  for ( ; anAllOrderedIter.More(); anAllOrderedIter.Next() ) {
+    QString anOrderedEntry = 
+      HYDROGUI_DataObject::dataObjectEntry( anAllOrderedIter.Value() );
+    
+    HYDROData_SequenceOfObjects::Iterator aToDisplayIter( anUnorderedToDisplay );
+    for ( ; aToDisplayIter.More(); aToDisplayIter.Next() ) {
+      Handle(HYDROData_Entity) anObjToDisplay = aToDisplayIter.Value();
+      QString anEntry = HYDROGUI_DataObject::dataObjectEntry( anObjToDisplay );
+      if ( anEntry == anOrderedEntry ) {
+        anOrderedToDisplay.Prepend( anObjToDisplay );
+        anUnorderedToDisplay.Remove( aToDisplayIter );
+        break;
+      }
+    }
+  }
+  
+  // Get 3d viewer
+  Handle(V3d_Viewer) aViewer3d = aViewer->getViewer3d();
+
+  // Display objects:
+  HYDROGUI_ZLayersIterator aZLayersIt( aViewer->getViewer3d() );
+  if ( !aZLayersIt.More() ) {
+    aZLayersIt.Next();
+  }
 
-      if ( anObjShape )
-        anObjShape->update( false );
+  // 1. Display the ordered objects:
+  HYDROData_SequenceOfObjects::Iterator anOrderedIter( anOrderedToDisplay );
+  for ( ; anOrderedIter.More(); anOrderedIter.Next() ) {
+    Handle(HYDROData_Entity) anObj = anOrderedIter.Value();
+    if ( Display( anObj, aViewer, theIsForced ) ) {
+      // set Z layer ( one Z layer for each ordered object )
+      int aZLayerId = aZLayersIt.LayerId();
+      SetZLayer( aViewer, anObj, aZLayerId );
+      SetZLayerSettings( aViewer3d, aZLayerId, true );
+      aZLayersIt.Next();
     }
+  }
 
-    if ( anObjShape )
-    {
-      bool anIsVisible = module()->isObjectVisible( (size_t)aViewer, anObj );
-      anObjShape->setVisible( anIsVisible, false );
+  // 2. Display the unordered objects:
+  bool isDisplayed = false;
+  int anUnorderedZLayerId = aZLayersIt.LayerId();
+  HYDROData_SequenceOfObjects::Iterator anUnorderedIter( anUnorderedToDisplay );
+  for ( ; anUnorderedIter.More(); anUnorderedIter.Next() ) {
+    Handle(HYDROData_Entity) anObj = anUnorderedIter.Value();
+    if ( Display( anObj, aViewer, theIsForced) ) {
+      // set Z layer ( one Z layer for all unordered objects )
+      SetZLayer( aViewer, anObj, anUnorderedZLayerId );
+      if ( !isDisplayed ) {
+        SetZLayerSettings( aViewer3d, anUnorderedZLayerId, false );
+      }
+      isDisplayed = true;
     }
   }
+  
+  // 3. Update the top Z layer index
+  if ( isDisplayed ) {
+    aZLayersIt.Next();
+  }
 
-  if ( theDoFitAll )
-  {
+  // Update Z layer of the active operation
+  int aPreviewZLayerId = aZLayersIt.LayerId();
+
+  HYDROGUI_Module* aModule = module();
+  SUIT_Operation* anOp = aModule->activeOperation();
+  HYDROGUI_Operation* aHOp = anOp ? dynamic_cast<HYDROGUI_Operation*>( anOp ) : 0;
+  if ( aHOp && aHOp->getPreviewZLayer() >= 0 ) {
+    aHOp->updatePreviewZLayer( aPreviewZLayerId );
+    aZLayersIt.Next();
+  }
+
+  // Update Z layer of hilight presentations
+  int aHilightLayer = aZLayersIt.TopLayer();
+  UpdateZLayersOfHilightPresentationsOfDisplayedObjects( aCtx, aHilightLayer );
+
+  // Fit all / update selection
+  if ( theDoFitAll ) {
     OCCViewer_ViewManager* aViewManager
       = ::qobject_cast<OCCViewer_ViewManager*>( aViewer->getViewManager() );
-    if ( aViewManager )
-    {
+    if ( aViewManager ) {
       OCCViewer_ViewWindow* aViewWindow = 
         ::qobject_cast<OCCViewer_ViewWindow*>( aViewManager->getActiveView() );
-      if ( aViewWindow )
-      {
+      if ( aViewWindow ) {
         aViewWindow->onFitAll();
       }
     }
+  } 
+  else if ( !aCtx.IsNull() ) { // TODO: determine if this code is necessary (added as a fix for issue# 359)
+    aCtx->UpdateSelected();
   }
+
+  UpdateColorScale( aViewer );
 }
 
 void HYDROGUI_OCCDisplayer::purgeObjects( const int theViewerId )
@@ -199,3 +331,198 @@ QString HYDROGUI_OCCDisplayer::GetType() const
 {
   return OCCViewer_Viewer::Type();
 }
+
+bool HYDROGUI_OCCDisplayer::Display( const Handle(HYDROData_Entity)& theObject,
+                                     const OCCViewer_Viewer* theViewer,
+                                     const bool theIsForced )
+{
+  bool aRes = false;
+
+  if ( theObject.IsNull() || theObject->IsRemoved() || !theViewer ) {
+    return aRes;
+  }
+
+  // Get interactive context
+  Handle(AIS_InteractiveContext) aCtx = theViewer->getAISContext();
+  if( aCtx.IsNull() ) {
+    return aRes;
+  }
+
+  // Viewer id
+  size_t aViewerId = (size_t)theViewer;
+
+  // Object shape 
+  HYDROGUI_Shape* anObjShape = module()->getObjectShape( aViewerId, theObject );
+  // create if needed
+  if ( !anObjShape ) {
+    anObjShape = createShape( aViewerId, aCtx, theObject );
+    if ( anObjShape ) {
+      anObjShape->setIsToUpdate( true );
+    }
+  }
+  
+  // Process the shape
+  if ( anObjShape ) {
+    // update if needed
+    if ( anObjShape->getIsToUpdate() || theIsForced ) {
+      anObjShape->update( false, false );
+    }
+
+    // Set visibility
+    bool anIsVisible = module()->isObjectVisible( aViewerId, theObject );
+    anObjShape->setVisible( anIsVisible, false );
+
+    aRes = true;
+  }
+
+  return aRes;
+}
+
+void HYDROGUI_OCCDisplayer::SetZLayer( const OCCViewer_Viewer* theViewer,
+                                       const Handle(HYDROData_Entity)& theObject, 
+                                       const int theZLayerId )
+{
+  if ( !theViewer /*|| ( theZLayerId < 0 )*/ ) {
+    return;
+  }
+  
+  // Get interactive context
+  Handle(AIS_InteractiveContext) aCtx = theViewer->getAISContext();
+  if( aCtx.IsNull() ) {
+    return;
+  }
+
+  // Get viewer id
+  size_t aViewerId = (size_t)theViewer;
+
+  // Get object shape 
+  HYDROGUI_Shape* anObjShape = module()->getObjectShape( aViewerId, theObject );
+
+  // Set Z layer
+  if ( anObjShape ) {
+    aCtx->SetZLayer( anObjShape->getAISObject(), theZLayerId );
+  }
+}
+
+void HYDROGUI_OCCDisplayer::SetToUpdateColorScale()
+{
+  myToUpdateColorScale = true;
+}
+
+void HYDROGUI_OCCDisplayer::UpdateColorScale( const OCCViewer_Viewer* theViewer )
+{
+  if( !myToUpdateColorScale || !theViewer )
+    return;
+  
+  OCCViewer_ViewWindow* aWnd = dynamic_cast<OCCViewer_ViewWindow*>( theViewer->getViewManager()->getActiveView() );
+  Handle(V3d_View) aView = aWnd->getViewPort()->getView();
+      
+  int aViewerId = (size_t)theViewer;//TODO: check if viewer id is correct
+  bool isLandCoverColoringOn = module()->isLandCoversScalarMapModeOn( aViewerId );
+    
+  QList<HYDROGUI_Shape*> aLandCoverMapShapes = module()->getObjectShapes( aViewerId, KIND_LAND_COVER_MAP );
+  QList<HYDROGUI_Shape*> aBathShapes = module()->getObjectShapes( aViewerId, KIND_BATHYMETRY );
+
+  bool isDisplayColorScale = !aBathShapes.empty() || isLandCoverColoringOn;
+  Standard_Real anXPos = 0.05; //TODO
+  Standard_Real anYPos = 0.1; //TODO
+  Standard_Real aWidth = 0.2; //TODO
+  Standard_Real aHeight = 0.5; //TODO
+  Standard_Integer aTextHeight = 14; //TODO
+  Standard_Integer aNbIntervals = 20; //TODO
+  TCollection_ExtendedString aColorScaleTitle = "";//TODO
+
+  Standard_Real aColorScaleMin = 0, aColorScaleMax = 1;
+
+  // Get range
+  Handle(HYDROData_StricklerTable) aTable;
+  QStringList aTableTypes;
+  if ( isLandCoverColoringOn ) {
+    aTable = module()->getLandCoverColoringTable( aViewerId );
+    if ( !aTable.IsNull() ) {
+      // TODO: non-empty title leads to buggy behaviour
+      // aColorScaleTitle = TCollection_ExtendedString( aTable->GetName().toLatin1().constData() );
+      aTable->GetCoefficientRange( aColorScaleMin, aColorScaleMax );
+      aTableTypes = aTable->GetTypes();
+    }
+  } else {
+    Standard_Real aMin, aMax;
+    bool isFirst = true;
+    foreach( HYDROGUI_Shape* aShape, aBathShapes )
+    {
+      HYDROGUI_ShapeBathymetry* aBathShape = dynamic_cast<HYDROGUI_ShapeBathymetry*>( aShape );
+      if( !aBathShape || !aBathShape->isVisible() )
+        continue;
+
+      aBathShape->GetRange( aMin, aMax );
+
+      if( isFirst || aMin < aColorScaleMin )
+        aColorScaleMin = aMin;
+      if( isFirst || aMax > aColorScaleMax )
+        aColorScaleMax = aMax;
+
+      isFirst = false;
+    }
+  }
+
+  Handle(Aspect_ColorScale) aColorScale;
+  if( isDisplayColorScale )
+  {
+    aColorScale = aView->ColorScale();
+    if( !aColorScale.IsNull() )
+    {
+      aColorScale->SetXPosition( anXPos );
+      aColorScale->SetYPosition( anYPos );
+      aColorScale->SetWidth( aWidth );
+      aColorScale->SetHeight( aHeight );
+
+      aColorScale->SetTextHeight( aTextHeight );
+      aColorScale->SetNumberOfIntervals( aNbIntervals );
+
+      aColorScale->SetTitle( aColorScaleTitle );
+      aColorScale->SetRange( aColorScaleMin, aColorScaleMax );
+
+      if ( !isLandCoverColoringOn ) {
+        foreach( HYDROGUI_Shape* aShape, aBathShapes ) {
+          HYDROGUI_ShapeBathymetry* aBathShape = dynamic_cast<HYDROGUI_ShapeBathymetry*>( aShape );
+          if( !aBathShape || !aBathShape->isVisible() )
+            continue;
+
+          aBathShape->UpdateWithColorScale( aColorScale );
+        }
+      }
+    }
+    if( !aView->ColorScaleIsDisplayed() )
+      aView->ColorScaleDisplay();
+  }
+  else
+  {
+    if( aView->ColorScaleIsDisplayed() )
+      aView->ColorScaleErase();
+  }
+
+  foreach( HYDROGUI_Shape* aShape, aLandCoverMapShapes ) {
+    HYDROGUI_ShapeLandCoverMap* aLandCoverMapShape = 
+      dynamic_cast<HYDROGUI_ShapeLandCoverMap*>( aShape );
+
+    if ( !aLandCoverMapShape || !aLandCoverMapShape->isVisible() ) {
+      continue;
+    }
+    
+    Handle(HYDROData_LandCoverMap) aLandCoverMap = 
+      Handle(HYDROData_LandCoverMap)::DownCast( aLandCoverMapShape->getObject() );
+
+    if ( aLandCoverMap.IsNull() ) {
+      continue;
+    }
+    
+    bool isScalarMode = aLandCoverMapShape->isScalarMapModeEnabled();
+    if( isScalarMode != isLandCoverColoringOn )
+    {
+      aLandCoverMapShape->setScalarMapModeEnabled( isLandCoverColoringOn );
+      theViewer->getAISContext()->Redisplay( aLandCoverMapShape->getAISObject() );
+    }
+  }
+  
+  myToUpdateColorScale = false;
+}