src/SketchPlugin/SketchPlugin_ConstraintMiddle.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_ConstraintMiddle_H_
  21 #define SketchPlugin_ConstraintMiddle_H_
  22
  23 #include "SketchPlugin.h"
  24 #include <SketchPlugin_Sketch.h>
  25 #include "SketchPlugin_ConstraintBase.h"
  26
  27 class ModelAPI_Feature;
  28
  29 /** \class SketchPlugin_ConstraintMiddle
  30  *  \ingroup Plugins
  31  *  \brief Feature for creation of a new constraint which places a point in the middle of a line
  32  *
  33  *  This constraint has two attributes:
  34  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  35  */
  36 class SketchPlugin_ConstraintMiddle : public SketchPlugin_ConstraintBase
  37 {
  38  public:
  39   /// Parallel constraint kind
  40   inline static const std::string& ID()
  41   {
  42     static const std::string MY_CONSTRAINT_MIDDLE_ID("SketchConstraintMiddle");
  43     return MY_CONSTRAINT_MIDDLE_ID;
  44   }
  45
  46   /// Middle constraint kind
  47   inline static const std::string& MIDDLE_TYPE()
  48   {
  49     static const std::string MY_TYPE_ID("middle_type");
  50     return MY_TYPE_ID;
  51   }
  52
  53   /// Middle constraint type by line and point
  54   inline static const std::string& MIDDLE_TYPE_BY_LINE_AND_POINT()
  55   {
  56     static const std::string MY_TYPE_ID("middle_type_by_line_and_point");
  57     return MY_TYPE_ID;
  58   }
  59
  60   /// Middle constraint type by line
  61   inline static const std::string& MIDDLE_TYPE_BY_LINE()
  62   {
  63     static const std::string MY_TYPE_ID("middle_type_by_line");
  64     return MY_TYPE_ID;
  65   }
  66
  67   /// Created points for middle type by line
  68   inline static const std::string& POINT_REF_ID()
  69   {
  70     static const std::string MY_POINT_REF("point");
  71     return MY_POINT_REF;
  72   }
  73
  74   /// \brief Returns the kind of a feature
  75   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  76   {
  77     static std::string MY_KIND = SketchPlugin_ConstraintMiddle::ID();
  78     return MY_KIND;
  79   }
  80
  81   /// Called on change of any argument-attribute of this object
  82   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  83
  84   /// \brief Creates a new part document if needed
  85   SKETCHPLUGIN_EXPORT virtual void execute();
  86
  87   /// \brief Request for initialization of data model of the feature: adding all attributes
  88   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  89
  90   /// Returns the AIS preview
  91   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  92
  93   /// \brief Use plugin manager for features creation
  94   SketchPlugin_ConstraintMiddle();
  95
  96 private:
  97   void CreatePoint();
  98
  99   std::shared_ptr<ModelAPI_Feature> myPoint;
 100 };
 101
 102 #endif