src/PrimitivesPlugin/PrimitivesPlugin_Cylinder.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 <PrimitivesPlugin_Cylinder.h>
  22
  23 #include <GeomAPI_Dir.h>
  24 #include <GeomAPI_Edge.h>
  25 #include <GeomAPI_Lin.h>
  26
  27 #include <GeomAlgoAPI_PointBuilder.h>
  28
  29 #include <ModelAPI_AttributeDouble.h>
  30 #include <ModelAPI_AttributeSelection.h>
  31 #include <ModelAPI_AttributeString.h>
  32 #include <ModelAPI_ResultBody.h>
  33 #include <ModelAPI_ResultConstruction.h>
  34 #include <ModelAPI_Session.h>
  35
  36 //=================================================================================================
  37 PrimitivesPlugin_Cylinder::PrimitivesPlugin_Cylinder()
  38 {
  39 }
  40
  41 //=================================================================================================
  42 void PrimitivesPlugin_Cylinder::initAttributes()
  43 {
  44   data()->addAttribute(PrimitivesPlugin_Cylinder::CREATION_METHOD(),
  45                        ModelAPI_AttributeString::typeId());
  46
  47   data()->addAttribute(PrimitivesPlugin_Cylinder::BASE_POINT_ID(),
  48                        ModelAPI_AttributeSelection::typeId());
  49   data()->addAttribute(PrimitivesPlugin_Cylinder::AXIS_ID(),
  50                        ModelAPI_AttributeSelection::typeId());
  51
  52   data()->addAttribute(PrimitivesPlugin_Cylinder::RADIUS_ID(),
  53                        ModelAPI_AttributeDouble::typeId());
  54   data()->addAttribute(PrimitivesPlugin_Cylinder::HEIGHT_ID(),
  55                        ModelAPI_AttributeDouble::typeId());
  56   data()->addAttribute(PrimitivesPlugin_Cylinder::ANGLE_ID(),
  57                        ModelAPI_AttributeDouble::typeId());
  58
  59   // Initialize the base point of the cylinder at the origin if the base point is not filled.
  60   AttributeSelectionPtr aBasePoint = data()->selection(BASE_POINT_ID());
  61   if (!aBasePoint->isInitialized()) {
  62     ObjectPtr aPointObj = ModelAPI_Session::get()->moduleDocument()
  63       ->objectByName(ModelAPI_ResultConstruction::group(), "Origin");
  64     if (aPointObj.get()) {
  65       ResultPtr aPointRes = std::dynamic_pointer_cast<ModelAPI_Result>(aPointObj);
  66       aBasePoint->setValue(aPointRes, std::shared_ptr<GeomAPI_Shape>());
  67     }
  68   }
  69
  70   // Initialize the axis at the OZ axis if the axis is not filled.
  71   AttributeSelectionPtr anAxis = data()->selection(AXIS_ID());
  72   if (!anAxis->isInitialized()) {
  73     ObjectPtr anAxisObj = ModelAPI_Session::get()->moduleDocument()
  74       ->objectByName(ModelAPI_ResultConstruction::group(), "OZ");
  75     if (anAxisObj.get()) {
  76       ResultPtr anAxisRes = std::dynamic_pointer_cast<ModelAPI_Result>(anAxisObj);
  77       anAxis->setValue(anAxisRes, std::shared_ptr<GeomAPI_Shape>());
  78     }
  79   }
  80 }
  81
  82 //=================================================================================================
  83 void PrimitivesPlugin_Cylinder::execute()
  84 {
  85   AttributeStringPtr aMethodTypeAttr = string(PrimitivesPlugin_Cylinder::CREATION_METHOD());
  86   std::string aMethodType = aMethodTypeAttr->value();
  87
  88   if (aMethodType == CREATION_METHOD_CYLINDER()) {
  89     createCylinder(false);
  90   }
  91
  92   if (aMethodType == CREATION_METHOD_CYLINDER_PORTION()) {
  93     createCylinder(true);
  94   }
  95 }
  96
  97 //=================================================================================================
  98 void PrimitivesPlugin_Cylinder::createCylinder(bool withAngle)
  99 {
 100   // Getting point.
 101   std::shared_ptr<GeomAPI_Pnt> aBasePoint;
 102   std::shared_ptr<ModelAPI_AttributeSelection> aPointRef =
 103     selection(PrimitivesPlugin_Cylinder::BASE_POINT_ID());
 104   if (aPointRef.get() != NULL) {
 105     GeomShapePtr aShape1 = aPointRef->value();
 106     if (!aShape1.get()) {
 107       aShape1 = aPointRef->context()->shape();
 108     }
 109     if (aShape1) {
 110       aBasePoint = GeomAlgoAPI_PointBuilder::point(aShape1);
 111     }
 112   }
 113
 114   // Getting axis.
 115   std::shared_ptr<GeomAPI_Ax2> anAxis;
 116   std::shared_ptr<GeomAPI_Edge> anEdge;
 117   std::shared_ptr<ModelAPI_AttributeSelection> anEdgeRef =
 118     selection(PrimitivesPlugin_Cylinder::AXIS_ID());
 119   if(anEdgeRef && anEdgeRef->value() && anEdgeRef->value()->isEdge()) {
 120     anEdge = std::shared_ptr<GeomAPI_Edge>(new GeomAPI_Edge(anEdgeRef->value()));
 121   } else if (anEdgeRef && !anEdgeRef->value() && anEdgeRef->context() &&
 122              anEdgeRef->context()->shape() && anEdgeRef->context()->shape()->isEdge()) {
 123     anEdge = std::shared_ptr<GeomAPI_Edge>(new GeomAPI_Edge(anEdgeRef->context()->shape()));
 124   }
 125   if(anEdge) {
 126     anAxis = std::shared_ptr<GeomAPI_Ax2>(new GeomAPI_Ax2(aBasePoint,
 127                                                           anEdge->line()->direction()));
 128   }
 129
 130   // Getting radius and height
 131   double aRadius = real(PrimitivesPlugin_Cylinder::RADIUS_ID())->value();
 132   double aHeight = real(PrimitivesPlugin_Cylinder::HEIGHT_ID())->value();
 133
 134   std::shared_ptr<GeomAlgoAPI_Cylinder> aCylinderAlgo;
 135   if (withAngle) {
 136     // Getting angle
 137     double anAngle = real(PrimitivesPlugin_Cylinder::ANGLE_ID())->value();
 138     aCylinderAlgo =
 139       std::shared_ptr<GeomAlgoAPI_Cylinder>(new GeomAlgoAPI_Cylinder(anAxis,
 140                                                                      aRadius, aHeight,
 141                                                                      anAngle));
 142   } else {
 143     aCylinderAlgo =
 144       std::shared_ptr<GeomAlgoAPI_Cylinder>(new GeomAlgoAPI_Cylinder(anAxis,
 145                                                                      aRadius, aHeight));
 146   }
 147
 148   // These checks should be made to the GUI for the feature but
 149   // the corresponding validator does not exist yet.
 150   if (!aCylinderAlgo->check()) {
 151     setError(aCylinderAlgo->getError());
 152     return;
 153   }
 154
 155   // Build the cylinder
 156   aCylinderAlgo->build();
 157
 158   // Check if the creation of the cylinder
 159   if(!aCylinderAlgo->isDone()) {
 160     // The error is not displayed in a popup window. It must be in the message console.
 161     setError(aCylinderAlgo->getError());
 162     return;
 163   }
 164   if(!aCylinderAlgo->checkValid("Cylinder builder")) {
 165     // The error is not displayed in a popup window. It must be in the message console.
 166     setError(aCylinderAlgo->getError());
 167     return;
 168   }
 169
 170   int aResultIndex = 0;
 171   ResultBodyPtr aResultBox = document()->createBody(data(), aResultIndex);
 172   loadNamingDS(aCylinderAlgo, aResultBox);
 173   setResult(aResultBox, aResultIndex);
 174 }
 175
 176 //=================================================================================================
 177 void PrimitivesPlugin_Cylinder::loadNamingDS(std::shared_ptr<GeomAlgoAPI_Cylinder> theCylinderAlgo,
 178                                              std::shared_ptr<ModelAPI_ResultBody> theResultCylinder)
 179 {
 180   // Load the result
 181   theResultCylinder->store(theCylinderAlgo->shape());
 182
 183   // Prepare the naming
 184   theCylinderAlgo->prepareNamingFaces();
 185
 186   // Insert to faces
 187   int num = 1;
 188   std::map< std::string, std::shared_ptr<GeomAPI_Shape> > listOfFaces =
 189     theCylinderAlgo->getCreatedFaces();
 190   for (std::map< std::string, std::shared_ptr<GeomAPI_Shape> >::iterator
 191        it=listOfFaces.begin(); it!=listOfFaces.end(); ++it) {
 192     std::shared_ptr<GeomAPI_Shape> aFace = (*it).second;
 193     theResultCylinder->generated(aFace, (*it).first, num++);
 194   }
 195 }