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
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>
41 #include <AIS_InteractiveContext.hxx>
42 #include <AIS_InteractiveObject.hxx>
43 #include <Prs3d_PointAspect.hxx>
45 //#define DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
47 PartSet_CustomPrs::PartSet_CustomPrs(ModuleBase_IWorkshop* theWorkshop)
48 : myWorkshop(theWorkshop), myFeature(FeaturePtr()), myPresentationIsEmpty(false),
51 Events_Loop* aLoop = Events_Loop::loop();
52 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION));
54 initPresentation(ModuleBase_IModule::CustomizeArguments);
55 initPresentation(ModuleBase_IModule::CustomizeResults);
56 initPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
58 myIsActive[ModuleBase_IModule::CustomizeArguments] = false;
59 myIsActive[ModuleBase_IModule::CustomizeResults] = false;
60 myIsActive[ModuleBase_IModule::CustomizeHighlightedObjects] = false;
63 bool PartSet_CustomPrs::isActive(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
65 return myIsActive[theFlag];
68 bool PartSet_CustomPrs::activate(const FeaturePtr& theFeature,
69 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
70 const bool theUpdateViewer)
72 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
75 bool isModified = false;
77 // Do not call customisation for sketcher and all its sub-objects
78 if (theFeature->getKind() == SketchPlugin_Sketch::ID())
81 FeaturePtr aParent = ModelAPI_Tools::compositeOwner(theFeature);
83 std::string aType = aParent->getKind();
84 if (aType == SketchPlugin_Sketch::ID())
88 if (theFeature.get()) {
89 myIsActive[theFlag] = true;
90 myFeature = theFeature;
91 displayPresentation(theFlag, theUpdateViewer);
97 bool PartSet_CustomPrs::deactivate(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
98 const bool theUpdateViewer)
100 myIsActive[theFlag] = false;
101 erasePresentation(theFlag, theUpdateViewer);
105 bool PartSet_CustomPrs::displayPresentation(
106 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
107 const bool theUpdateViewer)
109 bool isModified = false;
111 if (myDisabledMode == theFlag)
114 // update the AIS objects content
115 AISObjectPtr aPresentation = getPresentation(theFlag, true);
116 Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
117 Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
119 // do nothing if the feature can not be displayed [is moved from presentation, to be checked]
120 if (!myFeature.get())
123 QMap<ObjectPtr, QList<GeomShapePtr> > aFeatureShapes;
125 case ModuleBase_IModule::CustomizeArguments:
126 PartSet_OperationPrs::getFeatureShapes(myFeature, myWorkshop, aFeatureShapes);
128 case ModuleBase_IModule::CustomizeResults:
129 PartSet_OperationPrs::getResultShapes(myFeature, myWorkshop, aFeatureShapes);
130 PartSet_OperationPrs::getPresentationShapes(myFeature, myWorkshop, aFeatureShapes, false);
132 case ModuleBase_IModule::CustomizeHighlightedObjects:
133 PartSet_OperationPrs::getHighlightedShapes(myWorkshop, aFeatureShapes);
138 NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>& aShapeMap =
139 anOperationPrs->shapesMap();
140 PartSet_OperationPrs::fillShapeList(aFeatureShapes, myWorkshop, aShapeMap);
142 myPresentationIsEmpty = false;
143 // redisplay AIS objects
144 bool aRedisplayed = false;
145 Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
146 if (!aContext.IsNull() && !aContext->IsDisplayed(anOperationPrs)) {
147 // when the feature can not be visualized in the module, the operation preview should not
148 // be visualized also
149 if (anOperationPrs->hasShapes() && myWorkshop->module()->canDisplayObject(myFeature)) {
150 // set color here because it can be changed in preferences
151 Quantity_Color aShapeColor = getShapeColor(theFlag);
152 anOperationPrs->setShapeColor(aShapeColor);
154 PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
155 XGUI_Workshop* aWorkshop = workshop();
156 aRedisplayed = aWorkshop->displayer()->displayAIS(myPresentations[theFlag],
157 false/*load object in selection*/, 0, false);
158 aContext->SetZLayer(anOperationPrs, aModule->getVisualLayerId());
163 // when the feature can not be visualized in the module, the operation preview should not
164 // be visualized also
165 if (!anOperationPrs->hasShapes() || !myWorkshop->module()->canDisplayObject(myFeature)) {
166 aRedisplayed = erasePresentation(theFlag, false);
170 anOperationPrs->Redisplay();
175 if (myPresentationIsEmpty) {
176 aRedisplayed = erasePresentation(theFlag, false);
178 if (aRedisplayed && theUpdateViewer)
179 workshop()->displayer()->updateViewer();
184 bool PartSet_CustomPrs::erasePresentation(
185 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
186 const bool theUpdateViewer)
188 bool isErased = false;
189 XGUI_Workshop* aWorkshop = workshop();
190 if (myPresentations.contains(theFlag))
191 isErased = aWorkshop->displayer()->eraseAIS(myPresentations[theFlag], theUpdateViewer);
195 void PartSet_CustomPrs::clearPresentation(
196 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
198 AISObjectPtr aPresentation = getPresentation(theFlag, false);
199 if (aPresentation.get()) {
200 Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
201 Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
203 anOperationPrs->shapesMap().Clear();
204 if (!anOperationPrs.IsNull())
205 anOperationPrs.Nullify();
206 myPresentations.remove(theFlag);
210 AISObjectPtr PartSet_CustomPrs::getPresentation(
211 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
212 const bool theToCreate)
214 Handle(PartSet_OperationPrs) aPresentation;
216 AISObjectPtr anOperationPrs;
217 if (myPresentations.contains(theFlag))
218 anOperationPrs = myPresentations[theFlag];
220 if (!anOperationPrs.get() && theToCreate) {
221 initPresentation(theFlag);
222 anOperationPrs = myPresentations[theFlag];
225 return anOperationPrs;
228 bool PartSet_CustomPrs::redisplay(const ObjectPtr& theObject,
229 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
230 const bool theUpdateViewer)
232 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
235 bool aRedisplayed = false;
236 if (myIsActive[theFlag])
237 aRedisplayed = displayPresentation(theFlag, theUpdateViewer);
242 void PartSet_CustomPrs::clearPrs()
244 clearPresentation(ModuleBase_IModule::CustomizeArguments);
245 clearPresentation(ModuleBase_IModule::CustomizeResults);
246 clearPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
249 void PartSet_CustomPrs::processEvent(const std::shared_ptr<Events_Message>& theMessage)
251 if (theMessage->eventID() == Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION))
252 myPresentationIsEmpty = true; /// store state to analize it after display/erase is finished
255 void PartSet_CustomPrs::initPresentation(
256 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
258 AISObjectPtr anOperationPrs = AISObjectPtr(new GeomAPI_AISObject());
259 Handle(PartSet_OperationPrs) anAISPrs = new PartSet_OperationPrs(myWorkshop);
260 anOperationPrs->setImpl(new Handle(AIS_InteractiveObject)(anAISPrs));
261 if (theFlag == ModuleBase_IModule::CustomizeArguments ||
262 theFlag == ModuleBase_IModule::CustomizeResults) {
263 anOperationPrs->setPointMarker(5, 2.);
264 anOperationPrs->setWidth((theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)? 2 : 1);
266 else if (theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)
267 anAISPrs->useAISWidth();
269 if (anOperationPrs.get())
270 myPresentations[theFlag] = anOperationPrs;
273 Quantity_Color PartSet_CustomPrs::getShapeColor(
274 const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
276 Quantity_Color aColor;
278 case ModuleBase_IModule::CustomizeArguments:
279 aColor = ModuleBase_Tools::color("Visualization", "operation_parameter_color");
281 case ModuleBase_IModule::CustomizeResults:
282 aColor = ModuleBase_Tools::color("Visualization", "operation_result_color");
284 case ModuleBase_IModule::CustomizeHighlightedObjects:
285 aColor = ModuleBase_Tools::color("Visualization", "operation_highlight_color");
293 XGUI_Workshop* PartSet_CustomPrs::workshop() const
295 XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
296 return aConnector->workshop();