src/ConnectorPlugin/ConnectorPlugin_ExportFeature.py

   1 ## @package Plugins
   2 #  ExportFeature class definition
   3 #  Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   4
   5 import EventsAPI
   6 import ModelAPI
   7 import GeomAPI
   8 import GeomAlgoAPI
   9
  10 import salome
  11 from salome.geom import geomBuilder
  12
  13 def getObjectIndex(theName):
  14     aStudy = salome.myStudy
  15     aId = 0
  16     aObj = aStudy.FindObjectByName(theName, "GEOM")
  17     while len(aObj) != 0:
  18         aId = aId + 1
  19         aName = theName + '_' + str(aId)
  20         aObj = aStudy.FindObjectByName(aName, "GEOM")
  21     return aId
  22
  23 ## @ingroup Plugins
  24 #  Feature to export all shapes and groups into the GEOM module
  25 class ExportFeature(ModelAPI.ModelAPI_Feature):
  26
  27     ## The constructor.
  28     def __init__(self):
  29         ModelAPI.ModelAPI_Feature.__init__(self)
  30         ## Shape that will be exported (the compound if there are several exported bodies)
  31         self.shape = None
  32         ## BRep representation of the exported shape (a stream that will be sent to GEOM and converted to GEOM object)
  33         self.brep = None
  34
  35     @staticmethod
  36     ## Export kind. Static.
  37     def ID():
  38         return "ExportToGEOM"
  39
  40     ## Returns the kind of a feature.
  41     def getKind(self):
  42         return ExportFeature.ID()
  43
  44     ## This feature is action: has no property pannel and executes immideately.
  45     def isAction(self):
  46         return True
  47
  48     ## This feature has no attributes, as it is action.
  49     def initAttributes(self):
  50       pass
  51
  52     ## Exports all bodies
  53     def exportBodies(self):
  54         global ShapeIndex
  55         kResultBodyType = "Bodies"
  56         aPartSize = self.Part.size(kResultBodyType)
  57         if aPartSize == 0:
  58             EventsAPI.Events_InfoMessage("ExportFeature","No results in the active document").send()
  59             return
  60
  61         anObjList = [self.Part.object(kResultBodyType, idx) for idx in xrange(aPartSize)]
  62         aShapesList = GeomAlgoAPI.ShapeList()
  63         aName = ""
  64         for idx, anObject in enumerate(anObjList):
  65             aResult = ModelAPI.modelAPI_Result(anObject)
  66             aBodyResult = ModelAPI.modelAPI_ResultBody(aResult)
  67             if not aBodyResult:
  68                 continue
  69             aShape = aBodyResult.shape()
  70             if aShape is not None and not aShape.isNull():
  71               aShapesList.append(aShape)
  72               if len(aShapesList) == 1:
  73                 aName = aBodyResult.data().name()
  74
  75         # issue 1045: create compound if there are more than one shape
  76         if len(aShapesList) > 1:
  77           self.shape = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.compound(aShapesList)
  78           aName = "ShaperResults"
  79         elif len(aShapesList) == 1:
  80           self.shape = aShapesList[0]
  81
  82         # so, only one shape is always in the result
  83         aDump = self.shape.getShapeStream()
  84         # Load shape to SALOME Geom
  85         aBrep = self.geompy.RestoreShape(aDump)
  86
  87         # Make unique name
  88         aId = getObjectIndex(aName)
  89         if aId != 0:
  90             aName = aName + '_' + str(aId)
  91
  92         self.geompy.addToStudy(aBrep, aName)
  93         self.brep = aBrep
  94
  95     ## Exports all groups
  96     def exportGroups(self):
  97         # iterate all features to find groups
  98         aFeaturesNum = self.Part.size("Features")
  99         groupIndex = 0
 100         for anIndex in range(0, aFeaturesNum):
 101             aFeature = self.Part.object("Features", anIndex)
 102             aSelectionList = aFeature.data().selectionList("group_list")
 103             # if a group has been found
 104             if aSelectionList:
 105                 aFeature = ModelAPI.objectToFeature(aFeature)
 106                 if aFeature.firstResult() is not None:
 107                   aName = aFeature.firstResult().data().name()
 108                 groupIndex = groupIndex + 1
 109                 self.createGroupFromList(aSelectionList, aName)
 110
 111     ## Returns a type of the shape in the old GEOM representation
 112     def shapeType(self, shape):
 113         if shape.isVertex():
 114             return "VERTEX"
 115         elif shape.isEdge():
 116             return "EDGE"
 117         elif shape.isFace():
 118             return "FACE"
 119
 120         return "SOLID"
 121
 122     ## Creates a group by given list of selected objects and the name
 123     #  @param theSelectionList: list of selected objects
 124     #  @param theGroupName: name of the group to create
 125     def createGroupFromList(self, theSelectionList, theGroupName):
 126         # iterate on all selected entities of the group
 127         # and get the corresponding ID
 128         aSelectionNum = theSelectionList.size()
 129         Ids = []
 130         groupType = ""
 131         for aSelIndex in range(0, aSelectionNum):
 132             aSelection = theSelectionList.value(aSelIndex)
 133             # issue 1326: bodies that are already concealed did not exported, so groups should not be invalid
 134             aContext =  ModelAPI.modelAPI_Result(aSelection.context())
 135             if aContext is None or aContext.isConcealed() or aContext.isDisabled():
 136                 continue
 137
 138             anID = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(self.shape, aSelection.value())
 139             if anID == 0:
 140                 #it may be a compound of objects if movement of the group to the end
 141                 # splits the original element to several (issue 1146)
 142                 anExp = GeomAPI.GeomAPI_ShapeExplorer(aSelection.value(), GeomAPI.GeomAPI_Shape.SHAPE)
 143                 while anExp.more():
 144                     anID = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(self.shape, anExp.current())
 145                     if anID != 0:
 146                         Ids.append(anID)
 147                         groupType = self.shapeType(anExp.current())
 148                     anExp.next()
 149             else:
 150                 Ids.append(anID)
 151                 groupType = self.shapeType(aSelection.value())
 152
 153         if len(Ids) <> 0:
 154           aGroup = self.geompy.CreateGroup(self.brep, self.geompy.ShapeType[groupType])
 155           self.geompy.UnionIDs(aGroup,Ids)
 156           self.geompy.addToStudyInFather(self.brep, aGroup, theGroupName)
 157
 158     ## Exports all fields
 159     def exportFields(self):
 160         # iterate all features to find fields
 161         aFeaturesNum = self.Part.size("Features")
 162         fieldIndex = 0
 163         for anIndex in range(0, aFeaturesNum):
 164             aFeature = self.Part.object("Features", anIndex)
 165             aSelectionList = aFeature.data().selectionList("selected")
 166             # if a field has been found
 167             if aSelectionList:
 168                 aFeature = ModelAPI.objectToFeature(aFeature)
 169                 if aFeature.firstResult() is not None:
 170                   aName = aFeature.firstResult().data().name()
 171                 fieldIndex = fieldIndex + 1
 172                 self.createFieldFromFeature(aFeature, aName)
 173
 174     ## Returns a type of the shape type in the old GEOM representation
 175     def selectionDim(self, theSelectionType):
 176         selType=theSelectionType.lower() # more or less independed approach
 177         if selType== "vertex":
 178             return 0
 179         if selType== "edge":
 180             return 1
 181         if selType== "face":
 182             return 2
 183         if selType== "solid":
 184             return 3
 185         return -1
 186
 187     ## Returns a type of the shape type in the GeomAPI_Shape representation
 188     def geomAPISelectionDim(self, theSelectionType):
 189         selType=theSelectionType.lower() # more or less independed approach
 190         if selType== "vertex":
 191             return GeomAPI.GeomAPI_Shape.VERTEX
 192         if selType== "edge":
 193             return GeomAPI.GeomAPI_Shape.EDGE
 194         if selType== "face":
 195             return GeomAPI.GeomAPI_Shape.FACE
 196         if selType== "solid":
 197             return GeomAPI.GeomAPI_Shape.SOLID
 198         return GeomAPI.GeomAPI_Shape.SHAPE
 199
 200     ## Creates a field by the field feature and the name
 201     #  @param theField: the field feature
 202     #  @param theFieldName: name of the field to create
 203     def createFieldFromFeature(self, theField, theFieldName):
 204         # iterate on all selected entities of the field
 205         # and get the corresponding ID
 206         aTables = theField.tables("values")
 207         aSelection = theField.selectionList("selected")
 208
 209         # set component names
 210         aComps = theField.stringArray("components_names")
 211         aCompNames = []
 212         aCompNum = aComps.size()
 213         for aCompIndex in range(0, aCompNum):
 214           aCompNames.append(aComps.value(aCompIndex))
 215
 216         #if len(Ids) <> 0:
 217         aDim = self.selectionDim(aSelection.selectionType())
 218         aResField = self.geompy.CreateField(self.brep, theFieldName, aTables.type(), aDim, aCompNames)
 219         #self.geompy.UnionIDs(theField,Ids)
 220         self.geompy.addToStudyInFather(self.brep, aResField, theFieldName)
 221
 222         # set default values to all not filled sub-shapes (fields in GEOM support only full set of subs)
 223         Ids={}
 224         anExp = GeomAPI.GeomAPI_ShapeExplorer(self.shape, self.geomAPISelectionDim(aSelection.selectionType()))
 225         while anExp.more():
 226           anID = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(self.shape, anExp.current())
 227           if anID != 0:
 228             Ids[anID]=anExp.current()
 229           anExp.next()
 230
 231         SelectedIds={}
 232         for aSelIndex in range(aSelection.size()):
 233           selShape = aSelection.value(aSelIndex).value()
 234           # searching for this shape in Ids
 235           for a in Ids.items():
 236             if (a[1].isSame(selShape)):
 237               SelectedIds[a[0]] = aSelIndex
 238
 239         # values here are in the same order as in field
 240         listOfValues = Ids.items()
 241         listOfValues.sort()
 242         # set steps
 243         aStepsNum = aTables.tables()
 244         for aStepIndex in range(0, aStepsNum):
 245           aStamp = theField.intArray("stamps").value(aStepIndex)
 246           aValues = []
 247           for aValId in listOfValues:
 248             aRow = 0 # default value if not from selection
 249             if SelectedIds.has_key(aValId[0]): # take the value from the table
 250               aRow = SelectedIds[aValId[0]] + 1 # plus one to avoid default string
 251             aCols = aTables.columns()
 252             for aCol in range(0, aCols):
 253               aVal = aTables.valueStr(aRow, aCol, aStepIndex)
 254               if aTables.type() == 0: # bool
 255                 if aVal == "True":
 256                   aVal = True
 257                 else:
 258                   aVal = False
 259               elif aTables.type() == 1: # int
 260                 aVal = int(aVal)
 261               elif aTables.type() == 2: # double
 262                 aVal = float(aVal)
 263               aValues.append(aVal)
 264           aResField.addStep(aStepIndex + 1, aStamp, aValues)
 265
 266     ## Exports all shapes and groups into the GEOM module.
 267     def execute(self):
 268         aSession = ModelAPI.ModelAPI_Session.get()
 269         ## Get active document
 270         self.Part = aSession.activeDocument()
 271         ## List of objects created in the old geom for later use
 272         self.geomObjects = []
 273         ## geomBuilder tool
 274         salome.salome_init(0,1)
 275         self.geompy = geomBuilder.New(salome.myStudy)
 276
 277         # Export bodies and groups
 278         self.exportBodies()
 279         self.exportGroups()
 280         self.exportFields()
 281         pass