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           for aResId in range(aPartDoc.size(model.ModelAPI_ResultBody_group())):
  90             aResObject = aPartDoc.object(model.ModelAPI_ResultBody_group(), aResId)
  91             aRes = model.objectToResult(aResObject)
  92             print("Found a result to publish ", aRes.data().name())
  93             aResFeatureId = aPartDoc.feature(aRes).data().featureId()
  94             aSSEntry = str(aPartFeatureId) + ":" + str(aResFeatureId)
  95             aSShape = anEngine.FindOrCreateShape(aSSEntry)
  96             aSShape.SetShapeByStream(aRes.shape().getShapeStream(False))
  97             if not aSShape.GetSO(): # publish in case it is a new shape
  98               anEngine.AddInStudy(aSShape, aRes.data().name(), None)
  99             else: # restore a red reference if it was deleted
 100               aDone, aSO2 = aSShape.GetSO().FindSubObject(1)
 101               if aDone:
 102                 aDone, aRef = aSO2.ReferencedObject()
 103                 if not aDone:
 104                   aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 105                   aBuilder.Addreference(aSO2, aSShape.GetSO())
 106             allProcessed.append(aSSEntry)
 107             # Groups
 108             allGroupsProcessed = []
 109             aRefGroups = ModelAPI.referencedFeatures(aRes, "Group", True)
 110             for aRef in aRefGroups:
 111               aGroupIndices = []
 112               aGroupHasIndex = {}
 113               aResShape = aRes.shape()
 114               aSelList = aRef.selectionList("group_list")
 115               aSelType = GeomAPI_Shape.shapeTypeByStr(aSelList.selectionType())
 116               for aSelIndex in range(aSelList.size()):
 117                 aSelection = aSelList.value(aSelIndex)
 118                 if aSelection.contextObject():
 119                   aShape = aSelection.value()
 120                   if aShape:
 121                     allShapesList = [] # collect all sub-shapes selected in the group
 122                     if aShape.shapeType() == 0: # compound
 123                       anExplorer = GeomAPI_ShapeExplorer(aShape, aSelType)
 124                       while anExplorer.more():
 125                         allShapesList.append(anExplorer.current())
 126                         anExplorer.next()
 127                     else:
 128                       allShapesList.append(aShape)
 129                     # get index of each selected shape: if 0, this sub-shape is not in our result
 130                     for aSelected in allShapesList:
 131                       anId = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(aResShape, aSelected)
 132                       if anId > 0 and not anId in aGroupHasIndex:
 133                         aGroupIndices.append(anId)
 134                         aGroupHasIndex[anId] = 0
 135               if len(aGroupIndices): # create group
 136                 aGroupOp = anEngine.GetIGroupOperations()
 137                 aGroupFeatureId = aRef.data().featureId()
 138                 aGroupEntry = "group" + str(aPartFeatureId) + ":" + str(aGroupFeatureId)
 139                 aGroup = aGroupOp.FindGroup(aSShape, aGroupEntry)
 140                 if not aGroup: # create a new
 141                   aGroup = aGroupOp.CreateGroup(aSShape, aSelType)
 142                   aGroup.SetEntry(aGroupEntry)
 143                   anEngine.AddInStudy(aGroup, aRef.firstResult().data().name(), aSShape.GetSO())
 144                 aGroup.SetSelection(aGroupIndices)
 145                 # a group takes shape from the main result
 146                 #aGroup.SetShapeByStream(aRef.firstResult().shape().getShapeStream(False)) # group shape
 147                 allGroupsProcessed.append(aGroupEntry)
 148             # check all existing groups: if some does not processed, remove it from the tree
 149             aSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(aSShape.GetSO())
 150             while aSOIter.More():
 151               aSO = aSOIter.Value()
 152               anIOR = aSO.GetIOR()
 153               if len(anIOR):
 154                 anObj = salome.orb.string_to_object(anIOR)
 155                 if isinstance(anObj, SHAPERSTUDY_ORB._objref_SHAPER_Group):
 156                   anEntry = anObj.GetEntry()
 157                   if anEntry not in allGroupsProcessed: # found a removed group => remove
 158                     aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 159                     aBuilder.RemoveObject(anObj.GetSO())
 160               aSOIter.Next()
 161
 162         # process all SHAPER-STUDY shapes to find dead
 163         aSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(aComponent)
 164         while aSOIter.More():
 165           aSO = aSOIter.Value()
 166           anIOR = aSO.GetIOR()
 167           if len(anIOR):
 168             anObj = salome.orb.string_to_object(anIOR)
 169             if isinstance(anObj, SHAPERSTUDY_ORB._objref_SHAPER_Object):
 170               anEntry = anObj.GetEntry()
 171               if len(anEntry) == 0:
 172                 continue;
 173               elif anEntry not in allProcessed: # found a removed shape: make it dead for the moment
 174                 # remove the reference - red node
 175                 aRes, aSO2 = aSO.FindSubObject(1)
 176                 if aRes:
 177                   aRes, aRef = aSO2.ReferencedObject()
 178                   if aRes:
 179                     aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
 180                     aBuilder.RemoveReference(aSO2)
 181           aSOIter.Next()