1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include "ConstructionPlugin_Plane.h"
23 #include <Config_PropManager.h>
25 #include <GeomAlgoAPI_FaceBuilder.h>
26 #include <GeomAlgoAPI_Rotation.h>
27 #include <GeomAlgoAPI_ShapeTools.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>
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);
56 //==================================================================================================
57 ConstructionPlugin_Plane::ConstructionPlugin_Plane()
61 //==================================================================================================
62 void ConstructionPlugin_Plane::initAttributes()
64 data()->addAttribute(ConstructionPlugin_Plane::CREATION_METHOD(),
65 ModelAPI_AttributeString::typeId());
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());
80 data()->addAttribute(POINT1(), ModelAPI_AttributeSelection::typeId());
81 data()->addAttribute(POINT2(), ModelAPI_AttributeSelection::typeId());
82 data()->addAttribute(POINT3(), ModelAPI_AttributeSelection::typeId());
85 data()->addAttribute(LINE(), ModelAPI_AttributeSelection::typeId());
86 data()->addAttribute(POINT(), ModelAPI_AttributeSelection::typeId());
87 data()->addAttribute(PERPENDICULAR(), ModelAPI_AttributeBoolean::typeId());
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());
96 // By two parallel planes.
97 data()->addAttribute(PLANE1(), ModelAPI_AttributeSelection::typeId());
98 data()->addAttribute(PLANE2(), ModelAPI_AttributeSelection::typeId());
101 //==================================================================================================
102 void ConstructionPlugin_Plane::execute()
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();
123 } else if(aCreationMethod == CREATION_METHOD_BY_TWO_PARALLEL_PLANES()) {
124 aShape = createByTwoParallelPlanes();
126 setError("Error: Plane creation method \"" + aCreationMethod + "\" not supported.");
131 setError("Error: Could not create a plane.");
135 ResultConstructionPtr aConstr = document()->createConstruction(data());
136 aConstr->setInfinite(true);
137 aConstr->setShape(aShape);
141 //==================================================================================================
142 bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
143 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
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));
157 aColor = Config_PropManager::color("Visualization", "construction_plane_color");
159 bool isCustomized = false;
160 if (aColor.size() == 3)
161 isCustomized = thePrs->setColor(aColor[0], aColor[1], aColor[2]);
163 isCustomized = thePrs->setTransparensy(0.6) || isCustomized;
168 //==================================================================================================
169 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByGeneralEquation()
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::integer(SKETCH_TAB_NAME, "planes_size");
186 aPlaneFace = GeomAlgoAPI_FaceBuilder::squareFace(aPlane, aSize);
191 //==================================================================================================
192 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByThreePoints()
195 AttributeSelectionPtr aPointSelection1 = selection(POINT1());
196 GeomShapePtr aPointShape1 = aPointSelection1->value();
197 if(!aPointShape1.get()) {
198 aPointShape1 = aPointSelection1->context()->shape();
200 std::shared_ptr<GeomAPI_Vertex> aVertex1(new GeomAPI_Vertex(aPointShape1));
203 AttributeSelectionPtr aPointSelection2 = selection(POINT2());
204 GeomShapePtr aPointShape2 = aPointSelection2->value();
205 if(!aPointShape2.get()) {
206 aPointShape2 = aPointSelection2->context()->shape();
208 std::shared_ptr<GeomAPI_Vertex> aVertex2(new GeomAPI_Vertex(aPointShape2));
211 AttributeSelectionPtr aPointSelection3 = selection(POINT3());
212 GeomShapePtr aPointShape3 = aPointSelection3->value();
213 if(!aPointShape3.get()) {
214 aPointShape3 = aPointSelection3->context()->shape();
216 std::shared_ptr<GeomAPI_Vertex> aVertex3(new GeomAPI_Vertex(aPointShape3));
218 GeomShapePtr aRes = faceByThreeVertices(aVertex1, aVertex2, aVertex3);
223 //==================================================================================================
224 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
227 AttributeSelectionPtr anEdgeSelection = selection(LINE());
228 GeomShapePtr aLineShape = anEdgeSelection->value();
229 if(!aLineShape.get()) {
230 aLineShape = anEdgeSelection->context()->shape();
232 std::shared_ptr<GeomAPI_Edge> anEdge;
233 if (aLineShape->isEdge()) {
234 anEdge = aLineShape->edge();
236 else if (aLineShape->isCompound()) {
237 GeomAPI_ShapeIterator anIt(aLineShape);
238 anEdge = anIt.current()->edge();
242 AttributeSelectionPtr aPointSelection = selection(POINT());
243 GeomShapePtr aPointShape = aPointSelection->value();
244 if(!aPointShape.get()) {
245 aPointShape = aPointSelection->context()->shape();
247 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
249 // Get perpendicular flag.
250 bool anIsPerpendicular= boolean(PERPENDICULAR())->value();
253 if(anIsPerpendicular) {
254 std::shared_ptr<GeomAPI_Lin> aLin = anEdge->line();
255 std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
256 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aPnt, aLin->direction()));
257 double aSize = aLin->distance(aPnt) * 2;
258 // point may belong to line, so for the face size use maximum distance between point and line
259 // and the line size (distance between the start and end point)
260 double aDistance = anEdge->firstPoint()->distance(anEdge->lastPoint());
261 aRes = GeomAlgoAPI_FaceBuilder::squareFace(aNewPln, aSize > aDistance ? aSize : aDistance);
263 std::shared_ptr<GeomAPI_Vertex> aV1, aV2;
264 GeomAlgoAPI_ShapeTools::findBounds(anEdge, aV1, aV2);
265 aRes = faceByThreeVertices(aV1, aV2, aVertex);
271 //==================================================================================================
272 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOther()
274 AttributeSelectionPtr aFaceAttr = data()->selection(ConstructionPlugin_Plane::PLANE());
275 AttributeDoublePtr aDistAttr = data()->real(ConstructionPlugin_Plane::DISTANCE());
276 std::shared_ptr<GeomAPI_Shape> aPlane;
277 if ((aFaceAttr.get() != NULL) &&
278 (aDistAttr.get() != NULL) &&
279 aFaceAttr->isInitialized() && aDistAttr->isInitialized()) {
281 double aDist = aDistAttr->value();
282 bool anIsReverse = boolean(REVERSE())->value();
283 if(anIsReverse) aDist = -aDist;
284 GeomShapePtr aShape = aFaceAttr->value();
286 aShape = aFaceAttr->context()->shape();
293 std::shared_ptr<GeomAPI_Face> aFace;
294 if (aShape->isFace()) {
295 aFace = aShape->face();
297 else if (aShape->isCompound()) {
298 GeomAPI_ShapeIterator anIt(aShape);
299 aFace = anIt.current()->face();
302 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
303 std::shared_ptr<GeomAPI_Pnt> aOrig = aPln->location();
304 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
306 aOrig->translate(aDir, aDist);
307 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
309 aPlane = makeRectangularFace(aFace, aNewPln);
314 //==================================================================================================
315 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint()
318 AttributeSelectionPtr aFaceSelection = selection(PLANE());
319 GeomShapePtr aFaceShape = aFaceSelection->value();
320 if(!aFaceShape.get()) {
321 aFaceShape = aFaceSelection->context()->shape();
323 std::shared_ptr<GeomAPI_Face> aFace;
324 if (aFaceShape->isFace()) {
325 aFace = aFaceShape->face();
327 else if (aFaceShape->isCompound()) {
328 GeomAPI_ShapeIterator anIt(aFaceShape);
329 aFace = anIt.current()->face();
333 AttributeSelectionPtr aPointSelection = selection(COINCIDENT_POINT());
334 GeomShapePtr aPointShape = aPointSelection->value();
335 if(!aPointShape.get()) {
336 aPointShape = aPointSelection->context()->shape();
338 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
340 std::shared_ptr<GeomAPI_Pnt> anOrig = aVertex->point();
341 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
342 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
344 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(anOrig, aDir));
346 return makeRectangularFace(aFace, aNewPln);
349 //==================================================================================================
350 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
353 AttributeSelectionPtr aFaceSelection = selection(PLANE());
354 GeomShapePtr aFaceShape = aFaceSelection->value();
355 if(!aFaceShape.get()) {
356 aFaceShape = aFaceSelection->context()->shape();
358 std::shared_ptr<GeomAPI_Face> aFace;
359 if (aFaceShape->isFace()) {
360 aFace = aFaceShape->face();
362 else if (aFaceShape->isCompound()) {
363 GeomAPI_ShapeIterator anIt(aFaceShape);
364 aFace = anIt.current()->face();
366 aFace = makeRectangularFace(aFace, aFace->getPlane());
369 AttributeSelectionPtr anAxisSelection = selection(AXIS());
370 GeomShapePtr anAxisShape = anAxisSelection->value();
371 if(!anAxisShape.get()) {
372 anAxisShape = anAxisSelection->context()->shape();
374 std::shared_ptr<GeomAPI_Edge> anEdge;
375 if (anAxisShape->isEdge()) {
376 anEdge = anAxisShape->edge();
378 else if (anAxisShape->isCompound()) {
379 GeomAPI_ShapeIterator anIt(anAxisShape);
380 anEdge = anIt.current()->edge();
383 std::shared_ptr<GeomAPI_Ax1> anAxis =
384 std::shared_ptr<GeomAPI_Ax1>(new GeomAPI_Ax1(anEdge->line()->location(),
385 anEdge->line()->direction()));
388 double anAngle = real(ANGLE())->value();
390 GeomAlgoAPI_Rotation aRotationAlgo(aFace, anAxis, anAngle);
391 if (!aRotationAlgo.check()) {
392 setError(aRotationAlgo.getError());
393 return GeomShapePtr();
395 aRotationAlgo.build();
396 if (!aRotationAlgo.isDone()) {
397 setError("Error: Failed to rotate plane");
398 return GeomShapePtr();
401 std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo.shape()));
405 //==================================================================================================
406 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlanes()
409 AttributeSelectionPtr aFaceSelection1 = selection(PLANE1());
410 GeomShapePtr aFaceShape1 = aFaceSelection1->value();
411 if(!aFaceShape1.get()) {
412 aFaceShape1 = aFaceSelection1->context()->shape();
414 std::shared_ptr<GeomAPI_Face> aFace1;
415 if (aFaceShape1->isFace()) {
416 aFace1 = aFaceShape1->face();
418 else if (aFaceShape1->isCompound()) {
419 GeomAPI_ShapeIterator anIt(aFaceShape1);
420 aFace1 = anIt.current()->face();
422 std::shared_ptr<GeomAPI_Pln> aPln1 = aFace1->getPlane();
425 AttributeSelectionPtr aFaceSelection2 = selection(PLANE2());
426 GeomShapePtr aFaceShape2 = aFaceSelection2->value();
427 if(!aFaceShape2.get()) {
428 aFaceShape2 = aFaceSelection2->context()->shape();
430 std::shared_ptr<GeomAPI_Face> aFace2;
431 if (aFaceShape2->isFace()) {
432 aFace2 = aFaceShape2->face();
434 else if (aFaceShape2->isCompound()) {
435 GeomAPI_ShapeIterator anIt(aFaceShape2);
436 aFace2 = anIt.current()->face();
438 std::shared_ptr<GeomAPI_Pln> aPln2 = aFace2->getPlane();
440 std::shared_ptr<GeomAPI_Pnt> anOrig1 = aPln1->location();
441 std::shared_ptr<GeomAPI_Pnt> aPntOnPln2 = aPln2->project(anOrig1);
443 std::shared_ptr<GeomAPI_Pnt> aNewOrig(new GeomAPI_Pnt(anOrig1->xyz()->added(
444 aPntOnPln2->xyz())->multiplied(0.5)));
446 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aNewOrig, aPln1->direction()));
448 std::shared_ptr<GeomAPI_Face> aRes = makeRectangularFace(aFace1, aNewPln);
453 //==================================================================================================
454 GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
455 const std::shared_ptr<GeomAPI_Vertex> theV2,
456 const std::shared_ptr<GeomAPI_Vertex> theV3)
458 std::shared_ptr<GeomAPI_Face> aFace =
459 GeomAlgoAPI_FaceBuilder::planarFaceByThreeVertices(theV1, theV2, theV3);
461 ListOfShape anObjects;
462 anObjects.push_back(theV1);
463 anObjects.push_back(theV2);
464 anObjects.push_back(theV3);
465 std::list<std::shared_ptr<GeomAPI_Pnt> > aBoundingPoints =
466 GeomAlgoAPI_ShapeTools::getBoundingBox(anObjects, 1.0);
467 GeomShapePtr aRes = GeomAlgoAPI_ShapeTools::fitPlaneToBox(aFace, aBoundingPoints);
472 //==================================================================================================
473 std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_Face> theFace,
474 const std::shared_ptr<GeomAPI_Pln> thePln)
476 // Create rectangular face close to the selected
477 double aXmin, aYmin, Zmin, aXmax, aYmax, Zmax;
478 theFace->computeSize(aXmin, aYmin, Zmin, aXmax, aYmax, Zmax);
480 // use all 8 points of the bounding box to find the 2D bounds
482 double aMinX2d, aMaxX2d, aMinY2d, aMaxY2d;
483 for(int aXIsMin = 0; aXIsMin < 2; aXIsMin++) {
484 for(int aYIsMin = 0; aYIsMin < 2; aYIsMin++) {
485 for(int aZIsMin = 0; aZIsMin < 2; aZIsMin++) {
486 std::shared_ptr<GeomAPI_Pnt> aPnt(new GeomAPI_Pnt(
487 aXIsMin ? aXmin : aXmax, aYIsMin ? aYmin : aYmax, aZIsMin ? Zmin : Zmax));
488 std::shared_ptr<GeomAPI_Pnt2d> aPnt2d = aPnt->to2D(thePln);
489 if (isFirst || aPnt2d->x() < aMinX2d)
490 aMinX2d = aPnt2d->x();
491 if (isFirst || aPnt2d->y() < aMinY2d)
492 aMinY2d = aPnt2d->y();
493 if (isFirst || aPnt2d->x() > aMaxX2d)
494 aMaxX2d = aPnt2d->x();
495 if (isFirst || aPnt2d->y() > aMaxY2d)
496 aMaxY2d = aPnt2d->y();
502 double aWgap = (aMaxX2d - aMinX2d) * 0.1;
503 double aHgap = (aMaxY2d - aMinY2d) * 0.1;
504 std::shared_ptr<GeomAPI_Face> aResFace = GeomAlgoAPI_FaceBuilder::planarFace(thePln,
505 aMinX2d - aWgap, aMinY2d - aHgap, aMaxX2d - aMinX2d + 2. * aWgap,
506 aMaxY2d - aMinY2d + 2. * aHgap);