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 <BRep_Builder.hxx>
  40 #include <Graphic3d_AspectMarker3d.hxx>
  41 #include <Prs3d_Drawer.hxx>
  42 #include <Prs3d.hxx>
  43 #include <Prs3d_PointAspect.hxx>
  44 #include <Prs3d_IsoAspect.hxx>
  45 #include <Prs3d_ShadingAspect.hxx>
  46 #include <SelectMgr_SequenceOfOwner.hxx>
  47 #include <SelectMgr_EntityOwner.hxx>
  48 #include <SelectMgr_SelectionManager.hxx>
  49 #include <StdPrs_WFShape.hxx>
  50 #include <StdPrs_ShadedShape.hxx>
  51 #include <StdSelect_BRepSelectionTool.hxx>
  52 #include <TColStd_ListIteratorOfListOfInteger.hxx>
  53 #include <TopExp_Explorer.hxx>
  54 #include <TopoDS.hxx>
  55 #include <TopoDS_Builder.hxx>
  56
  57 //*******************************************************************************************
  58
  59 IMPLEMENT_STANDARD_RTTIEXT(ModuleBase_ResultPrs, ViewerData_AISShape);
  60
  61
  62
  63 //********************************************************************
  64 ModuleBase_ResultPrs::ModuleBase_ResultPrs(ResultPtr theResult)
  65   : ViewerData_AISShape(TopoDS_Shape()), myResult(theResult), myAdditionalSelectionPriority(0),
  66   myTransparency(1)
  67 {
  68   std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(theResult);
  69   TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
  70   Set(aShape);
  71   Handle(Prs3d_Drawer) aDrawer = Attributes();
  72   if (aDrawer->HasOwnPointAspect())
  73     aDrawer->PointAspect()->SetTypeOfMarker(Aspect_TOM_PLUS);
  74   else
  75     aDrawer->SetPointAspect(new Prs3d_PointAspect(Aspect_TOM_PLUS, Quantity_NOC_YELLOW, 1.));
  76
  77   // Activate individual repaintng if this is a part of compsolid
  78   ResultCompSolidPtr aCompSolid = ModelAPI_Tools::compSolidOwner(myResult);
  79   SetAutoHilight(aCompSolid.get() == NULL);
  80
  81   myHiddenSubShapesDrawer = new AIS_ColoredDrawer (myDrawer);
  82   Handle(Prs3d_ShadingAspect) aShadingAspect = new Prs3d_ShadingAspect();
  83   aShadingAspect->SetMaterial(Graphic3d_NOM_BRASS); //default value of context material
  84   myHiddenSubShapesDrawer->SetShadingAspect(aShadingAspect);
  85
  86   ModuleBase_Tools::setPointBallHighlighting(this);
  87 }
  88
  89 //********************************************************************
  90 void ModuleBase_ResultPrs::setAdditionalSelectionPriority(const int thePriority)
  91 {
  92   myAdditionalSelectionPriority = thePriority;
  93 }
  94
  95 //********************************************************************
  96 void ModuleBase_ResultPrs::SetColor (const Quantity_Color& theColor)
  97 {
  98   ViewerData_AISShape::SetColor(theColor);
  99   myHiddenSubShapesDrawer->ShadingAspect()->SetColor (theColor, myCurrentFacingModel);
 100 }
 101
 102 //********************************************************************
 103 bool ModuleBase_ResultPrs::setSubShapeHidden(const NCollection_List<TopoDS_Shape>& theShapes)
 104 {
 105   bool isModified = false;
 106
 107   TopoDS_Compound aCompound;
 108   BRep_Builder aBBuilder;
 109   aBBuilder.MakeCompound (aCompound);
 110   // restore hidden shapes if there are not the shapes in parameter container
 111   NCollection_List<TopoDS_Shape> aVisibleSubShapes;
 112   for (NCollection_List<TopoDS_Shape>::Iterator aHiddenIt(myHiddenSubShapes); aHiddenIt.More();
 113        aHiddenIt.Next()) {
 114     if (!theShapes.Contains(aHiddenIt.Value()))
 115       aVisibleSubShapes.Append(aHiddenIt.Value());
 116     else
 117       aBBuilder.Add (aCompound, aHiddenIt.Value());
 118   }
 119   isModified = !aVisibleSubShapes.IsEmpty();
 120   for (NCollection_List<TopoDS_Shape>::Iterator aVisibleIt(aVisibleSubShapes); aVisibleIt.More();
 121        aVisibleIt.Next())
 122     myHiddenSubShapes.Remove(aVisibleIt.Value());
 123
 124   // append hidden shapes into internal container if there are not these shapes
 125   for (NCollection_List<TopoDS_Shape>::Iterator aShapeIt(theShapes); aShapeIt.More();
 126     aShapeIt.Next())
 127   {
 128     if (aShapeIt.Value().ShapeType() != TopAbs_FACE) // only face shape can be hidden
 129       continue;
 130
 131     if (!myHiddenSubShapes.Contains(aShapeIt.Value())) {
 132       myHiddenSubShapes.Append(aShapeIt.Value());
 133       aBBuilder.Add (aCompound, aShapeIt.Value());
 134       isModified = true;
 135     }
 136   }
 137   myHiddenCompound = aCompound;
 138   return isModified;
 139 }
 140
 141 //********************************************************************
 142 bool ModuleBase_ResultPrs::hasSubShapeVisible(const TopoDS_Shape& theShape)
 143 {
 144   int aNbOfHiddenSubShapes = myHiddenSubShapes.Size();
 145
 146   if (!myHiddenSubShapes.Contains(theShape))
 147     aNbOfHiddenSubShapes++; // the shape to be hidden later
 148
 149   TopExp_Explorer anExp(myOriginalShape, TopAbs_FACE);
 150   bool aHasVisibleShape = false;
 151   for(TopExp_Explorer anExp(myOriginalShape, TopAbs_FACE); anExp.More() && !aHasVisibleShape;
 152       anExp.Next())
 153   {
 154     aNbOfHiddenSubShapes--;
 155     if (aNbOfHiddenSubShapes < 0)
 156       aHasVisibleShape = true;
 157   }
 158   return aHasVisibleShape;
 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_Shell aShell;
 188       BRep_Builder aShellBuilder;
 189       aShellBuilder.MakeShell(aShell);
 190       bool isEmptyShape = true;
 191       for(TopExp_Explorer anExp(myOriginalShape, TopAbs_FACE); anExp.More(); anExp.Next()) {
 192         if (myHiddenSubShapes.Contains(anExp.Current()))
 193           continue;
 194         aShellBuilder.Add(aShell, anExp.Current());
 195         isEmptyShape = false;
 196       }
 197       Set(aShell);
 198       if (isEmptyShape)
 199         aReadyToDisplay = false;
 200     }
 201   }
 202   // change deviation coefficient to provide more precise circle
 203   //ModuleBase_Tools::setDefaultDeviationCoefficient(myResult, Attributes());
 204   AIS_Shape::Compute(thePresentationManager, thePresentation, theMode);
 205
 206   // visualize hidden sub-shapes transparent
 207   if (myTransparency < 1 && !myHiddenSubShapes.IsEmpty())
 208   {
 209     StdPrs_ShadedShape::Add (thePresentation, myHiddenCompound, myHiddenSubShapesDrawer);
 210   }
 211
 212   if (!aReadyToDisplay) {
 213     Events_InfoMessage("ModuleBase_ResultPrs",
 214                        "An empty AIS presentation: ModuleBase_ResultPrs").send();
 215     static const Events_ID anEvent = Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION);
 216     ModelAPI_EventCreator::get()->sendUpdated(myResult, anEvent);
 217   }
 218 }
 219
 220 //********************************************************************
 221 void ModuleBase_ResultPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
 222                                             const Standard_Integer theMode)
 223 {
 224   if (appendVertexSelection(aSelection, theMode))
 225     return;
 226
 227   if (theMode > TopAbs_SHAPE) {
 228     // In order to avoid using custom selection modes
 229     if (theMode == ModuleBase_ResultPrs::Sel_Result) {
 230       AIS_Shape::ComputeSelection(aSelection, TopAbs_COMPOUND);
 231     }
 232     return;
 233   }
 234
 235   // TODO: OCCT issue should be created for the COMPOUND processing
 236   // before it is fixed, the next workaround in necessary
 237   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPOUND)) {
 238     const TopoDS_Shape& aShape = Shape();
 239     TopExp_Explorer aCompExp(aShape, TopAbs_COMPOUND);
 240     // do not activate in compound mode shapes which do not contain compounds
 241     if (!aCompExp.More())
 242       return;
 243   }
 244
 245   if (theMode == AIS_Shape::SelectionMode(TopAbs_COMPSOLID)) {
 246     // Limit selection area only by actual object (Shape)
 247     ResultCompSolidPtr aCompSolid = ModelAPI_Tools::compSolidOwner(myResult);
 248     if (aCompSolid.get()) {
 249       std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(aCompSolid);
 250       if (aShapePtr.get()) {
 251         TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
 252         int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_COMPSOLID);
 253         /// It is important to have priority for the shape of comp solid result less than priority
 254         /// for the presentation shape which is a sub-result.
 255         /// Reason is to select the sub-objects before: #1592
 256         aPriority = aPriority - 1;
 257         double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 258
 259         Handle(ModuleBase_BRepOwner) aOwner = new ModuleBase_BRepOwner(aShape, aPriority);
 260         StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 261           aDeflection, myDrawer->HLRAngle(), 9, 500);
 262
 263         for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 264           Handle(SelectMgr_EntityOwner) anOwner =
 265             Handle(SelectMgr_EntityOwner)
 266             ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 267           anOwner->Set(this);
 268         }
 269         return;
 270       }
 271     }
 272     //AIS_Shape::ComputeSelection(aSelection, 0);
 273   }
 274   AIS_Shape::ComputeSelection(aSelection, theMode);
 275
 276   if (myAdditionalSelectionPriority > 0) {
 277     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 278       Handle(SelectBasics_EntityOwner) aBasicsOwner =
 279         aSelection->Sensitive()->BaseSensitive()->OwnerId();
 280       if (!aBasicsOwner.IsNull())
 281         aBasicsOwner->Set(aBasicsOwner->Priority() + myAdditionalSelectionPriority);
 282     }
 283   }
 284 }
 285
 286 //********************************************************************
 287 bool ModuleBase_ResultPrs::appendVertexSelection(const Handle(SelectMgr_Selection)& aSelection,
 288                                                  const Standard_Integer theMode)
 289 {
 290   if (Shape().ShapeType() == TopAbs_VERTEX) {
 291     const TopoDS_Shape& aShape = Shape();
 292
 293     int aPriority = StdSelect_BRepSelectionTool::GetStandardPriority(aShape, TopAbs_VERTEX);
 294     double aDeflection = Prs3d::GetDeflection(aShape, myDrawer);
 295
 296     /// The cause of this method is the last parameter of BRep owner setting into True.
 297     /// That means that owner should behave like it comes from decomposition. (In this case, OCCT
 298     /// visualizes it in Ring style) OCCT version is 7.0.0 with path for SHAPER module.
 299     Handle(StdSelect_BRepOwner) aOwner = new StdSelect_BRepOwner(aShape, aPriority, Standard_True);
 300     StdSelect_BRepSelectionTool::ComputeSensitive(aShape, aOwner, aSelection,
 301                                                   aDeflection, myDrawer->HLRAngle(), 9, 500);
 302
 303     for (aSelection->Init(); aSelection->More(); aSelection->Next()) {
 304       Handle(SelectMgr_EntityOwner) anOwner =
 305         Handle(SelectMgr_EntityOwner)
 306         ::DownCast(aSelection->Sensitive()->BaseSensitive()->OwnerId());
 307       anOwner->Set(this);
 308     }
 309     return true;
 310   }
 311   return false;
 312 }
 313
 314 //********************************************************************
 315 void ModuleBase_ResultPrs::HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
 316                                            const SelectMgr_SequenceOfOwner& theOwners)
 317 {
 318   Handle(SelectMgr_EntityOwner) anOwner;
 319   Handle(ModuleBase_BRepOwner) aCompOwner;
 320   for (int i = 1; i <= theOwners.Length(); i++) {
 321     anOwner = theOwners.Value(i);
 322     aCompOwner = Handle(ModuleBase_BRepOwner)::DownCast(anOwner);
 323     if (aCompOwner.IsNull()) {
 324       thePM->Color(anOwner->Selectable(), GetContext()->SelectionStyle());
 325     }
 326     else {
 327       TopoDS_Shape aShape = aCompOwner->Shape();
 328       Handle( Prs3d_Presentation ) aSelectionPrs = GetSelectPresentation( thePM );
 329       aSelectionPrs->Clear();
 330
 331       StdPrs_WFShape::Add(aSelectionPrs, aShape, myDrawer);
 332
 333       aSelectionPrs->SetDisplayPriority(9);
 334       aSelectionPrs->Highlight(GetContext()->SelectionStyle());
 335       aSelectionPrs->Display();
 336       thePM->Color(this, GetContext()->SelectionStyle());
 337     }
 338   }
 339 }
 340
 341 //********************************************************************
 342 void ModuleBase_ResultPrs::HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM,
 343                                                  const Handle(Graphic3d_HighlightStyle)& theStyle,
 344                                                  const Handle(SelectMgr_EntityOwner)& theOwner)
 345 {
 346   Handle(StdSelect_BRepOwner) aOwner = Handle(StdSelect_BRepOwner)::DownCast(theOwner);
 347   if (aOwner.IsNull())
 348     return;
 349
 350   TopoDS_Shape aShape = aOwner->Shape();
 351   if (!aShape.IsNull()) {
 352     thePM->Color(this, theStyle);
 353
 354     Handle( Prs3d_Presentation ) aHilightPrs = GetHilightPresentation( thePM );
 355     aHilightPrs->Clear();
 356
 357     StdPrs_WFShape::Add(aHilightPrs, aShape, myDrawer);
 358     aHilightPrs->Highlight(theStyle);
 359
 360     if (thePM->IsImmediateModeOn())
 361       thePM->AddToImmediateList(aHilightPrs);
 362   }
 363 }