Salome HOME
Update copyrights
[modules/shaper.git] / src / ModuleBase / ModuleBase_Operation.cpp
index fc4e35945d538189b167bb51fa8dc1aaaa563cdd..b4f4a38b05296e9a20a94d30cabc41198ee4a188 100644 (file)
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_Operation.cpp
- *
- *  Created on: Apr 2, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// 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_Operation.h"
 
@@ -39,7 +49,6 @@
 
 ModuleBase_Operation::ModuleBase_Operation(const QString& theId, QObject* theParent)
     : QObject(theParent),
-      myIsEditing(false),
       myIsModified(false),
       myPropertyPanel(NULL)
 {
@@ -49,121 +58,43 @@ ModuleBase_Operation::ModuleBase_Operation(const QString& theId, QObject* thePar
 ModuleBase_Operation::~ModuleBase_Operation()
 {
   delete myDescription;
-  clearPreselection();
 }
 
-QString ModuleBase_Operation::id() const
+const QStringList& ModuleBase_Operation::grantedOperationIds() const
 {
-  return getDescription()->operationId();
+  return myGrantedIds;
 }
 
-FeaturePtr ModuleBase_Operation::feature() const
+void ModuleBase_Operation::setGrantedOperationIds(const QStringList& theList)
 {
-  return myFeature;
+  myGrantedIds = theList;
 }
 
-bool ModuleBase_Operation::isValid() const
-{
-  if (!myFeature || !myFeature->data()->isValid())
-    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;
-}
-
-
-bool ModuleBase_Operation::canBeCommitted() const
+QString ModuleBase_Operation::id() const
 {
-  return isValid();
+  return getDescription()->operationId();
 }
 
-FeaturePtr ModuleBase_Operation::createFeature(const bool theFlushMessage)
+bool ModuleBase_Operation::isValid() const
 {
-  if (myParentFeature.get()) {
-    myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
-  } else {
-    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
-    myIsModified = 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;
+  return true;
 }
 
-void ModuleBase_Operation::setFeature(FeaturePtr theFeature)
+bool ModuleBase_Operation::canBeCommitted() const
 {
-  myFeature = theFeature;
-  myIsEditing = true;
+  return isValid();
 }
 
-bool ModuleBase_Operation::hasObject(ObjectPtr theObj) const
+bool ModuleBase_Operation::start()
 {
-  FeaturePtr aFeature = feature();
-  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;
-    }
-  }
-  return false;
-}
+  myIsModified = false;
 
-void ModuleBase_Operation::start()
-{
-  QString anId = getDescription()->operationId();
-  if (myIsEditing) {
-    anId = anId.append(EditSuffix());
-  }
-  ModelAPI_Session::get()->startOperation(anId.toStdString());
-
-  if (!myIsEditing) {
-    FeaturePtr aFeature = createFeature();
-    // if the feature is not created, there is no sense to start the operation
-    if (aFeature.get() == NULL) {
-      // it is necessary to abor the operation in the session and emit the aborted signal
-      // in order to update commands status in the workshop, to be exact the feature action
-      // to be unchecked
-      abort();
-      return;
-    }
-  }
-  /// Set current feature and remeber old current feature
-  if (myIsEditing) {
-    SessionPtr aMgr = ModelAPI_Session::get();
-    DocumentPtr aDoc = aMgr->activeDocument();
-    myCurrentFeature = aDoc->currentFeature(true);
-    aDoc->setCurrentFeature(feature(), false);
-  }
+  ModelAPI_Session::get()->startOperation(id().toStdString());
 
   startOperation();
   emit started();
 
+  return true;
 }
 
 void ModuleBase_Operation::postpone()
@@ -180,47 +111,35 @@ void ModuleBase_Operation::resume()
 
 void ModuleBase_Operation::abort()
 {
-  if (myIsEditing) {
-    SessionPtr aMgr = ModelAPI_Session::get();
-    DocumentPtr aDoc = aMgr->activeDocument();
-    aDoc->setCurrentFeature(myCurrentFeature, true);
-    myCurrentFeature = FeaturePtr();
-  }
-  abortOperation();
-  emit aborted();
-
-  stopOperation();
-  // is is necessary to deactivate current widgets before the model operation is aborted
-  // because abort removes the feature and activated filters should not check it
-  propertyPanel()->cleanContent();
+  // the viewer update should be blocked in order to avoid the features blinking before they are
+  // hidden
+  //std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
+  //    new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
+  //Events_Loop::loop()->send(aMsg);
 
   ModelAPI_Session::get()->abortOperation();
+
   emit stopped();
+  // the viewer update should be unblocked in order to avoid the features blinking before they are
+  // hidden
+  //aMsg = std::shared_ptr<Events_Message>(
+  //              new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
+  //Events_Loop::loop()->send(aMsg);
+
+  emit aborted();
 }
 
 bool ModuleBase_Operation::commit()
 {
   if (canBeCommitted()) {
+    ModuleBase_IPropertyPanel* aPanel = propertyPanel();
+    if (aPanel)
+      aPanel->onAcceptData();
+
     SessionPtr aMgr = ModelAPI_Session::get();
-    /// Set current feature and remeber old current feature
-    if (myIsEditing) {
-      DocumentPtr aDoc = aMgr->activeDocument();
-      bool aIsOp = aMgr->isOperation();
-      if (!aIsOp)
-        aMgr->startOperation();
-      aDoc->setCurrentFeature(myCurrentFeature, true);
-      if (!aIsOp)
-        aMgr->finishOperation();
-      myCurrentFeature = FeaturePtr();
-    }
+
     commitOperation();
-    // check whether there are modifications performed during the current operation
-    // in the model
-    // in case if there are no modifications, do not increase the undo/redo stack
-    if (aMgr->isModified())
-      aMgr->finishOperation();
-    else
-      aMgr->abortOperation();
+    aMgr->finishOperation();
 
     stopOperation();
     emit stopped();
@@ -232,156 +151,28 @@ bool ModuleBase_Operation::commit()
   return false;
 }
 
-void ModuleBase_Operation::setRunning(bool theState)
+void ModuleBase_Operation::onValuesChanged()
 {
-  emit triggered(theState);
+  myIsModified = true;
 }
 
-void ModuleBase_Operation::activateByPreselection()
+void ModuleBase_Operation::onValueStateChanged(int thePreviousState)
 {
-  if (!myPropertyPanel || myPreSelection.empty()) {
-    myPropertyPanel->activateNextWidget(NULL);
-    return;
-  }
-  const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
-  if (aWidgets.empty()) {
-    myPropertyPanel->activateNextWidget(NULL);
-    return;
-  }
-  
-  ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
-  QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
-  bool isSet = false;
-  // 1. apply the selection to controls
-  int aCurrentPosition = 0;
-  for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
-    aWgt = (*aWIt);
-    if (!aWgt->canSetValue())
-      continue;
-
-    if (!aWgt->setSelection(myPreSelection, aCurrentPosition/*aValue*/)) {
-      isSet = false;
-      break;
-    } else {
-      isSet = true;
-      aFilledWgt = aWgt;
+  if (propertyPanel()) {
+    ModuleBase_ModelWidget* aWidget = propertyPanel()->activeWidget();
+    if (aWidget) {
+      if (aWidget->getValueState() == ModuleBase_ModelWidget::ModifiedInPP)
+        myIsModified = true;
     }
   }
-  // 2. ignore not obligatory widgets
-  /*for (; aWIt != aWidgets.constEnd(); ++aWIt) {
-    aWgt = (*aWIt);
-    if (aWgt && aWgt->isObligatory())
-      continue;
-    aFilledWgt = aWgt;
-  }*/
-
-  // 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();
-
-  // 4. activate the next obligatory widget
-  myPropertyPanel->activateNextWidget(aFilledWgt);
 }
 
-void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
+void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 {
-  myParentFeature = theParent;
-}
-
-CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
-{
-  return myParentFeature;
-}
-
-void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
-                                         ModuleBase_IViewer* theViewer)
-{
-  clearPreselection();
-
-  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();
-
-    std::list<ResultPtr> aResults = aFeature->results();
-    QObjectPtrList aResList;
-    std::list<ResultPtr>::const_iterator aIt;
-    for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
-      aResList.append(*aIt);
-
-    foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
-      if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
-        aPreSelected.append(aPrs);
-    }
-  } else
-    aPreSelected = theSelection->getSelected();
-
-  // convert the selection values to the values, which are set to the operation widgets
-
-  //Handle(V3d_View) aView = theViewer->activeView();
-  //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
-  //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
-  //  aValue->setObject(aPrs.object());
-
-  //  double aX, anY;
-  //  if (getViewerPoint(aPrs, theViewer, aX, anY))
-  //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
-  //  myPreSelection.append(aValue);
-  //}
-  myPreSelection = aPreSelected;
-}
-
-//void ModuleBase_Operation::onWidgetActivated(ModuleBase_ModelWidget* theWidget)
-//{
-//  //activateByPreselection();
-//  //if (theWidget && myPropertyPanel) {
-//  //  myPropertyPanel->activateNextWidget();
-//  ////  //emit activateNextWidget(myActiveWidget);
-//  //}
-//}
-
-//bool ModuleBase_Operation::setWidgetValue(ObjectPtr theFeature, double theX, double theY)
-//{
-//  ModuleBase_ModelWidget* aActiveWgt = myPropertyPanel->activeWidget();
-//  if (!aActiveWgt)
-//    return false;
-//  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
-//  aValue->setObject(theFeature);
-//  aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(theX, theY)));
-//  bool isApplyed = aActiveWgt->setValue(aValue);
-//
-//  delete aValue;
-//  myIsModified = (myIsModified || isApplyed);
-//  return isApplyed;
-//}
-
-bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
-                                               ModuleBase_IViewer* theViewer,
-                                               double& theX, double& theY)
-{
-  return false;
-}
-
-void ModuleBase_Operation::clearPreselection()
-{
-  myPreSelection.clear();
-}
-
-void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp) 
-{ 
-  myPropertyPanel = theProp; 
-  myPropertyPanel->setEditingMode(isEditOperation());
-
-  // 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. 
-  if (!isEditOperation())
-    activateByPreselection();
+  myPropertyPanel = theProp;
 }
 
 bool ModuleBase_Operation::isGranted(QString theId) const
 {
-  return myNestedFeatures.contains(theId);
+  return myGrantedIds.contains(theId);
 }