Salome HOME
Avoid crash on creation of a plane when default size is set to 0
[modules/shaper.git] / src / ConstructionPlugin / ConstructionPlugin_Plane.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 "ConstructionPlugin_Plane.h"
22
23 #include <Config_PropManager.h>
24
25 #include <GeomAlgoAPI_FaceBuilder.h>
26 #include <GeomAlgoAPI_Rotation.h>
27 #include <GeomAlgoAPI_ShapeTools.h>
28
29 #include <GeomAPI_Ax1.h>
30 #include <GeomAPI_Edge.h>
31 #include <GeomAPI_Face.h>
32 #include <GeomAPI_Lin.h>
33 #include <GeomAPI_Pln.h>
34 #include <GeomAPI_Pnt.h>
35 #include <GeomAPI_Pnt2d.h>
36 #include <GeomAPI_Vertex.h>
37 #include <GeomAPI_XYZ.h>
38
39 #include <ModelAPI_AttributeDouble.h>
40 #include <ModelAPI_AttributeIntArray.h>
41 #include <ModelAPI_AttributeSelection.h>
42 #include <ModelAPI_AttributeString.h>
43 #include <ModelAPI_AttributeBoolean.h>
44 #include <ModelAPI_ResultConstruction.h>
45 #include <ModelAPI_Session.h>
46 #include <ModelAPI_Validator.h>
47
48
49 static GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
50                                         const std::shared_ptr<GeomAPI_Vertex> theV2,
51                                         const std::shared_ptr<GeomAPI_Vertex> theV3);
52 static std::shared_ptr<GeomAPI_Face> makeRectangularFace(
53   const std::shared_ptr<GeomAPI_Face> theFace,
54   const std::shared_ptr<GeomAPI_Pln> thePln);
55
56 //==================================================================================================
57 ConstructionPlugin_Plane::ConstructionPlugin_Plane()
58 {
59 }
60
61 //==================================================================================================
62 void ConstructionPlugin_Plane::initAttributes()
63 {
64   data()->addAttribute(ConstructionPlugin_Plane::CREATION_METHOD(),
65                        ModelAPI_AttributeString::typeId());
66
67   data()->addAttribute(PLANE(), ModelAPI_AttributeSelection::typeId());
68   data()->addAttribute(DISTANCE(), ModelAPI_AttributeDouble::typeId());
69   // By general equation.
70   data()->addAttribute(A(), ModelAPI_AttributeDouble::typeId());
71   data()->addAttribute(B(), ModelAPI_AttributeDouble::typeId());
72   data()->addAttribute(C(), ModelAPI_AttributeDouble::typeId());
73   data()->addAttribute(D(), ModelAPI_AttributeDouble::typeId());
74   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), A());
75   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), B());
76   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), C());
77   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), D());
78
79   // By three points.
80   data()->addAttribute(POINT1(), ModelAPI_AttributeSelection::typeId());
81   data()->addAttribute(POINT2(), ModelAPI_AttributeSelection::typeId());
82   data()->addAttribute(POINT3(), ModelAPI_AttributeSelection::typeId());
83
84   // By line and point.
85   data()->addAttribute(LINE(), ModelAPI_AttributeSelection::typeId());
86   data()->addAttribute(POINT(), ModelAPI_AttributeSelection::typeId());
87   data()->addAttribute(PERPENDICULAR(), ModelAPI_AttributeBoolean::typeId());
88
89   // By other plane.
90   data()->addAttribute(CREATION_METHOD_BY_OTHER_PLANE_OPTION(), ModelAPI_AttributeString::typeId());
91   data()->addAttribute(REVERSE(), ModelAPI_AttributeBoolean::typeId());
92   data()->addAttribute(COINCIDENT_POINT(), ModelAPI_AttributeSelection::typeId());
93   data()->addAttribute(AXIS(), ModelAPI_AttributeSelection::typeId());
94   data()->addAttribute(ANGLE(), ModelAPI_AttributeDouble::typeId());
95
96   // By two parallel planes.
97   data()->addAttribute(PLANE1(), ModelAPI_AttributeSelection::typeId());
98   data()->addAttribute(PLANE2(), ModelAPI_AttributeSelection::typeId());
99 }
100
101 //==================================================================================================
102 void ConstructionPlugin_Plane::execute()
103 {
104   GeomShapePtr aShape;
105
106   std::string aCreationMethod = string(CREATION_METHOD())->value();
107   if(aCreationMethod == CREATION_METHOD_BY_GENERAL_EQUATION() ||
108       aCreationMethod == "PlaneByGeneralEquation") {
109     aShape = createByGeneralEquation();
110   } else if(aCreationMethod == CREATION_METHOD_BY_THREE_POINTS()) {
111     aShape = createByThreePoints();
112   } else if(aCreationMethod == CREATION_METHOD_BY_LINE_AND_POINT()) {
113     aShape = createByLineAndPoint();
114   } else if(aCreationMethod == CREATION_METHOD_BY_OTHER_PLANE()) {
115     std::string aCreationMethodOption = string(CREATION_METHOD_BY_OTHER_PLANE_OPTION())->value();
116     if(aCreationMethodOption == CREATION_METHOD_BY_DISTANCE_FROM_OTHER()) {
117       aShape = createByDistanceFromOther();
118     } else if(aCreationMethodOption == CREATION_METHOD_BY_COINCIDENT_TO_POINT()) {
119       aShape = createByCoincidentPoint();
120     } else if(aCreationMethodOption == CREATION_METHOD_BY_ROTATION()) {
121       aShape = createByRotation();
122     }
123   } else if(aCreationMethod == CREATION_METHOD_BY_TWO_PARALLEL_PLANES()) {
124     aShape = createByTwoParallelPlanes();
125   } else {
126     setError("Error: Plane creation method \"" + aCreationMethod + "\" not supported.");
127     return;
128   }
129
130   if(!aShape.get()) {
131     setError("Error: Could not create a plane.");
132     return;
133   }
134
135   ResultConstructionPtr aConstr = document()->createConstruction(data());
136   aConstr->setInfinite(true);
137   aConstr->setShape(aShape);
138   setResult(aConstr);
139 }
140
141 //==================================================================================================
142 bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
143                                                 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
144 {
145   std::vector<int> aColor;
146   // get color from the attribute of the result
147   if (theResult.get() != NULL &&
148       theResult->data()->attribute(ModelAPI_Result::COLOR_ID()).get() != NULL) {
149     AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
150     if (aColorAttr.get() && aColorAttr->size()) {
151       aColor.push_back(aColorAttr->value(0));
152       aColor.push_back(aColorAttr->value(1));
153       aColor.push_back(aColorAttr->value(2));
154     }
155   }
156   if (aColor.empty())
157     aColor = Config_PropManager::color("Visualization", "construction_plane_color");
158
159   bool isCustomized = false;
160   if (aColor.size() == 3)
161     isCustomized = thePrs->setColor(aColor[0], aColor[1], aColor[2]);
162
163   isCustomized = thePrs->setTransparensy(0.6) || isCustomized;
164
165   return isCustomized;
166 }
167
168 //==================================================================================================
169 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByGeneralEquation()
170 {
171   AttributeDoublePtr anAttrA = real(ConstructionPlugin_Plane::A());
172   AttributeDoublePtr anAttrB = real(ConstructionPlugin_Plane::B());
173   AttributeDoublePtr anAttrC = real(ConstructionPlugin_Plane::C());
174   AttributeDoublePtr anAttrD = real(ConstructionPlugin_Plane::D());
175   std::shared_ptr<GeomAPI_Shape> aPlaneFace;
176   if ((anAttrA.get() != NULL) && (anAttrB.get() != NULL) &&
177       (anAttrC.get() != NULL) && (anAttrD.get() != NULL) &&
178       anAttrA->isInitialized() && anAttrB->isInitialized() &&
179       anAttrC->isInitialized() && anAttrD->isInitialized() ) {
180     double aA = anAttrA->value(), aB = anAttrB->value(),
181            aC = anAttrC->value(), aD = anAttrD->value();
182     std::shared_ptr<GeomAPI_Pln> aPlane =
183       std::shared_ptr<GeomAPI_Pln>(new GeomAPI_Pln(aA, aB, aC, aD));
184     double aSize = Config_PropManager::real(SKETCH_TAB_NAME, "planes_size");
185     if (aSize <= 1.e-7)
186       aSize = 200;  // Set default value
187     aSize *= 4.;
188     aPlaneFace = GeomAlgoAPI_FaceBuilder::squareFace(aPlane, aSize);
189   }
190   return aPlaneFace;
191 }
192
193 //==================================================================================================
194 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByThreePoints()
195 {
196   // Get first point.
197   AttributeSelectionPtr aPointSelection1 = selection(POINT1());
198   GeomShapePtr aPointShape1 = aPointSelection1->value();
199   if(!aPointShape1.get()) {
200     aPointShape1 = aPointSelection1->context()->shape();
201   }
202   std::shared_ptr<GeomAPI_Vertex> aVertex1(new GeomAPI_Vertex(aPointShape1));
203
204   // Get second point.
205   AttributeSelectionPtr aPointSelection2 = selection(POINT2());
206   GeomShapePtr aPointShape2 = aPointSelection2->value();
207   if(!aPointShape2.get()) {
208     aPointShape2 = aPointSelection2->context()->shape();
209   }
210   std::shared_ptr<GeomAPI_Vertex> aVertex2(new GeomAPI_Vertex(aPointShape2));
211
212   // Get third point.
213   AttributeSelectionPtr aPointSelection3 = selection(POINT3());
214   GeomShapePtr aPointShape3 = aPointSelection3->value();
215   if(!aPointShape3.get()) {
216     aPointShape3 = aPointSelection3->context()->shape();
217   }
218   std::shared_ptr<GeomAPI_Vertex> aVertex3(new GeomAPI_Vertex(aPointShape3));
219
220   GeomShapePtr aRes = faceByThreeVertices(aVertex1, aVertex2, aVertex3);
221
222   return aRes;
223 }
224
225 //==================================================================================================
226 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
227 {
228   // Get edge.
229   AttributeSelectionPtr anEdgeSelection = selection(LINE());
230   GeomShapePtr aLineShape = anEdgeSelection->value();
231   if(!aLineShape.get()) {
232     aLineShape = anEdgeSelection->context()->shape();
233   }
234   std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aLineShape));
235
236   // Get point.
237   AttributeSelectionPtr aPointSelection = selection(POINT());
238   GeomShapePtr aPointShape = aPointSelection->value();
239   if(!aPointShape.get()) {
240     aPointShape = aPointSelection->context()->shape();
241   }
242   std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
243
244   // Get perpendicular flag.
245   bool anIsPerpendicular= boolean(PERPENDICULAR())->value();
246
247   GeomShapePtr aRes;
248   if(anIsPerpendicular) {
249     std::shared_ptr<GeomAPI_Lin> aLin = anEdge->line();
250     std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
251     std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aPnt, aLin->direction()));
252     double aSize = aLin->distance(aPnt) * 2;
253     // point may belong to line, so for the face size use maximum distance between point and line
254     // and the line size (distance between the start and end point)
255     double aDistance = anEdge->firstPoint()->distance(anEdge->lastPoint());
256     aRes = GeomAlgoAPI_FaceBuilder::squareFace(aNewPln, aSize > aDistance ? aSize : aDistance);
257   } else {
258     std::shared_ptr<GeomAPI_Vertex> aV1, aV2;
259     GeomAlgoAPI_ShapeTools::findBounds(anEdge, aV1, aV2);
260     aRes = faceByThreeVertices(aV1, aV2, aVertex);
261   }
262
263   return aRes;
264 }
265
266 //==================================================================================================
267 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOther()
268 {
269   AttributeSelectionPtr aFaceAttr = data()->selection(ConstructionPlugin_Plane::PLANE());
270   AttributeDoublePtr aDistAttr = data()->real(ConstructionPlugin_Plane::DISTANCE());
271   std::shared_ptr<GeomAPI_Shape> aPlane;
272   if ((aFaceAttr.get() != NULL) &&
273       (aDistAttr.get() != NULL) &&
274       aFaceAttr->isInitialized() && aDistAttr->isInitialized()) {
275
276     double aDist = aDistAttr->value();
277     bool anIsReverse = boolean(REVERSE())->value();
278     if(anIsReverse) aDist = -aDist;
279     GeomShapePtr aShape = aFaceAttr->value();
280     if (!aShape.get()) {
281       aShape = aFaceAttr->context()->shape();
282     }
283
284     if(!aShape.get()) {
285       return aPlane;
286     }
287
288     std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aShape));
289
290     std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
291     std::shared_ptr<GeomAPI_Pnt> aOrig = aPln->location();
292     std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
293
294     aOrig->translate(aDir, aDist);
295     std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
296
297     aPlane = makeRectangularFace(aFace, aNewPln);
298   }
299   return aPlane;
300 }
301
302 //==================================================================================================
303 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint()
304 {
305   // Get face.
306   AttributeSelectionPtr aFaceSelection = selection(PLANE());
307   GeomShapePtr aFaceShape = aFaceSelection->value();
308   if(!aFaceShape.get()) {
309     aFaceShape = aFaceSelection->context()->shape();
310   }
311   std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aFaceShape));
312
313   // Get point.
314   AttributeSelectionPtr aPointSelection = selection(COINCIDENT_POINT());
315   GeomShapePtr aPointShape = aPointSelection->value();
316   if(!aPointShape.get()) {
317     aPointShape = aPointSelection->context()->shape();
318   }
319   std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
320
321   std::shared_ptr<GeomAPI_Pnt> anOrig = aVertex->point();
322   std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
323   std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
324
325   std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(anOrig, aDir));
326
327   return makeRectangularFace(aFace, aNewPln);
328 }
329
330 //==================================================================================================
331 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
332 {
333   // Get face.
334   AttributeSelectionPtr aFaceSelection = selection(PLANE());
335   GeomShapePtr aFaceShape = aFaceSelection->value();
336   if(!aFaceShape.get()) {
337     aFaceShape = aFaceSelection->context()->shape();
338   }
339   std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aFaceShape));
340   aFace = makeRectangularFace(aFace, aFace->getPlane());
341
342   // Get axis.
343   AttributeSelectionPtr anAxisSelection = selection(AXIS());
344   GeomShapePtr anAxisShape = anAxisSelection->value();
345   if(!anAxisShape.get()) {
346     anAxisShape = anAxisSelection->context()->shape();
347   }
348   std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(anAxisShape));
349
350   std::shared_ptr<GeomAPI_Ax1> anAxis =
351     std::shared_ptr<GeomAPI_Ax1>(new GeomAPI_Ax1(anEdge->line()->location(),
352                                                  anEdge->line()->direction()));
353
354   // Getting angle.
355   double anAngle = real(ANGLE())->value();
356
357   GeomAlgoAPI_Rotation aRotationAlgo(aFace, anAxis, anAngle);
358   if (!aRotationAlgo.check()) {
359     setError(aRotationAlgo.getError());
360     return GeomShapePtr();
361   }
362   aRotationAlgo.build();
363   if (!aRotationAlgo.isDone()) {
364     setError("Error: Failed to rotate plane");
365     return GeomShapePtr();
366   }
367
368   std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo.shape()));
369   return aRes;
370 }
371
372 //==================================================================================================
373 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlanes()
374 {
375   // Get plane 1.
376   AttributeSelectionPtr aFaceSelection1 = selection(PLANE1());
377   GeomShapePtr aFaceShape1 = aFaceSelection1->value();
378   if(!aFaceShape1.get()) {
379     aFaceShape1 = aFaceSelection1->context()->shape();
380   }
381   std::shared_ptr<GeomAPI_Face> aFace1(new GeomAPI_Face(aFaceShape1));
382   std::shared_ptr<GeomAPI_Pln> aPln1 = aFace1->getPlane();
383
384   // Get plane 2.
385   AttributeSelectionPtr aFaceSelection2 = selection(PLANE2());
386   GeomShapePtr aFaceShape2 = aFaceSelection2->value();
387   if(!aFaceShape2.get()) {
388     aFaceShape2 = aFaceSelection2->context()->shape();
389   }
390   std::shared_ptr<GeomAPI_Face> aFace2(new GeomAPI_Face(aFaceShape2));
391   std::shared_ptr<GeomAPI_Pln> aPln2 = aFace2->getPlane();
392
393   std::shared_ptr<GeomAPI_Pnt> anOrig1 = aPln1->location();
394   std::shared_ptr<GeomAPI_Pnt> aPntOnPln2 = aPln2->project(anOrig1);
395
396   std::shared_ptr<GeomAPI_Pnt> aNewOrig(new GeomAPI_Pnt(anOrig1->xyz()->added(
397     aPntOnPln2->xyz())->multiplied(0.5)));
398
399   std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aNewOrig, aPln1->direction()));
400
401   std::shared_ptr<GeomAPI_Face> aRes = makeRectangularFace(aFace1, aNewPln);
402
403   return aRes;
404 }
405
406 //==================================================================================================
407 GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
408                                  const std::shared_ptr<GeomAPI_Vertex> theV2,
409                                  const std::shared_ptr<GeomAPI_Vertex> theV3)
410 {
411   std::shared_ptr<GeomAPI_Face> aFace =
412     GeomAlgoAPI_FaceBuilder::planarFaceByThreeVertices(theV1, theV2, theV3);
413
414   ListOfShape anObjects;
415   anObjects.push_back(theV1);
416   anObjects.push_back(theV2);
417   anObjects.push_back(theV3);
418   std::list<std::shared_ptr<GeomAPI_Pnt> > aBoundingPoints =
419     GeomAlgoAPI_ShapeTools::getBoundingBox(anObjects, 1.0);
420   GeomShapePtr aRes = GeomAlgoAPI_ShapeTools::fitPlaneToBox(aFace, aBoundingPoints);
421
422   return aRes;
423 }
424
425 //==================================================================================================
426 std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_Face> theFace,
427                                                   const std::shared_ptr<GeomAPI_Pln> thePln)
428 {
429   // Create rectangular face close to the selected
430   double aXmin, aYmin, Zmin, aXmax, aYmax, Zmax;
431   theFace->computeSize(aXmin, aYmin, Zmin, aXmax, aYmax, Zmax);
432
433   // use all 8 points of the bounding box to find the 2D bounds
434   bool isFirst = true;
435   double aMinX2d, aMaxX2d, aMinY2d, aMaxY2d;
436   for(int aXIsMin = 0; aXIsMin < 2; aXIsMin++) {
437     for(int aYIsMin = 0; aYIsMin < 2; aYIsMin++) {
438       for(int aZIsMin = 0; aZIsMin < 2; aZIsMin++) {
439         std::shared_ptr<GeomAPI_Pnt> aPnt(new GeomAPI_Pnt(
440           aXIsMin ? aXmin : aXmax, aYIsMin ? aYmin : aYmax, aZIsMin ? Zmin : Zmax));
441         std::shared_ptr<GeomAPI_Pnt2d> aPnt2d = aPnt->to2D(thePln);
442         if (isFirst || aPnt2d->x() < aMinX2d)
443           aMinX2d = aPnt2d->x();
444         if (isFirst || aPnt2d->y() < aMinY2d)
445           aMinY2d = aPnt2d->y();
446         if (isFirst || aPnt2d->x() > aMaxX2d)
447           aMaxX2d = aPnt2d->x();
448         if (isFirst || aPnt2d->y() > aMaxY2d)
449           aMaxY2d = aPnt2d->y();
450         if (isFirst)
451           isFirst = !isFirst;
452       }
453     }
454   }
455   double aWgap = (aMaxX2d - aMinX2d) * 0.1;
456   double aHgap = (aMaxY2d - aMinY2d) * 0.1;
457   std::shared_ptr<GeomAPI_Face> aResFace = GeomAlgoAPI_FaceBuilder::planarFace(thePln,
458     aMinX2d - aWgap, aMinY2d - aHgap, aMaxX2d - aMinX2d + 2. * aWgap,
459     aMaxY2d - aMinY2d + 2. * aHgap);
460
461   return aResFace;
462 }