src/SketchPlugin/SketchPlugin_ConstraintLength.h

   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 #ifndef SketchPlugin_ConstraintLength_H_
  21 #define SketchPlugin_ConstraintLength_H_
  22
  23 #include "SketchPlugin.h"
  24 #include "SketchPlugin_ConstraintBase.h"
  25 #include "SketchPlugin_Sketch.h"
  26
  27 #include <GeomAPI_ICustomPrs.h>
  28
  29 #include <list>
  30
  31 class GeomAPI_Pnt2d;
  32 class GeomDataAPI_Point2D;
  33
  34 /** \class SketchPlugin_ConstraintLength
  35  *  \ingroup Plugins
  36  *  \brief Feature for creation of a new constraint which defines a length of a line segment
  37  *
  38  *  This constraint has two attributes:
  39  *  SketchPlugin_Constraint::VALUE() (length) and SketchPlugin_Constraint::ENTITY_A() (segment),
  40  *  SketchPlugin_Constraint::FLYOUT_VALUE_PNT() (distance of a constraints handle)
  41  */
  42 class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
  43 {
  44  public:
  45   /// Length constraint kind
  46   inline static const std::string& ID()
  47   {
  48     static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
  49     return MY_CONSTRAINT_LENGTH_ID;
  50   }
  51
  52   /// \brief Returns the kind of a feature
  53   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  54   {
  55     static std::string MY_KIND = SketchPlugin_ConstraintLength::ID();
  56     return MY_KIND;
  57   }
  58
  59   /// attribute name of dimension location type
  60   inline static const std::string& LOCATION_TYPE_ID()
  61   {
  62     static const std::string MY_LOCATION_TYPE_ID("LocationType");
  63     return MY_LOCATION_TYPE_ID;
  64   }
  65
  66   /// \brief Creates a new part document if needed
  67   SKETCHPLUGIN_EXPORT virtual void execute();
  68
  69   /// Computes the attribute value on the base of other attributes if the value can be computed
  70   /// \param theAttributeId an attribute index to be computed
  71   /// \return a boolean value about it is computed
  72   SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
  73
  74   /// \brief Request for initialization of data model of the feature: adding all attributes
  75   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  76
  77   /// Retuns the parameters of color definition in the resources config manager
  78   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  79                                                    std::string& theDefault);
  80
  81   /// Returns the AIS preview
  82   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  83
  84   /// Called on change of any argument-attribute of this object
  85   /// \param theID identifier of changed attribute
  86   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  87
  88   /// \brief Use plugin manager for features creation
  89   SketchPlugin_ConstraintLength();
  90
  91   /// Computes distance between lenght point attributes
  92   /// \param theValue [out] distance or 0 if one of point attributes is not initialized
  93   /// \return boolean value if distance is computed
  94   bool computeLenghtValue(double& theValue);
  95
  96 private:
  97   /// retrns the points-base of length, returns false if it is not possible
  98   bool getPoints(
  99     std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
 100     std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
 101     std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint);
 102
 103 private:
 104   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
 105 };
 106
 107 #endif