src/ConstructionPlugin/ConstructionPlugin_Point.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_Point.h"
  22
  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>
  28
  29 #include <GeomAlgoAPI_PointBuilder.h>
  30 #include <GeomAlgoAPI_ShapeTools.h>
  31
  32 #include <GeomAPI_Edge.h>
  33 #include <GeomAPI_Pnt.h>
  34 #include <GeomAPI_Vertex.h>
  35 #include <GeomAPI_Pln.h>
  36
  37 //==================================================================================================
  38 ConstructionPlugin_Point::ConstructionPlugin_Point()
  39 {
  40 }
  41
  42 //==================================================================================================
  43 const std::string& ConstructionPlugin_Point::getKind()
  44 {
  45   static std::string MY_KIND = ConstructionPlugin_Point::ID();
  46   return MY_KIND;
  47 }
  48
  49 //==================================================================================================
  50 void ConstructionPlugin_Point::initAttributes()
  51 {
  52   data()->addAttribute(X(), ModelAPI_AttributeDouble::typeId());
  53   data()->addAttribute(Y(), ModelAPI_AttributeDouble::typeId());
  54   data()->addAttribute(Z(), ModelAPI_AttributeDouble::typeId());
  55
  56   data()->addAttribute(CREATION_METHOD(), ModelAPI_AttributeString::typeId());
  57
  58 /*
  59   data()->addAttribute(FIRST_LINE(), ModelAPI_AttributeSelection::typeId());
  60   data()->addAttribute(SECOND_LINE(), ModelAPI_AttributeSelection::typeId());
  61 */
  62
  63   data()->addAttribute(INTERSECTION_LINE(), ModelAPI_AttributeSelection::typeId());
  64   data()->addAttribute(INTERSECTION_PLANE(), ModelAPI_AttributeSelection::typeId());
  65
  66   data()->addAttribute(USE_OFFSET(), ModelAPI_AttributeString::typeId());
  67   data()->addAttribute(OFFSET(), ModelAPI_AttributeDouble::typeId());
  68   data()->addAttribute(REVERSE_OFFSET(), ModelAPI_AttributeBoolean::typeId());
  69
  70   data()->addAttribute(EDGE(), ModelAPI_AttributeSelection::typeId());
  71   data()->addAttribute(OFFSET_TYPE(), ModelAPI_AttributeString::typeId());
  72   data()->addAttribute(DISTANCE(), ModelAPI_AttributeDouble::typeId());
  73   data()->addAttribute(RATIO(), ModelAPI_AttributeDouble::typeId());
  74   data()->addAttribute(REVERSE(), ModelAPI_AttributeBoolean::typeId());
  75
  76   data()->addAttribute(POINT_TO_PROJECT_ON_FACE(), ModelAPI_AttributeSelection::typeId());
  77   data()->addAttribute(FACE_FOR_POINT_PROJECTION(), ModelAPI_AttributeSelection::typeId());
  78 }
  79
  80 //==================================================================================================
  81 void ConstructionPlugin_Point::execute()
  82 {
  83   GeomShapePtr aShape;
  84
  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_ON_FACE()) {
  94     aShape = createByProjectionOnFace();
  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
 101       int anIndex = 0;
 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);
 108       }
 109       removeResults(anIndex);
 110       return;
 111     }
 112   }
 113
 114   if(!aShape.get()) {
 115     setError("Error: intersection not found.");
 116     return;
 117   }
 118
 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);
 122   setResult(aConstr);
 123 }
 124
 125 //==================================================================================================
 126 bool ConstructionPlugin_Point::customisePresentation(ResultPtr theResult,
 127                                                      AISObjectPtr thePrs,
 128                                                 std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
 129 {
 130   bool isCustomized = theDefaultPrs.get() != NULL &&
 131                       theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
 132   //thePrs->setPointMarker(1, 1.); // Set point as a '+' symbol
 133   return true;
 134 }
 135
 136 //==================================================================================================
 137 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByXYZ()
 138 {
 139   return GeomAlgoAPI_PointBuilder::vertex(real(X())->value(),
 140                                           real(Y())->value(),
 141                                           real(Z())->value());
 142 }
 143
 144 //==================================================================================================
 145 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByDistanceOnEdge()
 146 {
 147   // Get edge.
 148   AttributeSelectionPtr anEdgeSelection = selection(EDGE());
 149   GeomShapePtr aShape = anEdgeSelection->value();
 150   if(!aShape.get()) {
 151     aShape = anEdgeSelection->context()->shape();
 152   }
 153   std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aShape));
 154
 155   // Get distance value and percent flag.
 156   double aValue;
 157   bool anIsPercent = false;
 158   if (string(OFFSET_TYPE())->value() == OFFSET_TYPE_BY_DISTANCE()) {
 159     aValue = real(DISTANCE())->value();
 160     anIsPercent = false;
 161   } else {
 162     aValue = real(RATIO())->value() * 100.0;
 163     anIsPercent = true;
 164   }
 165
 166   // Get reverse flag.
 167   bool anIsReverse = boolean(REVERSE())->value();
 168
 169   return GeomAlgoAPI_PointBuilder::vertexOnEdge(anEdge, aValue, anIsPercent, anIsReverse);
 170 }
 171
 172 //==================================================================================================
 173 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByProjectionOnFace()
 174 {
 175   // Get point.
 176   AttributeSelectionPtr aPointSelection = selection(POINT_TO_PROJECT_ON_FACE());
 177   GeomShapePtr aPointShape = aPointSelection->value();
 178   if(!aPointShape.get()) {
 179     aPointShape = aPointSelection->context()->shape();
 180   }
 181   std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
 182
 183   // Get plane.
 184   AttributeSelectionPtr aPlaneSelection = selection(FACE_FOR_POINT_PROJECTION());
 185   GeomShapePtr aPlaneShape = aPlaneSelection->value();
 186   if(!aPlaneShape.get()) {
 187     aPlaneShape = aPlaneSelection->context()->shape();
 188   }
 189   std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aPlaneShape));
 190
 191   return GeomAlgoAPI_PointBuilder::vertexByProjection(aVertex, aFace);
 192 }
 193
 194 /*
 195 //==================================================================================================
 196 std::shared_ptr<GeomAPI_Vertex> ConstructionPlugin_Point::createByLinesIntersection()
 197 {
 198   // Get first line.
 199   AttributeSelectionPtr aFirstLineSelection= selection(FIRST_LINE());
 200   GeomShapePtr aFirstLineShape = aFirstLineSelection->value();
 201   if(!aFirstLineShape.get()) {
 202     aFirstLineShape = aFirstLineSelection->context()->shape();
 203   }
 204   std::shared_ptr<GeomAPI_Edge> aFirstEdge(new GeomAPI_Edge(aFirstLineShape));
 205
 206   // Get second line.
 207   AttributeSelectionPtr aSecondLineSelection= selection(SECOND_LINE());
 208   GeomShapePtr aSecondLineShape = aSecondLineSelection->value();
 209   if(!aSecondLineShape.get()) {
 210     aSecondLineShape = aSecondLineSelection->context()->shape();
 211   }
 212   std::shared_ptr<GeomAPI_Edge> aSecondEdge(new GeomAPI_Edge(aSecondLineShape));
 213
 214   return GeomAlgoAPI_PointBuilder::vertexByIntersection(aFirstEdge, aSecondEdge);
 215 }
 216 */
 217
 218 //==================================================================================================
 219 std::list<std::shared_ptr<GeomAPI_Vertex> >
 220   ConstructionPlugin_Point::createByLineAndPlaneIntersection()
 221 {
 222   // Get line.
 223   AttributeSelectionPtr aLineSelection = selection(INTERSECTION_LINE());
 224   GeomShapePtr aLineShape = aLineSelection->value();
 225   if(!aLineShape.get()) {
 226     aLineShape = aLineSelection->context()->shape();
 227   }
 228   std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aLineShape));
 229
 230   // Get plane.
 231   AttributeSelectionPtr aPlaneSelection= selection(INTERSECTION_PLANE());
 232   GeomShapePtr aPlaneShape = aPlaneSelection->value();
 233   if(!aPlaneShape.get()) {
 234     aPlaneShape = aPlaneSelection->context()->shape();
 235   }
 236   std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aPlaneShape));
 237
 238   if (!string(USE_OFFSET())->value().empty()) {
 239     double anOffset = real(OFFSET())->value();
 240     if (boolean(REVERSE_OFFSET())->value())
 241       anOffset = -anOffset;
 242     if (fabs(anOffset) > 1.e-9) { // move face
 243       aFace->translate(aFace->getPlane()->direction(), anOffset);
 244     }
 245   }
 246
 247   return GeomAlgoAPI_ShapeTools::intersect(anEdge, aFace,
 248     aPlaneSelection->context()->groupName() == ModelAPI_ResultConstruction::group());
 249 }