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_Point.h"
23 #include <ModelAPI_AttributeBoolean.h>
24 #include <ModelAPI_AttributeDouble.h>
25 #include <ModelAPI_AttributeSelection.h>
26 #include <ModelAPI_AttributeString.h>
27 #include <ModelAPI_ResultConstruction.h>
29 #include <GeomAlgoAPI_PointBuilder.h>
30 #include <GeomAlgoAPI_ShapeTools.h>
32 #include <GeomAPI_Edge.h>
33 #include <GeomAPI_Pnt.h>
34 #include <GeomAPI_Vertex.h>
35 #include <GeomAPI_Pln.h>
37 //==================================================================================================
38 ConstructionPlugin_Point::ConstructionPlugin_Point()
42 //==================================================================================================
43 const std::string& ConstructionPlugin_Point::getKind()
45 static std::string MY_KIND = ConstructionPlugin_Point::ID();
49 //==================================================================================================
50 void ConstructionPlugin_Point::initAttributes()
52 data()->addAttribute(X(), ModelAPI_AttributeDouble::typeId());
53 data()->addAttribute(Y(), ModelAPI_AttributeDouble::typeId());
54 data()->addAttribute(Z(), ModelAPI_AttributeDouble::typeId());
56 data()->addAttribute(CREATION_METHOD(), ModelAPI_AttributeString::typeId());
59 data()->addAttribute(POINT(), ModelAPI_AttributeSelection::typeId());
60 data()->addAttribute(PLANE(), ModelAPI_AttributeSelection::typeId());
62 data()->addAttribute(FIRST_LINE(), ModelAPI_AttributeSelection::typeId());
63 data()->addAttribute(SECOND_LINE(), ModelAPI_AttributeSelection::typeId());
66 data()->addAttribute(INTERSECTION_LINE(), ModelAPI_AttributeSelection::typeId());
67 data()->addAttribute(INTERSECTION_PLANE(), ModelAPI_AttributeSelection::typeId());
69 data()->addAttribute(USE_OFFSET(), ModelAPI_AttributeString::typeId());
70 data()->addAttribute(OFFSET(), ModelAPI_AttributeDouble::typeId());
71 data()->addAttribute(REVERSE_OFFSET(), ModelAPI_AttributeBoolean::typeId());
73 data()->addAttribute(EDGE(), ModelAPI_AttributeSelection::typeId());
74 data()->addAttribute(OFFSET_TYPE(), ModelAPI_AttributeString::typeId());
75 data()->addAttribute(DISTANCE(), ModelAPI_AttributeDouble::typeId());
76 data()->addAttribute(RATIO(), ModelAPI_AttributeDouble::typeId());
77 data()->addAttribute(REVERSE(), ModelAPI_AttributeBoolean::typeId());
80 //==================================================================================================
81 void ConstructionPlugin_Point::execute()
85 // to support compatibility with old documents where aCreationMethod did not exist
86 std::string aCreationMethod =
87 string(CREATION_METHOD()).get() && !string(CREATION_METHOD())->value().empty() ?
88 string(CREATION_METHOD())->value() : CREATION_METHOD_BY_XYZ();
89 if(aCreationMethod == CREATION_METHOD_BY_XYZ()) {
90 aShape = createByXYZ();
91 } else if(aCreationMethod == CREATION_METHOD_BY_DISTANCE_ON_EDGE()) {
92 aShape = createByDistanceOnEdge();
93 }/* else if(aCreationMethod == CREATION_METHOD_BY_PROJECTION()) {
94 aShape = createByProjection();
95 } else if(aCreationMethod == CREATION_METHOD_BY_LINES_INTERSECTION()) {
96 aShape = createByLinesIntersection();
97 }*/ else if(aCreationMethod == CREATION_METHOD_BY_LINE_AND_PLANE_INTERSECTION()) {
98 // this may produce several points
99 std::list<std::shared_ptr<GeomAPI_Vertex> > aPoints = createByLineAndPlaneIntersection();
100 if (!aPoints.empty()) { // if no points found produce the standard error later
102 std::list<std::shared_ptr<GeomAPI_Vertex> >::iterator aPIter = aPoints.begin();
103 for(; aPIter != aPoints.end(); aPIter++, anIndex++) {
104 std::shared_ptr<ModelAPI_ResultConstruction> aConstr =
105 document()->createConstruction(data(), anIndex);
106 aConstr->setShape(*aPIter);
107 setResult(aConstr, anIndex);
109 removeResults(anIndex);
115 setError("Error: intersection not found.");
119 removeResults(1); // for case the point type was switched from multi-results type
120 std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
121 aConstr->setShape(aShape);
125 //==================================================================================================
126 bool ConstructionPlugin_Point::customisePresentation(ResultPtr theResult,
128 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
130 bool isCustomized = theDefaultPrs.get() != NULL &&
131 theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
132 //thePrs->setPointMarker(1, 1.); // Set point as a '+' symbol
136 //==================================================================================================
137 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByXYZ()
139 return GeomAlgoAPI_PointBuilder::vertex(real(X())->value(),
144 //==================================================================================================
145 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByDistanceOnEdge()
148 AttributeSelectionPtr anEdgeSelection = selection(EDGE());
149 GeomShapePtr aShape = anEdgeSelection->value();
151 aShape = anEdgeSelection->context()->shape();
153 std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aShape));
155 // Get distance value and percent flag.
157 bool anIsPercent = false;
158 if (string(OFFSET_TYPE())->value() == OFFSET_TYPE_BY_DISTANCE()) {
159 aValue = real(DISTANCE())->value();
162 aValue = real(RATIO())->value() * 100.0;
167 bool anIsReverse = boolean(REVERSE())->value();
169 return GeomAlgoAPI_PointBuilder::vertexOnEdge(anEdge, aValue, anIsPercent, anIsReverse);
172 //==================================================================================================
173 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByProjection()
176 AttributeSelectionPtr aPointSelection = selection(POINT());
177 GeomShapePtr aPointShape = aPointSelection->value();
178 if(!aPointShape.get()) {
179 aPointShape = aPointSelection->context()->shape();
181 std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
184 AttributeSelectionPtr aPlaneSelection = selection(PLANE());
185 GeomShapePtr aPlaneShape = aPlaneSelection->value();
186 if(!aPlaneShape.get()) {
187 aPlaneShape = aPlaneSelection->context()->shape();
189 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aPlaneShape));
191 return GeomAlgoAPI_PointBuilder::vertexByProjection(aVertex, aFace);
194 //==================================================================================================
195 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByLinesIntersection()
198 AttributeSelectionPtr aFirstLineSelection= selection(FIRST_LINE());
199 GeomShapePtr aFirstLineShape = aFirstLineSelection->value();
200 if(!aFirstLineShape.get()) {
201 aFirstLineShape = aFirstLineSelection->context()->shape();
203 std::shared_ptr<GeomAPI_Edge> aFirstEdge(new GeomAPI_Edge(aFirstLineShape));
206 AttributeSelectionPtr aSecondLineSelection= selection(SECOND_LINE());
207 GeomShapePtr aSecondLineShape = aSecondLineSelection->value();
208 if(!aSecondLineShape.get()) {
209 aSecondLineShape = aSecondLineSelection->context()->shape();
211 std::shared_ptr<GeomAPI_Edge> aSecondEdge(new GeomAPI_Edge(aSecondLineShape));
213 return GeomAlgoAPI_PointBuilder::vertexByIntersection(aFirstEdge, aSecondEdge);
217 //==================================================================================================
218 std::list<std::shared_ptr<GeomAPI_Vertex> >
219 ConstructionPlugin_Point::createByLineAndPlaneIntersection()
222 AttributeSelectionPtr aLineSelection = selection(INTERSECTION_LINE());
223 GeomShapePtr aLineShape = aLineSelection->value();
224 if(!aLineShape.get()) {
225 aLineShape = aLineSelection->context()->shape();
227 std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aLineShape));
230 AttributeSelectionPtr aPlaneSelection= selection(INTERSECTION_PLANE());
231 GeomShapePtr aPlaneShape = aPlaneSelection->value();
232 if(!aPlaneShape.get()) {
233 aPlaneShape = aPlaneSelection->context()->shape();
235 std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aPlaneShape));
237 if (!string(USE_OFFSET())->value().empty()) {
238 double anOffset = real(OFFSET())->value();
239 if (boolean(REVERSE_OFFSET())->value())
240 anOffset = -anOffset;
241 if (fabs(anOffset) > 1.e-9) { // move face
242 aFace->translate(aFace->getPlane()->direction(), anOffset);
246 return GeomAlgoAPI_ShapeTools::intersect(anEdge, aFace,
247 aPlaneSelection->context()->groupName() == ModelAPI_ResultConstruction::group());