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::hasSubShapeVisible(const TopoDS_Shape& theShape)
 144 {
 145   int aNbOfHiddenSubShapes = myHiddenSubShapes.Size();
 146
 147   if (!myHiddenSubShapes.Contains(theShape))
 148     aNbOfHiddenSubShapes++; // the shape to be hidden later
 149
 150   //const TopoDS_Shape aCurrentShape = Shape();
 151   NCollection_List<TopoDS_Shape> aHiddenSubShapes = myHiddenSubShapes;
 152   aHiddenSubShapes.Append(theShape);
 153
 154   TopoDS_Compound aCompound;
 155   BRep_Builder aBuilder;
 156   aBuilder.MakeCompound (aCompound);
 157   collectSubShapes(aBuilder, aCompound, myOriginalShape, aHiddenSubShapes);
 158   return !BOPTools_AlgoTools3D::IsEmptyShape(aCompound);
 159 }
 160
 161 //********************************************************************
 162 bool ModuleBase_ResultPrs::setHiddenSubShapeTransparency(double theTransparency)
 163 {
 164   if (myTransparency == theTransparency || theTransparency > 1 || theTransparency < 0)
 165     return false;
 166
 167   myTransparency = theTransparency;
 168   myHiddenSubShapesDrawer->ShadingAspect()->SetTransparency (theTransparency, myCurrentFacingModel);
 169   return true;
 170 }
 171
 172 //********************************************************************
 173 void ModuleBase_ResultPrs::Compute(
 174           const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
 175           const Handle(Prs3d_Presentation)& thePresentation,
 176           const Standard_Integer theMode)
 177 {
 178   std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(myResult);
 179   bool aReadyToDisplay = aShapePtr.get();
 180   if (aReadyToDisplay) {
 181     myOriginalShape = aShapePtr->impl<TopoDS_Shape>();
 182     if (myHiddenSubShapes.IsEmpty() || myOriginalShape.ShapeType() > TopAbs_FACE ) {
 183       if (!myOriginalShape.IsNull())
 184         Set(myOriginalShape);
 185     }
 186     else { // convert shape into SHELL
 187       TopoDS_Compound aCompound;
 188       BRep_Builder aBuilder;
 189       aBuilder.MakeCompound (aCompound);
 190       collectSubShapes(aBuilder, aCompound, myOriginalShape, myHiddenSubShapes);
 191       bool isEmptyShape = BOPTools_AlgoTools3D::IsEmptyShape(aCompound);
 192       Set(aCompound);
 193       if (isEmptyShape)
 194         aReadyToDisplay = false;
 195     }
 196   }
 197   // change deviation coefficient to provide more precise circle
 198   //ModuleBase_Tools::setDefaultDeviationCoefficient(myResult, Attributes());
 199   AIS_Shape::Compute(thePresentationManager, thePresentation, theMode);
 200
 201   // visualize hidden sub-shapes transparent
 202   if (myTransparency < 1 && !myHiddenSubShapes.IsEmpty())
 203   {
 204     StdPrs_ShadedShape::Add (thePresentation, myHiddenCompound, myHiddenSubShapesDrawer);
 205     aReadyToDisplay = true;
 206   }
 207
 208   if (!aReadyToDisplay) {
 209     Events_InfoMessage("ModuleBase_ResultPrs",
 210                        "An empty AIS presentation: ModuleBase_ResultPrs").send();
 211     static const Events_ID anEvent = Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION);
 212     ModelAPI_EventCreator::get()->sendUpdated(myResult, anEvent);
 213   }
 214 }
 215
 216 //********************************************************************
 217 void ModuleBase_ResultPrs::collectSubShapes(BRep_Builder& theBuilder,
 218   TopoDS_Shape& theCompound, const TopoDS_Shape& theShape,
 219   const NCollection_List<TopoDS_Shape>& theHiddenSubShapes)
 220 {
 221   switch (theShape.ShapeType()) {
 222     case TopAbs_COMPOUND: {
 223       for (TopoDS_Iterator aChildIter (theShape); aChildIter.More(); aChildIter.Next())
 224         collectSubShapes(theBuilder, theCompound, aChildIter.Value(), theHiddenSubShapes);
 225     }
 226     break;
 227     case TopAbs_SOLID:
 228     case TopAbs_SHELL: {
 229       for (TopExp_Explorer anExp (theShape, TopAbs_FACE); anExp.More(); anExp.Next()) {
 230         collectSubShapes(theBuilder, theCompound, anExp.Current(), theHiddenSubShapes);
 231       }
 232     }
 233     break;
 234     case TopAbs_WIRE: {
 235       for (TopExp_Explorer anExp (theShape, TopAbs_EDGE); anExp.More(); anExp.Next()) {
 236         collectSubShapes(theBuilder, theCompound, anExp.Current(), theHiddenSubShapes);
 237       }
 238     }
 239     break;
 240     case TopAbs_FACE: {
 241       if (theHiddenSubShapes.Contains(theShape))
 242         return; // remove hidden shape
 243       theBuilder.Add(theCompound, theShape);
 244     }
 245     break;
 246     case TopAbs_EDGE:
 247     case TopAbs_VERTEX: {
 248       theBuilder.Add(theCompound, theShape);
 249     }
 250     default:
 251       break;
 252   }
 253 }
 254
 255 //********************************************************************
 256 void ModuleBase_ResultPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
 257                                             const Standard_Integer theMode)
 258 {
 259   if (appendVertexSelection(aSelection, theMode))
 260     return;
 261
 262   if (theMode > TopAbs_SHAPE) {
 263     // In order to avoid using custom selection modes
 264     if (theMode == ModuleBase_ResultPrs::Sel_Result) {
 265       AIS_Shape::ComputeSelection(aSelection, TopAbs_COMPOUND);
 266     }
 267     return;
 268   }
 269
 270   // TODO: OCCT issue should be created for the COMPOUND processing
 271   // before it is fixed, the next workaround in necessary
 272   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPOUND)) {
 273     const TopoDS_Shape& aShape = Shape();
 274     TopExp_Explorer aCompExp(aShape, TopAbs_COMPOUND);
 275     // do not activate in compound mode shapes which do not contain compounds
 276     if (!aCompExp.More())
 277       return;
 278   }
 279
 280   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPSOLID)) {
 281     // Limit selection area only by actual object (Shape)
 282     ResultCompSolidPtr aCompSolid = ModelAPI_Tools::compSolidOwner(myResult);
 283     if (aCompSolid.get()) {
 284       std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(aCompSolid);
 285       if (aShapePtr.get()) {
 286         TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
 287         int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_COMPSOLID);
 288         /// It is important to have priority for the shape of comp solid result less than priority
 289         /// for the presentation shape which is a sub-result.
 290         /// Reason is to select the sub-objects before: #1592
 291         aPriority = aPriority - 1;
 292         double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 293
 294         Handle(ModuleBase_BRepOwner) aOwner = new ModuleBase_BRepOwner(aShape, aPriority);
 295         StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 296           aDeflection, myDrawer->HLRAngle(), 9, 500);
 297
 298         for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 299           Handle(SelectMgr_EntityOwner) anOwner =
 300             Handle(SelectMgr_EntityOwner)
 301             ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 302           anOwner->Set(this);
 303         }
 304         return;
 305       }
 306     }
 307     //AIS_Shape::ComputeSelection(aSelection, 0);
 308   }
 309   AIS_Shape::ComputeSelection(aSelection, theMode);
 310
 311   if (myAdditionalSelectionPriority > 0) {
 312     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 313       Handle(SelectBasics_EntityOwner) aBasicsOwner =
 314         aSelection->Sensitive()->BaseSensitive()->OwnerId();
 315       if (!aBasicsOwner.IsNull())
 316         aBasicsOwner->Set(aBasicsOwner->Priority() + myAdditionalSelectionPriority);
 317     }
 318   }
 319 }
 320
 321 //********************************************************************
 322 bool ModuleBase_ResultPrs::appendVertexSelection(const Handle(SelectMgr_Selection)& aSelection,
 323                                                  const Standard_Integer theMode)
 324 {
 325   if (Shape().ShapeType() == TopAbs_VERTEX) {
 326     const TopoDS_Shape& aShape = Shape();
 327
 328     int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_VERTEX);
 329     double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 330
 331     /// The cause of this method is the last parameter of BRep owner setting into True.
 332     /// That means that owner should behave like it comes from decomposition. (In this case, OCCT
 333     /// visualizes it in Ring style) OCCT version is 7.0.0 with path for SHAPER module.
 334     Handle(StdSelect_BRepOwner) aOwner = new StdSelect_BRepOwner(aShape, aPriority, Standard_True);
 335     StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 336                                                   aDeflection, myDrawer->HLRAngle(), 9, 500);
 337
 338     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 339       Handle(SelectMgr_EntityOwner) anOwner =
 340         Handle(SelectMgr_EntityOwner)
 341         ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 342       anOwner->Set(this);
 343     }
 344     return true;
 345   }
 346   return false;
 347 }
 348
 349 //********************************************************************
 350 void ModuleBase_ResultPrs::HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
 351                                            const SelectMgr_SequenceOfOwner& theOwners)
 352 {
 353   Handle(SelectMgr_EntityOwner) anOwner;
 354   Handle(ModuleBase_BRepOwner) aCompOwner;
 355   for (int i = 1; i <= theOwners.Length(); i++) {
 356     anOwner = theOwners.Value(i);
 357     aCompOwner = Handle(ModuleBase_BRepOwner)::DownCast(anOwner);
 358     if (aCompOwner.IsNull()) {
 359       thePM->Color(anOwner->Selectable(), GetContext()->SelectionStyle());
 360     }
 361     else {
 362       TopoDS_Shape aShape = aCompOwner->Shape();
 363       Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( thePM );
 364       aSelectionPrs->Clear();
 365
 366       StdPrs_WFShape::Add(aSelectionPrs, aShape, myDrawer);
 367
 368       aSelectionPrs->SetDisplayPriority(9);
 369       aSelectionPrs->Highlight(GetContext()->SelectionStyle());
 370       aSelectionPrs->Display();
 371       thePM->Color(this, GetContext()->SelectionStyle());
 372     }
 373   }
 374 }
 375
 376 //********************************************************************
 377 void ModuleBase_ResultPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM,
 378                                                  const Handle(Graphic3d_HighlightStyle)& theStyle,
 379                                                  const Handle(SelectMgr_EntityOwner)& theOwner)
 380 {
 381   Handle(StdSelect_BRepOwner) aOwner = Handle(StdSelect_BRepOwner)::DownCast(theOwner);
 382   if (aOwner.IsNull())
 383     return;
 384
 385   TopoDS_Shape aShape = aOwner->Shape();
 386   if (!aShape.IsNull()) {
 387     thePM->Color(this, theStyle);
 388
 389     Handle( Prs3d_Presentation ) aHilightPrs = GetHilightPresentation( thePM );
 390     aHilightPrs->Clear();
 391
 392     StdPrs_WFShape::Add(aHilightPrs, aShape, myDrawer);
 393     aHilightPrs->Highlight(theStyle);
 394
 395     if (thePM->IsImmediateModeOn())
 396       thePM->AddToImmediateList(aHilightPrs);
 397   }
 398 }