Salome HOME
Make the movement, placement and rotation 3D features may be applied to the Part...
[modules/shaper.git] / src / Model / Model_Data.cpp
index e13eaa406e5b6199c198ebf86dfb074140c5130a..29a9266a51ff31c74a7e42ad20b6f09c45704199 100644 (file)
 #include <Model_AttributeString.h>
 #include <Model_AttributeSelection.h>
 #include <Model_AttributeSelectionList.h>
+#include <Model_AttributeIntArray.h>
 #include <Model_Events.h>
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Result.h>
 #include <ModelAPI_Validator.h>
 #include <ModelAPI_Session.h>
+#include <ModelAPI_ResultPart.h>
 
 #include <GeomData_Point.h>
 #include <GeomData_Point2D.h>
 #include <Events_Error.h>
 
 #include <TDataStd_Name.hxx>
+#include <TDataStd_AsciiString.hxx>
+#include <TDataStd_IntegerArray.hxx>
+#include <TDF_AttributeIterator.hxx>
+#include <TDF_ChildIterator.hxx>
+#include <TDF_RelocationTable.hxx>
 
 #include <string>
 
 // myLab contains:
 // TDataStd_Name - name of the object
-// TDataStd_Integer - state of the object execution
+// TDataStd_IntegerArray - state of the object execution, transaction ID of update
+// TDataStd_BooleanArray - array of flags of this data:
+//                             0 - is in history or not
+static const int kFlagInHistory = 0;
+//                             1 - is displayed or not
+static const int kFlagDisplayed = 1;
+
+// invalid data
+const static std::shared_ptr<ModelAPI_Data> kInvalid(new Model_Data());
 
 Model_Data::Model_Data() : mySendAttributeUpdated(true)
 {
@@ -42,6 +57,13 @@ Model_Data::Model_Data() : mySendAttributeUpdated(true)
 void Model_Data::setLabel(TDF_Label theLab)
 {
   myLab = theLab;
+  // set or get the default flags
+  if (!myLab.FindAttribute(TDataStd_BooleanArray::GetID(), myFlags)) {
+    // set default values if not found
+    myFlags = TDataStd_BooleanArray::Set(myLab, 0, 1);
+    myFlags->SetValue(kFlagInHistory, Standard_True); // is in history by default is true
+    myFlags->SetValue(kFlagDisplayed, Standard_True); // is displayed by default is true
+  }
 }
 
 std::string Model_Data::name()
@@ -55,6 +77,7 @@ std::string Model_Data::name()
 void Model_Data::setName(const std::string& theName)
 {
   bool isModified = false;
+  std::string anOldName = name();
   Handle(TDataStd_Name) aName;
   if (!myLab.FindAttribute(TDataStd_Name::GetID(), aName)) {
     TDataStd_Name::Set(myLab, theName.c_str());
@@ -64,48 +87,55 @@ void Model_Data::setName(const std::string& theName)
     if (isModified)
       aName->Set(theName.c_str());
   }
+  if (isModified)
+    ModelAPI_ObjectRenamedMessage::send(myObject, anOldName, theName, this);
 }
 
-void Model_Data::addAttribute(const std::string& theID, const std::string theAttrType)
+AttributePtr Model_Data::addAttribute(const std::string& theID, const std::string theAttrType)
 {
+  AttributePtr aResult;
   TDF_Label anAttrLab = myLab.FindChild(myAttrs.size() + 1);
   ModelAPI_Attribute* anAttr = 0;
-  if (theAttrType == ModelAPI_AttributeDocRef::type()) {
+  if (theAttrType == ModelAPI_AttributeDocRef::typeId()) {
     anAttr = new Model_AttributeDocRef(anAttrLab);
-  } else if (theAttrType == Model_AttributeInteger::type()) {
+  } else if (theAttrType == Model_AttributeInteger::typeId()) {
     anAttr = new Model_AttributeInteger(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeDouble::type()) {
+  } else if (theAttrType == ModelAPI_AttributeDouble::typeId()) {
     anAttr = new Model_AttributeDouble(anAttrLab);
-  } else if (theAttrType == Model_AttributeBoolean::type()) {
+  } else if (theAttrType == Model_AttributeBoolean::typeId()) {
     anAttr = new Model_AttributeBoolean(anAttrLab);
-  } else if (theAttrType == Model_AttributeString::type()) {
+  } else if (theAttrType == Model_AttributeString::typeId()) {
     anAttr = new Model_AttributeString(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeReference::type()) {
+  } else if (theAttrType == ModelAPI_AttributeReference::typeId()) {
     anAttr = new Model_AttributeReference(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeSelection::type()) {
+  } else if (theAttrType == ModelAPI_AttributeSelection::typeId()) {
     anAttr = new Model_AttributeSelection(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeSelectionList::type()) {
+  } else if (theAttrType == ModelAPI_AttributeSelectionList::typeId()) {
     anAttr = new Model_AttributeSelectionList(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeRefAttr::type()) {
+  } else if (theAttrType == ModelAPI_AttributeRefAttr::typeId()) {
     anAttr = new Model_AttributeRefAttr(anAttrLab);
-  } else if (theAttrType == ModelAPI_AttributeRefList::type()) {
+  } else if (theAttrType == ModelAPI_AttributeRefList::typeId()) {
     anAttr = new Model_AttributeRefList(anAttrLab);
+  } else if (theAttrType == ModelAPI_AttributeIntArray::typeId()) {
+    anAttr = new Model_AttributeIntArray(anAttrLab);
   } 
   // create also GeomData attributes here because only here the OCAF strucure is known
-  else if (theAttrType == GeomData_Point::type()) {
+  else if (theAttrType == GeomData_Point::typeId()) {
     anAttr = new GeomData_Point(anAttrLab);
-  } else if (theAttrType == GeomData_Dir::type()) {
+  } else if (theAttrType == GeomData_Dir::typeId()) {
     anAttr = new GeomData_Dir(anAttrLab);
-  } else if (theAttrType == GeomData_Point2D::type()) {
+  } else if (theAttrType == GeomData_Point2D::typeId()) {
     anAttr = new GeomData_Point2D(anAttrLab);
   }
   if (anAttr) {
-    myAttrs[theID] = std::shared_ptr<ModelAPI_Attribute>(anAttr);
+    aResult = std::shared_ptr<ModelAPI_Attribute>(anAttr);
+    myAttrs[theID] = aResult;
     anAttr->setObject(myObject);
     anAttr->setID(theID);
   } else {
     Events_Error::send("Can not create unknown type of attribute " + theAttrType);
   }
+  return aResult;
 }
 
 // macro for gthe generic returning of the attribute by the ID
@@ -130,6 +160,7 @@ GET_ATTRIBUTE_BY_ID(ModelAPI_AttributeSelection, selection);
 GET_ATTRIBUTE_BY_ID(ModelAPI_AttributeSelectionList, selectionList);
 GET_ATTRIBUTE_BY_ID(ModelAPI_AttributeRefAttr, refattr);
 GET_ATTRIBUTE_BY_ID(ModelAPI_AttributeRefList, reflist);
+GET_ATTRIBUTE_BY_ID(ModelAPI_AttributeIntArray, intArray);
 
 std::shared_ptr<ModelAPI_Attribute> Model_Data::attribute(const std::string& theID)
 {
@@ -214,25 +245,62 @@ void Model_Data::erase()
     myLab.ForgetAllAttributes();
 }
 
+// indexes in the state array
+enum StatesIndexes {
+  STATE_INDEX_STATE = 1, // the state type itself
+  STATE_INDEX_TRANSACTION = 2, // transaction ID
+};
+
+/// Returns the label array, initialises it by default values if not exists
+static Handle(TDataStd_IntegerArray) stateArray(TDF_Label& theLab)
+{
+  Handle(TDataStd_IntegerArray) aStateArray;
+  if (!theLab.FindAttribute(TDataStd_IntegerArray::GetID(), aStateArray)) {
+    aStateArray = TDataStd_IntegerArray::Set(theLab, 1, 2);
+    aStateArray->SetValue(STATE_INDEX_STATE, ModelAPI_StateMustBeUpdated); // default state
+    aStateArray->SetValue(STATE_INDEX_TRANSACTION, 0); // default transaction ID (not existing)
+  }
+  return aStateArray;
+}
+
 void Model_Data::execState(const ModelAPI_ExecState theState)
 {
-  if (theState != ModelAPI_StateNothing)
-    TDataStd_Integer::Set(myLab, (int)theState);
+  if (theState != ModelAPI_StateNothing) {
+    stateArray(myLab)->SetValue(STATE_INDEX_STATE, (int)theState);
+  }
 }
 
 ModelAPI_ExecState Model_Data::execState()
 {
-  Handle(TDataStd_Integer) aStateAttr;
-  if (myLab.FindAttribute(TDataStd_Integer::GetID(), aStateAttr)) {
-    return ModelAPI_ExecState(aStateAttr->Get());
-  }
-  return ModelAPI_StateMustBeUpdated; // default value
+  return ModelAPI_ExecState(stateArray(myLab)->Value(STATE_INDEX_STATE));
 }
 
-void Model_Data::setError(const std::string& theError)
+int Model_Data::updateID()
+{
+  return stateArray(myLab)->Value(STATE_INDEX_TRANSACTION);
+}
+
+void Model_Data::setUpdateID(const int theID)
+{
+  stateArray(myLab)->SetValue(STATE_INDEX_TRANSACTION, theID);
+}
+
+void Model_Data::setError(const std::string& theError, bool theSend)
 {
   execState(ModelAPI_StateExecFailed);
-  Events_Error::send(theError);
+  if (theSend) {
+    Events_Error::send(theError);
+  }
+  TDataStd_AsciiString::Set(myLab, theError.c_str());
+}
+
+std::string Model_Data::error() const
+{
+  Handle(TDataStd_AsciiString) anErrorAttr;
+  if (myLab.FindAttribute(TDataStd_AsciiString::GetID(), anErrorAttr)) {
+    return std::string(anErrorAttr->Get().ToCString());
+  }
+  return std::string();
 }
 
 int Model_Data::featureId() const
@@ -249,40 +317,99 @@ void Model_Data::eraseBackReferences()
     aRes->setIsConcealed(false);
 }
 
-void Model_Data::addBackReference(FeaturePtr theFeature, std::string theAttrID)
+void Model_Data::removeBackReference(FeaturePtr theFeature, std::string theAttrID)
 {
-  myRefsToMe.insert(theFeature->data()->attribute(theAttrID));
+  AttributePtr anAttribute = theFeature->data()->attribute(theAttrID);
+  if (myRefsToMe.find(anAttribute) == myRefsToMe.end())
+    return;
+
+  myRefsToMe.erase(anAttribute);
+
+  // remove concealment immideately: on deselection it must be posible to reselect in GUI the same
   if (ModelAPI_Session::get()->validators()->isConcealed(theFeature->getKind(), theAttrID)) {
+    updateConcealmentFlag();
+  }
+}
+
+void Model_Data::addBackReference(FeaturePtr theFeature, std::string theAttrID, 
+   const bool theApplyConcealment)
+{
+  // do not add the same attribute twice
+  AttributePtr anAttribute = theFeature->data()->attribute(theAttrID);
+  if (myRefsToMe.find(anAttribute) != myRefsToMe.end())
+    return;
+
+  myRefsToMe.insert(theFeature->data()->attribute(theAttrID));
+  if (theApplyConcealment && 
+      ModelAPI_Session::get()->validators()->isConcealed(theFeature->getKind(), theAttrID)) {
     std::shared_ptr<ModelAPI_Result> aRes = 
       std::dynamic_pointer_cast<ModelAPI_Result>(myObject);
-    if (aRes) {
+    // the second condition is for history upper than concealment causer, so the feature result may
+    // be displayed and previewed; also for avoiding of quick show/hide on history
+    // moving deep down
+    if (aRes && !theFeature->isDisabled()) {
       aRes->setIsConcealed(true);
     }
   }
 }
 
+void Model_Data::updateConcealmentFlag()
+{
+  std::set<AttributePtr>::iterator aRefsIter = myRefsToMe.begin();
+  for(; aRefsIter != myRefsToMe.end(); aRefsIter++) {
+    if (aRefsIter->get()) {
+      FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefsIter)->owner());
+      if (aFeature.get() && !aFeature->isDisabled()) {
+        if (ModelAPI_Session::get()->validators()->isConcealed(
+              aFeature->getKind(), (*aRefsIter)->id())) {
+          return; // it is still concealed, nothing to do
+        }
+      }
+    }
+  }
+  // thus, no concealment references anymore => make not-concealed
+  std::shared_ptr<ModelAPI_Result> aRes = 
+    std::dynamic_pointer_cast<ModelAPI_Result>(myObject);
+  if (aRes.get()) {
+    aRes->setIsConcealed(false);
+    static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
+    ModelAPI_EventCreator::get()->sendUpdated(aRes, anEvent);
+    Events_Loop::loop()->flush(anEvent);
+  }
+}
+
+#include <Model_Validator.h>
+
 void Model_Data::referencesToObjects(
   std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs)
 {
+  static Model_ValidatorsFactory* aValidators = 
+    static_cast<Model_ValidatorsFactory*>(ModelAPI_Session::get()->validators());
+  FeaturePtr aMyFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(myObject);
+
   std::map<std::string, std::shared_ptr<ModelAPI_Attribute> >::iterator anAttr = myAttrs.begin();
   std::list<ObjectPtr> aReferenced; // not inside of cycle to avoid excess memory menagement
   for(; anAttr != myAttrs.end(); anAttr++) {
+    // skip not-case attributres, that really may refer to anything not-used (issue 671)
+    if (aMyFeature.get() && !aValidators->isCase(aMyFeature, anAttr->second->id()))
+      continue;
+
     std::string aType = anAttr->second->attributeType();
-    if (aType == ModelAPI_AttributeReference::type()) { // reference to object
+    if (aType == ModelAPI_AttributeReference::typeId()) { // reference to object
       std::shared_ptr<ModelAPI_AttributeReference> aRef = std::dynamic_pointer_cast<
           ModelAPI_AttributeReference>(anAttr->second);
       aReferenced.push_back(aRef->value());
-    } else if (aType == ModelAPI_AttributeRefAttr::type()) { // reference to attribute or object
+    } else if (aType == ModelAPI_AttributeRefAttr::typeId()) { // reference to attribute or object
       std::shared_ptr<ModelAPI_AttributeRefAttr> aRef = std::dynamic_pointer_cast<
           ModelAPI_AttributeRefAttr>(anAttr->second);
       aReferenced.push_back(aRef->isObject() ? aRef->object() : aRef->attr()->owner());
-    } else if (aType == ModelAPI_AttributeRefList::type()) { // list of references
+    } else if (aType == ModelAPI_AttributeRefList::typeId()) { // list of references
       aReferenced = std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(anAttr->second)->list();
-    } else if (aType == ModelAPI_AttributeSelection::type()) { // selection attribute
+    } else if (aType == ModelAPI_AttributeSelection::typeId()) { // selection attribute
       std::shared_ptr<ModelAPI_AttributeSelection> aRef = std::dynamic_pointer_cast<
           ModelAPI_AttributeSelection>(anAttr->second);
       aReferenced.push_back(aRef->context());
-    } else if (aType == ModelAPI_AttributeSelectionList::type()) { // list of selection attributes
+    } else if (aType == ModelAPI_AttributeSelectionList::typeId()) { // list of selection attributes
       std::shared_ptr<ModelAPI_AttributeSelectionList> aRef = std::dynamic_pointer_cast<
           ModelAPI_AttributeSelectionList>(anAttr->second);
       for(int a = aRef->size() - 1; a >= 0; a--) {
@@ -297,3 +424,86 @@ void Model_Data::referencesToObjects(
     }
   }
 }
+
+/// makes copy of all attributes on the given label and all sub-labels
+static void copyAttrs(TDF_Label theSource, TDF_Label theDestination) {
+  TDF_AttributeIterator anAttrIter(theSource);
+  for(; anAttrIter.More(); anAttrIter.Next()) {
+    Handle(TDF_Attribute) aTargetAttr;
+    if (!theDestination.FindAttribute(anAttrIter.Value()->ID(), aTargetAttr)) {
+      // create a new attribute if not yet exists in the destination
+           aTargetAttr = anAttrIter.Value()->NewEmpty();
+      theDestination.AddAttribute(aTargetAttr);
+    }
+    Handle(TDF_RelocationTable) aRelocTable = new TDF_RelocationTable(); // no relocation, empty map
+    anAttrIter.Value()->Paste(aTargetAttr, aRelocTable);
+  }
+  // copy the sub-labels content
+  TDF_ChildIterator aSubLabsIter(theSource);
+  for(; aSubLabsIter.More(); aSubLabsIter.Next()) {
+    copyAttrs(aSubLabsIter.Value(), theDestination.FindChild(aSubLabsIter.Value().Tag()));
+  }
+}
+
+void Model_Data::copyTo(std::shared_ptr<ModelAPI_Data> theTarget)
+{
+  TDF_Label aTargetRoot = std::dynamic_pointer_cast<Model_Data>(theTarget)->label();
+  copyAttrs(myLab, aTargetRoot);
+  // make initialized the initialized attributes
+  std::map<std::string, std::shared_ptr<ModelAPI_Attribute> >::iterator aMyIter = myAttrs.begin();
+  for(; aMyIter != myAttrs.end(); aMyIter++) {
+    if (aMyIter->second->isInitialized()) {
+      theTarget->attribute(aMyIter->first)->setInitialized();
+    }
+  }
+}
+
+bool Model_Data::isInHistory()
+{
+  return myFlags->Value(kFlagInHistory) == Standard_True;
+}
+
+void Model_Data::setIsInHistory(const bool theFlag)
+{
+  return myFlags->SetValue(kFlagInHistory, theFlag);
+}
+
+bool Model_Data::isDisplayed()
+{
+  if (!myObject.get() || !myObject->document().get() || // object is in valid
+      myFlags->Value(kFlagDisplayed) != Standard_True) // or it was not displayed before
+    return false;
+  if (myObject->document()->isActive()) // for active documents it must be ok anyway
+    return true;
+  // any object from the root document except part result may be displayed
+  if (myObject->document() == ModelAPI_Session::get()->moduleDocument() &&
+      myObject->groupName() != ModelAPI_ResultPart::group())
+    return true;
+  return false;
+}
+
+void Model_Data::setDisplayed(const bool theDisplay)
+{
+  if (theDisplay != isDisplayed()) {
+    myFlags->SetValue(kFlagDisplayed, theDisplay);
+    static Events_Loop* aLoop = Events_Loop::loop();
+    static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
+    static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
+    aECreator->sendUpdated(myObject, EVENT_DISP);
+  }
+}
+
+std::shared_ptr<ModelAPI_Data> Model_Data::invalidPtr()
+{
+  return kInvalid;
+}
+
+std::shared_ptr<ModelAPI_Data> Model_Data::invalidData()
+{
+  return kInvalid;
+}
+
+bool Model_Data::isOwner(ModelAPI_Object* theOwner)
+{
+  return theOwner == myObject.get();
+}