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