1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_WidgetSketchCreator.cpp
4 // Created: 08 June 2015
5 // Author: Vitaly SMETANNIKOV
7 #include "PartSet_WidgetSketchCreator.h"
8 #include "PartSet_Module.h"
9 #include "PartSet_WidgetSketchLabel.h"
10 #include "PartSet_PreviewPlanes.h"
12 #include <Config_Keywords.h>
14 #include <XGUI_ModuleConnector.h>
15 #include <XGUI_Workshop.h>
16 #include <XGUI_Displayer.h>
17 #include <XGUI_SelectionMgr.h>
18 #include <XGUI_OperationMgr.h>
19 #include <XGUI_PropertyPanel.h>
20 #include <XGUI_Tools.h>
21 #include <XGUI_ViewerProxy.h>
23 #include <GeomAPI_Face.h>
25 #include <ModelAPI_Session.h>
26 #include <ModelAPI_ResultBody.h>
27 #include <ModelAPI_AttributeSelection.h>
28 #include <ModelAPI_AttributeSelectionList.h>
29 #include <ModelAPI_Validator.h>
30 #include <ModelAPI_Events.h>
31 #include <ModelAPI_ResultConstruction.h>
33 #include <SketchPlugin_SketchEntity.h>
34 #include <FeaturesPlugin_CompositeBoolean.h>
36 #include <ModuleBase_Tools.h>
37 #include <ModuleBase_Operation.h>
38 #include <ModuleBase_IPropertyPanel.h>
39 #include <ModuleBase_OperationFeature.h>
40 #include <ModuleBase_ViewerPrs.h>
42 #include <Config_WidgetAPI.h>
44 #include <Events_Loop.h>
48 //#include <QFormLayout>
49 #include <QVBoxLayout>
50 #include <QMessageBox>
51 #include <QMainWindow>
53 #define DEBUG_UNDO_INVALID_SKETCH
55 PartSet_WidgetSketchCreator::PartSet_WidgetSketchCreator(QWidget* theParent,
56 PartSet_Module* theModule,
57 const Config_WidgetAPI* theData)
58 : ModuleBase_WidgetSelector(theParent, theModule->workshop(), theData),
59 myModule(theModule), myIsCustomAttribute(false)
61 myAttributeListID = theData->getProperty("attribute_list_id");
63 //QFormLayout* aLayout = new QFormLayout(this);
64 QVBoxLayout* aLayout = new QVBoxLayout(this);
65 ModuleBase_Tools::zeroMargins(aLayout);
67 ModuleBase_Tools::adjustMargins(aLayout);
69 QString aLabelText = QString::fromStdString(theData->widgetLabel());
70 QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
72 myLabel = new QLabel(aLabelText, this);
73 myLabel->setWordWrap(true);
74 aLayout->addWidget(myLabel);
75 aLayout->addStretch(1);
77 std::string aTypes = theData->getProperty("shape_types");
78 myShapeTypes = QString(aTypes.c_str()).split(' ', QString::SkipEmptyParts);
80 myPreviewPlanes = new PartSet_PreviewPlanes();
83 PartSet_WidgetSketchCreator::~PartSet_WidgetSketchCreator()
85 // we need to deactivate here in order to hide preview planes if the selection mode is
90 QList<QWidget*> PartSet_WidgetSketchCreator::getControls() const
92 QList<QWidget*> aControls;
93 aControls.append(myLabel);
97 bool PartSet_WidgetSketchCreator::restoreValueCustom()
102 bool PartSet_WidgetSketchCreator::storeValueCustom() const
107 AttributePtr PartSet_WidgetSketchCreator::attribute() const
109 AttributePtr anAttribute;
110 if (myIsCustomAttribute)
111 anAttribute = myFeature->attribute(myAttributeListID);
113 anAttribute = ModuleBase_WidgetSelector::attribute();
118 //********************************************************************
119 void PartSet_WidgetSketchCreator::openExtrusionTransaction()
121 SessionPtr aMgr = ModelAPI_Session::get();
122 bool aIsOp = aMgr->isOperation();
124 const static std::string aNestedOpID("Parameters modification");
125 aMgr->startOperation(aNestedOpID, true);
129 //********************************************************************
130 bool PartSet_WidgetSketchCreator::isValidSelection(const ModuleBase_ViewerPrsPtr& theValue)
133 if (myIsCustomAttribute) {
134 // check only suiting of the value to custom attribute (myAttributeListID)
135 // do not cash of validation to avoid using states, stored for XML attribute
136 // there is an alternative is to call clearValidatedCash() in setSelection()
137 aValid = isValidSelectionForAttribute(theValue, attribute());
139 else { /// if the validated attribute is already custom
140 if (getValidState(theValue, aValid)) {
143 aValid = isValidSelectionCustom(theValue);
145 // check selection to create new sketh (XML current attribute)
146 aValid = isValidSelectionForAttribute(theValue, attribute());
148 // check selection to fill list attribute (myAttributeListID)
149 bool isCustomAttribute = myIsCustomAttribute;
150 myIsCustomAttribute = true;
151 aValid = isValidSelectionForAttribute(theValue, attribute());
152 myIsCustomAttribute = isCustomAttribute;
155 storeValidState(theValue, aValid);
159 //********************************************************************
160 bool PartSet_WidgetSketchCreator::isValidSelectionCustom(const ModuleBase_ViewerPrsPtr& theValue)
162 return PartSet_WidgetSketchLabel::canFillSketch(theValue);
165 void PartSet_WidgetSketchCreator::activateSelectionControl()
167 // we need to call activate here as the widget has no focus accepted controls
168 // if these controls are added here, activate will happens automatically after focusIn()
169 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
170 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
171 aPanel->activateWidget(this, false);
174 void PartSet_WidgetSketchCreator::setVisibleSelectionControl(const bool theSelectionControl)
176 // hide current widget, activate the next widget
177 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
178 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
179 const QList<ModuleBase_ModelWidget*>& aWidgets = aPanel->modelWidgets();
180 foreach(ModuleBase_ModelWidget* aWidget, aWidgets) {
181 if (theSelectionControl) { // hide other controls
183 aWidget->setVisible(false);
185 else { // hide current control
187 aWidget->setVisible(false);
189 aWidget->setVisible(true);
190 if (aWidget->attributeID() == myAttributeListID)
191 setEnabledModelWidget(aWidget, !hasSubObjects());
196 if (theSelectionControl) {
197 bool aBodyIsVisualized = myPreviewPlanes->hasVisualizedBodies(myWorkshop);
198 if (!aBodyIsVisualized) {
199 // We have to select a plane before any operation
200 myPreviewPlanes->showPreviewPlanes(myWorkshop);
203 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
204 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
206 aWorkshop->viewer()->update();
210 QIntList PartSet_WidgetSketchCreator::getShapeTypes() const
212 QIntList aShapeTypes;
213 foreach(QString aType, myShapeTypes) {
214 aShapeTypes.append(ModuleBase_Tools::shapeType(aType));
219 void PartSet_WidgetSketchCreator::setEditingMode(bool isEditing)
221 ModuleBase_ModelWidget::setEditingMode(isEditing);
223 setVisibleSelectionControl(false);
225 ModuleBase_ModelWidget* anAttributeListWidget = 0;
226 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
227 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
228 const QList<ModuleBase_ModelWidget*>& aWidgets = aPanel->modelWidgets();
229 foreach(ModuleBase_ModelWidget* aWidget, aWidgets) {
230 if (aWidget->attributeID() == myAttributeListID) {
231 anAttributeListWidget = aWidget;
235 if (anAttributeListWidget)
236 setEnabledModelWidget(anAttributeListWidget, !hasSubObjects());
240 bool PartSet_WidgetSketchCreator::isSelectionMode() const
242 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
243 bool aHasValueInList = anAttrList.get() && anAttrList->size() > 0;
245 return !aHasValueInList;
248 bool PartSet_WidgetSketchCreator::hasSubObjects() const
250 bool aHasSubObjects = false;
252 bool aCanSetFocus = true;
253 CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
254 if (aComposite.get())
255 aHasSubObjects = aComposite->numberOfSubs() > 0;
256 return aHasSubObjects;
259 bool PartSet_WidgetSketchCreator::setSelection(QList<ModuleBase_ViewerPrsPtr>& theValues,
260 const bool theToValidate)
263 if (!startSketchOperation(theValues)) {
264 myIsCustomAttribute = true;
265 QList<ModuleBase_ViewerPrsPtr>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
266 bool aProcessed = false;
267 for (; anIt != aLast; anIt++) {
268 ModuleBase_ViewerPrsPtr aValue = *anIt;
269 if (!theToValidate || isValidInFilters(aValue))
270 aProcessed = setSelectionCustom(aValue) || aProcessed;
272 myIsCustomAttribute = false;
275 emit valuesChanged();
276 updateObject(myFeature);
277 setVisibleSelectionControl(false);
278 // manually deactivation because the widget was not activated as has no focus acceptin controls
280 emit focusOutWidget(this);
286 //********************************************************************
287 void PartSet_WidgetSketchCreator::onSelectionChanged()
289 QList<ModuleBase_ViewerPrsPtr> aSelected = getFilteredSelected();
290 bool isDone = setSelection(aSelected, true/*false*/);
293 //********************************************************************
294 void PartSet_WidgetSketchCreator::updateOnSelectionChanged(const bool theDone)
298 bool PartSet_WidgetSketchCreator::startSketchOperation(const QList<ModuleBase_ViewerPrsPtr>& theValues)
300 bool aSketchStarted = false;
302 if (theValues.size() != 1)
303 return aSketchStarted;
305 ModuleBase_ViewerPrsPtr aValue = theValues.front();
306 if (!aValue.get() || !PartSet_WidgetSketchLabel::canFillSketch(aValue))
307 return aSketchStarted;
309 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(aValue->object());
310 /// sketch should not started by object(face) selected as global. If Local face is selected,
311 /// sketch is started
312 if (aResult.get() && aValue->shape().get() && aResult->shape()->isEqual(aValue->shape()))
313 return aSketchStarted;
315 aSketchStarted = true;
317 // manually deactivation because the widget was not activated as has no focus acceptin controls
319 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
320 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
322 // Launch Sketch operation
323 CompositeFeaturePtr aCompFeature =
324 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
326 // start edit operation for the sketch
327 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
328 (myModule->createOperation("Sketch"));
329 QList<ModuleBase_ViewerPrsPtr> aValues;
330 aValues.push_back(aValue);
331 aFOperation->setPreselection(aValues);
333 myModule->sendOperation(aFOperation);
335 return aSketchStarted;
338 bool PartSet_WidgetSketchCreator::focusTo()
340 // this method is called only in creation mode. In Edition mode this widget is hidden
341 if (isSelectionMode() && !hasSubObjects()) {
342 setVisibleSelectionControl(true);
343 activateSelectionControl();
344 openExtrusionTransaction();
348 connect(myModule, SIGNAL(resumed(ModuleBase_Operation*)), SLOT(onResumed(ModuleBase_Operation*)));
353 void PartSet_WidgetSketchCreator::deactivate()
355 ModuleBase_WidgetSelector::deactivate();
357 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
358 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
360 XGUI_Tools::workshop(myWorkshop)->viewer()->update();
364 void PartSet_WidgetSketchCreator::onResumed(ModuleBase_Operation* theOp)
366 SessionPtr aMgr = ModelAPI_Session::get();
367 bool aIsOp = aMgr->isOperation();
369 // in current implementation, all transactions are closed when resume happens
370 // so, this is a wrong case, which is not checked.
371 // To provide it, make correction in later rows about abort/undo transactions
374 // Set visible only selection control
375 setVisibleSelectionControl(true);
377 // Validate the created sketch. If it is valid, it is set into the composite feature selection
378 // list, otherwise it is removed
379 CompositeFeaturePtr aCompFeature =
380 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
381 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
382 if (aCompFeature->numberOfSubs() > 0) {
383 // set the sub feature to attribute selection list and check whether sketch is valid
384 SessionPtr aMgr = ModelAPI_Session::get();
385 const static std::string aNestedOpID("Set Sketch result into Selection list");
386 aMgr->startOperation(aNestedOpID, false); // false to not attach to Extrusion operation
387 setSketchObjectToList(aCompFeature, anAttrList);
388 aMgr->finishOperation();
390 if (!validateSelectionList()) {
391 #ifdef DEBUG_UNDO_INVALID_SKETCH
392 aMgr->undo(); // Extrusion modification parameters: setSketchObjectToList()
393 aMgr->undo(); /// Sketch creation
395 aMgr->startOperation("Delete invalid Sketch feature", false);
397 // delete invalid sketch
398 CompositeFeaturePtr aSketchFeature =
399 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCompFeature->subFeature(0));
400 QObjectPtrList anObjects;
401 anObjects.append(aSketchFeature);
403 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
404 aWorkshop->deleteFeatures(anObjects, std::set<FeaturePtr>());
406 aMgr->finishOperation();
410 openExtrusionTransaction();
412 if (aCompFeature->numberOfSubs() == 0) {
413 // call activateWidget() of the parent to connect to the viewer seleciton
414 activateSelectionControl();
417 // check if the created sketch is valid. If it is invalid, it will be deleted with warning else
418 /// the attribute selection list will be filled by result of this sketch.
419 setVisibleSelectionControl(false);
421 // Update value in attribute selection list
422 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
423 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
424 const QList<ModuleBase_ModelWidget*>& aWidgets = aPanel->modelWidgets();
425 foreach(ModuleBase_ModelWidget* aWidget, aWidgets) {
426 if (aWidget->attributeID() == myAttributeListID)
427 aWidget->restoreValue();
430 // Hide sketcher result
431 CompositeFeaturePtr aSketchFeature =
432 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCompFeature->subFeature(0));
433 std::list<ResultPtr> aResults = aSketchFeature->results();
434 std::list<ResultPtr>::const_iterator aIt;
435 for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
436 (*aIt)->setDisplayed(false);
438 aSketchFeature->setDisplayed(false);
439 static Events_Loop* aLoop = Events_Loop::loop();
440 aLoop->flush(aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY));
442 // Add Selected body were created the sketcher to list of selected objects
443 std::string anObjectsAttribute = FeaturesPlugin_CompositeBoolean::OBJECTS_ID();
444 AttributeSelectionListPtr aSelList = aCompFeature->data()->selectionList(anObjectsAttribute);
445 if (aSelList.get()) {
446 DataPtr aData = aSketchFeature->data();
447 AttributeSelectionPtr aSelAttr = std::dynamic_pointer_cast<ModelAPI_AttributeSelection>
448 (aData->attribute(SketchPlugin_SketchEntity::EXTERNAL_ID()));
449 ResultPtr aRes = aSelAttr.get() ? aSelAttr->context() : ResultPtr();
451 SessionPtr aMgr = ModelAPI_Session::get();
452 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
453 AttributePtr anAttribute = myFeature->attribute(anObjectsAttribute);
454 std::string aValidatorID, anError;
455 aSelList->append(aRes, GeomShapePtr());
456 if (aFactory->validate(anAttribute, aValidatorID, anError))
457 updateObject(aCompFeature);
466 bool PartSet_WidgetSketchCreator::validateSelectionList() const
468 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
470 SessionPtr aMgr = ModelAPI_Session::get();
471 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
472 std::string aValidatorID, anError;
473 bool isValidPComposite = aFactory->validate(anAttrList, aValidatorID, anError);
474 if (!isValidPComposite) {
475 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
476 QMessageBox::question(aWorkshop->desktop(), tr("Apply current feature"),
477 tr("Sketch is invalid and will be deleted.\nError: %1").arg(anError.c_str()),
480 return isValidPComposite;
483 void PartSet_WidgetSketchCreator::setSketchObjectToList(const CompositeFeaturePtr& theCompositeFeature,
484 const AttributePtr& theAttribute)
486 if (!theCompositeFeature.get() || theCompositeFeature->numberOfSubs() != 1)
489 AttributeSelectionListPtr aBaseObjectsSelectionList =
490 std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(theAttribute);
491 if(!aBaseObjectsSelectionList.get() || aBaseObjectsSelectionList->isInitialized()) {
495 FeaturePtr aSketchFeature = theCompositeFeature->subFeature(0);
496 if(!aSketchFeature.get() || aSketchFeature->results().empty()) {
500 ResultPtr aSketchRes = aSketchFeature->results().front();
501 ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aSketchRes);
502 if(!aConstruction.get()) {
506 if(aBaseObjectsSelectionList->size() == 0) {
507 aBaseObjectsSelectionList->append(aSketchRes, GeomShapePtr());
511 void PartSet_WidgetSketchCreator::setEnabledModelWidget(ModuleBase_ModelWidget* theModelWidget,
512 const bool theEnabled)
514 QList<QWidget*> aMyControls = theModelWidget->getControls();
515 foreach(QWidget* eachControl, aMyControls) {
516 eachControl->setEnabled(theEnabled);