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