src/ModuleBase/ModuleBase_ResultPrs.cpp

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include "ModuleBase_ResultPrs.h"
  22
  23 #include <GeomAPI_PlanarEdges.h>
  24
  25 #include <ModelAPI_Events.h>
  26 #include <ModelAPI_Tools.h>
  27 #include <ModelAPI_ResultConstruction.h>
  28 #include <ModelAPI_ResultCompSolid.h>
  29
  30 #include "ModuleBase_Tools.h"
  31 #include "ModuleBase_BRepOwner.h"
  32
  33 #include <Events_InfoMessage.h>
  34 #include <Events_Loop.h>
  35
  36 #include <AIS_ColoredDrawer.hxx>
  37 #include <AIS_InteractiveContext.hxx>
  38 #include <AIS_Selection.hxx>
  39 #include <BOPTools_AlgoTools3D.hxx>
  40 #include <BRep_Builder.hxx>
  41 #include <Graphic3d_AspectMarker3d.hxx>
  42 #include <Prs3d_Drawer.hxx>
  43 #include <Prs3d.hxx>
  44 #include <Prs3d_PointAspect.hxx>
  45 #include <Prs3d_IsoAspect.hxx>
  46 #include <Prs3d_ShadingAspect.hxx>
  47 #include <SelectMgr_SequenceOfOwner.hxx>
  48 #include <SelectMgr_EntityOwner.hxx>
  49 #include <SelectMgr_SelectionManager.hxx>
  50 #include <StdPrs_WFShape.hxx>
  51 #include <StdPrs_ShadedShape.hxx>
  52 #include <StdSelect_BRepSelectionTool.hxx>
  53 #include <TColStd_ListIteratorOfListOfInteger.hxx>
  54 #include <TopExp_Explorer.hxx>
  55 #include <TopoDS.hxx>
  56 #include <TopoDS_Builder.hxx>
  57
  58 //*******************************************************************************************
  59
  60 IMPLEMENT_STANDARD_RTTIEXT(ModuleBase_ResultPrs, ViewerData_AISShape);
  61
  62
  63
  64 //********************************************************************
  65 ModuleBase_ResultPrs::ModuleBase_ResultPrs(ResultPtr theResult)
  66   : ViewerData_AISShape(TopoDS_Shape()), myResult(theResult), myAdditionalSelectionPriority(0),
  67   myTransparency(1)
  68 {
  69   std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(theResult);
  70   TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
  71   Set(aShape);
  72   Handle(Prs3d_Drawer) aDrawer = Attributes();
  73   if (aDrawer->HasOwnPointAspect())
  74     aDrawer->PointAspect()->SetTypeOfMarker(Aspect_TOM_PLUS);
  75   else
  76     aDrawer->SetPointAspect(new Prs3d_PointAspect(Aspect_TOM_PLUS, Quantity_NOC_YELLOW, 1.));
  77
  78   // Activate individual repaintng if this is a part of compsolid
  79   ResultCompSolidPtr aCompSolid = ModelAPI_Tools::compSolidOwner(myResult);
  80   SetAutoHilight(aCompSolid.get() == NULL);
  81
  82   myHiddenSubShapesDrawer = new AIS_ColoredDrawer (myDrawer);
  83   Handle(Prs3d_ShadingAspect) aShadingAspect = new Prs3d_ShadingAspect();
  84   aShadingAspect->SetMaterial(Graphic3d_NOM_BRASS); //default value of context material
  85   myHiddenSubShapesDrawer->SetShadingAspect(aShadingAspect);
  86
  87   ModuleBase_Tools::setPointBallHighlighting(this);
  88 }
  89
  90 //********************************************************************
  91 void ModuleBase_ResultPrs::setAdditionalSelectionPriority(const int thePriority)
  92 {
  93   myAdditionalSelectionPriority = thePriority;
  94 }
  95
  96 //********************************************************************
  97 void ModuleBase_ResultPrs::SetColor (const Quantity_Color& theColor)
  98 {
  99   ViewerData_AISShape::SetColor(theColor);
 100   myHiddenSubShapesDrawer->ShadingAspect()->SetColor (theColor, myCurrentFacingModel);
 101 }
 102
 103 //********************************************************************
 104 bool ModuleBase_ResultPrs::setSubShapeHidden(const NCollection_List<TopoDS_Shape>& theShapes)
 105 {
 106   bool isModified = false;
 107
 108   TopoDS_Compound aCompound;
 109   BRep_Builder aBBuilder;
 110   aBBuilder.MakeCompound (aCompound);
 111   // restore hidden shapes if there are not the shapes in parameter container
 112   NCollection_List<TopoDS_Shape> aVisibleSubShapes;
 113   for (NCollection_List<TopoDS_Shape>::Iterator aHiddenIt(myHiddenSubShapes); aHiddenIt.More();
 114        aHiddenIt.Next()) {
 115     if (!theShapes.Contains(aHiddenIt.Value()))
 116       aVisibleSubShapes.Append(aHiddenIt.Value());
 117     else
 118       aBBuilder.Add (aCompound, aHiddenIt.Value());
 119   }
 120   isModified = !aVisibleSubShapes.IsEmpty();
 121   for (NCollection_List<TopoDS_Shape>::Iterator aVisibleIt(aVisibleSubShapes); aVisibleIt.More();
 122        aVisibleIt.Next())
 123     myHiddenSubShapes.Remove(aVisibleIt.Value());
 124
 125   // append hidden shapes into internal container if there are not these shapes
 126   for (NCollection_List<TopoDS_Shape>::Iterator aShapeIt(theShapes); aShapeIt.More();
 127     aShapeIt.Next())
 128   {
 129     if (aShapeIt.Value().ShapeType() != TopAbs_FACE) // only face shape can be hidden
 130       continue;
 131
 132     if (!myHiddenSubShapes.Contains(aShapeIt.Value())) {
 133       myHiddenSubShapes.Append(aShapeIt.Value());
 134       aBBuilder.Add (aCompound, aShapeIt.Value());
 135       isModified = true;
 136     }
 137   }
 138   myHiddenCompound = aCompound;
 139   return isModified;
 140 }
 141
 142 //********************************************************************
 143 bool ModuleBase_ResultPrs::isSubShapeHidden(const TopoDS_Shape& theShape)
 144 {
 145   if (theShape.IsNull() || theShape.ShapeType() != TopAbs_FACE) // only face shape can be hidden
 146     return false;
 147
 148   if (myHiddenSubShapes.Contains(theShape))
 149     return true;
 150
 151   // orientation of parameter shape(come from selection) may be wrong, check isEqual() to be sure
 152   for (NCollection_List<TopoDS_Shape>::Iterator aShapeIt(myHiddenSubShapes); aShapeIt.More();
 153     aShapeIt.Next())
 154   {
 155     if (theShape.IsEqual(aShapeIt.Value()))
 156       return true;
 157   }
 158
 159   return true;
 160 }
 161
 162 //********************************************************************
 163 bool ModuleBase_ResultPrs::hasSubShapeVisible(
 164   const NCollection_List<TopoDS_Shape>& theShapesToSkip)
 165 {
 166   TopoDS_Compound aCompound;
 167   BRep_Builder aBuilder;
 168   aBuilder.MakeCompound (aCompound);
 169   NCollection_List<TopoDS_Shape> aShapesToSkip;
 170   aShapesToSkip.Append(myHiddenSubShapes);
 171   for (NCollection_List<TopoDS_Shape>::Iterator anIt(theShapesToSkip); anIt.More(); anIt.Next())
 172     aShapesToSkip.Append(anIt.Value());
 173
 174   collectSubShapes(aBuilder, aCompound, myOriginalShape, aShapesToSkip);
 175   return !BOPTools_AlgoTools3D::IsEmptyShape(aCompound);
 176 }
 177
 178 //********************************************************************
 179 bool ModuleBase_ResultPrs::setHiddenSubShapeTransparency(double theTransparency)
 180 {
 181   if (myTransparency == theTransparency || theTransparency > 1 || theTransparency < 0)
 182     return false;
 183
 184   myTransparency = theTransparency;
 185   myHiddenSubShapesDrawer->ShadingAspect()->SetTransparency (theTransparency, myCurrentFacingModel);
 186   return true;
 187 }
 188
 189 //********************************************************************
 190 void ModuleBase_ResultPrs::Compute(
 191           const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
 192           const Handle(Prs3d_Presentation)& thePresentation,
 193           const Standard_Integer theMode)
 194 {
 195   std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(myResult);
 196   bool aReadyToDisplay = aShapePtr.get();
 197   if (aReadyToDisplay) {
 198     myOriginalShape = aShapePtr->impl<TopoDS_Shape>();
 199     if (myHiddenSubShapes.IsEmpty() || myOriginalShape.ShapeType() > TopAbs_FACE ) {
 200       if (!myOriginalShape.IsNull())
 201         Set(myOriginalShape);
 202     }
 203     else { // convert shape into SHELL
 204       TopoDS_Compound aCompound;
 205       BRep_Builder aBuilder;
 206       aBuilder.MakeCompound (aCompound);
 207       collectSubShapes(aBuilder, aCompound, myOriginalShape, myHiddenSubShapes);
 208       bool isEmptyShape = BOPTools_AlgoTools3D::IsEmptyShape(aCompound);
 209       Set(aCompound);
 210       if (isEmptyShape)
 211         aReadyToDisplay = false;
 212     }
 213   }
 214   // change deviation coefficient to provide more precise circle
 215   //ModuleBase_Tools::setDefaultDeviationCoefficient(myResult, Attributes());
 216   AIS_Shape::Compute(thePresentationManager, thePresentation, theMode);
 217
 218   // visualize hidden sub-shapes transparent
 219   if (myTransparency < 1 && !myHiddenSubShapes.IsEmpty())
 220   {
 221     StdPrs_ShadedShape::Add (thePresentation, myHiddenCompound, myHiddenSubShapesDrawer);
 222     aReadyToDisplay = true;
 223   }
 224
 225   if (!aReadyToDisplay) {
 226     Events_InfoMessage("ModuleBase_ResultPrs",
 227                        "An empty AIS presentation: ModuleBase_ResultPrs").send();
 228     static const Events_ID anEvent = Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION);
 229     ModelAPI_EventCreator::get()->sendUpdated(myResult, anEvent);
 230   }
 231 }
 232
 233 //********************************************************************
 234 void ModuleBase_ResultPrs::collectSubShapes(BRep_Builder& theBuilder,
 235   TopoDS_Shape& theCompound, const TopoDS_Shape& theShape,
 236   const NCollection_List<TopoDS_Shape>& theHiddenSubShapes)
 237 {
 238   switch (theShape.ShapeType()) {
 239     case TopAbs_COMPOUND: {
 240       for (TopoDS_Iterator aChildIter (theShape); aChildIter.More(); aChildIter.Next())
 241         collectSubShapes(theBuilder, theCompound, aChildIter.Value(), theHiddenSubShapes);
 242     }
 243     break;
 244     case TopAbs_SOLID:
 245     case TopAbs_SHELL: {
 246       for (TopExp_Explorer anExp (theShape, TopAbs_FACE); anExp.More(); anExp.Next()) {
 247         collectSubShapes(theBuilder, theCompound, anExp.Current(), theHiddenSubShapes);
 248       }
 249     }
 250     break;
 251     case TopAbs_WIRE: {
 252       for (TopExp_Explorer anExp (theShape, TopAbs_EDGE); anExp.More(); anExp.Next()) {
 253         collectSubShapes(theBuilder, theCompound, anExp.Current(), theHiddenSubShapes);
 254       }
 255     }
 256     break;
 257     case TopAbs_FACE: {
 258       if (theHiddenSubShapes.Contains(theShape))
 259         return; // remove hidden shape
 260       theBuilder.Add(theCompound, theShape);
 261     }
 262     break;
 263     case TopAbs_EDGE:
 264     case TopAbs_VERTEX: {
 265       theBuilder.Add(theCompound, theShape);
 266     }
 267     default:
 268       break;
 269   }
 270 }
 271
 272 //********************************************************************
 273 void ModuleBase_ResultPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
 274                                             const Standard_Integer theMode)
 275 {
 276   if (appendVertexSelection(aSelection, theMode))
 277     return;
 278
 279   if (theMode > TopAbs_SHAPE) {
 280     // In order to avoid using custom selection modes
 281     if (theMode == ModuleBase_ResultPrs::Sel_Result) {
 282       AIS_Shape::ComputeSelection(aSelection, TopAbs_COMPOUND);
 283     }
 284     return;
 285   }
 286
 287   // TODO: OCCT issue should be created for the COMPOUND processing
 288   // before it is fixed, the next workaround in necessary
 289   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPOUND)) {
 290     const TopoDS_Shape& aShape = Shape();
 291     TopExp_Explorer aCompExp(aShape, TopAbs_COMPOUND);
 292     // do not activate in compound mode shapes which do not contain compounds
 293     if (!aCompExp.More())
 294       return;
 295   }
 296
 297   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPSOLID)) {
 298     // Limit selection area only by actual object (Shape)
 299     ResultCompSolidPtr aCompSolid = ModelAPI_Tools::compSolidOwner(myResult);
 300     if (aCompSolid.get()) {
 301       std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(aCompSolid);
 302       if (aShapePtr.get()) {
 303         TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
 304         int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_COMPSOLID);
 305         /// It is important to have priority for the shape of comp solid result less than priority
 306         /// for the presentation shape which is a sub-result.
 307         /// Reason is to select the sub-objects before: #1592
 308         aPriority = aPriority - 1;
 309         double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 310
 311         Handle(ModuleBase_BRepOwner) aOwner = new ModuleBase_BRepOwner(aShape, aPriority);
 312         StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 313           aDeflection, myDrawer->HLRAngle(), 9, 500);
 314
 315         for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 316           Handle(SelectMgr_EntityOwner) anOwner =
 317             Handle(SelectMgr_EntityOwner)
 318             ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 319           anOwner->Set(this);
 320         }
 321         return;
 322       }
 323     }
 324     //AIS_Shape::ComputeSelection(aSelection, 0);
 325   }
 326   AIS_Shape::ComputeSelection(aSelection, theMode);
 327
 328   if (myAdditionalSelectionPriority > 0) {
 329     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 330       Handle(SelectBasics_EntityOwner) aBasicsOwner =
 331         aSelection->Sensitive()->BaseSensitive()->OwnerId();
 332       if (!aBasicsOwner.IsNull())
 333         aBasicsOwner->Set(aBasicsOwner->Priority() + myAdditionalSelectionPriority);
 334     }
 335   }
 336 }
 337
 338 //********************************************************************
 339 bool ModuleBase_ResultPrs::appendVertexSelection(const Handle(SelectMgr_Selection)& aSelection,
 340                                                  const Standard_Integer theMode)
 341 {
 342   if (Shape().ShapeType() == TopAbs_VERTEX) {
 343     const TopoDS_Shape& aShape = Shape();
 344
 345     int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_VERTEX);
 346     double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 347
 348     /// The cause of this method is the last parameter of BRep owner setting into True.
 349     /// That means that owner should behave like it comes from decomposition. (In this case, OCCT
 350     /// visualizes it in Ring style) OCCT version is 7.0.0 with path for SHAPER module.
 351     Handle(StdSelect_BRepOwner) aOwner = new StdSelect_BRepOwner(aShape, aPriority, Standard_True);
 352     StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 353                                                   aDeflection, myDrawer->HLRAngle(), 9, 500);
 354
 355     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 356       Handle(SelectMgr_EntityOwner) anOwner =
 357         Handle(SelectMgr_EntityOwner)
 358         ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 359       anOwner->Set(this);
 360     }
 361     return true;
 362   }
 363   return false;
 364 }
 365
 366 //********************************************************************
 367 void ModuleBase_ResultPrs::HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
 368                                            const SelectMgr_SequenceOfOwner& theOwners)
 369 {
 370   Handle(SelectMgr_EntityOwner) anOwner;
 371   Handle(ModuleBase_BRepOwner) aCompOwner;
 372   for (int i = 1; i <= theOwners.Length(); i++) {
 373     anOwner = theOwners.Value(i);
 374     aCompOwner = Handle(ModuleBase_BRepOwner)::DownCast(anOwner);
 375     if (aCompOwner.IsNull()) {
 376       thePM->Color(anOwner->Selectable(), GetContext()->SelectionStyle());
 377     }
 378     else {
 379       TopoDS_Shape aShape = aCompOwner->Shape();
 380       Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( thePM );
 381       aSelectionPrs->Clear();
 382
 383       StdPrs_WFShape::Add(aSelectionPrs, aShape, myDrawer);
 384
 385       aSelectionPrs->SetDisplayPriority(9);
 386       aSelectionPrs->Highlight(GetContext()->SelectionStyle());
 387       aSelectionPrs->Display();
 388       thePM->Color(this, GetContext()->SelectionStyle());
 389     }
 390   }
 391 }
 392
 393 //********************************************************************
 394 void ModuleBase_ResultPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM,
 395                                                  const Handle(Graphic3d_HighlightStyle)& theStyle,
 396                                                  const Handle(SelectMgr_EntityOwner)& theOwner)
 397 {
 398   Handle(StdSelect_BRepOwner) aOwner = Handle(StdSelect_BRepOwner)::DownCast(theOwner);
 399   if (aOwner.IsNull())
 400     return;
 401
 402   TopoDS_Shape aShape = aOwner->Shape();
 403   if (!aShape.IsNull()) {
 404     thePM->Color(this, theStyle);
 405
 406     Handle( Prs3d_Presentation ) aHilightPrs = GetHilightPresentation( thePM );
 407     aHilightPrs->Clear();
 408
 409     StdPrs_WFShape::Add(aHilightPrs, aShape, myDrawer);
 410     aHilightPrs->Highlight(theStyle);
 411
 412     if (thePM->IsImmediateModeOn())
 413       thePM->AddToImmediateList(aHilightPrs);
 414   }
 415 }