1 // Copyright (C) 2014-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 "ConstructionPlugin_Plane.h"
22 #include <Config_PropManager.h>
24 #include <GeomAlgoAPI_FaceBuilder.h>
25 #include <GeomAlgoAPI_Rotation.h>
26 #include <GeomAlgoAPI_ShapeTools.h>
27 #include <GeomAlgoAPI_Tools.h>
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_ShapeIterator.h>
37 #include <GeomAPI_Vertex.h>
38 #include <GeomAPI_XYZ.h>
40 #include <ModelAPI_AttributeDouble.h>
41 #include <ModelAPI_AttributeIntArray.h>
42 #include <ModelAPI_AttributeSelection.h>
43 #include <ModelAPI_AttributeString.h>
44 #include <ModelAPI_AttributeBoolean.h>
45 #include <ModelAPI_ResultConstruction.h>
46 #include <ModelAPI_Session.h>
47 #include <ModelAPI_Validator.h>
52 static GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
53 const std::shared_ptr<GeomAPI_Vertex> theV2,
54 const std::shared_ptr<GeomAPI_Vertex> theV3);
55 static std::shared_ptr<GeomAPI_Face> makeRectangularFace(
56 const std::shared_ptr<GeomAPI_Face> theFace,
57 const std::shared_ptr<GeomAPI_Pln> thePln);
59 //==================================================================================================
60 ConstructionPlugin_Plane::ConstructionPlugin_Plane()
64 //==================================================================================================
65 void ConstructionPlugin_Plane::initAttributes()
67 data()->addAttribute(ConstructionPlugin_Plane::CREATION_METHOD(),
68 ModelAPI_AttributeString::typeId());
70 data()->addAttribute(PLANE(), ModelAPI_AttributeSelection::typeId());
71 data()->addAttribute(DISTANCE(), ModelAPI_AttributeDouble::typeId());
72 // By general equation.
73 data()->addAttribute(A(), ModelAPI_AttributeDouble::typeId());
74 data()->addAttribute(B(), ModelAPI_AttributeDouble::typeId());
75 data()->addAttribute(C(), ModelAPI_AttributeDouble::typeId());
76 data()->addAttribute(D(), ModelAPI_AttributeDouble::typeId());
77 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), A());
78 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), B());
79 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), C());
80 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), D());
83 data()->addAttribute(POINT1(), ModelAPI_AttributeSelection::typeId());
84 data()->addAttribute(POINT2(), ModelAPI_AttributeSelection::typeId());
85 data()->addAttribute(POINT3(), ModelAPI_AttributeSelection::typeId());
88 data()->addAttribute(LINE(), ModelAPI_AttributeSelection::typeId());
89 data()->addAttribute(POINT(), ModelAPI_AttributeSelection::typeId());
90 data()->addAttribute(PERPENDICULAR(), ModelAPI_AttributeBoolean::typeId());
93 data()->addAttribute(CREATION_METHOD_BY_OTHER_PLANE_OPTION(), ModelAPI_AttributeString::typeId());
94 data()->addAttribute(REVERSE(), ModelAPI_AttributeBoolean::typeId());
95 data()->addAttribute(COINCIDENT_POINT(), ModelAPI_AttributeSelection::typeId());
96 data()->addAttribute(AXIS(), ModelAPI_AttributeSelection::typeId());
97 data()->addAttribute(ANGLE(), ModelAPI_AttributeDouble::typeId());
99 // By two parallel planes.
100 data()->addAttribute(PLANE1(), ModelAPI_AttributeSelection::typeId());
101 data()->addAttribute(PLANE2(), ModelAPI_AttributeSelection::typeId());
104 //==================================================================================================
105 void ConstructionPlugin_Plane::execute()
109 std::string aCreationMethod = string(CREATION_METHOD())->value();
110 if(aCreationMethod == CREATION_METHOD_BY_GENERAL_EQUATION() ||
111 aCreationMethod == "PlaneByGeneralEquation") {
112 aShape = createByGeneralEquation();
113 } else if(aCreationMethod == CREATION_METHOD_BY_THREE_POINTS()) {
114 aShape = createByThreePoints();
115 } else if(aCreationMethod == CREATION_METHOD_BY_LINE_AND_POINT()) {
116 aShape = createByLineAndPoint();
117 } else if(aCreationMethod == CREATION_METHOD_BY_OTHER_PLANE()) {
118 std::string aCreationMethodOption = string(CREATION_METHOD_BY_OTHER_PLANE_OPTION())->value();
119 if(aCreationMethodOption == CREATION_METHOD_BY_DISTANCE_FROM_OTHER()) {
120 aShape = createByDistanceFromOther();
121 } else if(aCreationMethodOption == CREATION_METHOD_BY_COINCIDENT_TO_POINT()) {
122 aShape = createByCoincidentPoint();
123 } else if(aCreationMethodOption == CREATION_METHOD_BY_ROTATION()) {
124 aShape = createByRotation();
126 } else if(aCreationMethod == CREATION_METHOD_BY_TWO_PARALLEL_PLANES()) {
127 aShape = createByTwoParallelPlanes();
129 setError("Error: Plane creation method \"" + aCreationMethod + "\" not supported.");
134 setError("Error: Could not create a plane.");
138 ResultConstructionPtr aConstr = document()->createConstruction(data());
139 aConstr->setInfinite(true);
140 aConstr->setShape(aShape);
144 //==================================================================================================
145 bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs)
147 std::vector<int> aColor;
148 // get color from the attribute of the result
149 if (theResult.get() != NULL &&
150 theResult->data()->attribute(ModelAPI_Result::COLOR_ID()).get() != NULL) {
151 AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
152 if (aColorAttr.get() && aColorAttr->size()) {
153 aColor.push_back(aColorAttr->value(0));
154 aColor.push_back(aColorAttr->value(1));
155 aColor.push_back(aColorAttr->value(2));
159 aColor = Config_PropManager::color("Visualization", COLOR_NAME());
161 bool isCustomized = false;
162 if (aColor.size() == 3)
163 isCustomized = thePrs->setColor(aColor[0], aColor[1], aColor[2]);
165 isCustomized = thePrs->setTransparensy(0.6) || isCustomized;
170 //==================================================================================================
171 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByGeneralEquation()
173 AttributeDoublePtr anAttrA = real(ConstructionPlugin_Plane::A());
174 AttributeDoublePtr anAttrB = real(ConstructionPlugin_Plane::B());
175 AttributeDoublePtr anAttrC = real(ConstructionPlugin_Plane::C());
176 AttributeDoublePtr anAttrD = real(ConstructionPlugin_Plane::D());
177 std::shared_ptr<GeomAPI_Shape> aPlaneFace;
178 if ((anAttrA.get() != NULL) && (anAttrB.get() != NULL) &&
179 (anAttrC.get() != NULL) && (anAttrD.get() != NULL) &&
180 anAttrA->isInitialized() && anAttrB->isInitialized() &&
181 anAttrC->isInitialized() && anAttrD->isInitialized() ) {
182 double aA = anAttrA->value(), aB = anAttrB->value(),
183 aC = anAttrC->value(), aD = anAttrD->value();
184 std::shared_ptr<GeomAPI_Pln> aPlane =
185 std::shared_ptr<GeomAPI_Pln>(new GeomAPI_Pln(aA, aB, aC, aD));
186 double aSize = Config_PropManager::real(SKETCH_TAB_NAME, "planes_size");
188 aSize = 200; // Set default value
190 aPlaneFace = GeomAlgoAPI_FaceBuilder::squareFace(aPlane, aSize);
195 //==================================================================================================
196 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByThreePoints()
199 AttributeSelectionPtr aPointSelection1 = selection(POINT1());
200 GeomShapePtr aPointShape1 = aPointSelection1->value();
201 if(!aPointShape1.get()) {
202 aPointShape1 = aPointSelection1->context()->shape();
204 std::shared_ptr<GeomAPI_Vertex> aVertex1(new GeomAPI_Vertex(aPointShape1));
207 AttributeSelectionPtr aPointSelection2 = selection(POINT2());
208 GeomShapePtr aPointShape2 = aPointSelection2->value();
209 if(!aPointShape2.get()) {
210 aPointShape2 = aPointSelection2->context()->shape();
212 std::shared_ptr<GeomAPI_Vertex> aVertex2(new GeomAPI_Vertex(aPointShape2));
215 AttributeSelectionPtr aPointSelection3 = selection(POINT3());
216 GeomShapePtr aPointShape3 = aPointSelection3->value();
217 if(!aPointShape3.get()) {
218 aPointShape3 = aPointSelection3->context()->shape();
220 std::shared_ptr<GeomAPI_Vertex> aVertex3(new GeomAPI_Vertex(aPointShape3));
222 GeomShapePtr aRes = faceByThreeVertices(aVertex1, aVertex2, aVertex3);
227 //==================================================================================================
228 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
231 AttributeSelectionPtr anEdgeSelection = selection(LINE());
232 GeomShapePtr aLineShape = anEdgeSelection->value();
233 if(!aLineShape.get()) {
234 aLineShape = anEdgeSelection->context()->shape();
236 std::shared_ptr<GeomAPI_Edge> anEdge;
237 if (aLineShape->isEdge()) {
238 anEdge = aLineShape->edge();
240 else if (aLineShape->isCompound()) {
241 GeomAPI_ShapeIterator anIt(aLineShape);
242 anEdge = anIt.current()->edge();
245 return GeomShapePtr();
248 AttributeSelectionPtr aPointSelection = selection(POINT());
249 GeomShapePtr aPointShape = aPointSelection->value();
250 if(!aPointShape.get()) {
251 aPointShape = aPointSelection->context()->shape();
253 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
255 // Get perpendicular flag.
256 bool anIsPerpendicular= boolean(PERPENDICULAR())->value();
259 if(anIsPerpendicular) {
260 std::shared_ptr<GeomAPI_Lin> aLin = anEdge->line();
261 std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
262 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aPnt, aLin->direction()));
263 double aSize = aLin->distance(aPnt) * 2;
264 // point may belong to line, so for the face size use maximum distance between point and line
265 // and the line size (distance between the start and end point)
266 double aDistance = anEdge->firstPoint()->distance(anEdge->lastPoint());
267 aRes = GeomAlgoAPI_FaceBuilder::squareFace(aNewPln, aSize > aDistance ? aSize : aDistance);
269 std::shared_ptr<GeomAPI_Vertex> aV1, aV2;
270 GeomAlgoAPI_ShapeTools::findBounds(anEdge, aV1, aV2);
271 aRes = faceByThreeVertices(aV1, aV2, aVertex);
277 //==================================================================================================
278 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOther()
280 AttributeSelectionPtr aFaceAttr = data()->selection(ConstructionPlugin_Plane::PLANE());
281 AttributeDoublePtr aDistAttr = data()->real(ConstructionPlugin_Plane::DISTANCE());
282 std::shared_ptr<GeomAPI_Shape> aPlane;
283 if ((aFaceAttr.get() != NULL) &&
284 (aDistAttr.get() != NULL) &&
285 aFaceAttr->isInitialized() && aDistAttr->isInitialized()) {
287 double aDist = aDistAttr->value();
288 bool anIsReverse = boolean(REVERSE())->value();
289 if(anIsReverse) aDist = -aDist;
290 GeomShapePtr aShape = aFaceAttr->value();
291 if (!aShape.get() && aFaceAttr->context()) {
292 aShape = aFaceAttr->context()->shape();
299 std::shared_ptr<GeomAPI_Face> aFace;
300 if (aShape->isFace()) {
301 aFace = aShape->face();
303 else if (aShape->isCompound()) {
304 GeomAPI_ShapeIterator anIt(aShape);
305 aFace = anIt.current()->face();
308 return GeomShapePtr();
310 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
311 std::shared_ptr<GeomAPI_Pnt> aOrig = aPln->location();
312 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
314 aOrig->translate(aDir, aDist);
315 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
317 aPlane = makeRectangularFace(aFace, aNewPln);
322 //==================================================================================================
323 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint()
326 AttributeSelectionPtr aFaceSelection = selection(PLANE());
327 GeomShapePtr aFaceShape = aFaceSelection->value();
328 if(!aFaceShape.get()) {
329 aFaceShape = aFaceSelection->context()->shape();
331 std::shared_ptr<GeomAPI_Face> aFace;
332 if (aFaceShape->isFace()) {
333 aFace = aFaceShape->face();
335 else if (aFaceShape->isCompound()) {
336 GeomAPI_ShapeIterator anIt(aFaceShape);
337 aFace = anIt.current()->face();
341 AttributeSelectionPtr aPointSelection = selection(COINCIDENT_POINT());
342 GeomShapePtr aPointShape = aPointSelection->value();
343 if(!aPointShape.get()) {
344 aPointShape = aPointSelection->context()->shape();
346 std::shared_ptr<GeomAPI_Vertex> aVertex = aPointShape->vertex();
348 return GeomShapePtr();
350 std::shared_ptr<GeomAPI_Pnt> anOrig = aVertex->point();
351 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
352 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
354 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(anOrig, aDir));
356 return makeRectangularFace(aFace, aNewPln);
359 //==================================================================================================
360 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
363 AttributeSelectionPtr aFaceSelection = selection(PLANE());
364 GeomShapePtr aFaceShape = aFaceSelection->value();
365 if(!aFaceShape.get()) {
366 aFaceShape = aFaceSelection->context()->shape();
368 std::shared_ptr<GeomAPI_Face> aFace;
369 if (aFaceShape->isFace()) {
370 aFace = aFaceShape->face();
372 else if (aFaceShape->isCompound()) {
373 GeomAPI_ShapeIterator anIt(aFaceShape);
374 aFace = anIt.current()->face();
377 return GeomShapePtr();
378 aFace = makeRectangularFace(aFace, aFace->getPlane());
381 AttributeSelectionPtr anAxisSelection = selection(AXIS());
382 GeomShapePtr anAxisShape = anAxisSelection->value();
383 if(!anAxisShape.get()) {
384 anAxisShape = anAxisSelection->context()->shape();
386 std::shared_ptr<GeomAPI_Edge> anEdge;
387 if (anAxisShape->isEdge()) {
388 anEdge = anAxisShape->edge();
390 else if (anAxisShape->isCompound()) {
391 GeomAPI_ShapeIterator anIt(anAxisShape);
392 anEdge = anIt.current()->edge();
395 return GeomShapePtr();
397 std::shared_ptr<GeomAPI_Ax1> anAxis =
398 std::shared_ptr<GeomAPI_Ax1>(new GeomAPI_Ax1(anEdge->line()->location(),
399 anEdge->line()->direction()));
402 double anAngle = real(ANGLE())->value();
404 std::shared_ptr<GeomAlgoAPI_Rotation> aRotationAlgo(
405 new GeomAlgoAPI_Rotation(aFace, anAxis, anAngle));
406 // Checking that the algorithm worked properly.
408 if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aRotationAlgo, getKind(), anError)) {
409 setError("Error: Failed to rotate plane");
410 return GeomShapePtr();
413 std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo->shape()));
417 //==================================================================================================
418 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlanes()
421 AttributeSelectionPtr aFaceSelection1 = selection(PLANE1());
422 GeomShapePtr aFaceShape1 = aFaceSelection1->value();
423 if(!aFaceShape1.get()) {
424 aFaceShape1 = aFaceSelection1->context()->shape();
426 std::shared_ptr<GeomAPI_Face> aFace1;
427 if (aFaceShape1->isFace()) {
428 aFace1 = aFaceShape1->face();
430 else if (aFaceShape1->isCompound()) {
431 GeomAPI_ShapeIterator anIt(aFaceShape1);
432 aFace1 = anIt.current()->face();
435 return GeomShapePtr();
436 std::shared_ptr<GeomAPI_Pln> aPln1 = aFace1->getPlane();
439 AttributeSelectionPtr aFaceSelection2 = selection(PLANE2());
440 GeomShapePtr aFaceShape2 = aFaceSelection2->value();
441 if(!aFaceShape2.get()) {
442 aFaceShape2 = aFaceSelection2->context()->shape();
444 std::shared_ptr<GeomAPI_Face> aFace2;
445 if (aFaceShape2->isFace()) {
446 aFace2 = aFaceShape2->face();
448 else if (aFaceShape2->isCompound()) {
449 GeomAPI_ShapeIterator anIt(aFaceShape2);
450 aFace2 = anIt.current()->face();
453 return GeomShapePtr();
454 std::shared_ptr<GeomAPI_Pln> aPln2 = aFace2->getPlane();
456 std::shared_ptr<GeomAPI_Pnt> anOrig1 = aPln1->location();
457 std::shared_ptr<GeomAPI_Pnt> aPntOnPln2 = aPln2->project(anOrig1);
459 std::shared_ptr<GeomAPI_Pnt> aNewOrig(new GeomAPI_Pnt(anOrig1->xyz()->added(
460 aPntOnPln2->xyz())->multiplied(0.5)));
462 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aNewOrig, aPln1->direction()));
464 std::shared_ptr<GeomAPI_Face> aRes = makeRectangularFace(aFace1, aNewPln);
469 //==================================================================================================
470 GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
471 const std::shared_ptr<GeomAPI_Vertex> theV2,
472 const std::shared_ptr<GeomAPI_Vertex> theV3)
474 std::shared_ptr<GeomAPI_Face> aFace =
475 GeomAlgoAPI_FaceBuilder::planarFaceByThreeVertices(theV1, theV2, theV3);
477 ListOfShape anObjects;
478 anObjects.push_back(theV1);
479 anObjects.push_back(theV2);
480 anObjects.push_back(theV3);
481 std::list<std::shared_ptr<GeomAPI_Pnt> > aBoundingPoints =
482 GeomAlgoAPI_ShapeTools::getBoundingBox(anObjects, 1.0);
483 GeomShapePtr aRes = GeomAlgoAPI_ShapeTools::fitPlaneToBox(aFace, aBoundingPoints);
488 //==================================================================================================
489 std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_Face> theFace,
490 const std::shared_ptr<GeomAPI_Pln> thePln)
492 // Create rectangular face close to the selected
493 double aXmin, aYmin, Zmin, aXmax, aYmax, Zmax;
494 theFace->computeSize(aXmin, aYmin, Zmin, aXmax, aYmax, Zmax);
496 // use all 8 points of the bounding box to find the 2D bounds
498 double aMinX2d = DBL_MAX, aMaxX2d = -DBL_MAX;
499 double aMinY2d = DBL_MAX, aMaxY2d = -DBL_MAX;
500 for(int aXIsMin = 0; aXIsMin < 2; aXIsMin++) {
501 for(int aYIsMin = 0; aYIsMin < 2; aYIsMin++) {
502 for(int aZIsMin = 0; aZIsMin < 2; aZIsMin++) {
503 std::shared_ptr<GeomAPI_Pnt> aPnt(new GeomAPI_Pnt(
504 aXIsMin ? aXmin : aXmax, aYIsMin ? aYmin : aYmax, aZIsMin ? Zmin : Zmax));
505 std::shared_ptr<GeomAPI_Pnt2d> aPnt2d = aPnt->to2D(thePln);
506 if (isFirst || aPnt2d->x() < aMinX2d)
507 aMinX2d = aPnt2d->x();
508 if (isFirst || aPnt2d->y() < aMinY2d)
509 aMinY2d = aPnt2d->y();
510 if (isFirst || aPnt2d->x() > aMaxX2d)
511 aMaxX2d = aPnt2d->x();
512 if (isFirst || aPnt2d->y() > aMaxY2d)
513 aMaxY2d = aPnt2d->y();
519 double aWgap = (aMaxX2d - aMinX2d) * 0.1;
520 double aHgap = (aMaxY2d - aMinY2d) * 0.1;
521 std::shared_ptr<GeomAPI_Face> aResFace = GeomAlgoAPI_FaceBuilder::planarFace(thePln,
522 aMinX2d - aWgap, aMinY2d - aHgap, aMaxX2d - aMinX2d + 2. * aWgap,
523 aMaxY2d - aMinY2d + 2. * aHgap);