src/SketchPlugin/SketchPlugin_ConstraintCoincidenceInternal.h

   1 // Copyright (C) 2019-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_ConstraintCoincidenceInternal_H_
  21 #define SketchPlugin_ConstraintCoincidenceInternal_H_
  22
  23 #include "SketchPlugin.h"
  24 #include "SketchPlugin_ConstraintCoincidence.h"
  25
  26 /** \class SketchPlugin_ConstraintCoincidenceInternal
  27  *  \ingroup Plugins
  28  *  \brief Internal coincidence constraint not applicable for the end user
  29  */
  30 class SketchPlugin_ConstraintCoincidenceInternal : public SketchPlugin_ConstraintCoincidence
  31 {
  32   public:
  33   /// \brief Coincidence constraint kind
  34   inline static const std::string& ID()
  35   {
  36     static const std::string MY_CONSTRAINT_COINCIDENCE_ID("SketchConstraintCoincidenceInternal");
  37     return MY_CONSTRAINT_COINCIDENCE_ID;
  38   }
  39   /// \brief Returns the kind of a feature
  40   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  41   {
  42     static std::string MY_KIND = SketchPlugin_ConstraintCoincidenceInternal::ID();
  43     return MY_KIND;
  44   }
  45
  46   /// \brief Index of point in the array if the first attribute is an array
  47   inline static const std::string& INDEX_ENTITY_A()
  48   {
  49     static const std::string MY_INDEX("ConstraintEntityA_Index");
  50     return MY_INDEX;
  51   }
  52   /// \brief Index of point in the array if the second attribute is an array
  53   inline static const std::string& INDEX_ENTITY_B()
  54   {
  55     static const std::string MY_INDEX("ConstraintEntityB_Index");
  56     return MY_INDEX;
  57   }
  58
  59   /// \brief Returns the AIS preview
  60   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  61
  62   /// \brief Creates a new part document if needed
  63   SKETCHPLUGIN_EXPORT virtual void execute();
  64
  65   /// \brief Request for initialization of data model of the feature: adding all attributes
  66   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  67
  68   /// \brief Use plugin manager for features creation
  69   SketchPlugin_ConstraintCoincidenceInternal();
  70 };
  71
  72 #endif