Salome HOME
Updated copyright comment
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetShapeSelector.cpp
index 0a15d04b6e674b3fc1f8c181d610d4f069ed83fe..33ea54529dae03f23750697a4e629031f2f6b367 100644 (file)
@@ -1,6 +1,21 @@
-// File:        ModuleBase_WidgetShapeSelector.h
-// Created:     2 June 2014
-// Author:      Vitaly Smetannikov
+// Copyright (C) 2014-2024  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_WidgetShapeSelector.h>
 #include <ModuleBase_Definitions.h>
@@ -8,7 +23,12 @@
 #include <ModuleBase_IWorkshop.h>
 #include <ModuleBase_IViewer.h>
 #include <ModuleBase_Tools.h>
+#include <ModuleBase_Filter.h>
+#include <ModuleBase_IModule.h>
+#include <ModuleBase_ViewerPrs.h>
+#include <ModuleBase_IconFactory.h>
 
+#include <Config_Translator.h>
 #include <Config_WidgetAPI.h>
 #include <Events_Loop.h>
 #include <Events_Message.h>
 #include <ModelAPI_ResultBody.h>
 #include <ModelAPI_AttributeRefAttr.h>
 #include <ModelAPI_Validator.h>
-#include <ModelAPI_ResultValidator.h>
-#include <ModelAPI_RefAttrValidator.h>
+#include <ModelAPI_AttributeValidator.h>
 
 #include <Config_WidgetAPI.h>
-#include <Events_Error.h>
 
 #include <GeomAPI_Shape.h>
 
+#include <SelectMgr_ListIteratorOfListOfFilter.hxx>
 #include <TopoDS_Shape.hxx>
 #include <TopExp_Explorer.hxx>
 
@@ -49,6 +68,7 @@
 #include <QEvent>
 #include <QDockWidget>
 #include <QApplication>
+#include <QFormLayout>
 
 #include <TopExp_Explorer.hxx>
 #include <TopoDS_Shape.hxx>
 #include <list>
 #include <string>
 
-typedef QMap<QString, TopAbs_ShapeEnum> ShapeTypes;
-static ShapeTypes MyShapeTypes;
-
-TopAbs_ShapeEnum ModuleBase_WidgetShapeSelector::shapeType(const QString& theType)
-{
-  if (MyShapeTypes.count() == 0) {
-    MyShapeTypes["face"] = TopAbs_FACE;
-    MyShapeTypes["faces"] = TopAbs_FACE;
-    MyShapeTypes["vertex"] = TopAbs_VERTEX;
-    MyShapeTypes["vertices"] = TopAbs_VERTEX;
-    MyShapeTypes["wire"] = TopAbs_WIRE;
-    MyShapeTypes["edge"] = TopAbs_EDGE;
-    MyShapeTypes["edges"] = TopAbs_EDGE;
-    MyShapeTypes["shell"] = TopAbs_SHELL;
-    MyShapeTypes["solid"] = TopAbs_SOLID;
-    MyShapeTypes["solids"] = TopAbs_SOLID;
-  }
-  QString aType = theType.toLower();
-  if (MyShapeTypes.contains(aType))
-    return MyShapeTypes[aType];
-  Events_Error::send("Shape type defined in XML is not implemented!");
-  return TopAbs_SHAPE;
-}
-
 ModuleBase_WidgetShapeSelector::ModuleBase_WidgetShapeSelector(QWidget* theParent,
                                                      ModuleBase_IWorkshop* theWorkshop,
-                                                     const Config_WidgetAPI* theData,
-                                                     const std::string& theParentId)
-    : ModuleBase_ModelWidget(theParent, theData, theParentId),
-      myWorkshop(theWorkshop), myIsActive(false), myUseSubShapes(false)
+                                                     const Config_WidgetAPI* theData)
+: ModuleBase_WidgetSelector(theParent, theWorkshop, theData)
 {
-  myContainer = new QWidget(theParent);
-  QHBoxLayout* aLayout = new QHBoxLayout(myContainer);
+  QFormLayout* aLayout = new QFormLayout(this);
   ModuleBase_Tools::adjustMargins(aLayout);
 
-  QString aLabelText = QString::fromStdString(theData->widgetLabel());
+  QString aLabelText = translate(theData->widgetLabel());
   QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
-  myLabel = new QLabel(aLabelText, myContainer);
+  myLabel = new QLabel(aLabelText, this);
   if (!aLabelIcon.isEmpty())
-    myLabel->setPixmap(QPixmap(aLabelIcon));
+    myLabel->setPixmap(ModuleBase_IconFactory::loadPixmap(aLabelIcon));
 
-  aLayout->addWidget(myLabel);
 
-  QString aToolTip = QString::fromStdString(theData->widgetTooltip());
-  myTextLine = new QLineEdit(myContainer);
+  QString aToolTip = translate(theData->widgetTooltip());
+  myTextLine = new QLineEdit(this);
+  QString anObjName = QString::fromStdString(attributeID());
+  myTextLine->setObjectName(anObjName);
   myTextLine->setReadOnly(true);
   myTextLine->setToolTip(aToolTip);
   myTextLine->installEventFilter(this);
 
-  aLayout->addWidget(myTextLine, 1);
+  aLayout->addRow(myLabel, myTextLine);
+  myLabel->setToolTip(aToolTip);
 
   std::string aTypes = theData->getProperty("shape_types");
   myShapeTypes = QString(aTypes.c_str()).split(' ', QString::SkipEmptyParts);
-
-  std::string aObjTypes = theData->getProperty("object_types");
-  myObjectTypes = QString(aObjTypes.c_str()).split(' ', QString::SkipEmptyParts);
-
-  myUseSubShapes = theData->getBooleanAttribute("use_subshapes", false); 
 }
 
 //********************************************************************
 ModuleBase_WidgetShapeSelector::~ModuleBase_WidgetShapeSelector()
 {
-  activateSelection(false);
 }
 
 //********************************************************************
-bool ModuleBase_WidgetShapeSelector::storeValue() const
+bool ModuleBase_WidgetShapeSelector::storeValueCustom()
 {
-  FeaturePtr aSelectedFeature = ModelAPI_Feature::feature(mySelectedObject);
-  if (aSelectedFeature == myFeature)  // In order to avoid selection of the same object
-    return false;
+  // the value is stored on the selection changed signal processing
+  return true;
+}
 
-  DataPtr aData = myFeature->data();
-  if (myUseSubShapes) {
-    ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(mySelectedObject);
-    if (aBody) {
-      AttributePtr aAttr = aData->attribute(attributeID());
+//********************************************************************
+bool ModuleBase_WidgetShapeSelector::setSelection(QList<ModuleBase_ViewerPrsPtr>& theValues,
+                                                  const bool theToValidate)
+{
+  if (theValues.empty()) {
+    // In order to make reselection possible, set empty object and shape should be done
+    setSelectionCustom(std::shared_ptr<ModuleBase_ViewerPrs>(new ModuleBase_ViewerPrs(
+                                                  ObjectPtr(), GeomShapePtr(), NULL)));
+    return false;
+  }
+  // it removes the processed value from the parameters list
+  ModuleBase_ViewerPrsPtr aValue = theValues.takeFirst();
+  bool isDone = false;
 
-      // We have to check several attributes types
-      AttributeSelectionPtr aSelectAttr = 
-        std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(aAttr);
-      if (aSelectAttr) {
-        aSelectAttr->setValue(aBody, myShape);
-        updateObject(myFeature);
-        return true;
-      } else {
-        AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
-        if (aRefAttr) {
-          aRefAttr->setObject(mySelectedObject);
-          updateObject(myFeature);
-          return true;
-        }
-      }
-    }
-  } else {
-    AttributeReferencePtr aRef = aData->reference(attributeID());
-    if (aRef) {
-      ObjectPtr aObject = aRef->value();
-      if (!(aObject && aObject->isSame(mySelectedObject))) {
-        aRef->setValue(mySelectedObject);
-        updateObject(myFeature);
-        return true;
-      }
-    } else {
-      AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
-      if (aRefAttr) {
-        ObjectPtr aObject = aRefAttr->object();
-        if (!(aObject && aObject->isSame(mySelectedObject))) {
-          aRefAttr->setObject(mySelectedObject);
-          updateObject(myFeature);
-          return true;
-        }
-      }
-    }
+  if (!theToValidate || isValidInFilters(aValue)) {
+    isDone = setSelectionCustom(aValue);
+    // updateObject - to update/redisplay feature
+    // it is commented in order to perfom it outside the method
+    //updateObject(myFeature);
+    // to storeValue()
+    //emit valuesChanged();
   }
-  return false;
+  return isDone;
 }
 
 //********************************************************************
-void ModuleBase_WidgetShapeSelector::clearAttribute()
+QList<ModuleBase_ViewerPrsPtr> ModuleBase_WidgetShapeSelector::getAttributeSelection() const
 {
-  DataPtr aData = myFeature->data();
-  AttributeSelectionPtr aSelect = aData->selection(attributeID());
-  if (aSelect) {
-    aSelect->setValue(ResultPtr(), std::shared_ptr<GeomAPI_Shape>(new GeomAPI_Shape()));
-    return;
-  }
-  AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
-  if (aRefAttr) {
-    aRefAttr->setObject(ObjectPtr());
-    return;
-  }
-  AttributeReferencePtr aRef = aData->reference(attributeID());
-  if (aRef) {
-    aRef->setObject(ObjectPtr());
+  QList<ModuleBase_ViewerPrsPtr> aSelected;
+  if(myFeature) {
+    DataPtr aData = myFeature->data();
+    AttributePtr anAttribute = myFeature->attribute(attributeID());
+
+    ObjectPtr anObject = ModuleBase_Tools::getObject(anAttribute);
+    std::shared_ptr<GeomAPI_Shape> aShapePtr = getShape();
+    ModuleBase_ViewerPrsPtr aPrs(new ModuleBase_ViewerPrs(anObject, aShapePtr, NULL));
+    aSelected.append(aPrs);
   }
+  return aSelected;
 }
 
 //********************************************************************
-bool ModuleBase_WidgetShapeSelector::restoreValue()
+bool ModuleBase_WidgetShapeSelector::restoreValueCustom()
 {
-  DataPtr aData = myFeature->data();
   bool isBlocked = this->blockSignals(true);
-  if (myUseSubShapes) {
-    AttributeSelectionPtr aSelect = aData->selection(attributeID());
-    if (aSelect) {
-      mySelectedObject = aSelect->context();
-      myShape = aSelect->value();
-    } else {
-      AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
-      if (aRefAttr) {
-        mySelectedObject = aRefAttr->object();
-      }
-    }
-  } else {
-    AttributeReferencePtr aRef = aData->reference(attributeID());
-    if (aRef)
-      mySelectedObject = aRef->value();
-    else {
-      AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
-      if (aRefAttr)
-        mySelectedObject = aRefAttr->object();
-    }
-  }
   updateSelectionName();
-
   this->blockSignals(isBlocked);
+
   return true;
 }
 
@@ -237,276 +179,68 @@ QList<QWidget*> ModuleBase_WidgetShapeSelector::getControls() const
   return aControls;
 }
 
-//********************************************************************
-void ModuleBase_WidgetShapeSelector::onSelectionChanged()
-{
-  // In order to make reselection possible
-  // TODO: check with MPV clearAttribute();
-
-  //QObjectPtrList aObjects = myWorkshop->selection()->selectedPresentations();
-  QList<ModuleBase_ViewerPrs> aSelected = myWorkshop->selection()->getSelected();
-  if (aSelected.size() > 0)
-    setSelection(aSelected.first());
-}
-
-//********************************************************************
-bool ModuleBase_WidgetShapeSelector::setSelection(ModuleBase_ViewerPrs theValue)
-{
-  ObjectPtr aObject = theValue.object();
-  if ((!mySelectedObject) && (!aObject))
-    return false;
-
-  // Check that the selected object is result (others can not be accepted)
-  ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(aObject);
-  if (!aRes)
-    return false;
-
-  if (myFeature) {
-    // We can not select a result of our feature
-    const std::list<std::shared_ptr<ModelAPI_Result>>& aResList = myFeature->results();
-    std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aIt;
-    for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
-      if ((*aIt) == aRes)
-        return false;
-    }
-  }
-  // Check that object belongs to active document or PartSet
-  DocumentPtr aDoc = aRes->document();
-  SessionPtr aMgr = ModelAPI_Session::get();
-  if (!(aDoc == aMgr->activeDocument()) && !(aDoc == aMgr->moduleDocument()))
-    return false;
-
-  // Check that the result has a shape
-  GeomShapePtr aShape = ModelAPI_Tools::shape(aRes);
-  if (!aShape)
-    return false;
-
-  /// Check that object has acceptable type
-  if (!acceptObjectType(aObject)) 
-    return false;
-
-  // Get sub-shapes from local selection
-  if (myUseSubShapes) {
-    if (!theValue.shape().IsNull()) {
-      aShape = std::shared_ptr<GeomAPI_Shape>(new GeomAPI_Shape());
-      aShape->setImpl(new TopoDS_Shape(theValue.shape()));
-    }
-  }
-
-  // Check that the selection corresponds to selection type
-  if (myUseSubShapes) {
-    if (!acceptSubShape(aShape))
-      return false;
-  } else {
-    if (!acceptObjectShape(aObject))
-      return false;
-  }
-  if (isValid(aObject, aShape)) {
-    setObject(aObject, aShape);
-    emit focusOutWidget(this);
-  }
-  return true;
-}
-
-//********************************************************************
-void ModuleBase_WidgetShapeSelector::setObject(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape)
+void ModuleBase_WidgetShapeSelector::updateFocus()
 {
-  mySelectedObject = theObj;
-  myShape = theShape;
-  if (mySelectedObject) {
-    raisePanel();
-  } 
-  updateSelectionName();
-  emit valuesChanged();
+  emit focusOutWidget(this);
 }
 
 //********************************************************************
-bool ModuleBase_WidgetShapeSelector::acceptObjectShape(const ObjectPtr theResult) const
+QIntList ModuleBase_WidgetShapeSelector::shapeTypes() const
 {
-  ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theResult);
-
-  // Check that the shape of necessary type
-  std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(aResult);
-  if (!aShapePtr)
-    return false;
-  TopoDS_Shape aShape = aShapePtr->impl<TopoDS_Shape>();
-  if (aShape.IsNull())
-    return false;
-
-  TopAbs_ShapeEnum aShapeType = aShape.ShapeType();
-  if (aShapeType == TopAbs_COMPOUND) {
-    foreach (QString aType, myShapeTypes) {
-      TopExp_Explorer aEx(aShape, shapeType(aType));
-      if (aEx.More())
-        return true;
-    }
-  } else {
-    foreach (QString aType, myShapeTypes) {
-      if (shapeType(aType) == aShapeType)
-        return true;
-    }
+  QIntList aShapeTypes;
+  foreach(QString aType, myShapeTypes) {
+    aShapeTypes.append(ModuleBase_Tools::shapeType(aType));
   }
-  return false;
+  return aShapeTypes;
 }
 
 //********************************************************************
-bool ModuleBase_WidgetShapeSelector::acceptSubShape(std::shared_ptr<GeomAPI_Shape> theShape) const
+GeomShapePtr ModuleBase_WidgetShapeSelector::getShape() const
 {
-  TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
-  foreach (QString aType, myShapeTypes) {
-    if (aShape.ShapeType() == shapeType(aType))
-      return true;
-  }
-  return false;
-}
-
-//********************************************************************
-bool ModuleBase_WidgetShapeSelector::acceptObjectType(const ObjectPtr theObject) const
-{
-  // Definition of types is not obligatory. If types are not defined then
-  // it means that accepted any type
-  if (myObjectTypes.isEmpty())
-    return true;
-
-  foreach (QString aType, myObjectTypes) {
-    if (aType.toLower() == "construction") {
-      ResultConstructionPtr aConstr = 
-        std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theObject);
-      return (aConstr != NULL);
-    } // ToDo: Process other types of objects
+  GeomShapePtr aShape;
+  DataPtr aData = myFeature->data();
+  if (aData->isValid()) {
+    AttributePtr anAttribute = myFeature->data()->attribute(attributeID());
+    aShape = ModuleBase_Tools::getShape(anAttribute, myWorkshop);
   }
-  // Object type is defined but not found
-  return false;
+  return aShape;
 }
 
-
 //********************************************************************
 void ModuleBase_WidgetShapeSelector::updateSelectionName()
 {
-  if (mySelectedObject) {
-    std::string aName = mySelectedObject->data()->name();
-    myTextLine->setText(QString::fromStdString(aName));
-  } else {
-    if (myIsActive) {
-      myTextLine->setText("");
-    }
-  }
-}
-
-
-//********************************************************************
-void ModuleBase_WidgetShapeSelector::activateSelection(bool toActivate)
-{
-  if (myIsActive == toActivate)
+  DataPtr aData = myFeature->data();
+  if (!aData->isValid())
     return;
-  myIsActive = toActivate;
-  updateSelectionName();
-
-  if (myIsActive) {
-    connect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
-    if (myUseSubShapes) {
 
-      QIntList aList;
-      foreach (QString aType, myShapeTypes)
-        aList.append(shapeType(aType));
-      myWorkshop->activateSubShapesSelection(aList);
-      if (!myObjectTypes.isEmpty()) {
-        myObjTypeFilter = new ModuleBase_ObjectTypesFilter(myWorkshop, myObjectTypes);
-        myWorkshop->viewer()->clearSelectionFilters();
-        myWorkshop->viewer()->addSelectionFilter(myObjTypeFilter);
+  bool isNameUpdated = false;
+  AttributeSelectionPtr aSelect = aData->selection(attributeID());
+  if (aSelect) {
+    std::wstring aDefault = translate(getDefaultValue()).toStdWString();
+    myTextLine->setText(QString::fromStdWString(aSelect->namingName(aDefault)));
+    isNameUpdated = true;
+  }
+  if (!isNameUpdated) {
+    ObjectPtr anObject = ModuleBase_Tools::getObject(myFeature->attribute(attributeID()));
+    if (anObject.get() != NULL) {
+      std::wstring aName = anObject->data()->name();
+      myTextLine->setText(QString::fromStdWString(aName));
+    } else {
+      AttributeRefAttrPtr aRefAttr = aData->refattr(attributeID());
+      if (aRefAttr && aRefAttr->attr().get() != NULL) {
+        //myIsObject = aRefAttr->isObject();
+        std::wstring anAttrName = ModuleBase_Tools::generateName(aRefAttr->attr(), myWorkshop);
+        myTextLine->setText(QString::fromStdWString(anAttrName));
       }
-    }
-  } else {
-    disconnect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
-    if (myUseSubShapes) {
-      if (!myObjTypeFilter.IsNull()) {
-        myWorkshop->viewer()->removeSelectionFilter(myObjTypeFilter);
-        myObjTypeFilter.Nullify();
+      else {
+        myTextLine->setText(translate(getDefaultValue()));
       }
-      myWorkshop->deactivateSubShapesSelection();
     }
   }
 }
 
 //********************************************************************
-void ModuleBase_WidgetShapeSelector::raisePanel() const
-{
-  QWidget* aParent = myContainer->parentWidget();
-  QWidget* aLastPanel = 0;
-  while (!aParent->inherits("QDockWidget")) {
-    aLastPanel = aParent;
-    aParent = aParent->parentWidget();
-    if (!aParent)
-      return;
-  }
-  if (aParent->inherits("QDockWidget")) {
-    QDockWidget* aTabWgt = (QDockWidget*) aParent;
-    aTabWgt->raise();
-  }
-}
-
-//********************************************************************
-//bool ModuleBase_WidgetShapeSelector::setSelection(ModuleBase_ViewerPrs theValue)
-//{
-//  if (theValue.object()) {
-//    ObjectPtr aObject = theValue.object();
-//    if (acceptObjectShape(aObject)) {
-//      setObject(aObject);
-//      return true;
-//    }
-//  }
-//  return false;
-//}
-
-//********************************************************************
-void ModuleBase_WidgetShapeSelector::activate()
+bool ModuleBase_WidgetShapeSelector::isModified() const
 {
-  activateSelection(true);
-}
-
-//********************************************************************
-void ModuleBase_WidgetShapeSelector::deactivate()
-{
-  activateSelection(false);
-}
-
-//********************************************************************
-bool ModuleBase_WidgetShapeSelector::isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape)
-{
-  SessionPtr aMgr = ModelAPI_Session::get();
-  ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
-  std::list<ModelAPI_Validator*> aValidators;
-  std::list<std::list<std::string> > anArguments;
-  aFactory->validators(parentID(), attributeID(), aValidators, anArguments);
-
-  // Check the type of selected object
-  std::list<ModelAPI_Validator*>::iterator aValidator = aValidators.begin();
-  bool isValid = true;
-  for (; aValidator != aValidators.end(); aValidator++) {
-    const ModelAPI_ResultValidator* aResValidator =
-        dynamic_cast<const ModelAPI_ResultValidator*>(*aValidator);
-    if (aResValidator) {
-      isValid = false;
-      if (aResValidator->isValid(theObj)) {
-        isValid = true;
-        break;
-      }
-    }
-  }
-  if (!isValid)
-    return false;
-
-  // Check the acceptability of the object as attribute
-  aValidator = aValidators.begin();
-  std::list<std::list<std::string> >::iterator aArgs = anArguments.begin();
-  for (; aValidator != aValidators.end(); aValidator++, aArgs++) {
-    const ModelAPI_RefAttrValidator* aAttrValidator =
-        dynamic_cast<const ModelAPI_RefAttrValidator*>(*aValidator);
-    if (aAttrValidator) {
-      if (!aAttrValidator->isValid(myFeature, *aArgs, theObj)) {
-        return false;
-      }
-    }
-  }
-  return true;
+  return !myTextLine->text().isEmpty();
 }
\ No newline at end of file