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_AISObject.h>
13 #include <GeomAPI_Dir.h>
14 #include <GeomAPI_PlanarEdges.h>
16 #include <GeomAlgoAPI_FaceBuilder.h>
18 #include <GeomDataAPI_Point2D.h>
19 #include <GeomAlgoAPI_PointBuilder.h>
21 #include <ModelAPI_AttributeRefList.h>
22 #include <ModelAPI_AttributeString.h>
23 #include <ModelAPI_Data.h>
24 #include <ModelAPI_Document.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Object.h>
27 #include <ModelAPI_ResultConstruction.h>
28 #include <ModelAPI_Validator.h>
29 #include <ModelAPI_Session.h>
30 #include <ModelAPI_Events.h>
32 #include <SketchPlugin_Sketch.h>
33 #include <SketchPlugin_Feature.h>
34 #include <SketchPlugin_SketchEntity.h>
35 #include <SketchPlugin_Tools.h>
37 #include <Events_Loop.h>
46 SketchPlugin_Sketch::SketchPlugin_Sketch()
50 void SketchPlugin_Sketch::initAttributes()
52 data()->addAttribute(SketchPlugin_Sketch::ORIGIN_ID(), GeomDataAPI_Point::typeId());
53 data()->addAttribute(SketchPlugin_Sketch::DIRX_ID(), GeomDataAPI_Dir::typeId());
54 data()->addAttribute(SketchPlugin_Sketch::NORM_ID(), GeomDataAPI_Dir::typeId());
55 data()->addAttribute(SketchPlugin_Sketch::FEATURES_ID(), ModelAPI_AttributeRefList::typeId());
56 // the selected face, base for the sketcher plane, not obligatory
57 data()->addAttribute(SketchPlugin_SketchEntity::EXTERNAL_ID(), ModelAPI_AttributeSelection::typeId());
58 ModelAPI_Session::get()->validators()->registerNotObligatory(
59 getKind(), SketchPlugin_SketchEntity::EXTERNAL_ID());
60 data()->addAttribute(SketchPlugin_Sketch::SOLVER_ERROR(), ModelAPI_AttributeString::typeId());
61 ModelAPI_Session::get()->validators()->registerNotObligatory(
62 getKind(), SketchPlugin_Sketch::SOLVER_ERROR());
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())->value())
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 if (aFeaturesPreview.empty()) {
117 // no good features for generation of preview => erase result if exists
118 if (firstResult().get() && !firstResult()->isDisabled())
119 removeResults(0, false);
123 // Collect all edges as one big wire
124 std::shared_ptr<GeomAPI_PlanarEdges> aBigWire(new GeomAPI_PlanarEdges);
125 std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator aShapeIt = aFeaturesPreview.begin();
126 for (; aShapeIt != aFeaturesPreview.end(); ++aShapeIt) {
127 aBigWire->addEdge(*aShapeIt);
129 aBigWire->setPlane(anOrigin->pnt(), aDirX->dir(), aNorm->dir());
130 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
131 aConstr->setShape(aBigWire);
135 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::addFeature(std::string theID)
137 std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
139 std::dynamic_pointer_cast<SketchPlugin_Feature>(aNew)->setSketch(this);
140 data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->append(aNew);
142 // set as current also after it becomes sub to set correctly enabled for other sketch subs
143 document()->setCurrentFeature(aNew, false);
147 void SketchPlugin_Sketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
149 if (!data()->isValid()) // sketch is already removed (case on undo of sketch), sync is not needed
151 // to keep the persistent sub-elements indexing, do not remove elements from list,
152 // but substitute by nulls
153 reflist(SketchPlugin_Sketch::FEATURES_ID())->substitute(theFeature, ObjectPtr());
156 int SketchPlugin_Sketch::numberOfSubs(bool forTree) const
160 return data()->reflist(FEATURES_ID())->size(false);
163 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::subFeature(
164 const int theIndex, bool forTree)
169 ObjectPtr anObj = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->object(theIndex, false);
170 FeaturePtr aRes = std::dynamic_pointer_cast<ModelAPI_Feature>(anObj);
174 int SketchPlugin_Sketch::subFeatureId(const int theIndex) const
176 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
177 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
178 std::list<ObjectPtr> aFeatures = aRefList->list();
179 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
180 int aResultIndex = 1; // number of the counted (created) features, started from 1
181 int aFeatureIndex = -1; // number of the not-empty features in the list
182 for (; anIt != aFeatures.end(); anIt++) {
185 if (aFeatureIndex == theIndex)
192 bool SketchPlugin_Sketch::isSub(ObjectPtr theObject) const
194 // check is this feature of result
195 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
197 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
199 aFeature = document()->feature(aRes);
202 return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->isInList(aFeature);
208 void SketchPlugin_Sketch::erase()
210 std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
211 ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
212 std::list<ObjectPtr> aFeatures = aRefList->list();
213 std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
214 for (; anIt != aFeatures.end(); anIt++) {
215 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
217 // subs are referenced from sketch, but must be removed for sure, so not checkings
218 document()->removeFeature(aFeature);
221 ModelAPI_CompositeFeature::erase();
224 void SketchPlugin_Sketch::attributeChanged(const std::string& theID) {
225 if (theID == SketchPlugin_SketchEntity::EXTERNAL_ID()) {
226 std::shared_ptr<GeomAPI_Shape> aSelection =
227 data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->value();
228 if (aSelection) { // update arguments due to the selection value
229 // update the sketch plane
230 std::shared_ptr<GeomAPI_Pln> aPlane = GeomAlgoAPI_FaceBuilder::plane(aSelection);
232 double anA, aB, aC, aD;
233 aPlane->coefficients(anA, aB, aC, aD);
235 // calculate attributes of the sketch
236 std::shared_ptr<GeomAPI_Dir> aNormDir(new GeomAPI_Dir(anA, aB, aC));
237 std::shared_ptr<GeomAPI_XYZ> aCoords = aNormDir->xyz();
238 std::shared_ptr<GeomAPI_XYZ> aZero(new GeomAPI_XYZ(0, 0, 0));
239 aCoords = aCoords->multiplied(-aD * aCoords->distance(aZero));
240 std::shared_ptr<GeomAPI_Pnt> anOrigPnt(new GeomAPI_Pnt(aCoords));
241 // X axis is preferable to be dirX on the sketch
242 static const double tol = 0.1; // here can not be very small value to avoid very close to X normal axis (issue 595)
243 bool isX = fabs(anA) - 1.0 < tol && fabs(aB) < tol && fabs(aC) < tol;
244 std::shared_ptr<GeomAPI_Dir> aTempDir(
245 isX ? new GeomAPI_Dir(0, 1, 0) : new GeomAPI_Dir(1, 0, 0));
246 std::shared_ptr<GeomAPI_Dir> aYDir(new GeomAPI_Dir(aNormDir->cross(aTempDir)));
247 std::shared_ptr<GeomAPI_Dir> aXDir(new GeomAPI_Dir(aYDir->cross(aNormDir)));
249 // update position of the sketch
250 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast
251 <GeomDataAPI_Point>(data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
252 anOrigin->setValue(anOrigPnt);
253 std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
254 data()->attribute(SketchPlugin_Sketch::NORM_ID()));
255 aNormal->setValue(aNormDir);
256 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
257 data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
258 aDirX->setValue(aXDir);
259 std::shared_ptr<GeomAPI_Dir> aDir = aPlane->direction();
262 } else if (theID == SketchPlugin_Sketch::NORM_ID() || theID == SketchPlugin_Sketch::DIRX_ID()) {
263 // send all sub-elements are also updated: all entities become created on different plane
264 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
265 std::list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
266 std::list<ObjectPtr>::iterator aSub = aSubs.begin();
267 for(; aSub != aSubs.end(); aSub++) {
269 ModelAPI_EventCreator::get()->sendUpdated(*aSub, anUpdateEvent);
274 void SketchPlugin_Sketch::createPoint2DResult(ModelAPI_Feature* theFeature,
275 SketchPlugin_Sketch* theSketch,
276 const std::string& theAttributeID, const int theIndex)
278 std::shared_ptr<GeomDataAPI_Point2D> aPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
279 theFeature->attribute(theAttributeID));
281 if (!aPoint || !aPoint->isInitialized())
284 std::shared_ptr<GeomAPI_Pnt> aCenter(theSketch->to3D(aPoint->x(), aPoint->y()));
285 //std::cout<<"Execute circle "<<aCenter->x()<<" "<<aCenter->y()<<" "<<aCenter->z()<<std::endl;
286 // make a visible point
287 std::shared_ptr<GeomAPI_Shape> aCenterPointShape = GeomAlgoAPI_PointBuilder::point(aCenter);
288 std::shared_ptr<ModelAPI_ResultConstruction> aResult = theFeature->document()->createConstruction(
289 theFeature->data(), theIndex);
290 aResult->setShape(aCenterPointShape);
291 aResult->setIsInHistory(false);
293 theFeature->setResult(aResult, theIndex);
296 FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature(FeaturePtr theFeature,
297 SketchPlugin_Sketch* theSketch)
299 FeaturePtr aNewFeature = theSketch->addFeature(theFeature->getKind());
300 // addFeature generates a unique name for the feature, it caches the name
301 std::string aUniqueFeatureName = aNewFeature->data()->name();
302 // all attribute values are copied\pasted to the new feature, name is not an exception
303 theFeature->data()->copyTo(aNewFeature->data());
304 // as a name for the feature, the generated unique name is set
305 aNewFeature->data()->setName(aUniqueFeatureName);
306 // text expressions could block setValue of some attributes
307 clearExpressions(aNewFeature);
312 std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::plane(SketchPlugin_Sketch* theSketch)
314 std::shared_ptr<ModelAPI_Data> aData = theSketch->data();
316 std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
317 aData->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
318 std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
319 aData->attribute(SketchPlugin_Sketch::DIRX_ID()));
320 std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
321 aData->attribute(SketchPlugin_Sketch::NORM_ID()));
323 return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(anOrigin->pnt(), aDirX->dir(), aNorm->dir()));