src/SketchPlugin/SketchPlugin_IntersectionPoint.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_IntersectionPoint_H_
  22 #define SketchPlugin_IntersectionPoint_H_
  23
  24 #include "SketchPlugin_SketchEntity.h"
  25
  26 /**\class SketchPlugin_IntersectionPoint
  27  * \ingroup Plugins
  28  * \brief Feature for creation of external point as an intersection
  29  *        between external edge and a plane of the sketch.
  30  */
  31 class SketchPlugin_IntersectionPoint : public SketchPlugin_SketchEntity
  32 {
  33 public:
  34   /// Point feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_POINT_ID("SketchIntersectionPoint");
  38     return MY_POINT_ID;
  39   }
  40   /// Returns the kind of a feature
  41   virtual const std::string& getKind()
  42   {
  43     static std::string MY_KIND = SketchPlugin_IntersectionPoint::ID();
  44     return MY_KIND;
  45   }
  46
  47   static const std::string& EXTERNAL_FEATURE_ID()
  48   {
  49     static std::string MY_FEATURE_ID("ExternalFeature");
  50     return MY_FEATURE_ID;
  51   }
  52
  53   static const std::string& INTERSECTION_POINTS_ID()
  54   {
  55     static std::string MY_INTERSECTIONS_ID("IntersectionPoints");
  56     return MY_INTERSECTIONS_ID;
  57   }
  58
  59   static const std::string& INCLUDE_INTO_RESULT()
  60   {
  61     static std::string MY_INCLUDE("IncludeToResult");
  62     return MY_INCLUDE;
  63   }
  64
  65   /// Returns true because intersection point is always external
  66   virtual bool isFixed()
  67   { return true; }
  68
  69   /// Returns true if the feature and the feature results can be displayed.
  70   /// \return false
  71   virtual bool canBeDisplayed() const
  72   { return false; }
  73
  74   /// Creates a new part document if needed
  75   SKETCHPLUGIN_EXPORT virtual void execute();
  76
  77   /// Called on change of any argument-attribute of this object: for external point
  78   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  79
  80   /// Use plugin manager for features creation
  81   SketchPlugin_IntersectionPoint();
  82
  83 protected:
  84   /// \brief Initializes attributes of derived class.
  85   virtual void initDerivedClassAttributes();
  86
  87 private:
  88   /// \brief Find intersection between a line and a sketch plane
  89   void computePoint(const std::string& theID);
  90
  91   bool myIsComputing;
  92 };
  93
  94 #endif