1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_Sketch.cxx
4 // Created: 27 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #include <Config_PropManager.h>
9 #include <GeomAlgoAPI_CompoundBuilder.h>
10 #include <GeomAlgoAPI_FaceBuilder.h>
12 #include <GeomAPI_Dir.h>
13 #include <GeomAPI_PlanarEdges.h>
14 #include <GeomAPI_Vertex.h>
16 #include <GeomDataAPI_Point2D.h>
17 #include <GeomAlgoAPI_PointBuilder.h>
19 #include <ModelAPI_AttributeRefList.h>
20 #include <ModelAPI_AttributeString.h>
21 #include <ModelAPI_Data.h>
22 #include <ModelAPI_Document.h>
23 #include <ModelAPI_Feature.h>
24 #include <ModelAPI_Object.h>
25 #include <ModelAPI_ResultConstruction.h>
26 #include <ModelAPI_Validator.h>
27 #include <ModelAPI_Session.h>
28 #include <ModelAPI_Events.h>
30 #include <SketchPlugin_Sketch.h>
31 #include <SketchPlugin_Feature.h>
32 #include <SketchPlugin_SketchEntity.h>
33 #include <SketchPlugin_Tools.h>
35 #include <Events_Loop.h>
42 SketchPlugin_Sketch::SketchPlugin_Sketch()
46 void SketchPlugin_Sketch::initAttributes()
48 data()->addAttribute(SketchPlugin_Sketch::ORIGIN_ID(), GeomDataAPI_Point::typeId());
49 data()->addAttribute(SketchPlugin_Sketch::DIRX_ID(), GeomDataAPI_Dir::typeId());
50 data()->addAttribute(SketchPlugin_Sketch::NORM_ID(), GeomDataAPI_Dir::typeId());
51 data()->addAttribute(SketchPlugin_Sketch::FEATURES_ID(), ModelAPI_AttributeRefList::typeId());
52 // the selected face, base for the sketcher plane, not obligatory
53 data()->addAttribute(SketchPlugin_SketchEntity::EXTERNAL_ID(),
54 ModelAPI_AttributeSelection::typeId());
55 ModelAPI_Session::get()->validators()->registerNotObligatory(
56 getKind(), SketchPlugin_SketchEntity::EXTERNAL_ID());
57 data()->addAttribute(SketchPlugin_Sketch::SOLVER_ERROR(), ModelAPI_AttributeString::typeId());
58 ModelAPI_Session::get()->validators()->registerNotObligatory(
59 getKind(), SketchPlugin_Sketch::SOLVER_ERROR());
60 data()->addAttribute(SketchPlugin_Sketch::SOLVER_DOF(), ModelAPI_AttributeString::typeId());
61 ModelAPI_Session::get()->validators()->registerNotObligatory(
62 getKind(), SketchPlugin_Sketch::SOLVER_DOF());
65 void SketchPlugin_Sketch::execute()
67 if (!data()->isValid())
69 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
70 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
72 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
73 data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
74 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
75 data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
76 std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
77 data()->attribute(SketchPlugin_Sketch::NORM_ID()));
79 std::list<ObjectPtr> aFeatures = aRefList->list();
80 if (aFeatures.empty()) // actually, this must be avoided by the validators
83 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin(), aLast = aFeatures.end();
84 std::shared_ptr<SketchPlugin_Feature> aFeature;
85 std::list<std::shared_ptr<GeomAPI_Shape> > aFeaturesPreview;
86 for (; anIt != aLast; anIt++) {
87 aFeature = std::dynamic_pointer_cast<SketchPlugin_Feature>(*anIt);
89 if (!aFeature->sketch()) // on load document the back references are missed
90 aFeature->setSketch(this);
91 // do not include the external edges into the result
92 if (aFeature->data()->attribute(SketchPlugin_SketchEntity::EXTERNAL_ID())) {
93 if (aFeature->data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->context())
96 // do not include the construction entities in the result
97 if (aFeature->data()->attribute(SketchPlugin_SketchEntity::AUXILIARY_ID())) {
98 if (aFeature->data()->boolean(SketchPlugin_SketchEntity::AUXILIARY_ID())->value())
102 const std::list<std::shared_ptr<ModelAPI_Result> >& aRes = aFeature->results();
103 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter = aRes.cbegin();
104 for (; aResIter != aRes.cend(); aResIter++) {
105 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = std::dynamic_pointer_cast<
106 ModelAPI_ResultConstruction>(*aResIter);
108 std::shared_ptr<GeomAPI_Shape> aShape = aConstr->shape();
110 aFeaturesPreview.push_back(aShape);
116 // Collect all edges as one big wire
117 std::shared_ptr<GeomAPI_PlanarEdges> aBigWire(new GeomAPI_PlanarEdges);
118 std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator aShapeIt = aFeaturesPreview.begin();
119 for (; aShapeIt != aFeaturesPreview.end(); ++aShapeIt) {
120 aBigWire->addEdge(*aShapeIt);
122 aBigWire->setPlane(anOrigin->pnt(), aDirX->dir(), aNorm->dir());
123 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
124 aConstr->setShape(aBigWire);
128 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::addFeature(std::string theID)
130 std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
132 // the sketch cannot be specified for the macro-features defined in python
133 // like SketchRectangle, so we need to check the type of new feature
134 std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
135 std::dynamic_pointer_cast<SketchPlugin_Feature>(aNew);
137 aSketchFeature->setSketch(this);
138 data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->append(aNew);
140 // set as current also after it becomes sub to set correctly enabled for other sketch subs
141 document()->setCurrentFeature(aNew, false);
143 static Events_Loop* aLoop = Events_Loop::loop();
144 static Events_ID aDeleteEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
145 aLoop->flush(aDeleteEvent);
150 void SketchPlugin_Sketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
152 if (!data()->isValid()) // sketch is already removed (case on undo of sketch), sync is not needed
154 AttributeRefListPtr aList = reflist(SketchPlugin_Sketch::FEATURES_ID());
155 // if the object is last, remove it from the list
156 // (needed to skip empty transaction on edit of sketch feature)
157 if (aList->object(aList->size(true) - 1, true) == theFeature) {
158 aList->remove(theFeature);
160 // to keep the persistent sub-elements indexing, do not remove elements from list,
161 // but substitute by nulls
162 aList->substitute(theFeature, ObjectPtr());
166 int SketchPlugin_Sketch::numberOfSubs(bool forTree) const
170 return data()->reflist(FEATURES_ID())->size(false);
173 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::subFeature(
174 const int theIndex, bool forTree)
179 ObjectPtr anObj = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->object(theIndex, false);
180 FeaturePtr aRes = std::dynamic_pointer_cast<ModelAPI_Feature>(anObj);
184 int SketchPlugin_Sketch::subFeatureId(const int theIndex) const
186 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
187 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
188 std::list<ObjectPtr> aFeatures = aRefList->list();
189 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
190 int aResultIndex = 1; // number of the counted (created) features, started from 1
191 int aFeatureIndex = -1; // number of the not-empty features in the list
192 for (; anIt != aFeatures.end(); anIt++) {
195 if (aFeatureIndex == theIndex)
202 bool SketchPlugin_Sketch::isSub(ObjectPtr theObject) const
204 // check is this feature of result
205 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
207 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
209 aFeature = document()->feature(aRes);
212 return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->isInList(aFeature);
218 void SketchPlugin_Sketch::attributeChanged(const std::string& theID) {
219 if (theID == SketchPlugin_SketchEntity::EXTERNAL_ID()) {
220 AttributeSelectionPtr aSelAttr = selection(SketchPlugin_SketchEntity::EXTERNAL_ID());
221 if (aSelAttr->context().get()) { // update arguments due to the selection value
222 std::shared_ptr<GeomAPI_Shape> aSelection = aSelAttr->value();
223 if (!aSelection.get()) aSelection = aSelAttr->context()->shape();
224 // update the sketch plane
225 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aSelection));
226 std::shared_ptr<GeomAPI_Pln> aPlane = aFace->getPlane();
228 double anA, aB, aC, aD;
229 aPlane->coefficients(anA, aB, aC, aD);
231 // calculate attributes of the sketch
232 std::shared_ptr<GeomAPI_Dir> aNormDir(new GeomAPI_Dir(anA, aB, aC));
233 std::shared_ptr<GeomAPI_XYZ> aCoords = aNormDir->xyz();
234 std::shared_ptr<GeomAPI_XYZ> aZero(new GeomAPI_XYZ(0, 0, 0));
235 aCoords = aCoords->multiplied(-aD * aCoords->distance(aZero));
236 std::shared_ptr<GeomAPI_Pnt> anOrigPnt(new GeomAPI_Pnt(aCoords));
237 // X axis is preferable to be dirX on the sketch
238 // here can not be very small value to avoid very close to X normal axis (issue 595)
239 static const double tol = 0.1;
240 bool isX = fabs(anA) - 1.0 < tol && fabs(aB) < tol && fabs(aC) < tol;
241 std::shared_ptr<GeomAPI_Dir> aTempDir(
242 isX ? new GeomAPI_Dir(0, 1, 0) : new GeomAPI_Dir(1, 0, 0));
243 std::shared_ptr<GeomAPI_Dir> aYDir(new GeomAPI_Dir(aNormDir->cross(aTempDir)));
244 std::shared_ptr<GeomAPI_Dir> aXDir(new GeomAPI_Dir(aYDir->cross(aNormDir)));
246 // update position of the sketch
247 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast
248 <GeomDataAPI_Point>(data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
249 anOrigin->setValue(anOrigPnt);
250 std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
251 data()->attribute(SketchPlugin_Sketch::NORM_ID()));
252 aNormal->setValue(aNormDir);
253 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
254 data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
255 aDirX->setValue(aXDir);
256 std::shared_ptr<GeomAPI_Dir> aDir = aPlane->direction();
259 } else if (theID == NORM_ID() || theID == DIRX_ID() || theID == ORIGIN_ID()) {
260 // send all sub-elements are also updated: all entities become created on different plane
261 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
262 std::list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
263 std::list<ObjectPtr>::iterator aSub = aSubs.begin();
264 for(; aSub != aSubs.end(); aSub++) {
266 ModelAPI_EventCreator::get()->sendUpdated(*aSub, anUpdateEvent);
271 void SketchPlugin_Sketch::createPoint2DResult(ModelAPI_Feature* theFeature,
272 SketchPlugin_Sketch* theSketch,
273 const std::string& theAttributeID, const int theIndex)
275 std::shared_ptr<GeomDataAPI_Point2D> aPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
276 theFeature->attribute(theAttributeID));
278 if (!aPoint || !aPoint->isInitialized())
281 std::shared_ptr<GeomAPI_Pnt> aCenter(theSketch->to3D(aPoint->x(), aPoint->y()));
282 //std::cout<<"Execute circle "<<aCenter->x()<<" "<<aCenter->y()<<" "<<aCenter->z()<<std::endl;
283 // make a visible point
284 std::shared_ptr<GeomAPI_Shape> aCenterPointShape = GeomAlgoAPI_PointBuilder::vertex(aCenter);
285 std::shared_ptr<ModelAPI_ResultConstruction> aResult = theFeature->document()->createConstruction(
286 theFeature->data(), theIndex);
287 aResult->setShape(aCenterPointShape);
288 aResult->setIsInHistory(false);
290 theFeature->setResult(aResult, theIndex);
293 FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature(FeaturePtr theFeature,
294 SketchPlugin_Sketch* theSketch,
295 const bool theIsCopy)
297 FeaturePtr aNewFeature = theSketch->addFeature(theFeature->getKind());
298 // addFeature generates a unique name for the feature, it caches the name
299 std::string aUniqueFeatureName = aNewFeature->data()->name();
300 // all attribute values are copied\pasted to the new feature, name is not an exception
301 theFeature->data()->copyTo(aNewFeature->data());
302 // external state should not be copied as a new object is an object of the current sketch
303 if (theFeature->selection(SketchPlugin_SketchEntity::EXTERNAL_ID()).get())
304 aNewFeature->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->setValue(ResultPtr(),
306 aNewFeature->data()->setName(aUniqueFeatureName);
307 // text expressions could block setValue of some attributes
308 SketchPlugin_Tools::clearExpressions(aNewFeature);
309 // Set copy attribute
310 AttributeBooleanPtr anAttr = aNewFeature->data()->boolean(SketchPlugin_SketchEntity::COPY_ID());
312 anAttr->setValue(theIsCopy);
318 std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::plane(SketchPlugin_Sketch* theSketch)
320 std::shared_ptr<ModelAPI_Data> aData = theSketch->data();
322 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
323 aData->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
324 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
325 aData->attribute(SketchPlugin_Sketch::DIRX_ID()));
326 std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
327 aData->attribute(SketchPlugin_Sketch::NORM_ID()));
329 return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(anOrigin->pnt(), aDirX->dir(), aNorm->dir()));
332 void SketchPlugin_Sketch::exchangeIDs(
333 std::shared_ptr<ModelAPI_Feature> theFeature1, std::shared_ptr<ModelAPI_Feature> theFeature2)
335 reflist(SketchPlugin_Sketch::FEATURES_ID())->exchange(theFeature1, theFeature2);