Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_OperationFeature.cpp
old mode 100755 (executable)
new mode 100644 (file)
index 39bdd4e..108f1df
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_OperationFeature.cpp
- *
- *  Created on: Apr 2, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #include "ModuleBase_OperationFeature.h"
 
@@ -15,6 +25,7 @@
 #include "ModuleBase_IPropertyPanel.h"
 #include "ModuleBase_ISelection.h"
 #include "ModuleBase_IViewer.h"
+#include "ModuleBase_Tools.h"
 
 #include <ModelAPI_AttributeDouble.h>
 #include <ModelAPI_Document.h>
 
 #include <QTimer>
 
+// the define to check the activated object as a sub-feature by argument of
+// the operation feature. E.g. rectangle feature(operation), line(in argument) to be not activated
+#define DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
+#ifdef DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
+#include <ModelAPI_AttributeRefList.h>
+#endif
+
+//#define DEBUG_OPERATION_START
+
 #ifdef _DEBUG
 #include <QDebug>
 #endif
 
-#define APPLY_BY_ENTER_OR_TAB
-
 ModuleBase_OperationFeature::ModuleBase_OperationFeature(const QString& theId, QObject* theParent)
-: ModuleBase_Operation(theId, theParent),
-  myIsEditing(false)
+: ModuleBase_Operation(theId, theParent), myIsEditing(false), myNeedToBeAborted(false),
+myRestartTransactionOnResume(false)
 {
 }
 
@@ -51,6 +69,36 @@ ModuleBase_OperationFeature::~ModuleBase_OperationFeature()
   clearPreselection();
 }
 
+void ModuleBase_OperationFeature::setEditOperation(const bool& isEditState
+                                                   /*const bool theRestartTransaction*/)
+{
+  bool isCurrentEditState = isEditOperation();
+  if (isCurrentEditState == isEditState)
+    return;
+
+  /*
+  // this case is obsolete as it was not approved for reentrant sketch operation
+  // it was implemented when isEditState did not exist and only edit operation can be set
+  if (theRestartTransaction) {
+    // finsh previous create operation
+    emit beforeCommitted();
+    SessionPtr aMgr = ModelAPI_Session::get();
+    ModelAPI_Session::get()->finishOperation();
+
+    // start new edit operation
+    myIsEditing = true;
+    QString anId = getDescription()->operationId();
+    if (myIsEditing) {
+      anId = anId.append(EditSuffix());
+    }
+    ModelAPI_Session::get()->startOperation(anId.toStdString());
+    emit beforeStarted();
+  } else*/
+  myIsEditing = isEditState;
+
+  propertyPanel()->setEditingMode(isEditOperation());
+}
+
 FeaturePtr ModuleBase_OperationFeature::feature() const
 {
   return myFeature;
@@ -62,17 +110,10 @@ bool ModuleBase_OperationFeature::isValid() const
     return true; // rename operation
   if (myFeature->isAction())
     return true;
-  //Get validators for the Id
-  SessionPtr aMgr = ModelAPI_Session::get();
-  ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
-  bool aValid = aFactory->validate(myFeature);
 
-  // the feature exec state should be checked in order to do not apply features, which result can not
-  // be built. E.g. extrusion on sketch, where the "to" is a perpendicular plane to the sketch
-  bool isDone = ( myFeature->data()->execState() == ModelAPI_StateDone
-               || myFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
-
-  return aValid && isDone;
+  std::string anError = ModelAPI_Tools::getFeatureError(myFeature);
+  //ModuleBase_Tools::translate(myFeature->getKind(), anError);
+  return anError.empty();
 }
 
 void ModuleBase_OperationFeature::startOperation()
@@ -86,7 +127,8 @@ void ModuleBase_OperationFeature::startOperation()
 
   myVisualizedObjects.clear();
   // store hidden result features
-  std::list<ResultPtr> aResults = aFeature->results();
+  std::list<ResultPtr> aResults;
+  ModelAPI_Tools::allResults(aFeature, aResults);
   std::list<ResultPtr>::const_iterator aIt;
   for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
     ObjectPtr anObject = *aIt;
@@ -109,7 +151,8 @@ void ModuleBase_OperationFeature::stopOperation()
     return;
 
   // store hidden result features
-  std::list<ResultPtr> aResults = aFeature->results();
+  std::list<ResultPtr> aResults;
+  ModelAPI_Tools::allResults(aFeature, aResults);
   std::list<ResultPtr>::const_iterator aIt;
   for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
     ObjectPtr anObject = *aIt;
@@ -132,20 +175,6 @@ FeaturePtr ModuleBase_OperationFeature::createFeature(const bool theFlushMessage
     std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
     myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
   }
-  if (myFeature) {  // TODO: generate an error if feature was not created
-    setIsModified(true);
-    // Model update should call "execute" of a feature.
-    //myFeature->execute();
-    // Init default values
-    /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
-     QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
-     for (; anIt != aLast; anIt++) {
-     (*anIt)->storeValue(aFeature);
-     }*/
-  }
-
-  if (theFlushMessage)
-    Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
   return myFeature;
 }
 
@@ -161,12 +190,35 @@ bool ModuleBase_OperationFeature::hasObject(ObjectPtr theObj) const
   if (aFeature) {
     if (aFeature == theObj)
       return true;
-    std::list<ResultPtr> aResults = aFeature->results();
-    std::list<ResultPtr>::const_iterator aIt;
-    for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
-      if (theObj == (*aIt))
-        return true;
+    ResultPtr anObjRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObj);
+    if (anObjRes.get() && aFeature == aFeature->document()->feature(anObjRes)) {
+      return true;
     }
+#ifdef DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
+    if (aFeature->isMacro()) {
+      // macro feature may refers to sub-features,
+      // which also should be deactivated when the operation
+      // is active, e.g. rectangle'lines.
+      FeaturePtr anObjectFeature = ModelAPI_Feature::feature(theObj);
+      std::list<AttributePtr> anAttributes = aFeature->data()->attributes(
+                                              ModelAPI_AttributeRefList::typeId());
+      std::list<AttributePtr>::const_iterator
+        anIt = anAttributes.begin(), aLast = anAttributes.end();
+      bool aFoundObject = false;
+      for (; anIt != aLast && !aFoundObject; anIt++) {
+        std::shared_ptr<ModelAPI_AttributeRefList> aCurSelList =
+                               std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(*anIt);
+        for (int i = 0, aNb = aCurSelList->size(); i < aNb && !aFoundObject; i++) {
+          ObjectPtr aCurObj = aCurSelList->object(i);
+          FeaturePtr aCurFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(aCurObj);
+          if (aCurFeat.get()) {
+            aFoundObject = anObjectFeature == aCurFeat;
+          }
+        }
+      }
+      return aFoundObject;
+    }
+#endif
   }
   return false;
 }
@@ -176,9 +228,11 @@ bool ModuleBase_OperationFeature::isDisplayedOnStart(ObjectPtr theObject)
   return myVisualizedObjects.find(theObject) != myVisualizedObjects.end();
 }
 
-void ModuleBase_OperationFeature::start()
+bool ModuleBase_OperationFeature::start()
 {
-  setIsModified(false);
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::start -- begin");
+#endif
   QString anId = getDescription()->operationId();
   if (myIsEditing) {
     anId = anId.append(EditSuffix());
@@ -196,16 +250,26 @@ void ModuleBase_OperationFeature::start()
       // in order to update commands status in the workshop, to be exact the feature action
       // to be unchecked
       abort();
-      return;
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::start -- end : IMPOSSIBLE to start");
+#endif
+      return false;
     }
   }
   //Already called startOperation();
   emit started();
-
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::start -- end");
+#endif
+  return true;
 }
 
 void ModuleBase_OperationFeature::abort()
 {
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::abort -- begin");
+#endif
+
   emit beforeAborted();
 
   // the viewer update should be blocked in order to avoid the features blinking before they are
@@ -214,6 +278,12 @@ void ModuleBase_OperationFeature::abort()
       new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
   Events_Loop::loop()->send(aMsg);
 
+  if (myFeature.get())
+  {
+    static const Events_ID anEvent = Events_Loop::eventByName(EVENT_VISUAL_ATTRIBUTES);
+    ModelAPI_EventCreator::get()->sendUpdated(myFeature, anEvent);
+  }
+
   // the widgets of property panel should not process any events come from data mode
   // after abort clicked. Some signal such as redisplay/create influence on content
   // of the object browser and viewer context. Therefore it influence to the current
@@ -223,7 +293,8 @@ void ModuleBase_OperationFeature::abort()
   if (aPropertyPanel)
     aPropertyPanel->cleanContent();
 
-  myFeature->setStable(true);
+  if (myFeature.get())
+    myFeature->setStable(true);
 
   abortOperation();
   stopOperation();
@@ -239,11 +310,26 @@ void ModuleBase_OperationFeature::abort()
   Events_Loop::loop()->send(aMsg);
 
   emit aborted();
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::abort -- end");
+#endif
 }
 
 bool ModuleBase_OperationFeature::commit()
 {
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::commit -- begin");
+#endif
+  ModuleBase_IPropertyPanel* aPanel = propertyPanel();
+  if (aPanel) {
+    ModuleBase_ModelWidget* anActiveWidget = aPanel->activeWidget();
+    if (anActiveWidget && anActiveWidget->getValueState() == ModuleBase_ModelWidget::ModifiedInPP) {
+      anActiveWidget->storeValue();
+    }
+    aPanel->onAcceptData();
+  }
   if (canBeCommitted()) {
+    emit beforeCommitted();
     // the widgets of property panel should not process any events come from data mode
     // after commit clicked. Some signal such as redisplay/create influence on content
     // of the object browser and viewer context. Therefore it influence to the current
@@ -255,69 +341,86 @@ bool ModuleBase_OperationFeature::commit()
 
     myFeature->setStable(true);
 
-    SessionPtr aMgr = ModelAPI_Session::get();
-    /// Set current feature and remeber old current feature
-
-    emit beforeCommitted();
     commitOperation();
-    aMgr->finishOperation();
 
     stopOperation();
+
+    SessionPtr aMgr = ModelAPI_Session::get();
+    aMgr->finishOperation();
+    // Finish operation has to be before stopped because stopped caused update of Object browser
+    // If it will be done before of cleaning of obsolete objects it will cause crash
     emit stopped();
     emit committed();
 
     afterCommitOperation();
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::commit -- end");
+#endif
     return true;
   }
+#ifdef DEBUG_OPERATION_START
+  qDebug("ModuleBase_OperationFeature::commit -- end : IMPOSSIBLE to commit");
+#endif
   return false;
 }
 
-void ModuleBase_OperationFeature::activateByPreselection()
+ModuleBase_ModelWidget* ModuleBase_OperationFeature::activateByPreselection(
+                                              const std::string& theGreedAttributeId)
 {
+  ModuleBase_ModelWidget* aWidget = 0;
   if (myPreSelection.empty())
-    return;
-
-  ModuleBase_ISelection::filterSelectionOnEqualPoints(myPreSelection);
+    return aWidget;
 
-  ModuleBase_ModelWidget* aFilledWgt = 0;
   ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
+  ModuleBase_ModelWidget* aFilledWgt = 0;
   if (aPropertyPanel) {
     const QList<ModuleBase_ModelWidget*>& aWidgets = aPropertyPanel->modelWidgets();
+    QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
+    ModuleBase_ModelWidget* aWgt = 0;
     if (!aWidgets.empty()) {
-      ModuleBase_ModelWidget* aWgt = 0;
-      QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
-      bool isSet = false;
-      // 1. apply the selection to controls
-      for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
-        aWgt = (*aWIt);
-        if (!aWgt->canSetValue())
-          continue;
-        aPropertyPanel->setPreselectionWidget(aWgt);
-        if (!aWgt->setSelection(myPreSelection, true)) {
-          isSet = false;
-          break;
-        } else {
-          isSet = true;
-          aFilledWgt = aWgt;
+      // equal vertices should not be used here
+      ModuleBase_ISelection::filterSelectionOnEqualPoints(myPreSelection);
+
+      if (!theGreedAttributeId.empty()) {
+        // set preselection to greed widget
+        for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
+          aWgt = (*aWIt);
+          if (aWgt->attributeID() == theGreedAttributeId) {
+            aPropertyPanel->setPreselectionWidget(aWgt);
+            if (aWgt->setSelection(myPreSelection, true)) {
+              aPropertyPanel->setPreselectionWidget(NULL);
+              aFilledWgt = aWgt;
+              break;
+            }
+            else { // do not process invalid for greed widget selection
+              break;
+            }
+          }
+        }
+      }
+      else {
+        // 1. apply the selection to controls
+        for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
+          aWgt = (*aWIt);
+          if (!aWgt->canAcceptFocus())
+            continue;
+          aPropertyPanel->setPreselectionWidget(aWgt);
+          if (myPreSelection.empty() || !aWgt->setSelection(myPreSelection, true))
+            break;
+          else
+            aFilledWgt = aWgt;
         }
       }
       aPropertyPanel->setPreselectionWidget(NULL);
       // in order to redisplay object in the viewer, the update/redisplay signals should be flushed
       // it is better to perform it not in setSelection of each widget, but do it here,
       // after the preselection is processed
-      ModuleBase_ModelWidget::updateObject(myFeature);
-
-      // 3. a signal should be emitted before the next widget activation
-      // because, the activation of the next widget will give a focus to the widget. As a result
-      // the value of the widget is initialized. And commit may happens until the value is entered.
-      if (aFilledWgt)
-        emit activatedByPreselection();
+      ModuleBase_Tools::flushUpdated(myFeature);
     }
-    // 4. activate the next obligatory widget
-    aPropertyPanel->activateNextWidget(aFilledWgt);
   }
-
   clearPreselection();
+
+  return aFilledWgt;
 }
 
 void ModuleBase_OperationFeature::setParentFeature(CompositeFeaturePtr theParent)
@@ -340,31 +443,37 @@ FeaturePtr ModuleBase_OperationFeature::previousCurrentFeature()
   return myPreviousCurrentFeature;
 }
 
-void ModuleBase_OperationFeature::initSelection(ModuleBase_ISelection* theSelection,
-                                         ModuleBase_IViewer* theViewer)
+void ModuleBase_OperationFeature::initSelection(
+  const QList<ModuleBase_ViewerPrsPtr>& thePreSelected)
 {
-  clearPreselection();
+  QObjectPtrList aCurrentFeatureResults;
 
-  QList<ModuleBase_ViewerPrs> aPreSelected;
   // Check that the selected result are not results of operation feature
   FeaturePtr aFeature = feature();
   if (aFeature) {
-    QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
-
-    std::list<ResultPtr> aResults = aFeature->results();
-    QObjectPtrList aResList;
+    std::list<ResultPtr> aResults;
+    ModelAPI_Tools::allResults(aFeature, aResults);
     std::list<ResultPtr>::const_iterator aIt;
     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
-      aResList.append(*aIt);
+      aCurrentFeatureResults.append(*aIt);
+  }
 
-    foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
-      if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
+  if (aCurrentFeatureResults.empty()) /// filtering of selection is not necessary
+    setPreselection(thePreSelected);
+  else { // create preselection list without results of current feature
+    QList<ModuleBase_ViewerPrsPtr> aPreSelected;
+    foreach (ModuleBase_ViewerPrsPtr aPrs, thePreSelected) {
+      if ((!aCurrentFeatureResults.contains(aPrs->object())) && (aPrs->object() != aFeature))
         aPreSelected.append(aPrs);
     }
-  } else
-    aPreSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
+    setPreselection(aPreSelected);
+  }
+}
 
-  myPreSelection = aPreSelected;
+void ModuleBase_OperationFeature::setPreselection(const QList<ModuleBase_ViewerPrsPtr>& theValues)
+{
+  clearPreselection();
+  myPreSelection = theValues;
 }
 
 void ModuleBase_OperationFeature::clearPreselection()
@@ -372,7 +481,7 @@ void ModuleBase_OperationFeature::clearPreselection()
   myPreSelection.clear();
 }
 
-void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* theProp) 
+void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 {
   ModuleBase_Operation::setPropertyPanel(theProp);
 
@@ -384,11 +493,12 @@ void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* th
     for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
       ModuleBase_ModelWidget* aWgt = (*aWIt);
       connect(aWgt, SIGNAL(valuesChanged()), this, SLOT(onValuesChanged()));
+      connect(aWgt, SIGNAL(valueStateChanged(int)), this, SLOT(onValueStateChanged(int)));
     }
   }
 
   // Do not activate widgets by default if the current operation is editing operation
-  // Because we don't know which widget is going to be edited. 
+  // Because we don't know which widget is going to be edited.
   if (!isEditOperation()) {
     // 4. activate the first obligatory widget
     theProp->activateNextWidget(NULL);
@@ -399,3 +509,11 @@ void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* th
       theProp->setFocusOnOkButton();
   }
 }
+
+void ModuleBase_OperationFeature::resumeOperation()
+{
+  if (myRestartTransactionOnResume) {
+    ModelAPI_Session::get()->startOperation(this->id().toStdString(), true);
+    myRestartTransactionOnResume = false;
+  }
+}