Salome HOME
Merge commit 'f709219506b7cd587e94abc5ebed18d629df92d8'
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_MultiTranslation.cpp
index 71eca57ca89f10927d685525d7996c18a3e12c82..e30ea0fbf81590c5b17ad7f7cb42c181454bfbeb 100644 (file)
@@ -1,10 +1,24 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:    SketchPlugin_MultiTranslation.cpp
-// Created: 21 Apr 2015
-// Author:  Artem ZHIDKOV
+// Copyright (C) 2014-2022  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 "SketchPlugin_MultiTranslation.h"
+#include "SketchPlugin_Tools.h"
 
 #include <GeomAPI_XY.h>
 #include <GeomDataAPI_Point2D.h>
 #include <ModelAPI_Data.h>
 #include <ModelAPI_ResultConstruction.h>
 #include <ModelAPI_AttributeRefList.h>
-#include <ModelAPI_AttributeSelectionList.h>
+#include <ModelAPI_AttributeRefAttr.h>
+#include <ModelAPI_AttributeString.h>
 #include <ModelAPI_Events.h>
 #include <ModelAPI_Session.h>
 #include <ModelAPI_Validator.h>
+#include <ModelAPI_Tools.h>
 
+#include <SketchPlugin_SketchEntity.h>
 #include <SketcherPrs_Factory.h>
 
 SketchPlugin_MultiTranslation::SketchPlugin_MultiTranslation()
@@ -26,37 +43,49 @@ SketchPlugin_MultiTranslation::SketchPlugin_MultiTranslation()
 
 void SketchPlugin_MultiTranslation::initAttributes()
 {
-  data()->addAttribute(START_POINT_ID(), GeomDataAPI_Point2D::typeId());
-  data()->addAttribute(END_POINT_ID(), GeomDataAPI_Point2D::typeId());
-  data()->addAttribute(NUMBER_OF_COPIES_ID(), ModelAPI_AttributeInteger::typeId());
+  data()->addAttribute(VALUE_TYPE(),   ModelAPI_AttributeString::typeId());
+
+  data()->addAttribute(START_POINT_ID(), ModelAPI_AttributeRefAttr::typeId());
+  data()->addAttribute(END_POINT_ID(), ModelAPI_AttributeRefAttr::typeId());
+
+  data()->addAttribute(NUMBER_OF_OBJECTS_ID(), ModelAPI_AttributeInteger::typeId());
   data()->addAttribute(SketchPlugin_Constraint::ENTITY_A(), ModelAPI_AttributeRefList::typeId());
   data()->addAttribute(SketchPlugin_Constraint::ENTITY_B(), ModelAPI_AttributeRefList::typeId());
-  AttributeSelectionListPtr aSelection = 
-    std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(data()->addAttribute(
-    TRANSLATION_LIST_ID(), ModelAPI_AttributeSelectionList::typeId()));
-  aSelection->setSelectionType("EDGE");
-  ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SketchPlugin_Constraint::ENTITY_A());
-  ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SketchPlugin_Constraint::ENTITY_B());
+  data()->addAttribute(TRANSLATION_LIST_ID(), ModelAPI_AttributeRefList::typeId());
+  ModelAPI_Session::get()->validators()->
+    registerNotObligatory(getKind(), SketchPlugin_Constraint::ENTITY_A());
+  ModelAPI_Session::get()->validators()->
+    registerNotObligatory(getKind(), SketchPlugin_Constraint::ENTITY_B());
 }
 
 void SketchPlugin_MultiTranslation::execute()
 {
-  AttributeSelectionListPtr aTranslationObjectRefs = selectionList(TRANSLATION_LIST_ID());
-  int aNbCopies = integer(NUMBER_OF_COPIES_ID())->value();
+  if (!sketch()) {
+    // it is possible, that this method is called before this feature has back reference to sketch
+    // in this case, the execute is performed after this is done
+    return;
+  }
+
+  AttributeRefListPtr aTranslationObjectRefs = reflist(TRANSLATION_LIST_ID());
+  int aNbCopies = integer(NUMBER_OF_OBJECTS_ID())->value()-1;
+  if (aNbCopies <= 0)
+    return;
 
   // Calculate shift vector
-  std::shared_ptr<GeomDataAPI_Point2D> aStart = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
-      attribute(START_POINT_ID()));
-  std::shared_ptr<GeomDataAPI_Point2D> aEnd = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
-      attribute(END_POINT_ID()));
-  if (!aStart || !aEnd || !aStart->isInitialized() || !aEnd->isInitialized())
+  AttributeRefAttrPtr aStartAttr = data()->refattr(START_POINT_ID());
+  AttributeRefAttrPtr anEndAttr = data()->refattr(END_POINT_ID());
+
+  if (!aStartAttr || !anEndAttr || !aStartAttr->isInitialized() || !anEndAttr->isInitialized())
     return;
 
-  // make a visible points
-  SketchPlugin_Sketch::createPoint2DResult(this, sketch(), START_POINT_ID(), 0);
-  SketchPlugin_Sketch::createPoint2DResult(this, sketch(), END_POINT_ID(), 1);
+  DataPtr aData = data();
+  AttributePoint2DPtr aStart = GeomDataAPI_Point2D::getPoint2D(aData, START_POINT_ID());
+  AttributePoint2DPtr aEnd = GeomDataAPI_Point2D::getPoint2D(aData, END_POINT_ID());
+  if (!aStart || !aEnd)
+    return;
 
-  std::shared_ptr<GeomAPI_XY> aShiftVec(new GeomAPI_XY(aEnd->x() - aStart->x(), aEnd->y() - aStart->y()));
+  std::shared_ptr<GeomAPI_XY>
+    aShiftVec(new GeomAPI_XY(aEnd->x() - aStart->x(), aEnd->y() - aStart->y()));
 
   // Wait all objects being created, then send update events
   static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
@@ -64,7 +93,11 @@ void SketchPlugin_MultiTranslation::execute()
   if (isUpdateFlushed)
     Events_Loop::loop()->setFlushed(anUpdateEvent, false);
 
-  std::shared_ptr<ModelAPI_Data> aData = data();
+  // Save the current feature of the document, because new features may appear while executing.
+  // In this case, they will become current. But if the number of copies is updated from outside
+  // of sketch (e.g. by parameter change), the history line should not hold in sketch.
+  keepCurrentFeature();
+
   AttributeRefListPtr aRefListOfShapes = std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(
       aData->attribute(SketchPlugin_Constraint::ENTITY_A()));
   AttributeRefListPtr aRefListOfTranslated = std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(
@@ -73,29 +106,33 @@ void SketchPlugin_MultiTranslation::execute()
       aRefListOfTranslated->size() / aRefListOfShapes->size() - 1 : 0;
   std::list<ObjectPtr> anInitialList = aRefListOfShapes->list();
   std::list<ObjectPtr> aTargetList = aRefListOfTranslated->list();
-  std::list<ResultPtr> anAddition;
+  std::list<ObjectPtr> anAddition;
   std::vector<bool> isUsed(anInitialList.size(), false);
   // collect new items and check the items to remove
   for(int anInd = 0; anInd < aTranslationObjectRefs->size(); anInd++) {
-    std::shared_ptr<ModelAPI_AttributeSelection> aSelect = aTranslationObjectRefs->value(anInd);
+    //std::shared_ptr<ModelAPI_AttributeSelection> aSelect = aTranslationObjectRefs->value(anInd);
+    ObjectPtr anObject = aTranslationObjectRefs->object(anInd);
     std::list<ObjectPtr>::const_iterator anIt = anInitialList.begin();
     std::vector<bool>::iterator aUsedIt = isUsed.begin();
     for (; anIt != anInitialList.end(); anIt++, aUsedIt++)
-      if (*anIt == aSelect->context()) {
+      if (*anIt == anObject) {
         *aUsedIt = true;
         break;
       }
     if (anIt == anInitialList.end())
-      anAddition.push_back(aSelect->context());
+      anAddition.push_back(anObject);
   }
   // remove unused items
   std::list<ObjectPtr>::iterator anInitIter = anInitialList.begin();
   std::list<ObjectPtr>::iterator aTargetIter = aTargetList.begin();
   std::vector<bool>::iterator aUsedIter = isUsed.begin();
+  std::set<FeaturePtr> aFeaturesToBeRemoved;
   for (; aUsedIter != isUsed.end(); aUsedIter++) {
     if (!(*aUsedIter)) {
       aRefListOfShapes->remove(*anInitIter);
-      for (int i = 0; i < aCurrentNbCopies && aTargetIter != aTargetList.end(); i++, aTargetIter++) {
+      aRefListOfTranslated->remove(*aTargetIter++);
+      for (int i = 0; i < aCurrentNbCopies && aTargetIter != aTargetList.end();
+           i++, aTargetIter++) {
         aRefListOfTranslated->remove(*aTargetIter);
         // remove the corresponding feature from the sketch
         ResultConstructionPtr aRC =
@@ -103,7 +140,7 @@ void SketchPlugin_MultiTranslation::execute()
         DocumentPtr aDoc = aRC ? aRC->document() : DocumentPtr();
         FeaturePtr aFeature =  aDoc ? aDoc->feature(aRC) : FeaturePtr();
         if (aFeature)
-          aDoc->removeFeature(aFeature);
+          aFeaturesToBeRemoved.insert(aFeature);
       }
     } else {
       for (int i = 0; i <= aNbCopies && aTargetIter != aTargetList.end(); i++)
@@ -112,6 +149,7 @@ void SketchPlugin_MultiTranslation::execute()
     if (anInitIter != anInitialList.end())
       anInitIter++;
   }
+  ModelAPI_Tools::removeFeaturesAndReferences(aFeaturesToBeRemoved);
   // change number of copies
   if (aCurrentNbCopies != 0 && aNbCopies != aCurrentNbCopies) {
     bool isAdd = aNbCopies > aCurrentNbCopies;
@@ -158,7 +196,7 @@ void SketchPlugin_MultiTranslation::execute()
       aRefListOfTranslated->append(*aTargetIter);
   }
   // add new items
-  std::list<ResultPtr>::iterator anAddIter = anAddition.begin();
+  std::list<ObjectPtr>::iterator anAddIter = anAddition.begin();
   for (; anAddIter != anAddition.end(); anAddIter++) {
     aRefListOfShapes->append(*anAddIter);
     aRefListOfTranslated->append(*anAddIter);
@@ -168,6 +206,8 @@ void SketchPlugin_MultiTranslation::execute()
     }
   }
 
+  restoreCurrentFeature();
+
   // send events to update the sub-features by the solver
   if (isUpdateFlushed)
     Events_Loop::loop()->setFlushed(anUpdateEvent, true);
@@ -178,13 +218,51 @@ AISObjectPtr SketchPlugin_MultiTranslation::getAISObject(AISObjectPtr thePreviou
   if (!sketch())
     return thePrevious;
 
-  AISObjectPtr anAIS = thePrevious;
-  if (!anAIS) {
-    anAIS = SketcherPrs_Factory::translateConstraint(this, sketch()->coordinatePlane());
-  }
+  AISObjectPtr anAIS = SketcherPrs_Factory::translateConstraint(this, sketch(),
+                                                                thePrevious);
   return anAIS;
 }
 
+void SketchPlugin_MultiTranslation::erase()
+{
+  static Events_Loop* aLoop = Events_Loop::loop();
+  static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
+
+  // Set copy attribute to false on all copied features.
+  AttributeRefListPtr aRefListOfShapes = std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(
+      data()->attribute(SketchPlugin_Constraint::ENTITY_A()));
+  AttributeRefListPtr aRefListOfTranslated = std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(
+      data()->attribute(SketchPlugin_Constraint::ENTITY_B()));
+
+  if(aRefListOfShapes.get() && aRefListOfTranslated.get()) {
+    for(int anIndex = 0; anIndex < aRefListOfTranslated->size(); anIndex++) {
+      ObjectPtr anObject = aRefListOfTranslated->object(anIndex);
+      if(aRefListOfShapes->isInList(anObject)) {
+        // Don't modify attribute of original features, just skip.
+        continue;
+      }
+      if(anObject.get()) {
+        ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
+        if(aRes.get()) {
+          FeaturePtr aFeature = aRes->document()->feature(aRes);
+          if(aFeature.get()) {
+            AttributeBooleanPtr aBooleanAttr =
+              aFeature->boolean(SketchPlugin_SketchEntity::COPY_ID());
+            if(aBooleanAttr.get()) {
+              if (ModelAPI_Session::get()->isOperation()) // if this is not undo or redo
+                aBooleanAttr->setValue(false);
+              // Redisplay object as it is not copy anymore.
+              ModelAPI_EventCreator::get()->sendUpdated(aRes, aRedispEvent);
+            }
+          }
+        }
+      }
+    }
+  }
+
+  SketchPlugin_ConstraintBase::erase();
+}
+
 ObjectPtr SketchPlugin_MultiTranslation::copyFeature(ObjectPtr theObject)
 {
   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theObject);
@@ -192,10 +270,10 @@ ObjectPtr SketchPlugin_MultiTranslation::copyFeature(ObjectPtr theObject)
   if (!aFeature || !aResult)
     return ObjectPtr();
 
-  FeaturePtr aNewFeature = sketch()->addFeature(aFeature->getKind());
-  aFeature->data()->copyTo(aNewFeature->data());
-  aNewFeature->execute();
+  FeaturePtr aNewFeature =
+    SketchPlugin_Sketch::addUniqueNamedCopiedFeature(aFeature, sketch(), true);
 
+  aNewFeature->execute();
   static Events_ID aRedisplayEvent = Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY);
   ModelAPI_EventCreator::get()->sendUpdated(aNewFeature, aRedisplayEvent);
 
@@ -214,3 +292,31 @@ ObjectPtr SketchPlugin_MultiTranslation::copyFeature(ObjectPtr theObject)
   return ObjectPtr();
 }
 
+void SketchPlugin_MultiTranslation::attributeChanged(const std::string& theID)
+{
+  if (theID == TRANSLATION_LIST_ID()) {
+    AttributeRefListPtr aTranslationObjectRefs = reflist(TRANSLATION_LIST_ID());
+    if (aTranslationObjectRefs->size() == 0) {
+      int aNbCopies = integer(NUMBER_OF_OBJECTS_ID())->value()-1;
+      if (aNbCopies <= 0)
+        return;
+
+      DocumentPtr aDoc = document();
+      // Clear list of objects
+      AttributeRefListPtr aRefListOfTranslated = reflist(SketchPlugin_Constraint::ENTITY_B());
+      std::list<ObjectPtr> aTargetList = aRefListOfTranslated->list();
+      std::list<ObjectPtr>::iterator aTargetIter = aTargetList.begin();
+      while (aTargetIter != aTargetList.end()) {
+        aTargetIter++;
+        for (int i = 0; i < aNbCopies && aTargetIter != aTargetList.end(); i++, aTargetIter++) {
+          aRefListOfTranslated->remove(*aTargetIter);
+          FeaturePtr aFeature = ModelAPI_Feature::feature(*aTargetIter);
+          if (aFeature)
+            aDoc->removeFeature(aFeature);
+        }
+      }
+      aRefListOfTranslated->clear();
+      reflist(SketchPlugin_Constraint::ENTITY_A())->clear();
+    }
+  }
+}