1 // Copyright (C) 2014-2017 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<mailto:webmaster.salome@opencascade.com>
20 #include <Config_PropManager.h>
22 #include <GeomAlgoAPI_CompoundBuilder.h>
23 #include <GeomAlgoAPI_FaceBuilder.h>
25 #include <GeomAPI_Dir.h>
26 #include <GeomAPI_PlanarEdges.h>
27 #include <GeomAPI_Vertex.h>
29 #include <GeomDataAPI_Point2D.h>
30 #include <GeomAlgoAPI_PointBuilder.h>
32 #include <ModelAPI_AttributeRefList.h>
33 #include <ModelAPI_AttributeString.h>
34 #include <ModelAPI_Data.h>
35 #include <ModelAPI_Document.h>
36 #include <ModelAPI_Feature.h>
37 #include <ModelAPI_Object.h>
38 #include <ModelAPI_ResultConstruction.h>
39 #include <ModelAPI_Validator.h>
40 #include <ModelAPI_Session.h>
41 #include <ModelAPI_Events.h>
43 #include <SketchPlugin_Sketch.h>
44 #include <SketchPlugin_Feature.h>
45 #include <SketchPlugin_SketchEntity.h>
46 #include <SketchPlugin_Tools.h>
48 #include <Events_Loop.h>
55 SketchPlugin_Sketch::SketchPlugin_Sketch()
59 void SketchPlugin_Sketch::initAttributes()
61 data()->addAttribute(SketchPlugin_Sketch::ORIGIN_ID(), GeomDataAPI_Point::typeId());
62 data()->addAttribute(SketchPlugin_Sketch::DIRX_ID(), GeomDataAPI_Dir::typeId());
63 data()->addAttribute(SketchPlugin_Sketch::NORM_ID(), GeomDataAPI_Dir::typeId());
64 data()->addAttribute(SketchPlugin_Sketch::FEATURES_ID(), ModelAPI_AttributeRefList::typeId());
65 // the selected face, base for the sketcher plane, not obligatory
66 data()->addAttribute(SketchPlugin_SketchEntity::EXTERNAL_ID(),
67 ModelAPI_AttributeSelection::typeId());
68 ModelAPI_Session::get()->validators()->registerNotObligatory(
69 getKind(), SketchPlugin_SketchEntity::EXTERNAL_ID());
70 data()->addAttribute(SketchPlugin_Sketch::SOLVER_ERROR(), ModelAPI_AttributeString::typeId());
71 ModelAPI_Session::get()->validators()->registerNotObligatory(
72 getKind(), SketchPlugin_Sketch::SOLVER_ERROR());
73 data()->addAttribute(SketchPlugin_Sketch::SOLVER_DOF(), ModelAPI_AttributeString::typeId());
74 ModelAPI_Session::get()->validators()->registerNotObligatory(
75 getKind(), SketchPlugin_Sketch::SOLVER_DOF());
78 void SketchPlugin_Sketch::execute()
80 if (!data()->isValid())
82 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
83 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
85 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
86 data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
87 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
88 data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
89 std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
90 data()->attribute(SketchPlugin_Sketch::NORM_ID()));
92 std::list<ObjectPtr> aFeatures = aRefList->list();
93 if (aFeatures.empty()) // actually, this must be avoided by the validators
96 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin(), aLast = aFeatures.end();
97 std::shared_ptr<SketchPlugin_Feature> aFeature;
98 std::list<std::shared_ptr<GeomAPI_Shape> > aFeaturesPreview;
99 for (; anIt != aLast; anIt++) {
100 aFeature = std::dynamic_pointer_cast<SketchPlugin_Feature>(*anIt);
102 if (!aFeature->sketch()) // on load document the back references are missed
103 aFeature->setSketch(this);
104 // do not include the external edges into the result
105 if (aFeature->data()->attribute(SketchPlugin_SketchEntity::EXTERNAL_ID())) {
106 if (aFeature->data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->context())
109 // do not include the construction entities in the result
110 if (aFeature->data()->attribute(SketchPlugin_SketchEntity::AUXILIARY_ID())) {
111 if (aFeature->data()->boolean(SketchPlugin_SketchEntity::AUXILIARY_ID())->value())
115 const std::list<std::shared_ptr<ModelAPI_Result> >& aRes = aFeature->results();
116 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter = aRes.cbegin();
117 for (; aResIter != aRes.cend(); aResIter++) {
118 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = std::dynamic_pointer_cast<
119 ModelAPI_ResultConstruction>(*aResIter);
121 std::shared_ptr<GeomAPI_Shape> aShape = aConstr->shape();
123 aFeaturesPreview.push_back(aShape);
129 // Collect all edges as one big wire
130 std::shared_ptr<GeomAPI_PlanarEdges> aBigWire(new GeomAPI_PlanarEdges);
131 std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator aShapeIt = aFeaturesPreview.begin();
132 for (; aShapeIt != aFeaturesPreview.end(); ++aShapeIt) {
133 aBigWire->addEdge(*aShapeIt);
135 aBigWire->setPlane(anOrigin->pnt(), aDirX->dir(), aNorm->dir());
136 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
137 aConstr->setShape(aBigWire);
141 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::addFeature(std::string theID)
143 std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
145 // the sketch cannot be specified for the macro-features defined in python
146 // like SketchRectangle, so we need to check the type of new feature
147 std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
148 std::dynamic_pointer_cast<SketchPlugin_Feature>(aNew);
150 aSketchFeature->setSketch(this);
151 data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->append(aNew);
153 // set as current also after it becomes sub to set correctly enabled for other sketch subs
154 document()->setCurrentFeature(aNew, false);
159 void SketchPlugin_Sketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
161 if (!data()->isValid()) // sketch is already removed (case on undo of sketch), sync is not needed
163 AttributeRefListPtr aList = reflist(SketchPlugin_Sketch::FEATURES_ID());
164 // if the object is last, remove it from the list
165 // (needed to skip empty transaction on edit of sketch feature)
166 if (aList->object(aList->size(true) - 1, true) == theFeature) {
167 aList->remove(theFeature);
169 // to keep the persistent sub-elements indexing, do not remove elements from list,
170 // but substitute by nulls
171 aList->substitute(theFeature, ObjectPtr());
175 int SketchPlugin_Sketch::numberOfSubs(bool forTree) const
179 return data()->reflist(FEATURES_ID())->size(false);
182 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::subFeature(
183 const int theIndex, bool forTree)
188 ObjectPtr anObj = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->object(theIndex, false);
189 FeaturePtr aRes = std::dynamic_pointer_cast<ModelAPI_Feature>(anObj);
193 int SketchPlugin_Sketch::subFeatureId(const int theIndex) const
195 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
196 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
197 std::list<ObjectPtr> aFeatures = aRefList->list();
198 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
199 int aResultIndex = 1; // number of the counted (created) features, started from 1
200 int aFeatureIndex = -1; // number of the not-empty features in the list
201 for (; anIt != aFeatures.end(); anIt++) {
204 if (aFeatureIndex == theIndex)
211 bool SketchPlugin_Sketch::isSub(ObjectPtr theObject) const
213 // check is this feature of result
214 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
216 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
218 aFeature = document()->feature(aRes);
221 return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->isInList(aFeature);
227 void SketchPlugin_Sketch::attributeChanged(const std::string& theID) {
228 if (theID == SketchPlugin_SketchEntity::EXTERNAL_ID()) {
229 AttributeSelectionPtr aSelAttr = selection(SketchPlugin_SketchEntity::EXTERNAL_ID());
230 if (aSelAttr->context().get()) { // update arguments due to the selection value
231 std::shared_ptr<GeomAPI_Shape> aSelection = aSelAttr->value();
232 if (!aSelection.get()) aSelection = aSelAttr->context()->shape();
233 // update the sketch plane
234 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aSelection));
235 std::shared_ptr<GeomAPI_Pln> aPlane = aFace->getPlane();
237 double anA, aB, aC, aD;
238 aPlane->coefficients(anA, aB, aC, aD);
240 // calculate attributes of the sketch
241 std::shared_ptr<GeomAPI_Dir> aNormDir(new GeomAPI_Dir(anA, aB, aC));
242 std::shared_ptr<GeomAPI_XYZ> aCoords = aNormDir->xyz();
243 std::shared_ptr<GeomAPI_XYZ> aZero(new GeomAPI_XYZ(0, 0, 0));
244 aCoords = aCoords->multiplied(-aD * aCoords->distance(aZero));
245 std::shared_ptr<GeomAPI_Pnt> anOrigPnt(new GeomAPI_Pnt(aCoords));
246 // X axis is preferable to be dirX on the sketch
247 // here can not be very small value to avoid very close to X normal axis (issue 595)
248 static const double tol = 0.1;
249 bool isX = fabs(anA) - 1.0 < tol && fabs(aB) < tol && fabs(aC) < tol;
250 std::shared_ptr<GeomAPI_Dir> aTempDir(
251 isX ? new GeomAPI_Dir(0, 1, 0) : new GeomAPI_Dir(1, 0, 0));
252 std::shared_ptr<GeomAPI_Dir> aYDir(new GeomAPI_Dir(aNormDir->cross(aTempDir)));
253 std::shared_ptr<GeomAPI_Dir> aXDir(new GeomAPI_Dir(aYDir->cross(aNormDir)));
255 // update position of the sketch
256 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast
257 <GeomDataAPI_Point>(data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
258 anOrigin->setValue(anOrigPnt);
259 std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
260 data()->attribute(SketchPlugin_Sketch::NORM_ID()));
261 aNormal->setValue(aNormDir);
262 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
263 data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
264 aDirX->setValue(aXDir);
265 std::shared_ptr<GeomAPI_Dir> aDir = aPlane->direction();
268 } else if (theID == NORM_ID() || theID == DIRX_ID() || theID == ORIGIN_ID()) {
269 // send all sub-elements are also updated: all entities become created on different plane
270 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
271 std::list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
272 std::list<ObjectPtr>::iterator aSub = aSubs.begin();
273 for(; aSub != aSubs.end(); aSub++) {
275 ModelAPI_EventCreator::get()->sendUpdated(*aSub, anUpdateEvent);
280 void SketchPlugin_Sketch::createPoint2DResult(ModelAPI_Feature* theFeature,
281 SketchPlugin_Sketch* theSketch,
282 const std::string& theAttributeID, const int theIndex)
284 std::shared_ptr<GeomDataAPI_Point2D> aPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
285 theFeature->attribute(theAttributeID));
287 if (!aPoint || !aPoint->isInitialized())
290 std::shared_ptr<GeomAPI_Pnt> aCenter(theSketch->to3D(aPoint->x(), aPoint->y()));
291 //std::cout<<"Execute circle "<<aCenter->x()<<" "<<aCenter->y()<<" "<<aCenter->z()<<std::endl;
292 // make a visible point
293 std::shared_ptr<GeomAPI_Shape> aCenterPointShape = GeomAlgoAPI_PointBuilder::vertex(aCenter);
294 std::shared_ptr<ModelAPI_ResultConstruction> aResult = theFeature->document()->createConstruction(
295 theFeature->data(), theIndex);
296 aResult->setShape(aCenterPointShape);
297 aResult->setIsInHistory(false);
299 theFeature->setResult(aResult, theIndex);
302 FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature(FeaturePtr theFeature,
303 SketchPlugin_Sketch* theSketch,
304 const bool theIsCopy)
306 FeaturePtr aNewFeature = theSketch->addFeature(theFeature->getKind());
307 // addFeature generates a unique name for the feature, it caches the name
308 std::string aUniqueFeatureName = aNewFeature->data()->name();
309 // all attribute values are copied\pasted to the new feature, name is not an exception
310 theFeature->data()->copyTo(aNewFeature->data());
311 // external state should not be copied as a new object is an object of the current sketch
312 if (theFeature->selection(SketchPlugin_SketchEntity::EXTERNAL_ID()).get())
313 aNewFeature->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->setValue(ResultPtr(),
315 aNewFeature->data()->setName(aUniqueFeatureName);
316 // text expressions could block setValue of some attributes
317 SketchPlugin_Tools::clearExpressions(aNewFeature);
318 // Set copy attribute
319 AttributeBooleanPtr anAttr = aNewFeature->data()->boolean(SketchPlugin_SketchEntity::COPY_ID());
321 anAttr->setValue(theIsCopy);
327 std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::plane(SketchPlugin_Sketch* theSketch)
329 std::shared_ptr<ModelAPI_Data> aData = theSketch->data();
331 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
332 aData->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
333 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
334 aData->attribute(SketchPlugin_Sketch::DIRX_ID()));
335 std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
336 aData->attribute(SketchPlugin_Sketch::NORM_ID()));
338 return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(anOrigin->pnt(), aDirX->dir(), aNorm->dir()));
341 void SketchPlugin_Sketch::exchangeIDs(
342 std::shared_ptr<ModelAPI_Feature> theFeature1, std::shared_ptr<ModelAPI_Feature> theFeature2)
344 reflist(SketchPlugin_Sketch::FEATURES_ID())->exchange(theFeature1, theFeature2);