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