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()
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 bool aSketchIsVisualized = myPreviewPlanes->hasVisualizedSketch(myWorkshop);
199 if (!aBodyIsVisualized && !aSketchIsVisualized) {
200 // We have to select a plane before any operation
201 myPreviewPlanes->showPreviewPlanes(myWorkshop);
204 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
205 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
207 aWorkshop->viewer()->update();
211 QIntList PartSet_WidgetSketchCreator::getShapeTypes() const
213 QIntList aShapeTypes;
214 foreach(QString aType, myShapeTypes) {
215 aShapeTypes.append(ModuleBase_Tools::shapeType(aType));
220 void PartSet_WidgetSketchCreator::setEditingMode(bool isEditing)
222 ModuleBase_ModelWidget::setEditingMode(isEditing);
224 setVisibleSelectionControl(false);
226 ModuleBase_ModelWidget* anAttributeListWidget = 0;
227 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
228 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
229 const QList<ModuleBase_ModelWidget*>& aWidgets = aPanel->modelWidgets();
230 foreach(ModuleBase_ModelWidget* aWidget, aWidgets) {
231 if (aWidget->attributeID() == myAttributeListID) {
232 anAttributeListWidget = aWidget;
236 if (anAttributeListWidget)
237 setEnabledModelWidget(anAttributeListWidget, !hasSubObjects());
241 bool PartSet_WidgetSketchCreator::isSelectionMode() const
243 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
244 bool aHasValueInList = anAttrList.get() && anAttrList->size() > 0;
246 return !aHasValueInList;
249 bool PartSet_WidgetSketchCreator::hasSubObjects() const
251 bool aHasSubObjects = false;
253 bool aCanSetFocus = true;
254 CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
255 if (aComposite.get())
256 aHasSubObjects = aComposite->numberOfSubs() > 0;
257 return aHasSubObjects;
260 bool PartSet_WidgetSketchCreator::setSelection(QList<ModuleBase_ViewerPrsPtr>& theValues,
261 const bool theToValidate)
264 if (!startSketchOperation(theValues)) {
265 myIsCustomAttribute = true;
266 QList<ModuleBase_ViewerPrsPtr>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
267 bool aProcessed = false;
268 for (; anIt != aLast; anIt++) {
269 ModuleBase_ViewerPrsPtr aValue = *anIt;
270 if (!theToValidate || isValidInFilters(aValue))
271 aProcessed = setSelectionCustom(aValue) || aProcessed;
273 myIsCustomAttribute = false;
276 emit valuesChanged();
277 updateObject(myFeature);
278 setVisibleSelectionControl(false);
279 // manually deactivation because the widget was not activated as has no focus acceptin controls
281 emit focusOutWidget(this);
287 //********************************************************************
288 void PartSet_WidgetSketchCreator::onSelectionChanged()
290 QList<ModuleBase_ViewerPrsPtr> aSelected = getFilteredSelected();
291 bool isDone = setSelection(aSelected, true/*false*/);
294 //********************************************************************
295 void PartSet_WidgetSketchCreator::updateOnSelectionChanged(const bool theDone)
299 bool PartSet_WidgetSketchCreator::startSketchOperation(const QList<ModuleBase_ViewerPrsPtr>& theValues)
301 bool aSketchStarted = false;
303 if (theValues.size() != 1)
304 return aSketchStarted;
306 ModuleBase_ViewerPrsPtr aValue = theValues.front();
307 if (!aValue.get() || !PartSet_WidgetSketchLabel::canFillSketch(aValue))
308 return aSketchStarted;
310 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(aValue->object());
311 /// sketch should not started by object(face) selected as global. If Local face is selected,
312 /// sketch is started
313 if (aResult.get() && aValue->shape().get() && aResult->shape()->isEqual(aValue->shape())) {
314 ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aResult);
315 if (!aConstruction.get() || !aConstruction->isInfinite())
316 return aSketchStarted;
318 aSketchStarted = true;
320 // manually deactivation because the widget was not activated as has no focus acceptin controls
322 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
323 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
325 // Launch Sketch operation
326 CompositeFeaturePtr aCompFeature =
327 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
329 // start edit operation for the sketch
330 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
331 (myModule->createOperation("Sketch"));
332 QList<ModuleBase_ViewerPrsPtr> aValues;
333 aValues.push_back(aValue);
334 aFOperation->setPreselection(aValues);
336 myModule->sendOperation(aFOperation);
338 return aSketchStarted;
341 bool PartSet_WidgetSketchCreator::focusTo()
343 // this method is called only in creation mode. In Edition mode this widget is hidden
344 if (isSelectionMode() && !hasSubObjects()) {
345 setVisibleSelectionControl(true);
346 activateSelectionControl();
347 openExtrusionTransaction();
351 connect(myModule, SIGNAL(resumed(ModuleBase_Operation*)), SLOT(onResumed(ModuleBase_Operation*)));
356 void PartSet_WidgetSketchCreator::deactivate()
358 ModuleBase_WidgetSelector::deactivate();
360 bool aHidePreview = myPreviewPlanes->isPreviewDisplayed();
361 myPreviewPlanes->erasePreviewPlanes(myWorkshop);
363 XGUI_Tools::workshop(myWorkshop)->viewer()->update();
367 void PartSet_WidgetSketchCreator::onResumed(ModuleBase_Operation* theOp)
369 SessionPtr aMgr = ModelAPI_Session::get();
370 bool aIsOp = aMgr->isOperation();
372 // in current implementation, all transactions are closed when resume happens
373 // so, this is a wrong case, which is not checked.
374 // To provide it, make correction in later rows about abort/undo transactions
377 // Set visible only selection control
378 setVisibleSelectionControl(true);
380 // Validate the created sketch. If it is valid, it is set into the composite feature selection
381 // list, otherwise it is removed
382 CompositeFeaturePtr aCompFeature =
383 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(myFeature);
384 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
385 if (aCompFeature->numberOfSubs() > 0) {
386 // set the sub feature to attribute selection list and check whether sketch is valid
387 SessionPtr aMgr = ModelAPI_Session::get();
388 const static std::string aNestedOpID("Set Sketch result into Selection list");
389 aMgr->startOperation(aNestedOpID, false); // false to not attach to Extrusion operation
390 setSketchObjectToList(aCompFeature, anAttrList);
391 aMgr->finishOperation();
393 if (!validateSelectionList()) {
394 #ifdef DEBUG_UNDO_INVALID_SKETCH
395 aMgr->undo(); // Extrusion modification parameters: setSketchObjectToList()
396 aMgr->undo(); /// Sketch creation
398 aMgr->startOperation("Delete invalid Sketch feature", false);
400 // delete invalid sketch
401 CompositeFeaturePtr aSketchFeature =
402 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCompFeature->subFeature(0));
403 QObjectPtrList anObjects;
404 anObjects.append(aSketchFeature);
406 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
407 aWorkshop->deleteFeatures(anObjects, std::set<FeaturePtr>());
409 aMgr->finishOperation();
413 openExtrusionTransaction();
415 if (aCompFeature->numberOfSubs() == 0) {
416 // call activateWidget() of the parent to connect to the viewer seleciton
417 activateSelectionControl();
420 // check if the created sketch is valid. If it is invalid, it will be deleted with warning else
421 /// the attribute selection list will be filled by result of this sketch.
422 setVisibleSelectionControl(false);
424 // Update value in attribute selection list
425 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
426 XGUI_PropertyPanel* aPanel = aWorkshop->propertyPanel();
427 const QList<ModuleBase_ModelWidget*>& aWidgets = aPanel->modelWidgets();
428 foreach(ModuleBase_ModelWidget* aWidget, aWidgets) {
429 if (aWidget->attributeID() == myAttributeListID)
430 aWidget->restoreValue();
433 // Hide sketcher result
434 CompositeFeaturePtr aSketchFeature =
435 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCompFeature->subFeature(0));
436 std::list<ResultPtr> aResults = aSketchFeature->results();
437 std::list<ResultPtr>::const_iterator aIt;
438 for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
439 (*aIt)->setDisplayed(false);
441 aSketchFeature->setDisplayed(false);
442 static Events_Loop* aLoop = Events_Loop::loop();
443 aLoop->flush(aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY));
445 // Add Selected body were created the sketcher to list of selected objects
446 std::string anObjectsAttribute = FeaturesPlugin_CompositeBoolean::OBJECTS_ID();
447 AttributeSelectionListPtr aSelList = aCompFeature->data()->selectionList(anObjectsAttribute);
448 if (aSelList.get()) {
449 DataPtr aData = aSketchFeature->data();
450 AttributeSelectionPtr aSelAttr = std::dynamic_pointer_cast<ModelAPI_AttributeSelection>
451 (aData->attribute(SketchPlugin_SketchEntity::EXTERNAL_ID()));
452 ResultPtr aRes = aSelAttr.get() ? aSelAttr->context() : ResultPtr();
454 SessionPtr aMgr = ModelAPI_Session::get();
455 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
456 AttributePtr anAttribute = myFeature->attribute(anObjectsAttribute);
457 std::string aValidatorID, anError;
458 aSelList->append(aRes, GeomShapePtr());
459 if (aFactory->validate(anAttribute, aValidatorID, anError))
460 updateObject(aCompFeature);
469 bool PartSet_WidgetSketchCreator::validateSelectionList() const
471 AttributeSelectionListPtr anAttrList = myFeature->data()->selectionList(myAttributeListID);
473 SessionPtr aMgr = ModelAPI_Session::get();
474 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
475 std::string aValidatorID, anError;
476 bool isValidPComposite = aFactory->validate(anAttrList, aValidatorID, anError);
477 if (!isValidPComposite) {
478 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myModule->workshop());
479 QMessageBox::question(aWorkshop->desktop(), tr("Apply current feature"),
480 tr("Sketch is invalid and will be deleted.\nError: %1").arg(anError.c_str()),
483 return isValidPComposite;
486 void PartSet_WidgetSketchCreator::setSketchObjectToList(const CompositeFeaturePtr& theCompositeFeature,
487 const AttributePtr& theAttribute)
489 if (!theCompositeFeature.get() || theCompositeFeature->numberOfSubs() != 1)
492 AttributeSelectionListPtr aBaseObjectsSelectionList =
493 std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(theAttribute);
494 if(!aBaseObjectsSelectionList.get() || aBaseObjectsSelectionList->isInitialized()) {
498 FeaturePtr aSketchFeature = theCompositeFeature->subFeature(0);
499 if(!aSketchFeature.get() || aSketchFeature->results().empty()) {
503 ResultPtr aSketchRes = aSketchFeature->results().front();
504 ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aSketchRes);
505 if(!aConstruction.get()) {
509 if(aBaseObjectsSelectionList->size() == 0) {
510 aBaseObjectsSelectionList->append(aSketchRes, GeomShapePtr());
514 void PartSet_WidgetSketchCreator::setEnabledModelWidget(ModuleBase_ModelWidget* theModelWidget,
515 const bool theEnabled)
517 QList<QWidget*> aMyControls = theModelWidget->getControls();
518 foreach(QWidget* eachControl, aMyControls) {
519 eachControl->setEnabled(theEnabled);