1 // Copyright (C) 2014-2022 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
20 #include "PartSet_OperationPrs.h"
21 #include "PartSet_Tools.h"
23 #include "XGUI_Workshop.h"
24 #include "XGUI_ModuleConnector.h"
25 #include "XGUI_Displayer.h"
26 #include "XGUI_Tools.h"
28 #include "ModuleBase_Tools.h"
29 #include "ModuleBase_IModule.h"
30 #include <ModuleBase_IPropertyPanel.h>
31 #include <ModuleBase_ModelWidget.h>
32 #include <ModuleBase_ViewerPrs.h>
34 #include <ModelAPI_Events.h>
35 #include <ModelAPI_Result.h>
36 #include <ModelAPI_Attribute.h>
37 #include <ModelAPI_AttributeRefAttr.h>
38 #include <ModelAPI_AttributeReference.h>
39 #include <ModelAPI_AttributeSelection.h>
40 #include <ModelAPI_AttributeSelectionList.h>
41 #include <ModelAPI_AttributeRefList.h>
42 #include <ModelAPI_Validator.h>
43 #include <ModelAPI_Session.h>
44 #include <ModelAPI_ResultBody.h>
45 #include <ModelAPI_Tools.h>
47 #include <Events_InfoMessage.h>
48 #include <Events_Loop.h>
50 #include <GeomAPI_IPresentable.h>
52 #include <StdPrs_WFShape.hxx>
57 #include <TopoDS_Vertex.hxx>
58 #include <BRepBuilderAPI_MakeVertex.hxx>
59 #include <BRep_Builder.hxx>
60 #include <TopoDS_Compound.hxx>
61 #include <Prs3d_IsoAspect.hxx>
63 //#define DEBUG_EMPTY_SHAPE
64 //#define DEBUG_OPERATION_PRS
66 // multi-rotation/translation operation
67 //#define DEBUG_HIDE_COPY_ATTRIBUTE
68 #ifdef DEBUG_HIDE_COPY_ATTRIBUTE
69 #include <ModelAPI_AttributeBoolean.h>
70 #include <SketchPlugin_SketchEntity.h>
73 IMPLEMENT_STANDARD_RTTIEXT(PartSet_OperationPrs, ViewerData_AISShape);
75 PartSet_OperationPrs::PartSet_OperationPrs(ModuleBase_IWorkshop* theWorkshop)
76 : ViewerData_AISShape(TopoDS_Shape()), myWorkshop(theWorkshop), myUseAISWidth(false)
78 #ifdef DEBUG_OPERATION_PRS
79 qDebug("PartSet_OperationPrs::PartSet_OperationPrs");
81 myShapeColor = Quantity_Color(1, 1, 1, Quantity_TOC_RGB);
83 // first presentation for having correct Compute until presentation with shapes are set
84 gp_Pnt aPnt(0.0, 0.0, 0.0);
85 BRepBuilderAPI_MakeVertex aMaker(aPnt);
86 TopoDS_Vertex aVertex = aMaker.Vertex();
87 myShapeToPrsMap.Bind(aVertex, NULL);
89 Handle(Prs3d_Drawer) aDrawer = Attributes();
90 Handle(Prs3d_IsoAspect) aUIsoAspect = new Prs3d_IsoAspect(myShapeColor, Aspect_TOL_SOLID, 1, 0);
91 Handle(Prs3d_IsoAspect) aVIsoAspect = new Prs3d_IsoAspect(myShapeColor, Aspect_TOL_SOLID, 1, 0);
92 aDrawer->SetUIsoAspect(aUIsoAspect);
93 aDrawer->SetVIsoAspect(aVIsoAspect);
94 aDrawer->SetIsoOnPlane(false);
95 //aDrawer->SetTypeOfDeflection(Aspect_TOD_ABSOLUTE);
98 bool PartSet_OperationPrs::hasShapes()
100 return !myShapeToPrsMap.IsEmpty();
103 void PartSet_OperationPrs::setShapeColor(const Quantity_Color& theColor)
105 myShapeColor = theColor;
108 void PartSet_OperationPrs::useAISWidth()
110 myUseAISWidth = true;
113 void PartSet_OperationPrs::Compute(
114 const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
115 const Handle(Prs3d_Presentation)& thePresentation,
116 const Standard_Integer theMode)
118 #ifdef DEBUG_OPERATION_PRS
119 qDebug("PartSet_OperationPrs::Compute -- begin");
122 SetColor(myShapeColor);
123 thePresentation->Clear();
124 bool aReadyToDisplay = !myShapeToPrsMap.IsEmpty();
126 Handle(Prs3d_Drawer) aDrawer = Attributes();
127 // create presentations on the base of the shapes
128 BRep_Builder aBuilder;
129 TopoDS_Compound aComp;
130 aBuilder.MakeCompound(aComp);
131 for(NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>::Iterator
132 anIter(myShapeToPrsMap); anIter.More(); anIter.Next()) {
133 const TopoDS_Shape& aShape = anIter.Key();
134 aBuilder.Add(aComp, aShape);
135 // change deviation coefficient to provide more precise circle
136 // as there is no result, the shape is processed to correct deviation. To be unified
137 ModuleBase_Tools::setDefaultDeviationCoefficient(aShape, aDrawer);
138 //This presentation is not used for selection, so it don't need highlighting
139 //ModuleBase_Tools::setDefaultDeviationCoefficient(aShape, DynamicHilightAttributes());
142 Handle(AIS_InteractiveObject) anIO = anIter.Value();
143 if (!anIO.IsNull()) {
144 int aWidth = anIO->Width();
145 /// workaround for zero width. Else, there will be a crash
146 if (aWidth == 0) { // width returns of TSolid shape is zero
147 aWidth = PartSet_Tools::getAISDefaultWidth();// default width value
149 setWidth(aDrawer, aWidth);
153 StdPrs_WFShape::Add(thePresentation, aShape, aDrawer);
160 if (!aReadyToDisplay) {
161 Events_InfoMessage("PartSet_OperationPrs",
162 "An empty AIS presentation: PartSet_OperationPrs").send();
163 std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
164 new Events_Message(Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION)));
165 Events_Loop::loop()->send(aMsg);
167 #ifdef DEBUG_OPERATION_PRS
168 qDebug("PartSet_OperationPrs::Compute -- end");
172 void PartSet_OperationPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
173 const Standard_Integer aMode)
175 // the presentation is not used in the selection
178 NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>& PartSet_OperationPrs::shapesMap()
180 return myShapeToPrsMap;
183 bool isSubObject(const ObjectPtr& theObject, const FeaturePtr& theFeature)
186 CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
187 if (aComposite.get())
188 isSub = aComposite->isSub(theObject);
193 void PartSet_OperationPrs::addValue(const ObjectPtr& theObject, const GeomShapePtr& theShape,
194 const FeaturePtr& theFeature, ModuleBase_IWorkshop* theWorkshop,
195 QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
197 if (theObject.get()) {
198 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
200 ResultBodyPtr aBodyResult =
201 std::dynamic_pointer_cast<ModelAPI_ResultBody>(theObject);
202 if (aBodyResult.get()) {
203 if (aBodyResult->numberOfSubs() > 0) {
204 for(int i = 0; i < aBodyResult->numberOfSubs(); i++) {
205 ResultPtr aSubResult = aBodyResult->subResult(i);
206 if (aSubResult.get()) {
208 addValue(aSubResult, aShape, theFeature, theWorkshop, theObjectShapes);
214 #ifdef DEBUG_HIDE_COPY_ATTRIBUTE
216 FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
217 if (aFeature.get()) {
218 AttributeBooleanPtr aCopyAttr =
219 aFeature->data()->boolean(SketchPlugin_SketchEntity::COPY_ID());
220 if (aCopyAttr.get()) {
221 bool isCopy = aCopyAttr->value();
230 GeomShapePtr aShape = theShape;
232 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
234 aShape = aRes->shape();
236 if (!isSubObject(theObject, theFeature))
237 appendShapeIfVisible(theWorkshop, theObject, aShape, theObjectShapes);
241 void PartSet_OperationPrs::appendShapeIfVisible(ModuleBase_IWorkshop* theWorkshop,
242 const ObjectPtr& theObject,
243 GeomShapePtr theGeomShape,
244 QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
246 if (theGeomShape.get()) {
247 if (theObjectShapes.contains(theObject))
248 theObjectShapes[theObject].append(theGeomShape);
250 QList<GeomShapePtr> aShapes;
251 aShapes.append(theGeomShape);
252 theObjectShapes[theObject] = aShapes;
255 #ifdef DEBUG_EMPTY_SHAPE
256 qDebug(QString("Empty shape in result, result: %1")
257 .arg(ModuleBase_Tools::objectInfo(theObject)).toStdString().c_str());
262 void PartSet_OperationPrs::getFeatureShapes(const FeaturePtr& theFeature,
263 ModuleBase_IWorkshop* theWorkshop,
264 QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
266 theObjectShapes.clear();
267 if (!theFeature.get())
270 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
272 QList<GeomShapePtr> aShapes;
273 std::list<AttributePtr> anAttributes = theFeature->data()->attributes("");
274 std::list<AttributePtr>::const_iterator anIt = anAttributes.begin(), aLast = anAttributes.end();
275 for (; anIt != aLast; anIt++) {
276 AttributePtr anAttribute = *anIt;
277 if (!isSelectionAttribute(anAttribute))
280 if (!aValidators->isCase(theFeature, anAttribute->id()))
281 continue; // this attribute is not participated in the current case
283 std::string anAttrType = anAttribute->attributeType();
285 if (anAttrType == ModelAPI_AttributeSelectionList::typeId()) {
286 std::shared_ptr<ModelAPI_AttributeSelectionList> aCurSelList =
287 std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(anAttribute);
288 for(int i = 0; i < aCurSelList->size(); i++) {
289 std::shared_ptr<ModelAPI_AttributeSelection> aSelAttribute = aCurSelList->value(i);
290 ResultPtr aResult = aSelAttribute->context();
291 GeomShapePtr aShape = aSelAttribute->value();
292 addValue(aResult, aShape, theFeature, theWorkshop, theObjectShapes);
295 if (anAttrType == ModelAPI_AttributeRefList::typeId()) {
296 std::shared_ptr<ModelAPI_AttributeRefList> aCurSelList =
297 std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(anAttribute);
298 for (int i = 0; i < aCurSelList->size(); i++) {
299 ObjectPtr anObject = aCurSelList->object(i);
300 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
301 // if a feature is stored in the attribute, we should obtain the feature results
302 // e.g. feature rectangle uses parameters feature lines in the attribute
303 if (aFeature.get()) {
304 getResultShapes(aFeature, theWorkshop, theObjectShapes, false);
307 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
309 GeomShapePtr aShape = aResult->shape();
311 addValue(aResult, aShape, theFeature, theWorkshop, theObjectShapes);
319 if (anAttrType == ModelAPI_AttributeRefAttr::typeId()) {
320 AttributeRefAttrPtr aRefAttr =
321 std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(anAttribute);
322 if (aRefAttr->isObject()) {
323 anObject = aRefAttr->object();
326 AttributePtr anAttr = aRefAttr->attr();
327 aShape = PartSet_Tools::findShapeBy2DPoint(anAttr, theWorkshop);
328 // the distance point is not found if the point is selected in the 2nd time
329 // TODO: after debug, this check can be removed
332 anObject = anAttr->owner();
335 if (anAttrType == ModelAPI_AttributeSelection::typeId()) {
336 AttributeSelectionPtr anAttr =
337 std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(anAttribute);
338 anObject = anAttr->context();
339 aShape = anAttr->value();
341 if (anAttrType == ModelAPI_AttributeReference::typeId()) {
342 AttributeReferencePtr anAttr =
343 std::dynamic_pointer_cast<ModelAPI_AttributeReference>(anAttribute);
344 anObject = anAttr->value();
346 addValue(anObject, aShape, theFeature, theWorkshop, theObjectShapes);
351 void PartSet_OperationPrs::getResultShapes(const FeaturePtr& theFeature,
352 ModuleBase_IWorkshop* theWorkshop,
353 QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes,
354 const bool theListShouldBeCleared)
356 if (theListShouldBeCleared)
357 theObjectShapes.clear();
359 if (!theFeature.get())
362 std::list<ResultPtr> aResults;
363 ModelAPI_Tools::allResults(theFeature, aResults);
364 std::list<ResultPtr>::const_iterator aRIt = aResults.begin(),
365 aRLast = aResults.end();
366 for (; aRIt != aRLast; aRIt++) {
367 ResultPtr aResult = *aRIt;
368 if (!aResult->isDisabled()) {
369 GeomShapePtr aGeomShape = aResult->shape();
370 appendShapeIfVisible(theWorkshop, aResult, aGeomShape, theObjectShapes);
375 void PartSet_OperationPrs::getPresentationShapes(const FeaturePtr& theFeature,
376 ModuleBase_IWorkshop* theWorkshop,
377 QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes,
378 const bool theListShouldBeCleared)
380 if (theListShouldBeCleared)
381 theObjectShapes.clear();
383 if (!theFeature.get() || !theFeature->data()->isValid()) // if feature is already removed
386 XGUI_Displayer* aDisplayer = XGUI_Tools::workshop(theWorkshop)->displayer();
388 GeomPresentablePtr aPrs = std::dynamic_pointer_cast<GeomAPI_IPresentable>(theFeature);
392 AISObjectPtr anAIS = aPrs->getAISObject(aDisplayer->getAISObject(theFeature));
396 Handle(AIS_InteractiveObject) anAISPrs = anAIS->impl<Handle(AIS_InteractiveObject)>();
397 if (!anAISPrs.IsNull()) {
398 Handle(AIS_Shape) aShapePrs = Handle(AIS_Shape)::DownCast(anAISPrs);
399 if (!aShapePrs.IsNull()) {
400 TopoDS_Shape aShape = aShapePrs->Shape();
401 if (!aShape.IsNull()) {
402 std::shared_ptr<GeomAPI_Shape> aGeomShape(new GeomAPI_Shape());
403 aGeomShape->setImpl(new TopoDS_Shape(aShape));
404 appendShapeIfVisible(theWorkshop, theFeature, aGeomShape, theObjectShapes);
410 void PartSet_OperationPrs::getHighlightedShapes(ModuleBase_IWorkshop* theWorkshop,
412 QList<GeomShapePtr> >& theObjectShapes)
414 theObjectShapes.clear();
416 QList<ModuleBase_ViewerPrsPtr> aValues;
417 ModuleBase_ModelWidget* anActiveWidget = theWorkshop->module()->activeWidget();
419 anActiveWidget->getHighlighted(aValues);
421 QList<GeomShapePtr> aShapes;
422 QList<ModuleBase_ViewerPrsPtr>::const_iterator anIIt = aValues.begin(),
423 aILast = aValues.end();
424 for (; anIIt != aILast; anIIt++) {
425 ModuleBase_ViewerPrsPtr aPrs = *anIIt;
426 ObjectPtr anObject = aPrs->object();
428 GeomShapePtr aGeomShape = aPrs->shape();
429 if (!aGeomShape.get() || aGeomShape->isNull()) {
430 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
432 aGeomShape = aResult->shape();
435 appendShapeIfVisible(theWorkshop, anObject, aGeomShape, theObjectShapes);
440 bool PartSet_OperationPrs::isSelectionAttribute(const AttributePtr& theAttribute)
442 std::string anAttrType = theAttribute->attributeType();
444 return anAttrType == ModelAPI_AttributeSelectionList::typeId() ||
445 anAttrType == ModelAPI_AttributeRefList::typeId() ||
446 anAttrType == ModelAPI_AttributeRefAttr::typeId() ||
447 anAttrType == ModelAPI_AttributeSelection::typeId() ||
448 anAttrType == ModelAPI_AttributeReference::typeId();
451 void PartSet_OperationPrs::fillShapeList(
452 const QMap<ObjectPtr, QList<GeomShapePtr> >& theFeatureShapes,
453 ModuleBase_IWorkshop* theWorkshop,
454 NCollection_DataMap<TopoDS_Shape,
455 Handle(AIS_InteractiveObject)>& theShapeToPrsMap)
457 theShapeToPrsMap.Clear();
459 XGUI_Displayer* aDisplayer = XGUI_Tools::workshop(theWorkshop)->displayer();
461 // create presentations on the base of the shapes
462 QMap<ObjectPtr, QList<GeomShapePtr> >::const_iterator anIt = theFeatureShapes.begin(),
463 aLast = theFeatureShapes.end();
464 for (; anIt != aLast; anIt++) {
465 ObjectPtr anObject = anIt.key();
466 QList<GeomShapePtr> aShapes = anIt.value();
467 QList<GeomShapePtr>::const_iterator aShIt = aShapes.begin(), aShLast = aShapes.end();
468 for (; aShIt != aShLast; aShIt++) {
469 GeomShapePtr aGeomShape = *aShIt;
470 // the shape should not be checked here on empty value because it should be checked in
471 // appendShapeIfVisible() on the step of filling theFeatureShapes list
472 // the reason is to avoid empty AIS object visualized in the viewer
473 //if (!aGeomShape.get()) continue;
474 TopoDS_Shape aShape = aGeomShape.get() ? aGeomShape->impl<TopoDS_Shape>() : TopoDS_Shape();
478 // change deviation coefficient to provide more precise circle
479 Handle(AIS_InteractiveObject) anIO;
480 AISObjectPtr anAISPtr = aDisplayer->getAISObject(anObject);
482 anIO = anAISPtr->impl<Handle(AIS_InteractiveObject)>();
483 theShapeToPrsMap.Bind(aShape, anIO);