src/ModuleBase/ModuleBase_WidgetSelector.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_WidgetSelector.h>
  22
  23 #include <ModuleBase_Events.h>
  24 #include <ModuleBase_IModule.h>
  25 #include <ModuleBase_ISelection.h>
  26 #include <ModuleBase_ISelectionActivate.h>
  27 #include <ModuleBase_IWorkshop.h>
  28 #include <ModuleBase_Operation.h>
  29 #include <ModuleBase_OperationDescription.h>
  30 #include <ModuleBase_ResultPrs.h>
  31 #include <ModuleBase_Tools.h>
  32 #include <ModuleBase_ViewerPrs.h>
  33 #include <ModuleBase_WidgetFactory.h>
  34
  35 #include <ModelAPI_AttributeSelection.h>
  36 #include <ModelAPI_AttributeSelectionList.h>
  37 #include <ModelAPI_Events.h>
  38 #include <ModelAPI_ResultConstruction.h>
  39
  40 #include <Config_WidgetAPI.h>
  41
  42 #include <TopoDS_Iterator.hxx>
  43
  44 ModuleBase_WidgetSelector::ModuleBase_WidgetSelector(QWidget* theParent,
  45                                                      ModuleBase_IWorkshop* theWorkshop,
  46                                                      const Config_WidgetAPI* theData)
  47 : ModuleBase_WidgetValidated(theParent, theWorkshop, theData),
  48 myIsPointsFiltering(true)
  49 {
  50   QString aFiltering = QString::fromStdString(theData->getProperty("filter_points"));
  51   if (aFiltering.toLower() == "false")
  52     myIsPointsFiltering = false;
  53 }
  54
  55 //********************************************************************
  56 ModuleBase_WidgetSelector::~ModuleBase_WidgetSelector()
  57 {
  58 }
  59
  60 //********************************************************************
  61 void ModuleBase_WidgetSelector::getGeomSelection(const ModuleBase_ViewerPrsPtr& thePrs,
  62                                                       ObjectPtr& theObject,
  63                                                       GeomShapePtr& theShape)
  64 {
  65   ModuleBase_ISelection* aSelection = myWorkshop->selection();
  66   theObject = aSelection->getResult(thePrs);
  67   if (!theObject.get())
  68     theObject = thePrs->object();
  69   theShape = aSelection->getShape(thePrs);
  70 }
  71
  72 //********************************************************************
  73 bool ModuleBase_WidgetSelector::processSelection()
  74 {
  75   QList<ModuleBase_ViewerPrsPtr> aSelected = getFilteredSelected();
  76   // equal vertices should not be used here
  77   if (myIsPointsFiltering)
  78     ModuleBase_ISelection::filterSelectionOnEqualPoints(aSelected);
  79
  80   bool isDone = setSelection(aSelected, true/*false*/);
  81   updateOnSelectionChanged(isDone);
  82
  83   return isDone;
  84 }
  85
  86 //********************************************************************
  87 void ModuleBase_WidgetSelector::updateOnSelectionChanged(const bool theDone)
  88 {
  89   // "false" flag should be used here, it connects to the #26658 OCC bug, when the user click in
  90   // the same place repeatedly without mouse moved. In the case validation by filters is not
  91   // perfromed, so an invalid object is selected. E.g. distance constraint, selection of a point.
  92   // the 3rd click in the same point allow using this point.
  93   emit valuesChanged();
  94   // the updateObject method should be called to flush the updated sigal. The workshop listens it,
  95   // calls validators for the feature and, as a result, updates the Apply button state.
  96   updateObject(myFeature);
  97
  98   // we need to forget about previous validation result as the current selection can influence on it
  99   clearValidatedCash();
 100
 101   if (theDone)
 102     updateFocus();
 103 }
 104
 105 //********************************************************************
 106 QIntList ModuleBase_WidgetSelector::getShapeTypes() const
 107 {
 108   QIntList aShapeTypes = shapeTypes();
 109   // this type should be mentioned in XML, poor selection otherwise
 110   if (/*aShapeTypes.contains(TopAbs_SOLID) ||*/
 111       aShapeTypes.contains(ModuleBase_ResultPrs::Sel_Result/*TopAbs_SHAPE*/)) {
 112     // it should be selectable for both, "solids" and "objects" types
 113     aShapeTypes.append(TopAbs_COMPSOLID);
 114   }
 115   return aShapeTypes;
 116 }
 117
 118 //********************************************************************
 119 QList<ModuleBase_ViewerPrsPtr> ModuleBase_WidgetSelector::getAttributeSelection() const
 120 {
 121   return QList<ModuleBase_ViewerPrsPtr>();
 122 }
 123
 124 //********************************************************************
 125 bool ModuleBase_WidgetSelector::acceptSubShape(const GeomShapePtr& theShape,
 126                                                const ResultPtr& theResult) const
 127 {
 128   bool aValid = false;
 129
 130   GeomShapePtr aShape = theShape;
 131
 132   QIntList aShapeTypes = getShapeTypes();
 133   if (aShapeTypes.empty()) {
 134     aValid = true;
 135     return aValid;
 136   }
 137   // when the SHAPE type is provided by XML as Object, the whole result shape should be selected.
 138   if (!aShape.get() && aShapeTypes.contains(ModuleBase_ResultPrs::Sel_Result)) {
 139     aValid = true;
 140     return aValid;
 141   }
 142
 143   if (!aShape.get() && theResult.get()) {
 144     if (theResult.get())
 145       aShape = theResult->shape();
 146   }
 147   TopAbs_ShapeEnum aShapeType = TopAbs_SHAPE;
 148   if (aShape.get()) {
 149     // Check that the selection corresponds to selection type
 150     TopoDS_Shape aTopoShape = aShape->impl<TopoDS_Shape>();
 151     aShapeType = aTopoShape.ShapeType();
 152     // for compounds check sub-shapes: it may be compound of needed type:
 153     // Booleans may produce compounds of Solids
 154     if (aShapeType == TopAbs_COMPOUND) {
 155       aShapeType = ModuleBase_Tools::getCompoundSubType(aTopoShape);
 156     }
 157   }
 158
 159   QIntList::const_iterator anIt = aShapeTypes.begin(), aLast = aShapeTypes.end();
 160   for (; anIt != aLast && !aValid; anIt++) {
 161     TopAbs_ShapeEnum aCurrentShapeType = (TopAbs_ShapeEnum)*anIt;
 162     if (aShapeType == aCurrentShapeType)
 163       aValid = true;
 164     else if (aCurrentShapeType == TopAbs_FACE) {
 165       // try to process the construction shape only if there is no a selected shape in the viewer
 166       if (!theShape.get() && theResult.get()) {
 167         ResultConstructionPtr aCResult =
 168                                 std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theResult);
 169         aValid = aCResult.get() && aCResult->facesNum() > 0;
 170       }
 171     }
 172   }
 173   return aValid;
 174 }
 175
 176 //********************************************************************
 177 void ModuleBase_WidgetSelector::selectionModes(int& theModuleSelectionModes, QIntList& theModes)
 178 {
 179   theModuleSelectionModes = -1;
 180   theModes.append(getShapeTypes());
 181 }
 182
 183 //********************************************************************
 184 void ModuleBase_WidgetSelector::updateSelectionModesAndFilters(bool toActivate)
 185 {
 186   updateSelectionName();
 187
 188   myWorkshop->selectionActivate()->updateSelectionFilters();
 189   myWorkshop->selectionActivate()->updateSelectionModes();
 190
 191   if (!toActivate)
 192     clearValidatedCash();
 193 }
 194
 195 //********************************************************************
 196 void ModuleBase_WidgetSelector::activateCustom()
 197 {
 198   // Restore selection in the viewer by the attribute selection list
 199   // it should be postponed to have current widget as active to validate restored selection
 200   static Events_ID anEvent = Events_Loop::eventByName(EVENT_UPDATE_BY_WIDGET_SELECTION);
 201   ModelAPI_EventCreator::get()->sendUpdated(myFeature, anEvent);
 202 }
 203
 204 //********************************************************************
 205 bool ModuleBase_WidgetSelector::isValidSelectionCustom(const ModuleBase_ViewerPrsPtr& thePrs)
 206 {
 207   GeomShapePtr aShape = myWorkshop->selection()->getShape(thePrs);
 208   ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 209   bool aValid = acceptSubShape(aShape, aResult);
 210
 211   if (aValid) {
 212     // In order to avoid selection of the same object
 213     ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 214     FeaturePtr aSelectedFeature = ModelAPI_Feature::feature(aResult);
 215     aValid = aSelectedFeature != myFeature;
 216   }
 217   return aValid;
 218 }
 219
 220 //********************************************************************
 221 bool ModuleBase_WidgetSelector::setSelectionCustom(const ModuleBase_ViewerPrsPtr& thePrs)
 222 {
 223   ObjectPtr anObject;
 224   GeomShapePtr aShape;
 225   getGeomSelection(thePrs, anObject, aShape);
 226
 227   // the last flag is to be depending on hasObject is called before. To be corrected later
 228   return ModuleBase_Tools::setObject(attribute(), anObject, aShape,
 229                                      myWorkshop, myIsInValidate, true);
 230 }
 231
 232 //********************************************************************
 233 void ModuleBase_WidgetSelector::deactivate()
 234 {
 235   ModuleBase_WidgetValidated::deactivate();
 236   /// clear temporary cash
 237   AttributePtr anAttribute = attribute();
 238   if (!anAttribute.get())
 239     return;
 240   std::string aType = anAttribute->attributeType();
 241   if (anAttribute->attributeType() == ModelAPI_AttributeSelection::typeId()) {
 242     AttributeSelectionPtr aSelectAttr =
 243                              std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(anAttribute);
 244     aSelectAttr->removeTemporaryValues();
 245   }
 246   else if (anAttribute->attributeType() == ModelAPI_AttributeSelectionList::typeId()) {
 247     AttributeSelectionListPtr aSelectAttr =
 248                       std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(anAttribute);
 249     aSelectAttr->removeTemporaryValues();
 250   }
 251 }