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_CustomPrs.h"
21 #include "PartSet_Module.h"
22 #include "PartSet_OperationPrs.h"
23 #include "PartSet_OverconstraintListener.h"
24 #include "PartSet_SketcherMgr.h"
26 #include <XGUI_ModuleConnector.h>
27 #include <XGUI_Workshop.h>
28 #include <XGUI_Displayer.h>
30 #include <ModuleBase_IWorkshop.h>
31 #include <ModuleBase_IViewer.h>
32 #include <ModuleBase_Tools.h>
34 #include <ModelAPI_Tools.h>
35 #include <SketchPlugin_Sketch.h>
37 #include <Config_PropManager.h>
38 #include <Events_Loop.h>
39 #include <ModelAPI_Events.h>
40 #include <GeomAlgoAPI_CompoundBuilder.h>
42 #include <AIS_InteractiveContext.hxx>
43 #include <AIS_InteractiveObject.hxx>
44 #include <Prs3d_PointAspect.hxx>
46 //#define DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
48 PartSet_CustomPrs::PartSet_CustomPrs(ModuleBase_IWorkshop* theWorkshop)
49 : myWorkshop(theWorkshop), myFeature(FeaturePtr()), myPresentationIsEmpty(false),
52 Events_Loop* aLoop = Events_Loop::loop();
53 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION));
54 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OPERATION_SHAPES_FAILED));
56 initPresentation(ModuleBase_IModule::CustomizeArguments);
57 initPresentation(ModuleBase_IModule::CustomizeResults);
58 initPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
60 myIsActive[ModuleBase_IModule::CustomizeArguments] = false;
61 myIsActive[ModuleBase_IModule::CustomizeResults] = false;
62 myIsActive[ModuleBase_IModule::CustomizeHighlightedObjects] = false;
65 bool PartSet_CustomPrs::isActive(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
67 return myIsActive[theFlag];
70 bool PartSet_CustomPrs::activate(const FeaturePtr& theFeature,
71 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
72 const bool theUpdateViewer)
74 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
77 bool isModified = false;
79 // Do not call customisation for sketcher and all its sub-objects
80 if (theFeature->getKind() == SketchPlugin_Sketch::ID())
83 FeaturePtr aParent = ModelAPI_Tools::compositeOwner(theFeature);
85 std::string aType = aParent->getKind();
86 if (aType == SketchPlugin_Sketch::ID())
90 if (theFeature.get()) {
91 myIsActive[theFlag] = true;
92 myFeature = theFeature;
93 displayPresentation(theFlag, theUpdateViewer);
99 bool PartSet_CustomPrs::deactivate(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
100 const bool theUpdateViewer)
102 myIsActive[theFlag] = false;
103 erasePresentation(theFlag, theUpdateViewer);
104 if (theFlag == ModuleBase_IModule::CustomizeResults)
109 bool PartSet_CustomPrs::displayPresentation(
110 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
111 const bool theUpdateViewer)
113 bool isModified = false;
115 if (myDisabledMode == theFlag)
118 // update the AIS objects content
119 AISObjectPtr aPresentation = getPresentation(theFlag, true);
120 Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
121 Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
123 // do nothing if the feature can not be displayed [is moved from presentation, to be checked]
124 if (!myFeature.get())
127 QMap<ObjectPtr, QList<GeomShapePtr> > aFeatureShapes;
129 case ModuleBase_IModule::CustomizeArguments:
130 PartSet_OperationPrs::getFeatureShapes(myFeature, myWorkshop, aFeatureShapes);
132 case ModuleBase_IModule::CustomizeResults:
133 PartSet_OperationPrs::getResultShapes(myFeature, myWorkshop, aFeatureShapes);
134 PartSet_OperationPrs::getPresentationShapes(myFeature, myWorkshop, aFeatureShapes, false);
136 case ModuleBase_IModule::CustomizeHighlightedObjects:
137 PartSet_OperationPrs::getHighlightedShapes(myWorkshop, aFeatureShapes);
142 NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>& aShapeMap =
143 anOperationPrs->shapesMap();
144 PartSet_OperationPrs::fillShapeList(aFeatureShapes, myWorkshop, aShapeMap);
146 myPresentationIsEmpty = false;
147 // redisplay AIS objects
148 bool aRedisplayed = false;
149 Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
150 if (!aContext.IsNull() && !aContext->IsDisplayed(anOperationPrs)) {
151 // when the feature can not be visualized in the module, the operation preview should not
152 // be visualized also
153 if (anOperationPrs->hasShapes() && myWorkshop->module()->canDisplayObject(myFeature)) {
154 // set color here because it can be changed in preferences
155 Quantity_Color aShapeColor = getShapeColor(theFlag);
156 anOperationPrs->setShapeColor(aShapeColor);
158 PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
159 XGUI_Workshop* aWorkshop = workshop();
160 aRedisplayed = aWorkshop->displayer()->displayAIS(myPresentations[theFlag],
161 false/*load object in selection*/, 0, false);
162 aContext->SetZLayer(anOperationPrs, aModule->getVisualLayerId());
167 // when the feature can not be visualized in the module, the operation preview should not
168 // be visualized also
169 if (!anOperationPrs->hasShapes() || !myWorkshop->module()->canDisplayObject(myFeature)) {
170 aRedisplayed = erasePresentation(theFlag, false);
174 if (myFeature->firstResult().get()) {
175 PartSet_Module::setTexture(aPresentation, myFeature->firstResult());
177 anOperationPrs->Redisplay();
182 if (myPresentationIsEmpty) {
183 aRedisplayed = erasePresentation(theFlag, false);
185 if (aRedisplayed && theUpdateViewer)
186 workshop()->displayer()->updateViewer();
191 bool PartSet_CustomPrs::erasePresentation(
192 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
193 const bool theUpdateViewer)
195 bool isErased = false;
196 XGUI_Workshop* aWorkshop = workshop();
197 if (myPresentations.contains(theFlag))
198 isErased = aWorkshop->displayer()->eraseAIS(myPresentations[theFlag], theUpdateViewer);
202 void PartSet_CustomPrs::clearPresentation(
203 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
205 AISObjectPtr aPresentation = getPresentation(theFlag, false);
206 if (aPresentation.get()) {
207 Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
208 Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
210 anOperationPrs->shapesMap().Clear();
211 if (!anOperationPrs.IsNull())
212 anOperationPrs.Nullify();
213 myPresentations.remove(theFlag);
217 AISObjectPtr PartSet_CustomPrs::getPresentation(
218 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
219 const bool theToCreate)
221 Handle(PartSet_OperationPrs) aPresentation;
223 AISObjectPtr anOperationPrs;
224 if (myPresentations.contains(theFlag))
225 anOperationPrs = myPresentations[theFlag];
227 if (!anOperationPrs.get() && theToCreate) {
228 initPresentation(theFlag);
229 anOperationPrs = myPresentations[theFlag];
232 return anOperationPrs;
235 bool PartSet_CustomPrs::redisplay(const ObjectPtr& theObject,
236 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
237 const bool theUpdateViewer)
239 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
242 bool aRedisplayed = false;
243 if (myIsActive[theFlag])
244 aRedisplayed = displayPresentation(theFlag, theUpdateViewer);
249 void PartSet_CustomPrs::clearPrs()
251 clearPresentation(ModuleBase_IModule::CustomizeArguments);
252 clearPresentation(ModuleBase_IModule::CustomizeResults);
253 clearPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
257 void PartSet_CustomPrs::clearErrorShape()
259 if (!myErrorShapes.IsNull()) {
260 Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
261 if (aContext->IsDisplayed(myErrorShapes)) {
262 aContext->Remove(myErrorShapes, true);
263 myErrorShapes.Nullify();
268 void PartSet_CustomPrs::processEvent(const std::shared_ptr<Events_Message>& theMessage)
270 if (theMessage->eventID() == Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION))
271 myPresentationIsEmpty = true; /// store state to analize it after display/erase is finished
272 else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_OPERATION_SHAPES_FAILED)) {
273 std::shared_ptr<ModelAPI_ShapesFailedMessage> aErrMsg =
274 std::dynamic_pointer_cast<ModelAPI_ShapesFailedMessage>(theMessage);
275 Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
276 ListOfShape aShapes = aErrMsg->shapes();
277 if (aShapes.size() > 0) {
278 GeomShapePtr aCompound = GeomAlgoAPI_CompoundBuilder::compound(aShapes);
279 TopoDS_Shape aErrShape = aCompound->impl<TopoDS_Shape>();
280 if (myErrorShapes.IsNull()) {
281 myErrorShapes = new AIS_Shape(aErrShape);
282 myErrorShapes->SetColor(Quantity_NOC_RED);
283 Handle(Prs3d_Drawer) aDrawer = myErrorShapes->Attributes();
284 aDrawer->SetPointAspect(new Prs3d_PointAspect(Aspect_TOM_RING1, Quantity_NOC_RED, 2.));
285 aDrawer->SetLineAspect(new Prs3d_LineAspect(Quantity_NOC_RED, Aspect_TOL_SOLID, 2.));
286 aContext->Display(myErrorShapes, true);
287 aContext->Deactivate(myErrorShapes);
290 myErrorShapes->Set(aErrShape);
291 aContext->Redisplay(myErrorShapes, true);
295 if (!myErrorShapes.IsNull()) {
296 aContext->Remove(myErrorShapes, true);
297 myErrorShapes.Nullify();
303 void PartSet_CustomPrs::initPresentation(
304 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
306 AISObjectPtr anOperationPrs = AISObjectPtr(new GeomAPI_AISObject());
307 Handle(PartSet_OperationPrs) anAISPrs = new PartSet_OperationPrs(myWorkshop);
308 anOperationPrs->setImpl(new Handle(AIS_InteractiveObject)(anAISPrs));
309 if (theFlag == ModuleBase_IModule::CustomizeArguments ||
310 theFlag == ModuleBase_IModule::CustomizeResults) {
311 anOperationPrs->setPointMarker(5, 2.);
312 anOperationPrs->setWidth((theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)? 2 : 1);
314 else if (theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)
315 anAISPrs->useAISWidth();
317 if (anOperationPrs.get())
318 myPresentations[theFlag] = anOperationPrs;
321 Quantity_Color PartSet_CustomPrs::getShapeColor(
322 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
324 Quantity_Color aColor;
326 case ModuleBase_IModule::CustomizeArguments:
327 aColor = ModuleBase_Tools::color("Visualization", "operation_parameter_color");
329 case ModuleBase_IModule::CustomizeResults:
330 aColor = ModuleBase_Tools::color("Visualization", "operation_result_color");
332 case ModuleBase_IModule::CustomizeHighlightedObjects:
333 aColor = ModuleBase_Tools::color("Visualization", "operation_highlight_color");
341 XGUI_Workshop* PartSet_CustomPrs::workshop() const
343 XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
344 return aConnector->workshop();