src/SketchPlugin/SketchPlugin_ConstraintLength.cpp

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "SketchPlugin_ConstraintLength.h"
  21 #include <SketchPlugin_Line.h>
  22 #include <SketchPlugin_Tools.h>
  23
  24 #include <GeomDataAPI_Point2D.h>
  25
  26 #include <SketcherPrs_Factory.h>
  27 #include <SketcherPrs_Tools.h>
  28
  29 #include <ModelAPI_AttributeDouble.h>
  30 #include <ModelAPI_AttributeInteger.h>
  31 #include <ModelAPI_Data.h>
  32 #include <ModelAPI_Result.h>
  33 #include <ModelAPI_Session.h>
  34 #include <ModelAPI_Validator.h>
  35
  36 #include <GeomDataAPI_Point2D.h>
  37
  38 #include <GeomAPI_Dir2d.h>
  39 #include <GeomAPI_Lin2d.h>
  40 #include <GeomAPI_Pnt2d.h>
  41 #include <GeomAPI_XY.h>
  42
  43 #include <Config_PropManager.h>
  44
  45 #include <math.h>
  46
  47 const double tolerance = 1e-7;
  48
  49 SketchPlugin_ConstraintLength::SketchPlugin_ConstraintLength()
  50 {
  51   myFlyoutUpdate = false;
  52 }
  53
  54 void SketchPlugin_ConstraintLength::initAttributes()
  55 {
  56   data()->addAttribute(SketchPlugin_Constraint::VALUE(), ModelAPI_AttributeDouble::typeId());
  57   data()->addAttribute(SketchPlugin_Constraint::FLYOUT_VALUE_PNT(), GeomDataAPI_Point2D::typeId());
  58   data()->addAttribute(SketchPlugin_Constraint::ENTITY_A(), ModelAPI_AttributeRefAttr::typeId());
  59
  60   data()->addAttribute(SketchPlugin_ConstraintLength::LOCATION_TYPE_ID(),
  61                        ModelAPI_AttributeInteger::typeId());
  62   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), LOCATION_TYPE_ID());
  63 }
  64
  65 void SketchPlugin_ConstraintLength::colorConfigInfo(std::string& theSection, std::string& theName,
  66                                                     std::string& theDefault)
  67 {
  68   theSection = "Visualization";
  69   theName = "sketch_dimension_color";
  70   theDefault = SKETCH_DIMENSION_COLOR;
  71 }
  72
  73 void SketchPlugin_ConstraintLength::execute()
  74 {
  75   std::shared_ptr<ModelAPI_AttributeRefAttr> aRef = std::dynamic_pointer_cast<
  76       ModelAPI_AttributeRefAttr>(data()->attribute(SketchPlugin_Constraint::ENTITY_A()));
  77   FeaturePtr aFeature = ModelAPI_Feature::feature(aRef->object());
  78   if (aFeature) {
  79     // set length value
  80     std::shared_ptr<GeomDataAPI_Point2D> aPoint1 = std::dynamic_pointer_cast<
  81         GeomDataAPI_Point2D>(aFeature->data()->attribute(SketchPlugin_Line::START_ID()));
  82     std::shared_ptr<GeomDataAPI_Point2D> aPoint2 = std::dynamic_pointer_cast<
  83         GeomDataAPI_Point2D>(aFeature->data()->attribute(SketchPlugin_Line::END_ID()));
  84
  85     if (aPoint1.get() && aPoint2.get()) {
  86       // the value should to be computed here, not in the getAISObject
  87       // in order to change the model value
  88       // inside the object transaction. This is important for creating a constraint by preselection.
  89       // The display of the presentation in this case happens after the transaction commit
  90       AttributePtr aFlyOutAttribute =
  91         data()->attribute(SketchPlugin_Constraint::FLYOUT_VALUE_PNT());
  92       if (!aFlyOutAttribute->isInitialized()) {
  93         compute(SketchPlugin_Constraint::FLYOUT_VALUE_PNT());
  94       }
  95     }
  96   }
  97 }
  98
  99 bool SketchPlugin_ConstraintLength::compute(const std::string& theAttributeId)
 100 {
 101   if (theAttributeId != SketchPlugin_Constraint::FLYOUT_VALUE_PNT())
 102     return false;
 103
 104   std::shared_ptr<GeomAPI_Pnt> aPoint1, aPoint2;
 105   std::shared_ptr<GeomDataAPI_Point2D> aStartPoint, anEndPoint;
 106   if (!getPoints(aPoint1, aPoint2, aStartPoint, anEndPoint))
 107     return false;
 108
 109   std::shared_ptr<GeomDataAPI_Point2D> aFlyOutAttr = std::dynamic_pointer_cast<
 110       GeomDataAPI_Point2D>(data()->attribute(theAttributeId));
 111
 112   std::shared_ptr<GeomAPI_Lin2d> aLine =
 113     std::shared_ptr<GeomAPI_Lin2d>(new GeomAPI_Lin2d(aStartPoint->pnt(), anEndPoint->pnt()));
 114   if (!aFlyOutAttr->isInitialized() ||
 115       (fabs(aFlyOutAttr->x()) < tolerance && fabs(aFlyOutAttr->y()) < tolerance)) {
 116     double aDist = aPoint1->distance(aPoint2)/5.;
 117     std::shared_ptr<GeomAPI_Pnt2d> aFPnt = aLine->shiftedLocation(aDist);
 118     aFlyOutAttr->setValue(aFPnt);
 119   }
 120
 121   return true;
 122 }
 123
 124 bool SketchPlugin_ConstraintLength::computeLenghtValue(double& theValue)
 125 {
 126   bool aResult = false;
 127   std::shared_ptr<GeomAPI_Pnt> aPoint1, aPoint2;
 128   std::shared_ptr<GeomDataAPI_Point2D> aStartPoint, anEndPoint;
 129   if (getPoints(aPoint1, aPoint2, aStartPoint, anEndPoint)) {
 130     theValue = aPoint1->distance(aPoint2);
 131     aResult = true;
 132   }
 133   return aResult;
 134 }
 135
 136 bool SketchPlugin_ConstraintLength::getPoints(
 137   std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
 138   std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
 139   std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint)
 140 {
 141   if (!sketch())
 142     return false;
 143   std::shared_ptr<ModelAPI_AttributeRefAttr> anAttr = std::dynamic_pointer_cast<
 144       ModelAPI_AttributeRefAttr>(data()->attribute(SketchPlugin_Constraint::ENTITY_A()));
 145   if (!anAttr)
 146     return false;
 147   FeaturePtr aFeature = ModelAPI_Feature::feature(anAttr->object());
 148   if (!aFeature || aFeature->getKind() != SketchPlugin_Line::ID())
 149     return false;
 150   DataPtr aData = aFeature->data();
 151   theStartPoint = std::dynamic_pointer_cast<
 152       GeomDataAPI_Point2D>(aData->attribute(SketchPlugin_Line::START_ID()));
 153   theEndPoint = std::dynamic_pointer_cast<
 154       GeomDataAPI_Point2D>(aData->attribute(SketchPlugin_Line::END_ID()));
 155   thePoint1 = sketch()->to3D(theStartPoint->x(), theStartPoint->y());
 156   thePoint2 = sketch()->to3D(theEndPoint->x(), theEndPoint->y());
 157   return true;
 158 }
 159
 160 AISObjectPtr SketchPlugin_ConstraintLength::getAISObject(AISObjectPtr thePrevious)
 161 {
 162   if (!sketch())
 163     return thePrevious;
 164
 165   AISObjectPtr anAIS = SketcherPrs_Factory::lengthDimensionConstraint(this,
 166     sketch(), thePrevious);
 167   if (anAIS.get() && !thePrevious.get())
 168     SketchPlugin_Tools::setDimensionColor(anAIS);
 169   return anAIS;
 170 }
 171
 172 void SketchPlugin_ConstraintLength::attributeChanged(const std::string& theID) {
 173   if (theID == SketchPlugin_Constraint::ENTITY_A())
 174   {
 175     std::shared_ptr<ModelAPI_AttributeDouble> aValueAttr = std::dynamic_pointer_cast<
 176       ModelAPI_AttributeDouble>(attribute(SketchPlugin_Constraint::VALUE()));
 177     if (!aValueAttr->isInitialized()) {
 178       // only if it is not initialized, try to compute the current value
 179       double aLength;
 180       if (computeLenghtValue(aLength))
 181         aValueAttr->setValue(aLength);
 182     }
 183   } else if (theID == SketchPlugin_Constraint::FLYOUT_VALUE_PNT() && !myFlyoutUpdate) {
 184     // Recalculate flyout point in local coordinates of the line:
 185     // the X coordinate is a length of projection of the flyout point on the line
 186     // the Y coordinate is a distance from the point to the line
 187     std::shared_ptr<GeomDataAPI_Point2D> aFlyoutAttr =
 188         std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 189         attribute(SketchPlugin_Constraint::FLYOUT_VALUE_PNT()));
 190     AttributeRefAttrPtr aLineAttr = std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(
 191         attribute(SketchPlugin_Constraint::ENTITY_A()));
 192     if (!aLineAttr || !aLineAttr->isObject())
 193       return;
 194     FeaturePtr aLine = ModelAPI_Feature::feature(aLineAttr->object());
 195     if (!aLine || aLine->getKind() != SketchPlugin_Line::ID())
 196       return;
 197
 198     std::shared_ptr<GeomAPI_Pnt2d> aFlyoutPnt = aFlyoutAttr->pnt();
 199     std::shared_ptr<GeomAPI_XY> aStartPnt = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 200         aLine->attribute(SketchPlugin_Line::START_ID()))->pnt()->xy();
 201     std::shared_ptr<GeomAPI_XY> aEndPnt = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 202         aLine->attribute(SketchPlugin_Line::END_ID()))->pnt()->xy();
 203
 204     myFlyoutUpdate = true;
 205     std::shared_ptr<GeomAPI_Dir2d> aLineDir(new GeomAPI_Dir2d(aEndPnt->decreased(aStartPnt)));
 206     std::shared_ptr<GeomAPI_XY> aFlyoutDir = aFlyoutPnt->xy()->decreased(aStartPnt);
 207     double X = aFlyoutDir->dot(aLineDir->xy());
 208     double Y = -aFlyoutDir->cross(aLineDir->xy());
 209     aFlyoutAttr->setValue(X, Y);
 210     myFlyoutUpdate = false;
 211   }
 212 }