1 # Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # ExportFeature class definition
30 from salome.shaper import model
32 import SHAPERSTUDY_ORB
33 import SHAPERSTUDY_utils
36 # Feature to export all shapes and groups into the GEOM module
37 class PublishToStudyFeature(ModelAPI.ModelAPI_Feature):
41 ModelAPI.ModelAPI_Feature.__init__(self)
45 ## Export kind. Static.
47 return "PublishToStudy"
49 ## Returns the kind of a feature.
51 return PublishToStudyFeature.ID()
53 ## This feature is action: has no property panel and executes immediately.
57 ## This feature has no attributes, as it is action.
58 def initAttributes(self):
61 ## Exports all shapes and groups into the GEOM module.
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
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()
73 # find a shaper-study component
75 aComponent = SHAPERSTUDY_utils.findOrCreateComponent()
76 anEngine = SHAPERSTUDY_utils.getEngine()
77 # collect all processed internal entries to break the link of unprocessed later
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()
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.
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])
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)
109 aDone, aRef = aSO2.ReferencedObject()
111 aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
112 aBuilder.Addreference(aSO2, aSShape.GetSO())
113 allProcessed.append(aSSEntry)
115 self.processGroups(aRes, anEngine, aPartFeatureId, aSShape, False)
117 self.processGroups(aRes, anEngine, aPartFeatureId, aSShape, True)
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
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:
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)
135 aRes, aRef = aSO2.ReferencedObject()
137 aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
138 aBuilder.RemoveReference(aSO2)
139 # if the object is not marked as dead, mark it (#3201) to make all entries unique
140 aDeadEntry = anObj.GetEntry()
141 if not aDeadEntry.startswith("dead"):
143 anObj.SetEntry("dead0" + str(anIndex) + "_" + aDeadEntry)
146 aGrSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(aSO)
147 while aGrSOIter.More():
148 aGroupSO = aGrSOIter.Value()
150 anIOR = aGroupSO.GetIOR()
152 aGroup = salome.orb.string_to_object(anIOR)
153 if isinstance(aGroup, SHAPERSTUDY_ORB._objref_SHAPER_Group) or \
154 isinstance(aGroup, SHAPERSTUDY_ORB._objref_SHAPER_Field):
155 if not aGroup.GetEntry().startswith("dead"):
156 aDeadGroupEntry = "dead0" + str(anIndex) + "_" + aGroup.GetEntry()
157 aGroup.SetEntry(aDeadGroupEntry)
159 # Part of the "execute" method: processes the Groups of theRes result publication.
160 # If theFields is true, the same is performed for Fields.
161 def processGroups(self, theRes, theEngine, thePartFeatureId, theStudyShape, theFields):
162 allGroupsProcessed = []
164 aRefGroups = ModelAPI.referencedFeatures(theRes, "Field", True)
166 aRefGroups = ModelAPI.referencedFeatures(theRes, "Group", True)
167 for aRef in aRefGroups:
170 aResShape = theRes.shape()
172 aSelList = aRef.selectionList("selected")
174 aSelList = aRef.selectionList("group_list")
175 aSelType = GeomAPI_Shape.shapeTypeByStr(aSelList.selectionType())
176 for aSelIndex in range(aSelList.size()):
177 aSelection = aSelList.value(aSelIndex)
178 if aSelection.contextObject():
179 aShape = aSelection.value()
181 allShapesList = [] # collect all sub-shapes selected in the group
182 if aShape.shapeType() == 0 or aShape.shapeType() != aSelType: # compound or whole res
183 anExplorer = GeomAPI_ShapeExplorer(aShape, aSelType)
184 while anExplorer.more():
185 allShapesList.append(anExplorer.current())
188 allShapesList.append(aShape)
189 # get index of each selected shape: if 0, this sub-shape is not in our result
190 for aSelected in allShapesList:
191 anId = GeomAlgoAPI.GeomAlgoAPI_CompoundBuilder.id(aResShape, aSelected)
192 if anId > 0 and not anId in aGroupHasIndex:
193 aGroupIndices.append(anId)
194 aGroupHasIndex[anId] = 0
195 if len(aGroupIndices): # create group
196 aGroupFeatureId = aRef.data().featureId()
198 aFieldOp = theEngine.GetIFieldOperations()
199 aGroupEntry = "field" + str(thePartFeatureId) + ":" + str(aGroupFeatureId)
200 aGroup = aFieldOp.FindField(theStudyShape, aGroupEntry)
202 aGroupOp = theEngine.GetIGroupOperations()
203 aGroupEntry = "group" + str(thePartFeatureId) + ":" + str(aGroupFeatureId)
204 aGroup = aGroupOp.FindGroup(theStudyShape, aGroupEntry)
205 if not aGroup: # create a new
207 aGroup = aFieldOp.CreateFieldByType(theStudyShape, aSelType)
209 aGroup = aGroupOp.CreateGroup(theStudyShape, aSelType)
210 aGroup.SetEntry(aGroupEntry)
211 theEngine.AddInStudy(aGroup, aRef.firstResult().data().name(), theStudyShape)
212 aGroup.SetSelection(aGroupIndices)
214 self.fillField(aGroup, aRef, theEngine, aGroupIndices)
215 # a group takes shape from the main result
216 #aGroup.SetShapeByStream(aRef.firstResult().shape().getShapeStream(False)) # group shape
217 allGroupsProcessed.append(aGroupEntry)
218 # check all existing groups: if some does not processed, remove it from the tree
219 aSOIter = SHAPERSTUDY_utils.getStudy().NewChildIterator(theStudyShape.GetSO())
220 while aSOIter.More():
221 aSO = aSOIter.Value()
224 anObj = salome.orb.string_to_object(anIOR)
225 if (theFields and isinstance(anObj, SHAPERSTUDY_ORB._objref_SHAPER_Field)) or \
226 (not theFields and type(anObj) == SHAPERSTUDY_ORB._objref_SHAPER_Group):
227 anEntry = anObj.GetEntry()
228 if anEntry not in allGroupsProcessed: # found a removed group => remove
229 aBuilder = SHAPERSTUDY_utils.getStudy().NewBuilder()
230 aBuilder.RemoveObject(anObj.GetSO())
233 # Part of the "execute" method: theFiled fields filling.
234 def fillField(self, theField, theFeature, theEngine, theSelectionIndices):
235 aTables = theFeature.tables("values")
236 aValType = aTables.type() # type of the values
237 theField.SetValuesType(aValType)
238 aNumSteps = aTables.tables() # number of steps is number of tables
240 for aVal in range(aNumSteps):
241 aSteps.append(aVal + 1)
242 theField.SetSteps(aSteps)
244 aCompNamesAttr = theFeature.stringArray("components_names")
245 for anIndex in range(aCompNamesAttr.size()):
246 aCompNames.append(aCompNamesAttr.value(anIndex))
247 theField.SetComponents(aCompNames)
248 # prepare the sub-shapes indices: all values for all sub-shapes must be defined
249 aShapeOp = theEngine.GetIShapesOperations()
250 allIndices = aShapeOp.GetAllSubShapesIDs(theField.GetShape(), theField.GetSelectionType(), False)
252 theField.ClearFieldSteps()
253 for aVal in range(aNumSteps):
255 for aCol in range(aTables.columns()):
256 #for aRow in range(aTables.rows()):
257 for anIndex in allIndices:
258 if anIndex in theSelectionIndices:
259 aRow = theSelectionIndices.index(anIndex) + 1 # starting from the first line
261 aRow = 0 # default value
262 aStrVal = aTables.valueStr(aRow, aCol, aVal)
263 if aValType == 0: # boolean
264 if aStrVal == "True":
268 elif aValType == 1: # int
269 aVals.append(int(aStrVal))
270 elif aValType == 2: # double
271 aVals.append(float(aStrVal))
272 theField.AddFieldStep(theFeature.intArray("stamps").value(aVal), aVal + 1, aVals)