Salome HOME
Merge remote-tracking branch 'remotes/origin/Dev_FolderFeature'
[modules/shaper.git] / src / PartSet / PartSet_ExternalObjectsMgr.cpp
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #include "PartSet_ExternalObjectsMgr.h"
22 #include "PartSet_Tools.h"
23
24 #include <XGUI_Workshop.h>
25 #include <XGUI_ModuleConnector.h>
26
27 #include <ModuleBase_ViewerPrs.h>
28 #include <ModuleBase_ISelection.h>
29
30 #include <SketchPlugin_Feature.h>
31
32 #include <QString>
33
34 PartSet_ExternalObjectsMgr::PartSet_ExternalObjectsMgr(const std::string& theExternal,
35                                                        const std::string& theCanCreateExternal,
36                                                        const bool theDefaultValue)
37 : myUseExternal(theDefaultValue), myCanCreateExternal(true)
38 {
39   QString aIsExternal(theExternal.c_str());
40   if (!aIsExternal.isEmpty()) {
41     QString aStr = aIsExternal.toUpper();
42     myUseExternal = (aStr == "TRUE") || (aStr == "YES");
43   }
44
45   QString aCanCreateExternal(theCanCreateExternal.c_str());
46   if (!aCanCreateExternal.isEmpty()) {
47     QString aStr = aCanCreateExternal.toUpper();
48     myCanCreateExternal = (aStr == "TRUE") || (aStr == "YES");
49   }
50 }
51
52 bool PartSet_ExternalObjectsMgr::isValidObject(const ObjectPtr& theObject)
53 {
54   bool aValid = true;
55   FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
56   // Do check using of external feature
57   std::shared_ptr<SketchPlugin_Feature> aSPFeature =
58           std::dynamic_pointer_cast<SketchPlugin_Feature>(aFeature);
59
60   // Do check that we can use external feature
61   if (aSPFeature.get() != NULL && aSPFeature->isExternal() && !useExternal()) {
62     aValid = false;
63   }
64
65   return aValid;
66 }
67
68 ObjectPtr PartSet_ExternalObjectsMgr::externalObject(const ObjectPtr& theSelectedObject,
69                                                      const GeomShapePtr& theShape,
70                                                      const CompositeFeaturePtr& theSketch,
71                                                      const bool theTemporary)
72 {
73   ObjectPtr aSelectedObject = PartSet_Tools::findFixedObjectByExternal(
74                                   theShape->impl<TopoDS_Shape>(), theSelectedObject, theSketch);
75   if (!aSelectedObject.get()) {
76     // Processing of external (non-sketch) object
77     FeaturePtr aCreatedFeature;
78     aSelectedObject = PartSet_Tools::createFixedObjectByExternal(theShape,
79       theSelectedObject, theSketch, theTemporary, aCreatedFeature);
80     if (aCreatedFeature.get() && theTemporary)
81         myExternalObjectValidated = aCreatedFeature;
82   }
83   return aSelectedObject;
84 }
85
86 void PartSet_ExternalObjectsMgr::getGeomSelection(const ModuleBase_ViewerPrsPtr& thePrs,
87                                                    ObjectPtr& theObject,
88                                                    GeomShapePtr& theShape,
89                                                    ModuleBase_IWorkshop* theWorkshop,
90                                                    const CompositeFeaturePtr& theSketch,
91                                                    const bool isInValidate)
92 {
93   FeaturePtr aSelectedFeature = ModelAPI_Feature::feature(theObject);
94   std::shared_ptr<SketchPlugin_Feature> aSPFeature =
95           std::dynamic_pointer_cast<SketchPlugin_Feature>(aSelectedFeature);
96   // there is no a sketch feature is selected, but the shape exists,
97   // try to create an exernal object
98   // TODO: unite with the same functionality in PartSet_WidgetShapeSelector
99   if (aSPFeature.get() == NULL) {
100     ObjectPtr anExternalObject = ObjectPtr();
101     GeomShapePtr anExternalShape = GeomShapePtr();
102     if (useExternal()) {
103       if (canCreateExternal()) {
104         GeomShapePtr aShape = theShape;
105         if (!aShape.get()) {
106           ResultPtr aResult = theWorkshop->selection()->getResult(thePrs);
107           if (aResult.get())
108             aShape = aResult->shape();
109         }
110         if (aShape.get() != NULL && !aShape->isNull())
111           anExternalObject =
112             externalObject(theObject, aShape, theSketch, isInValidate);
113       }
114       else { /// use objects of found selection
115         anExternalObject = theObject;
116         anExternalShape = theShape;
117       }
118     }
119     /// the object is null if the selected feature is "external"(not sketch entity feature of the
120     /// current sketch) and it is not created by object manager
121     theObject = anExternalObject;
122     theShape = anExternalShape;
123   }
124 }
125
126 //********************************************************************
127 void PartSet_ExternalObjectsMgr::removeExternal(const CompositeFeaturePtr& theSketch,
128                                                 const FeaturePtr& theFeature,
129                                                 ModuleBase_IWorkshop* theWorkshop,
130                                                 const bool theTemporary)
131 {
132   if (theTemporary)
133     removeExternalObject(myExternalObjectValidated, theSketch, theFeature, theWorkshop);
134 }
135
136 void PartSet_ExternalObjectsMgr::removeExternalObject(const ObjectPtr& theObject,
137                                                       const CompositeFeaturePtr& /*theSketch*/,
138                                                       const FeaturePtr& theFeature,
139                                                       ModuleBase_IWorkshop* theWorkshop)
140 {
141   if (theObject.get()) {
142     DocumentPtr aDoc = theObject->document();
143     FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
144     if (aFeature.get() != NULL) {
145       QObjectPtrList anObjects;
146       anObjects.append(aFeature);
147       // the external feature should be removed with all references,
148       // composite sketch feature will be ignored
149       workshop(theWorkshop)->deleteFeatures(anObjects);
150     }
151   }
152 }
153
154 XGUI_Workshop* PartSet_ExternalObjectsMgr::workshop(ModuleBase_IWorkshop* theWorkshop)
155 {
156   XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(theWorkshop);
157   return aConnector->workshop();
158 }