src/SketchPlugin/SketchPlugin_ConstraintLength.h

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