1 // Copyright (C) 2019-2020 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 <SketchPlugin_MacroBSpline.h>
22 #include <SketchPlugin_BSpline.h>
23 #include <SketchPlugin_BSplinePeriodic.h>
24 #include <SketchPlugin_ConstraintCoincidenceInternal.h>
25 #include <SketchPlugin_Line.h>
26 #include <SketchPlugin_Point.h>
27 #include <SketchPlugin_Tools.h>
28 #include <SketchPlugin_Sketch.h>
30 #include <ModelAPI_AttributeDoubleArray.h>
31 #include <ModelAPI_AttributeInteger.h>
32 #include <ModelAPI_AttributeRefAttrList.h>
33 #include <ModelAPI_Events.h>
34 #include <ModelAPI_Session.h>
35 #include <ModelAPI_Validator.h>
36 #include <ModelAPI_Tools.h>
38 #include <GeomDataAPI_Point2DArray.h>
40 #include <GeomAlgoAPI_CompoundBuilder.h>
41 #include <GeomAlgoAPI_EdgeBuilder.h>
42 #include <GeomAlgoAPI_PointBuilder.h>
44 #include <GeomAPI_BSpline2d.h>
48 /// Create internal coincidence constraint with B-spline pole
49 static void createInternalConstraint(SketchPlugin_Sketch* theSketch,
50 AttributePtr thePoint,
51 AttributePtr theBSplinePoles,
52 const int thePoleIndex);
55 SketchPlugin_MacroBSpline::SketchPlugin_MacroBSpline()
56 : SketchPlugin_SketchEntity(),
62 SketchPlugin_MacroBSpline::SketchPlugin_MacroBSpline(bool isPeriodic)
63 : SketchPlugin_SketchEntity(),
65 myIsPeriodic(isPeriodic)
69 void SketchPlugin_MacroBSpline::initAttributes()
71 data()->addAttribute(POLES_ID(), GeomDataAPI_Point2DArray::typeId());
72 data()->addAttribute(WEIGHTS_ID(), ModelAPI_AttributeDoubleArray::typeId());
74 data()->addAttribute(REF_POLES_ID(), ModelAPI_AttributeRefAttrList::typeId());
75 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), REF_POLES_ID());
77 data()->addAttribute(CONTROL_POLYGON_ID(), ModelAPI_AttributeBoolean::typeId());
79 data()->addAttribute(AUXILIARY_ID(), ModelAPI_AttributeBoolean::typeId());
82 void SketchPlugin_MacroBSpline::execute()
84 FeaturePtr aBSpline = createBSplineFeature();
86 if (boolean(CONTROL_POLYGON_ID())->value()) {
87 std::list<FeaturePtr> aControlPoles;
88 createControlPolygon(aBSpline, myIsPeriodic, aControlPoles);
89 constraintsForPoles(aControlPoles);
93 FeaturePtr SketchPlugin_MacroBSpline::createBSplineFeature()
95 if (myKnots.empty() || myMultiplicities.empty())
96 getAISObject(AISObjectPtr()); // fill B-spline parameters
98 FeaturePtr aBSpline = sketch()->addFeature(
99 myIsPeriodic ? SketchPlugin_BSplinePeriodic::ID() : SketchPlugin_BSpline::ID());
101 aBSpline->integer(SketchPlugin_BSplineBase::DEGREE_ID())->setValue(myDegree);
103 AttributePoint2DArrayPtr aPoles = std::dynamic_pointer_cast<GeomDataAPI_Point2DArray>(
104 aBSpline->attribute(SketchPlugin_BSplineBase::POLES_ID()));
105 AttributePoint2DArrayPtr aPolesMacro =
106 std::dynamic_pointer_cast<GeomDataAPI_Point2DArray>(attribute(POLES_ID()));
107 aPoles->assign(aPolesMacro);
109 AttributeDoubleArrayPtr aWeights =
110 aBSpline->data()->realArray(SketchPlugin_BSplineBase::WEIGHTS_ID());
111 AttributeDoubleArrayPtr aWeightsMacro = data()->realArray(WEIGHTS_ID());
112 int aSize = aWeightsMacro->size();
113 aWeights->setSize(aSize);
114 for (int index = 0; index < aSize; ++index)
115 aWeights->setValue(index, aWeightsMacro->value(index));
117 AttributeDoubleArrayPtr aKnots =
118 aBSpline->data()->realArray(SketchPlugin_BSplineBase::KNOTS_ID());
119 aSize = (int)myKnots.size();
120 aKnots->setSize(aSize);
121 std::list<double>::iterator aKIt = myKnots.begin();
122 for (int index = 0; index < aSize; ++index, ++aKIt)
123 aKnots->setValue(index, *aKIt);
125 AttributeIntArrayPtr aMults = aBSpline->data()->intArray(SketchPlugin_BSplineBase::MULTS_ID());
126 aSize = (int)myMultiplicities.size();
127 aMults->setSize(aSize);
128 std::list<int>::iterator aMIt = myMultiplicities.begin();
129 for (int index = 0; index < aSize; ++index, ++aMIt)
130 aMults->setValue(index, *aMIt);
133 AttributePoint2DPtr aStartPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
134 aBSpline->attribute(SketchPlugin_BSpline::START_ID()));
135 aStartPoint->setValue(aPoles->pnt(0));
137 AttributePoint2DPtr aEndPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
138 aBSpline->attribute(SketchPlugin_BSpline::END_ID()));
139 aEndPoint->setValue(aPoles->pnt(aPoles->size() - 1));
142 aBSpline->boolean(SketchPlugin_SketchEntity::AUXILIARY_ID())->setValue(
143 boolean(AUXILIARY_ID())->value());
150 void SketchPlugin_MacroBSpline::createControlPolygon(FeaturePtr theBSpline,
152 std::list<FeaturePtr>& thePoles)
154 AttributePoint2DArrayPtr aPoles = std::dynamic_pointer_cast<GeomDataAPI_Point2DArray>(
155 theBSpline->attribute(SketchPlugin_BSpline::POLES_ID()));
156 int aSize = aPoles->size();
158 for (int index = 0; index < aSize; ++index)
159 thePoles.push_back(createAuxiliaryPole(aPoles, index));
161 for (int index = 1; index < aSize; ++index)
162 createAuxiliarySegment(aPoles, index - 1, index);
164 // additional segment to close the control polygon
165 createAuxiliarySegment(aPoles, aSize - 1, 0);
169 void SketchPlugin_MacroBSpline::constraintsForPoles(const std::list<FeaturePtr>& thePoles)
171 AttributeRefAttrListPtr aRefAttrList = data()->refattrlist(REF_POLES_ID());
172 std::list<std::pair<ObjectPtr, AttributePtr> > aList;
174 aList = aRefAttrList->list();
176 SketchPlugin_Sketch* aSketch = sketch();
178 std::list<std::pair<ObjectPtr, AttributePtr> >::iterator aLIt = aList.begin();
179 std::list<FeaturePtr>::const_iterator aPIt = thePoles.begin();
180 for (; aLIt != aList.end() && aPIt != thePoles.end(); ++aPIt, ++aLIt) {
181 // firstly, check the attribute (in this case the object will be not empty too)
183 SketchPlugin_Tools::createConstraintAttrAttr(aSketch,
184 SketchPlugin_ConstraintCoincidence::ID(),
185 (*aPIt)->attribute(SketchPlugin_Point::COORD_ID()), aLIt->second);
187 // now add coincidence with the result
188 else if (aLIt->first) {
189 SketchPlugin_Tools::createConstraintAttrObject(aSketch,
190 SketchPlugin_ConstraintCoincidence::ID(),
191 (*aPIt)->attribute(SketchPlugin_Point::COORD_ID()), aLIt->first);
196 AISObjectPtr SketchPlugin_MacroBSpline::getAISObject(AISObjectPtr thePrevious)
198 SketchPlugin_Sketch* aSketch = sketch();
200 return AISObjectPtr();
202 AttributePoint2DArrayPtr aPolesArray =
203 std::dynamic_pointer_cast<GeomDataAPI_Point2DArray>(attribute(POLES_ID()));
204 AttributeDoubleArrayPtr aWeightsArray = data()->realArray(WEIGHTS_ID());
206 if (aPolesArray->size() < 2)
207 return AISObjectPtr();
209 std::list<GeomShapePtr> aShapes;
211 // convert poles to vertices and collect weights
212 std::list<GeomPnt2dPtr> aPoles2D;
213 std::list<double> aWeights;
214 for (int anIndex = 0; anIndex < aPolesArray->size(); ++anIndex) {
215 double aWeight = aWeightsArray->value(anIndex);
216 if (aWeight < 1.e-10)
217 continue; // skip poles with zero weights
219 aWeights.push_back(aWeight);
221 GeomPnt2dPtr aPole = aPolesArray->pnt(anIndex);
222 aPoles2D.push_back(aPole);
223 GeomPointPtr aPole3D = aSketch->to3D(aPole->x(), aPole->y());
224 aShapes.push_back(GeomAlgoAPI_PointBuilder::vertex(aPole3D));
227 // create result non-periodic B-spline curve
228 std::shared_ptr<GeomAPI_BSpline2d> aBSplineCurve;
230 aBSplineCurve.reset(new GeomAPI_BSpline2d(aPoles2D, aWeights, myIsPeriodic));
232 // cannot build a B-spline curve
233 return AISObjectPtr();
235 GeomShapePtr anEdge =
236 GeomAlgoAPI_EdgeBuilder::bsplineOnPlane(aSketch->coordinatePlane(), aBSplineCurve);
238 return AISObjectPtr();
240 // store transient parameters of B-spline curve
241 myDegree = aBSplineCurve->degree();
242 myKnots = aBSplineCurve->knots();
243 myMultiplicities = aBSplineCurve->mults();
245 aShapes.push_back(anEdge);
246 GeomShapePtr aCompound = GeomAlgoAPI_CompoundBuilder::compound(aShapes);
248 AISObjectPtr anAIS = thePrevious;
250 anAIS.reset(new GeomAPI_AISObject());
251 anAIS->createShape(aCompound);
254 SketchPlugin_Tools::customizeFeaturePrs(anAIS, boolean(AUXILIARY_ID())->value());
261 // ========================== Auxiliary functions ===========================================
263 void SketchPlugin_MacroBSpline::assignDefaultNameForAux(FeaturePtr theAuxFeature,
264 AttributePoint2DArrayPtr theBSplinePoles,
265 const int thePoleIndex1,
266 const int thePoleIndex2)
268 FeaturePtr aBSpline = ModelAPI_Feature::feature(theBSplinePoles->owner());
270 std::wostringstream aName;
271 aName << aBSpline->name();
272 if (theAuxFeature->getKind() == SketchPlugin_Point::ID())
273 aName << "_" << ModelAPI_Tools::toWString(theBSplinePoles->id()) << "_" << thePoleIndex1;
275 aName << "_segment_" << thePoleIndex1 << "_" << thePoleIndex2;
277 theAuxFeature->data()->setName(aName.str());
278 theAuxFeature->lastResult()->data()->setName(aName.str());
281 FeaturePtr SketchPlugin_MacroBSpline::createAuxiliaryPole(AttributePoint2DArrayPtr theBSplinePoles,
282 const int thePoleIndex)
284 FeaturePtr aBSpline = ModelAPI_Feature::feature(theBSplinePoles->owner());
286 SketchPlugin_Sketch* aSketch =
287 std::dynamic_pointer_cast<SketchPlugin_Feature>(aBSpline)->sketch();
289 // create child point equal to the B-spline's pole
290 FeaturePtr aPointFeature = aSketch->addFeature(SketchPlugin_Point::ID());
291 aPointFeature->boolean(SketchPlugin_Point::AUXILIARY_ID())->setValue(true);
292 aPointFeature->reference(SketchPlugin_Point::PARENT_ID())->setValue(aBSpline);
294 GeomPnt2dPtr aPole = theBSplinePoles->pnt(thePoleIndex);
296 AttributePoint2DPtr aCoord = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
297 aPointFeature->attribute(SketchPlugin_Point::COORD_ID()));
298 aCoord->setValue(aPole);
300 aPointFeature->execute();
301 assignDefaultNameForAux(aPointFeature, theBSplinePoles, thePoleIndex);
303 // internal constraint to keep position of the point
304 createInternalConstraint(aSketch, aCoord, theBSplinePoles, thePoleIndex);
306 return aPointFeature;
309 void SketchPlugin_MacroBSpline::createAuxiliarySegment(AttributePoint2DArrayPtr theBSplinePoles,
310 const int thePoleIndex1,
311 const int thePoleIndex2)
313 FeaturePtr aBSpline = ModelAPI_Feature::feature(theBSplinePoles->owner());
315 SketchPlugin_Sketch* aSketch =
316 std::dynamic_pointer_cast<SketchPlugin_Feature>(aBSpline)->sketch();
318 // create child segment between B-spline poles
319 FeaturePtr aLineFeature = aSketch->addFeature(SketchPlugin_Line::ID());
320 aLineFeature->boolean(SketchPlugin_Point::AUXILIARY_ID())->setValue(true);
321 aLineFeature->reference(SketchPlugin_Point::PARENT_ID())->setValue(aBSpline);
323 AttributePoint2DPtr aLineStart = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
324 aLineFeature->attribute(SketchPlugin_Line::START_ID()));
325 aLineStart->setValue(theBSplinePoles->pnt(thePoleIndex1));
327 AttributePoint2DPtr aLineEnd = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
328 aLineFeature->attribute(SketchPlugin_Line::END_ID()));
329 aLineEnd->setValue(theBSplinePoles->pnt(thePoleIndex2));
331 aLineFeature->execute();
332 assignDefaultNameForAux(aLineFeature, theBSplinePoles, thePoleIndex1, thePoleIndex2);
334 // internal constraints to keep the segment position
335 createInternalConstraint(aSketch, aLineStart, theBSplinePoles, thePoleIndex1);
336 createInternalConstraint(aSketch, aLineEnd, theBSplinePoles, thePoleIndex2);
339 void createInternalConstraint(SketchPlugin_Sketch* theSketch,
340 AttributePtr thePoint,
341 AttributePtr theBSplinePoles,
342 const int thePoleIndex)
344 std::shared_ptr<SketchPlugin_ConstraintCoincidenceInternal> aConstraint =
345 std::dynamic_pointer_cast<SketchPlugin_ConstraintCoincidenceInternal>(
346 theSketch->addFeature(SketchPlugin_ConstraintCoincidenceInternal::ID()));
347 aConstraint->refattr(SketchPlugin_Constraint::ENTITY_A())->setAttr(thePoint);
348 aConstraint->refattr(SketchPlugin_Constraint::ENTITY_B())->setAttr(theBSplinePoles);
349 aConstraint->integer(SketchPlugin_ConstraintCoincidenceInternal::INDEX_ENTITY_B())
350 ->setValue(thePoleIndex);