src/ConnectorPlugin/ConnectorPlugin_PublishToStudyFeature.py

   1 # Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 ## @package Plugins
  21 #  ExportFeature class definition
  22
  23 import ModelAPI
  24 import ExchangeAPI
  25 import EventsAPI
  26 from GeomAPI import *
  27 import GeomAlgoAPI
  28
  29 import salome
  30 from salome.shaper import model
  31
  32 import SHAPERSTUDY_ORB
  33 import SHAPERSTUDY_utils
  34
  35 ## @ingroup Plugins
  36 #  Feature to export all shapes and groups into the GEOM module
  37 class PublishToStudyFeature(ModelAPI.ModelAPI_Feature):
  38
  39     ## The constructor.
  40     def __init__(self):
  41         ModelAPI.ModelAPI_Feature.__init__(self)
  42         pass
  43
  44     @staticmethod
  45     ## Export kind. Static.
  46     def ID():
  47         return "PublishToStudy"
  48
  49     ## Returns the kind of a feature.
  50     def getKind(self):
  51         return PublishToStudyFeature.ID()
  52
  53     ## This feature is action: has no property panel and executes immediately.
  54     def isAction(self):
  55         return True
  56
  57     ## This feature has no attributes, as it is action.
  58     def initAttributes(self):
  59         pass
  60
  61     ## Exports all shapes and groups into the GEOM module.
  62     def execute(self):
  63         aSession = ModelAPI.ModelAPI_Session.get()
  64         aPartSet = aSession.moduleDocument()
  65         # check that the PartSet document current feature is the last to avoid problems with all
  66         # features update
  67         if aPartSet.size(model.ModelAPI_Feature_group()) > 0:
  68           aLastFeature = ModelAPI.objectToFeature(aPartSet.object(model.ModelAPI_Feature_group(), aPartSet.size(model.ModelAPI_Feature_group()) - 1))
  69           aCurrentFeature = aPartSet.currentFeature(True)
  70           if aLastFeature.data().featureId() != aCurrentFeature.data().featureId():
  71             EventsAPI.Events_InfoMessage("PublishToStudy", "Not all PartSet parts are up-to-date, nothing is published. Please, make the last PartSet feature as current.", self).send()
  72             return
  73         # find a shaper-study component
  74         salome.salome_init(1)
  75         aComponent = SHAPERSTUDY_utils.findOrCreateComponent()
  76         anEngine = SHAPERSTUDY_utils.getEngine()
  77         # collect all processed internal entries to break the link of unprocessed later
  78         allProcessed = []
  79
  80         # iterate all parts and all results to publish them in SHAPER_STUDY
  81         for aPartId in range(aPartSet.size(model.ModelAPI_ResultPart_group())):
  82           aPartObject = aPartSet.object(model.ModelAPI_ResultPart_group(), aPartId)
  83           aPartRes = ModelAPI.modelAPI_ResultPart(ModelAPI.modelAPI_Result(aPartObject))
  84           aPartDoc = aPartRes.partDoc()
  85           if aPartDoc is None and aPartObject is not None:
  86             EventsAPI.Events_InfoMessage("PublishToStudy", "For publish to SHAPER-STUDY some Part is not activated", self).send()
  87             break
  88           aPartFeatureId = aPartSet.feature(aPartRes).data().featureId()
  89           # Collects all features of exported results to find results of the same features and extend id.
  90           # Map from feature index to index of result. If index is zero (initial), no surrfix to entry is added.
  91           aFeaturesIndices = {}
  92           for aResId in range(aPartDoc.size(model.ModelAPI_ResultBody_group())):
  93             aResObject = aPartDoc.object(model.ModelAPI_ResultBody_group(), aResId)
  94             aRes = model.objectToResult(aResObject)
  95             aResFeatureId = str(aPartDoc.feature(aRes).data().featureId())
  96             if aResFeatureId in aFeaturesIndices:
  97               aFeaturesIndices[aResFeatureId] += 1
  98               aResFeatureId += ":" + str(aFeaturesIndices[aResFeatureId])
  99             else:
 100               aFeaturesIndices[aResFeatureId] = 0
 101             aSSEntry = str(aPartFeatureId) + ":" + aResFeatureId
 102             aSShape = anEngine.FindOrCreateShape(aSSEntry)
 103             aSShape.SetShapeByStream(aRes.shape().getShapeStream(False))
 104             if not aSShape.GetSO(): # publish in case it is a new shape
 105               anEngine.AddInStudy(aSShape, aRes.data().name(), None)
 106             else: # restore a red reference if it was deleted
 107               aDone, aSO2 = aSShape.GetSO().FindSubObject(1)
 108               if aDone:
 109                 aDone, aRef = aSO2.ReferencedObject()
 110                 if not aDone:
 111                   aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 112                   aBuilder.Addreference(aSO2, aSShape.GetSO())
 113             allProcessed.append(aSSEntry)
 114             # Groups
 115             self.processGroups(aRes, anEngine, aPartFeatureId, aSShape, False)
 116             # Fields
 117             self.processGroups(aRes, anEngine, aPartFeatureId, aSShape, True)
 118
 119         # process all SHAPER-STUDY shapes to find dead
 120         aSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(aComponent)
 121         while aSOIter.More():
 122           aSO = aSOIter.Value()
 123           aSOIter.Next() ### here because there is continue inside the loop!
 124           anIOR = aSO.GetIOR()
 125           if len(anIOR):
 126             anObj = salome.orb.string_to_object(anIOR)
 127             if isinstance(anObj, SHAPERSTUDY_ORB._objref_SHAPER_Object):
 128               anEntry = anObj.GetEntry()
 129               if len(anEntry) == 0:
 130                 continue;
 131               elif anEntry not in allProcessed: # found a removed shape: make it dead for the moment
 132                 # remove the reference - red node
 133                 aRes, aSO2 = aSO.FindSubObject(1)
 134                 if aRes:
 135                   aRes, aRef = aSO2.ReferencedObject()
 136                   if aRes:
 137                     aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 138                     aBuilder.RemoveReference(aSO2)
 139                 # 18884 - remove also the shape object and all sub-objects
 140                 aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 141                 aBuilder.RemoveObjectWithChildren(aSO)
 142
 143     # Part of the "execute" method: processes the Groups of theRes result publication.
 144     # If theFields is true, the same is performed for Fields.
 145     def processGroups(self, theRes, theEngine, thePartFeatureId, theStudyShape, theFields):
 146       allGroupsProcessed = []
 147       if theFields:
 148         aRefGroups = ModelAPI.referencedFeatures(theRes, "Field", True)
 149       else:
 150         aRefGroups = ModelAPI.referencedFeatures(theRes, "Group", True)
 151       for aRef in aRefGroups:
 152         aGroupIndices = []
 153         aGroupHasIndex = {}
 154         aResShape = theRes.shape()
 155         if theFields:
 156           aSelList = aRef.selectionList("selected")
 157         else:
 158           aSelList = aRef.selectionList("group_list")
 159         aSelType = GeomAPI_Shape.shapeTypeByStr(aSelList.selectionType())
 160         for aSelIndex in range(aSelList.size()):
 161           aSelection = aSelList.value(aSelIndex)
 162           if aSelection.contextObject():
 163             aShape = aSelection.value()
 164             if aShape:
 165               allShapesList = [] # collect all sub-shapes selected in the group
 166               if aShape.shapeType() == 0: # compound
 167                 anExplorer = GeomAPI_ShapeExplorer(aShape, aSelType)
 168                 while anExplorer.more():
 169                   allShapesList.append(anExplorer.current())
 170                   anExplorer.next()
 171               else:
 172                 allShapesList.append(aShape)
 173               # get index of each selected shape: if 0, this sub-shape is not in our result
 174               for aSelected in allShapesList:
 175                 anId = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(aResShape, aSelected)
 176                 if anId > 0 and not anId in aGroupHasIndex:
 177                   aGroupIndices.append(anId)
 178                   aGroupHasIndex[anId] = 0
 179         if len(aGroupIndices): # create group
 180           aGroupFeatureId = aRef.data().featureId()
 181           if theFields:
 182             aFieldOp = theEngine.GetIFieldOperations()
 183             aGroupEntry = "field" + str(thePartFeatureId) + ":" + str(aGroupFeatureId)
 184             aGroup = aFieldOp.FindField(theStudyShape, aGroupEntry)
 185           else:
 186             aGroupOp = theEngine.GetIGroupOperations()
 187             aGroupEntry = "group" + str(thePartFeatureId) + ":" + str(aGroupFeatureId)
 188             aGroup = aGroupOp.FindGroup(theStudyShape, aGroupEntry)
 189           if not aGroup: # create a new
 190             if theFields:
 191               aGroup = aFieldOp.CreateFieldByType(theStudyShape, aSelType)
 192             else:
 193               aGroup = aGroupOp.CreateGroup(theStudyShape, aSelType)
 194             aGroup.SetEntry(aGroupEntry)
 195             theEngine.AddInStudy(aGroup, aRef.firstResult().data().name(), theStudyShape)
 196           aGroup.SetSelection(aGroupIndices)
 197           if theFields:
 198             self.fillField(aGroup, aRef, theEngine, aGroupIndices)
 199           # a group takes shape from the main result
 200           #aGroup.SetShapeByStream(aRef.firstResult().shape().getShapeStream(False)) # group shape
 201           allGroupsProcessed.append(aGroupEntry)
 202       # check all existing groups: if some does not processed, remove it from the tree
 203       aSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(theStudyShape.GetSO())
 204       while aSOIter.More():
 205         aSO = aSOIter.Value()
 206         anIOR = aSO.GetIOR()
 207         if len(anIOR):
 208           anObj = salome.orb.string_to_object(anIOR)
 209           if (theFields and isinstance(anObj, SHAPERSTUDY_ORB._objref_SHAPER_Field)) or \
 210              (not theFields and type(anObj) == SHAPERSTUDY_ORB._objref_SHAPER_Group):
 211             anEntry = anObj.GetEntry()
 212             if anEntry not in allGroupsProcessed: # found a removed group => remove
 213               aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 214               aBuilder.RemoveObject(anObj.GetSO())
 215         aSOIter.Next()
 216
 217     # Part of the "execute" method: theFiled fields filling.
 218     def fillField(self, theField, theFeature, theEngine, theSelectionIndices):
 219       aTables = theFeature.tables("values")
 220       aValType = aTables.type() # type of the values
 221       theField.SetValuesType(aValType)
 222       aNumSteps = aTables.tables() # number of steps is number of tables
 223       aSteps = []
 224       for aVal in range(aNumSteps):
 225         aSteps.append(aVal + 1)
 226       theField.SetSteps(aSteps)
 227       aCompNames = []
 228       aCompNamesAttr = theFeature.stringArray("components_names")
 229       for anIndex in range(aCompNamesAttr.size()):
 230         aCompNames.append(aCompNamesAttr.value(anIndex))
 231       theField.SetComponents(aCompNames)
 232       # prepare the sub-shapes indices: all values for all sub-shapes must be defined
 233       aShapeOp = theEngine.GetIShapesOperations()
 234       allIndices = aShapeOp.GetAllSubShapesIDs(theField.GetShape(), theField.GetSelectionType(), False)
 235       # define steps
 236       theField.ClearFieldSteps()
 237       for aVal in range(aNumSteps):
 238         aVals = []
 239         for aCol in range(aTables.columns()):
 240           #for aRow in range(aTables.rows()):
 241           for anIndex in allIndices:
 242             if anIndex in theSelectionIndices:
 243               aRow = theSelectionIndices.index(anIndex) + 1 # starting from the first line
 244             else:
 245               aRow = 0 # default value
 246             aStrVal = aTables.valueStr(aRow, aCol, aVal)
 247             if aValType == 0: # boolean
 248               if aStrVal == "True":
 249                 aVals.append(1)
 250               else:
 251                 aVals.append(0)
 252             elif aValType == 1: # int
 253               aVals.append(int(aStrVal))
 254             elif aValType == 2: # double
 255               aVals.append(float(aStrVal))
 256         theField.AddFieldStep(theFeature.intArray("stamps").value(aVal), aVal + 1, aVals)