src/SketchPlugin/SketchPlugin_Point.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_Point_H_
  21 #define SketchPlugin_Point_H_
  22
  23 #include "SketchPlugin.h"
  24 #include <SketchPlugin_Sketch.h>
  25 #include "SketchPlugin_SketchEntity.h"
  26 #include <list>
  27
  28 /**\class SketchPlugin_Point
  29  * \ingroup Plugins
  30  * \brief Feature for creation of a new point.
  31  */
  32 class SketchPlugin_Point : public SketchPlugin_SketchEntity
  33 {
  34  public:
  35   /// Point feature kind
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_POINT_ID("SketchPoint");
  39     return MY_POINT_ID;
  40   }
  41   /// Coordinates of the point
  42   inline static const std::string& COORD_ID()
  43   {
  44     static const std::string MY_COORD_ID("PointCoordinates");
  45     return MY_COORD_ID;
  46   }
  47   /// Returns the kind of a feature
  48   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  49   {
  50     static std::string MY_KIND = SketchPlugin_Point::ID();
  51     return MY_KIND;
  52   }
  53
  54   /// Returns true is sketch element is under the rigid constraint
  55   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  56
  57   /// Creates a new part document if needed
  58   SKETCHPLUGIN_EXPORT virtual void execute();
  59
  60   /// Called on change of any argument-attribute of this object: for external point
  61   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  62
  63   /// Use plugin manager for features creation
  64   SketchPlugin_Point();
  65
  66 protected:
  67   /// \brief Initializes attributes of derived class.
  68   virtual void initDerivedClassAttributes();
  69 };
  70
  71 #endif