src/SketchPlugin/SketchPlugin_ConstraintDistance.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_ConstraintDistance_H_
  21 #define SketchPlugin_ConstraintDistance_H_
  22
  23 #include "SketchPlugin.h"
  24 #include "SketchPlugin_ConstraintBase.h"
  25 #include "SketchPlugin_Sketch.h"
  26 #include "ModelAPI_Data.h"
  27
  28 #include <GeomAPI_ICustomPrs.h>
  29
  30 #include <list>
  31
  32 class SketchPlugin_Line;
  33 class GeomDataAPI_Point2D;
  34
  35 /** \class SketchPlugin_ConstraintDistance
  36  *  \ingroup Plugins
  37  *  \brief Feature for creation of a new constraint which defines a distance
  38  *         between a point and another feature (point, line, plane or face)
  39  *
  40  *  This constraint has three attributes:
  41  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  42  */
  43 class SketchPlugin_ConstraintDistance : public SketchPlugin_ConstraintBase
  44 {
  45  public:
  46   /// Distance constraint kind
  47   inline static const std::string& ID()
  48   {
  49     static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance");
  50     return MY_CONSTRAINT_DISTANCE_ID;
  51   }
  52
  53   /// \brief Returns the kind of a feature
  54   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  55   {
  56     static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID();
  57     return MY_KIND;
  58   }
  59
  60   /// \brief Shows whether the point-line distance should keep its sign
  61   inline static const std::string& SIGNED()
  62   {
  63     static const std::string MY_SIGNED("SignedDistance");
  64     return MY_SIGNED;
  65   }
  66
  67   /// \brief The direction from the first object to the second.
  68   ///        To change distance value from zero to non-zero correctly.
  69   inline static const std::string& DIRECTION_ID()
  70   {
  71     static const std::string MY_DIRECTION_ID("DistanceDirection");
  72     return MY_DIRECTION_ID;
  73   }
  74
  75   /// attribute name of dimension location type
  76   inline static const std::string& LOCATION_TYPE_ID()
  77   {
  78     static const std::string MY_LOCATION_TYPE_ID("LocationType");
  79     return MY_LOCATION_TYPE_ID;
  80   }
  81
  82   /// \brief Creates a new part document if needed
  83   SKETCHPLUGIN_EXPORT virtual void execute();
  84
  85   /// \brief Request for initialization of data model of the feature: adding all attributes
  86   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  87
  88   /// Retuns the parameters of color definition in the resources config manager
  89   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  90                                                    std::string& theDefault);
  91
  92   /// Returns the AIS preview
  93   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  94
  95   /// Called on change of any argument-attribute of this object
  96   /// \param theID identifier of changed attribute
  97   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  98
  99   /// \brief Use plugin manager for features creation
 100   SketchPlugin_ConstraintDistance();
 101
 102 protected:
 103   /// Returns the current distance between the feature attributes
 104   virtual double calculateCurrentDistance();
 105
 106   /// Check the attributes related to distanced points/features are initialized
 107   bool areAttributesInitialized();
 108
 109 protected:
 110   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
 111 };
 112
 113 #endif