1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ConstructionPlugin_Plane.cpp
4 // Created: 12 Dec 2014
5 // Author: Vitaly Smetannikov
7 #include "ConstructionPlugin_Plane.h"
9 #include <Config_PropManager.h>
11 #include <GeomAlgoAPI_FaceBuilder.h>
12 #include <GeomAlgoAPI_Rotation.h>
13 #include <GeomAlgoAPI_ShapeTools.h>
15 #include <GeomAPI_Ax1.h>
16 #include <GeomAPI_Edge.h>
17 #include <GeomAPI_Face.h>
18 #include <GeomAPI_Lin.h>
19 #include <GeomAPI_Pln.h>
20 #include <GeomAPI_Pnt.h>
21 #include <GeomAPI_Pnt2d.h>
22 #include <GeomAPI_Vertex.h>
23 #include <GeomAPI_XYZ.h>
25 #include <ModelAPI_AttributeDouble.h>
26 #include <ModelAPI_AttributeIntArray.h>
27 #include <ModelAPI_AttributeSelection.h>
28 #include <ModelAPI_AttributeString.h>
29 #include <ModelAPI_AttributeBoolean.h>
30 #include <ModelAPI_ResultConstruction.h>
31 #include <ModelAPI_Session.h>
32 #include <ModelAPI_Validator.h>
34 static GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
35 const std::shared_ptr<GeomAPI_Vertex> theV2,
36 const std::shared_ptr<GeomAPI_Vertex> theV3);
37 static std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_Face> theFace,
38 const std::shared_ptr<GeomAPI_Pln> thePln);
40 //==================================================================================================
41 ConstructionPlugin_Plane::ConstructionPlugin_Plane()
45 //==================================================================================================
46 void ConstructionPlugin_Plane::initAttributes()
48 data()->addAttribute(ConstructionPlugin_Plane::CREATION_METHOD(), ModelAPI_AttributeString::typeId());
50 data()->addAttribute(PLANE(), ModelAPI_AttributeSelection::typeId());
51 data()->addAttribute(DISTANCE(), ModelAPI_AttributeDouble::typeId());
52 // By general equation.
53 data()->addAttribute(A(), ModelAPI_AttributeDouble::typeId());
54 data()->addAttribute(B(), ModelAPI_AttributeDouble::typeId());
55 data()->addAttribute(C(), ModelAPI_AttributeDouble::typeId());
56 data()->addAttribute(D(), ModelAPI_AttributeDouble::typeId());
57 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), A());
58 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), B());
59 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), C());
60 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), D());
63 data()->addAttribute(POINT1(), ModelAPI_AttributeSelection::typeId());
64 data()->addAttribute(POINT2(), ModelAPI_AttributeSelection::typeId());
65 data()->addAttribute(POINT3(), ModelAPI_AttributeSelection::typeId());
68 data()->addAttribute(LINE(), ModelAPI_AttributeSelection::typeId());
69 data()->addAttribute(POINT(), ModelAPI_AttributeSelection::typeId());
70 data()->addAttribute(PERPENDICULAR(), ModelAPI_AttributeBoolean::typeId());
73 data()->addAttribute(CREATION_METHOD_BY_OTHER_PLANE_OPTION(), ModelAPI_AttributeString::typeId());
74 data()->addAttribute(REVERSE(), ModelAPI_AttributeBoolean::typeId());
75 data()->addAttribute(COINCIDENT_POINT(), ModelAPI_AttributeSelection::typeId());
76 data()->addAttribute(AXIS(), ModelAPI_AttributeSelection::typeId());
77 data()->addAttribute(ANGLE(), ModelAPI_AttributeDouble::typeId());
79 // By two parallel planes.
80 data()->addAttribute(PLANE1(), ModelAPI_AttributeSelection::typeId());
81 data()->addAttribute(PLANE2(), ModelAPI_AttributeSelection::typeId());
84 //==================================================================================================
85 void ConstructionPlugin_Plane::execute()
89 std::string aCreationMethod = string(CREATION_METHOD())->value();
90 if(aCreationMethod == CREATION_METHOD_BY_GENERAL_EQUATION() || aCreationMethod == "PlaneByGeneralEquation") {
91 aShape = createByGeneralEquation();
92 } else if(aCreationMethod == CREATION_METHOD_BY_THREE_POINTS()) {
93 aShape = createByThreePoints();
94 } else if(aCreationMethod == CREATION_METHOD_BY_LINE_AND_POINT()) {
95 aShape = createByLineAndPoint();
96 } else if(aCreationMethod == CREATION_METHOD_BY_OTHER_PLANE()) {
97 std::string aCreationMethodOption = string(CREATION_METHOD_BY_OTHER_PLANE_OPTION())->value();
98 if(aCreationMethodOption == CREATION_METHOD_BY_DISTANCE_FROM_OTHER()) {
99 aShape = createByDistanceFromOther();
100 } else if(aCreationMethodOption == CREATION_METHOD_BY_COINCIDENT_TO_POINT()) {
101 aShape = createByCoincidentPoint();
102 } else if(aCreationMethodOption == CREATION_METHOD_BY_ROTATION()) {
103 aShape = createByRotation();
105 } else if(aCreationMethod == CREATION_METHOD_BY_TWO_PARALLEL_PLANES()) {
106 aShape = createByTwoParallelPlanes();
108 setError("Error: Plane creation method \"" + aCreationMethod + "\" not supported.");
113 setError("Error: Could not create a plane.");
117 ResultConstructionPtr aConstr = document()->createConstruction(data());
118 aConstr->setInfinite(true);
119 aConstr->setShape(aShape);
123 //==================================================================================================
124 bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
125 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
127 std::vector<int> aColor;
128 // get color from the attribute of the result
129 if (theResult.get() != NULL && theResult->data()->attribute(ModelAPI_Result::COLOR_ID()).get() != NULL) {
130 AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
131 if (aColorAttr.get() && aColorAttr->size()) {
132 aColor.push_back(aColorAttr->value(0));
133 aColor.push_back(aColorAttr->value(1));
134 aColor.push_back(aColorAttr->value(2));
138 aColor = Config_PropManager::color("Visualization", "construction_plane_color",
139 ConstructionPlugin_Plane::DEFAULT_COLOR());
141 bool isCustomized = false;
142 if (aColor.size() == 3)
143 isCustomized = thePrs->setColor(aColor[0], aColor[1], aColor[2]);
145 isCustomized = thePrs->setTransparensy(0.6) || isCustomized;
150 //==================================================================================================
151 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByGeneralEquation()
153 AttributeDoublePtr anAttrA = real(ConstructionPlugin_Plane::A());
154 AttributeDoublePtr anAttrB = real(ConstructionPlugin_Plane::B());
155 AttributeDoublePtr anAttrC = real(ConstructionPlugin_Plane::C());
156 AttributeDoublePtr anAttrD = real(ConstructionPlugin_Plane::D());
157 std::shared_ptr<GeomAPI_Shape> aPlaneFace;
158 if ((anAttrA.get() != NULL) && (anAttrB.get() != NULL) &&
159 (anAttrC.get() != NULL) && (anAttrD.get() != NULL) &&
160 anAttrA->isInitialized() && anAttrB->isInitialized() &&
161 anAttrC->isInitialized() && anAttrD->isInitialized() ) {
162 double aA = anAttrA->value(), aB = anAttrB->value(),
163 aC = anAttrC->value(), aD = anAttrD->value();
164 std::shared_ptr<GeomAPI_Pln> aPlane =
165 std::shared_ptr<GeomAPI_Pln>(new GeomAPI_Pln(aA, aB, aC, aD));
166 std::string kDefaultPlaneSize = "200";
167 double aSize = Config_PropManager::integer(SKETCH_TAB_NAME, "planes_size", kDefaultPlaneSize);
169 aPlaneFace = GeomAlgoAPI_FaceBuilder::squareFace(aPlane, aSize);
174 //==================================================================================================
175 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByThreePoints()
178 AttributeSelectionPtr aPointSelection1 = selection(POINT1());
179 GeomShapePtr aPointShape1 = aPointSelection1->value();
180 if(!aPointShape1.get()) {
181 aPointShape1 = aPointSelection1->context()->shape();
183 std::shared_ptr<GeomAPI_Vertex> aVertex1(new GeomAPI_Vertex(aPointShape1));
186 AttributeSelectionPtr aPointSelection2 = selection(POINT2());
187 GeomShapePtr aPointShape2 = aPointSelection2->value();
188 if(!aPointShape2.get()) {
189 aPointShape2 = aPointSelection2->context()->shape();
191 std::shared_ptr<GeomAPI_Vertex> aVertex2(new GeomAPI_Vertex(aPointShape2));
194 AttributeSelectionPtr aPointSelection3 = selection(POINT3());
195 GeomShapePtr aPointShape3 = aPointSelection3->value();
196 if(!aPointShape3.get()) {
197 aPointShape3 = aPointSelection3->context()->shape();
199 std::shared_ptr<GeomAPI_Vertex> aVertex3(new GeomAPI_Vertex(aPointShape3));
201 GeomShapePtr aRes = faceByThreeVertices(aVertex1, aVertex2, aVertex3);
206 //==================================================================================================
207 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
210 AttributeSelectionPtr anEdgeSelection = selection(LINE());
211 GeomShapePtr aLineShape = anEdgeSelection->value();
212 if(!aLineShape.get()) {
213 aLineShape = anEdgeSelection->context()->shape();
215 std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aLineShape));
218 AttributeSelectionPtr aPointSelection = selection(POINT());
219 GeomShapePtr aPointShape = aPointSelection->value();
220 if(!aPointShape.get()) {
221 aPointShape = aPointSelection->context()->shape();
223 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
225 // Get perpendicular flag.
226 bool anIsPerpendicular= boolean(PERPENDICULAR())->value();
229 if(anIsPerpendicular) {
230 std::shared_ptr<GeomAPI_Lin> aLin = anEdge->line();
231 std::shared_ptr<GeomAPI_Pnt> aPnt = aVertex->point();
232 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aPnt, aLin->direction()));
233 double aSize = aLin->distance(aPnt) * 2;
234 // point may belong to line, so for the face size use maximum distance between point and line
235 // and the line size (distance between the start and end point)
236 double aDistance = anEdge->firstPoint()->distance(anEdge->lastPoint());
237 aRes = GeomAlgoAPI_FaceBuilder::squareFace(aNewPln, aSize > aDistance ? aSize : aDistance);
239 std::shared_ptr<GeomAPI_Vertex> aV1, aV2;
240 GeomAlgoAPI_ShapeTools::findBounds(anEdge, aV1, aV2);
241 aRes = faceByThreeVertices(aV1, aV2, aVertex);
247 //==================================================================================================
248 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOther()
250 AttributeSelectionPtr aFaceAttr = data()->selection(ConstructionPlugin_Plane::PLANE());
251 AttributeDoublePtr aDistAttr = data()->real(ConstructionPlugin_Plane::DISTANCE());
252 std::shared_ptr<GeomAPI_Shape> aPlane;
253 if ((aFaceAttr.get() != NULL) &&
254 (aDistAttr.get() != NULL) &&
255 aFaceAttr->isInitialized() && aDistAttr->isInitialized()) {
257 double aDist = aDistAttr->value();
258 bool anIsReverse = boolean(REVERSE())->value();
259 if(anIsReverse) aDist = -aDist;
260 GeomShapePtr aShape = aFaceAttr->value();
262 aShape = aFaceAttr->context()->shape();
269 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aShape));
271 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
272 std::shared_ptr<GeomAPI_Pnt> aOrig = aPln->location();
273 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
275 aOrig->translate(aDir, aDist);
276 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
278 aPlane = makeRectangularFace(aFace, aNewPln);
283 //==================================================================================================
284 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint()
287 AttributeSelectionPtr aFaceSelection = selection(PLANE());
288 GeomShapePtr aFaceShape = aFaceSelection->value();
289 if(!aFaceShape.get()) {
290 aFaceShape = aFaceSelection->context()->shape();
292 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aFaceShape));
295 AttributeSelectionPtr aPointSelection = selection(COINCIDENT_POINT());
296 GeomShapePtr aPointShape = aPointSelection->value();
297 if(!aPointShape.get()) {
298 aPointShape = aPointSelection->context()->shape();
300 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
302 std::shared_ptr<GeomAPI_Pnt> anOrig = aVertex->point();
303 std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
304 std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
306 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(anOrig, aDir));
308 return makeRectangularFace(aFace, aNewPln);
311 //==================================================================================================
312 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
315 AttributeSelectionPtr aFaceSelection = selection(PLANE());
316 GeomShapePtr aFaceShape = aFaceSelection->value();
317 if(!aFaceShape.get()) {
318 aFaceShape = aFaceSelection->context()->shape();
320 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aFaceShape));
321 aFace = makeRectangularFace(aFace, aFace->getPlane());
324 AttributeSelectionPtr anAxisSelection = selection(AXIS());
325 GeomShapePtr anAxisShape = anAxisSelection->value();
326 if(!anAxisShape.get()) {
327 anAxisShape = anAxisSelection->context()->shape();
329 std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(anAxisShape));
331 std::shared_ptr<GeomAPI_Ax1> anAxis = std::shared_ptr<GeomAPI_Ax1>(new GeomAPI_Ax1(anEdge->line()->location(),
332 anEdge->line()->direction()));
335 double anAngle = real(ANGLE())->value();
337 GeomAlgoAPI_Rotation aRotationAlgo(aFace, anAxis, anAngle);
338 std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo.shape()));
343 //==================================================================================================
344 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlanes()
347 AttributeSelectionPtr aFaceSelection1 = selection(PLANE1());
348 GeomShapePtr aFaceShape1 = aFaceSelection1->value();
349 if(!aFaceShape1.get()) {
350 aFaceShape1 = aFaceSelection1->context()->shape();
352 std::shared_ptr<GeomAPI_Face> aFace1(new GeomAPI_Face(aFaceShape1));
353 std::shared_ptr<GeomAPI_Pln> aPln1 = aFace1->getPlane();
356 AttributeSelectionPtr aFaceSelection2 = selection(PLANE2());
357 GeomShapePtr aFaceShape2 = aFaceSelection2->value();
358 if(!aFaceShape2.get()) {
359 aFaceShape2 = aFaceSelection2->context()->shape();
361 std::shared_ptr<GeomAPI_Face> aFace2(new GeomAPI_Face(aFaceShape2));
362 std::shared_ptr<GeomAPI_Pln> aPln2 = aFace2->getPlane();
364 std::shared_ptr<GeomAPI_Pnt> anOrig1 = aPln1->location();
365 std::shared_ptr<GeomAPI_Pnt> aPntOnPln2 = aPln2->project(anOrig1);
367 std::shared_ptr<GeomAPI_Pnt> aNewOrig(new GeomAPI_Pnt(anOrig1->xyz()->added(
368 aPntOnPln2->xyz())->multiplied(0.5)));
370 std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aNewOrig, aPln1->direction()));
372 std::shared_ptr<GeomAPI_Face> aRes = makeRectangularFace(aFace1, aNewPln);
377 //==================================================================================================
378 GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
379 const std::shared_ptr<GeomAPI_Vertex> theV2,
380 const std::shared_ptr<GeomAPI_Vertex> theV3)
382 std::shared_ptr<GeomAPI_Face> aFace = GeomAlgoAPI_FaceBuilder::planarFaceByThreeVertices(theV1, theV2, theV3);
384 ListOfShape anObjects;
385 anObjects.push_back(theV1);
386 anObjects.push_back(theV2);
387 anObjects.push_back(theV3);
388 std::list<std::shared_ptr<GeomAPI_Pnt> > aBoundingPoints = GeomAlgoAPI_ShapeTools::getBoundingBox(anObjects, 1.0);
389 GeomShapePtr aRes = GeomAlgoAPI_ShapeTools::fitPlaneToBox(aFace, aBoundingPoints);
394 //==================================================================================================
395 std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_Face> theFace,
396 const std::shared_ptr<GeomAPI_Pln> thePln)
398 // Create rectangular face close to the selected
399 double aXmin, aYmin, Zmin, aXmax, aYmax, Zmax;
400 theFace->computeSize(aXmin, aYmin, Zmin, aXmax, aYmax, Zmax);
402 // use all 8 points of the bounding box to find the 2D bounds
404 double aMinX2d, aMaxX2d, aMinY2d, aMaxY2d;
405 for(int aXIsMin = 0; aXIsMin < 2; aXIsMin++) {
406 for(int aYIsMin = 0; aYIsMin < 2; aYIsMin++) {
407 for(int aZIsMin = 0; aZIsMin < 2; aZIsMin++) {
408 std::shared_ptr<GeomAPI_Pnt> aPnt(new GeomAPI_Pnt(
409 aXIsMin ? aXmin : aXmax, aYIsMin ? aYmin : aYmax, aZIsMin ? Zmin : Zmax));
410 std::shared_ptr<GeomAPI_Pnt2d> aPnt2d = aPnt->to2D(thePln);
411 if (isFirst || aPnt2d->x() < aMinX2d)
412 aMinX2d = aPnt2d->x();
413 if (isFirst || aPnt2d->y() < aMinY2d)
414 aMinY2d = aPnt2d->y();
415 if (isFirst || aPnt2d->x() > aMaxX2d)
416 aMaxX2d = aPnt2d->x();
417 if (isFirst || aPnt2d->y() > aMaxY2d)
418 aMaxY2d = aPnt2d->y();
424 double aWgap = (aMaxX2d - aMinX2d) * 0.1;
425 double aHgap = (aMaxY2d - aMinY2d) * 0.1;
426 std::shared_ptr<GeomAPI_Face> aResFace = GeomAlgoAPI_FaceBuilder::planarFace(thePln,
427 aMinX2d - aWgap, aMinY2d - aHgap, aMaxX2d - aMinX2d + 2. * aWgap, aMaxY2d - aMinY2d + 2. * aHgap);