Salome HOME
Issue #684 Buttons "X"
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetValidated.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 #include <ModuleBase_WidgetValidated.h>
4 #include <ModuleBase_FilterFactory.h>
5 #include <ModuleBase_IViewer.h>
6 #include <ModuleBase_ISelection.h>
7
8 #include <ModelAPI_Session.h>
9 #include <ModelAPI_Validator.h>
10 #include <ModelAPI_AttributeValidator.h>
11 #include <ModelAPI_Events.h>
12
13 #include <SelectMgr_ListIteratorOfListOfFilter.hxx>
14 #include <SelectMgr_EntityOwner.hxx>
15 #include <StdSelect_BRepOwner.hxx>
16
17 #include <Events_Loop.h>
18
19 #include <QWidget>
20
21 //#define DEBUG_VALID_STATE
22
23 ModuleBase_WidgetValidated::ModuleBase_WidgetValidated(QWidget* theParent,
24                                                        ModuleBase_IWorkshop* theWorkshop,
25                                                        const Config_WidgetAPI* theData,
26                                                        const std::string& theParentId)
27 : ModuleBase_ModelWidget(theParent, theData, theParentId),
28   myWorkshop(theWorkshop), myIsInValidate(false)
29 {
30 }
31
32 ModuleBase_WidgetValidated::~ModuleBase_WidgetValidated()
33 {
34 }
35
36 //********************************************************************
37 bool ModuleBase_WidgetValidated::setSelection(QList<ModuleBase_ViewerPrs>& theValues,
38                                               const bool theToValidate)
39 {
40   if (theValues.empty())
41     return false;
42   // it removes the processed value from the parameters list
43   ModuleBase_ViewerPrs aValue = theValues.takeFirst();
44   bool isDone = false;
45
46   if (!theToValidate || isValidInFilters(aValue)) {
47     isDone = setSelectionCustom(aValue);
48     // updateObject - to update/redisplay feature
49     // it is commented in order to perfom it outside the method
50     //updateObject(myFeature);
51     // to storeValue()
52     //emit valuesChanged();
53   }
54   return isDone;
55 }
56
57 //********************************************************************
58 ObjectPtr ModuleBase_WidgetValidated::findPresentedObject(const AISObjectPtr& theAIS) const
59 {
60   return myPresentedObject;
61 }
62
63 //********************************************************************
64 void ModuleBase_WidgetValidated::storeAttributeValue()
65 {
66   myIsInValidate = true;
67 }
68
69 //********************************************************************
70 void ModuleBase_WidgetValidated::restoreAttributeValue(const bool theValid)
71 {
72   myIsInValidate = false;
73 }
74
75 //********************************************************************
76 bool ModuleBase_WidgetValidated::isValidInFilters(const ModuleBase_ViewerPrs& thePrs)
77 {
78   bool aValid = true;
79   Handle(SelectMgr_EntityOwner) anOwner = thePrs.owner();
80
81   // if an owner is null, the selection happens in the Object browser.
82   // creates a selection owner on the base of object shape and the object AIS object
83   if (anOwner.IsNull() && thePrs.owner().IsNull() && thePrs.object().get()) {
84     ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
85     if (aResult.get() && aResult->shape().get()) {
86       // some results have no shape, e.g. the parameter one. So, they should not be validated
87       GeomShapePtr aShape = aResult->shape();
88       const TopoDS_Shape aTDShape = aShape->impl<TopoDS_Shape>();
89       Handle(AIS_InteractiveObject) anIO = myWorkshop->selection()->getIO(thePrs);
90       anOwner = new StdSelect_BRepOwner(aTDShape, anIO);
91       myPresentedObject = aResult;
92     }
93     else
94       aValid = false; // only results with a shape can be filtered
95   }
96   // checks the owner by the AIS context activated filters
97   if (!anOwner.IsNull()) {
98     // the widget validator filter should be active, but during check by preselection
99     // it is not yet activated, so we need to activate/deactivate it manually
100     bool isActivated = isFilterActivated();
101     if (!isActivated)
102       activateFilters(true);
103
104     Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
105     if (!aContext.IsNull()) {
106       const SelectMgr_ListOfFilter& aFilters = aContext->Filters();
107       SelectMgr_ListIteratorOfListOfFilter anIt(aFilters);
108       for (; anIt.More() && aValid; anIt.Next()) {
109         Handle(SelectMgr_Filter) aFilter = anIt.Value();
110         aValid = aFilter->IsOk(anOwner);
111       }
112       if (!isActivated)
113         activateFilters(false);
114     }
115   }
116
117   // removes created owner
118   if (!anOwner.IsNull() && anOwner != thePrs.owner()) {
119     anOwner.Nullify();
120     myPresentedObject = ObjectPtr();
121   }
122   return aValid;
123 }
124
125 //********************************************************************
126 bool ModuleBase_WidgetValidated::isValidSelection(const ModuleBase_ViewerPrs& theValue)
127 {
128   bool aValid = false;
129   if (getValidState(theValue, aValid)) {
130     return aValid;
131   }
132
133   aValid = isValidSelectionCustom(theValue);
134   if (!aValid) {
135     storeValidState(theValue, aValid);
136     return aValid;
137   }
138
139   DataPtr aData = myFeature->data();
140   AttributePtr anAttribute = myFeature->attribute(attributeID());
141
142   // stores the current values of the widget attribute
143   Events_Loop* aLoop = Events_Loop::loop();
144   // blocks the flush signals to avoid the temporary objects visualization in the viewer
145   // they should not be shown in order to do not lose highlight by erasing them
146   bool isActive = aLoop->activateFlushes(false);
147
148   aData->blockSendAttributeUpdated(true);
149   bool isAttributeBlocked = anAttribute->blockSetInitialized(true);
150   storeAttributeValue();
151
152   // saves the owner value to the widget attribute
153   aValid = setSelectionCustom(theValue);
154   if (aValid)
155     // checks the attribute validity
156     aValid = isValidAttribute();
157
158   // restores the current values of the widget attribute
159   restoreAttributeValue(aValid);
160   aData->blockSendAttributeUpdated(false);
161   anAttribute->blockSetInitialized(isAttributeBlocked);
162   aLoop->activateFlushes(isActive);
163
164   // In particular case the results are deleted and called as redisplayed inside of this
165   // highlight-selection, to they must be flushed as soon as possible.
166   // Example: selection of group-vertices subshapes with shift pressend on body. Without
167   //  these 4 lines below the application crashes because of left presentations on
168   //  removed results still in the viewer.
169   static Events_ID aDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
170   static Events_ID aRedispEvent = Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY);
171   aLoop->flush(aDeletedEvent);
172   aLoop->flush(aRedispEvent);
173
174   storeValidState(theValue, aValid);
175   return aValid;
176 }
177
178 //********************************************************************
179 bool ModuleBase_WidgetValidated::isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs)
180 {
181   return true;
182 }
183
184 //********************************************************************
185 bool ModuleBase_WidgetValidated::isValidAttribute() const
186 {
187   SessionPtr aMgr = ModelAPI_Session::get();
188   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
189   AttributePtr anAttribute = myFeature->attribute(attributeID());
190   std::string aValidatorID, anError;
191   return aFactory->validate(anAttribute, aValidatorID, anError);
192 }
193
194 bool ModuleBase_WidgetValidated::isFilterActivated() const
195 {
196   bool isActivated = false;
197
198   Handle(SelectMgr_Filter) aSelFilter = myWorkshop->validatorFilter();
199   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
200
201   return aViewer->hasSelectionFilter(aSelFilter);
202 }
203
204 void ModuleBase_WidgetValidated::activateFilters(const bool toActivate)
205 {
206   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
207
208   Handle(SelectMgr_Filter) aSelFilter = myWorkshop->validatorFilter();
209   if (toActivate)
210     aViewer->addSelectionFilter(aSelFilter);
211   else {
212     aViewer->removeSelectionFilter(aSelFilter);
213     clearValidState();
214   }
215 }
216
217 //********************************************************************
218 void ModuleBase_WidgetValidated::storeValidState(const ModuleBase_ViewerPrs& theValue, const bool theValid)
219 {
220   bool aValidPrs = myInvalidPrs.contains(theValue);
221   bool anInvalidPrs = myInvalidPrs.contains(theValue);
222
223   if (theValid) {
224     if (!aValidPrs)
225       myValidPrs.append(theValue);
226     // the commented code will be useful when the valid state of the presentation
227     // will be changable between activate/deactivate. Currently it does not happen.
228     //if (anInvalidPrs)
229     //  myInvalidPrs.removeOne(theValue);
230   }
231   else { // !theValid
232     if (!anInvalidPrs)
233       myInvalidPrs.append(theValue);
234     //if (!aValidPrs)
235     //  myValidPrs.removeOne(theValue);
236   }
237 #ifdef DEBUG_VALID_STATE
238   qDebug(QString("storeValidState: myValidPrs.size() = %1, myInvalidPrs.size() = %2").arg(myValidPrs.count())
239                  .arg(myInvalidPrs.count()).toStdString().c_str());
240 #endif
241 }
242
243 //********************************************************************
244 bool ModuleBase_WidgetValidated::getValidState(const ModuleBase_ViewerPrs& theValue, bool& theValid)
245 {
246   bool aValidPrs = myValidPrs.contains(theValue);
247   bool anInvalidPrs = myInvalidPrs.contains(theValue);
248
249   if (aValidPrs)
250     theValid = true;
251   else if (anInvalidPrs)
252     theValid = false;
253
254   return aValidPrs || anInvalidPrs;
255 }
256
257 //********************************************************************
258 void ModuleBase_WidgetValidated::clearValidState()
259 {
260 #ifdef DEBUG_VALID_STATE
261   qDebug("clearValidState");
262 #endif
263   myValidPrs.clear();
264   myInvalidPrs.clear();
265 }
266
267 //********************************************************************
268 QList<ModuleBase_ViewerPrs> ModuleBase_WidgetValidated::getFilteredSelected()
269 {
270   QList<ModuleBase_ViewerPrs> aSelected = myWorkshop->selection()->getSelected(
271                                                        ModuleBase_ISelection::Viewer);
272
273   QList<ModuleBase_ViewerPrs> anOBSelected = myWorkshop->selection()->getSelected(
274                                                        ModuleBase_ISelection::Browser);
275   // filter the OB presentations
276   filterPresentations(anOBSelected);
277   if (!anOBSelected.isEmpty())
278     ModuleBase_ISelection::appendSelected(anOBSelected, aSelected);
279
280   return aSelected;
281 }
282
283 //********************************************************************
284 void ModuleBase_WidgetValidated::filterPresentations(QList<ModuleBase_ViewerPrs>& theValues)
285 {
286   QList<ModuleBase_ViewerPrs> aValidatedValues;
287
288   QList<ModuleBase_ViewerPrs>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
289   bool isDone = false;
290   for (; anIt != aLast; anIt++) {
291     if (isValidInFilters(*anIt))
292       aValidatedValues.append(*anIt);
293   }
294   if (aValidatedValues.size() != theValues.size()) {
295     theValues.clear();
296     theValues = aValidatedValues;
297   }
298 }