src/SketchPlugin/SketchPlugin_Projection.h

   1 // Copyright (C) 2014-2020  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SketchPlugin_Projection_H_
  21 #define SketchPlugin_Projection_H_
  22
  23 #include "SketchPlugin_SketchEntity.h"
  24
  25 class GeomAPI_Curve;
  26
  27 /** \class SketchPlugin_Projection
  28  *  \ingroup Plugins
  29  *  \brief Feature for creation of external feature as a projection onto the sketch plane.
  30  */
  31 class SketchPlugin_Projection : public SketchPlugin_SketchEntity
  32 {
  33 public:
  34   /// Projection feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_PROJECTION_ID("SketchProjection");
  38     return MY_PROJECTION_ID;
  39   }
  40   /// Returns the kind of a feature
  41   virtual const std::string& getKind()
  42   {
  43     static std::string MY_KIND = SketchPlugin_Projection::ID();
  44     return MY_KIND;
  45   }
  46
  47   static const std::string& EXTERNAL_FEATURE_ID()
  48   {
  49     static std::string MY_EXT_FEATURE_ID("ExternalFeature");
  50     return MY_EXT_FEATURE_ID;
  51   }
  52
  53   static const std::string& PROJECTED_FEATURE_ID()
  54   {
  55     static std::string MY_PROJ_FEATURE_ID("ProjectedFeature");
  56     return MY_PROJ_FEATURE_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 projected feature 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   SKETCHPLUGIN_EXPORT virtual bool canBeDisplayed() const
  72   {
  73     return false;
  74   }
  75
  76   /// Creates a new part document if needed
  77   SKETCHPLUGIN_EXPORT virtual void execute();
  78
  79   /// Called on change of any argument-attribute of this object: for external point
  80   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  81
  82   /// Use plugin manager for features creation
  83   SketchPlugin_Projection();
  84
  85 protected:
  86   /// \brief Initializes attributes of derived class.
  87   virtual void initDerivedClassAttributes();
  88
  89 private:
  90   /// \brief Find projection of a feature onto sketch plane
  91   void computeProjection(const std::string& theID);
  92
  93   /// \brief Project point to the sketch plane
  94   bool projectPoint(FeaturePtr& theProjection, const std::shared_ptr<GeomAPI_Pnt>& thePoint);
  95   /// \brief Project segment to the sketch plane
  96   bool projectSegment(FeaturePtr& theProjection, const std::shared_ptr<GeomAPI_Edge>& theEdge);
  97   /// \brief Project any edge to sketch plane
  98   bool projectEdge(FeaturePtr& theProjection, const std::shared_ptr<GeomAPI_Edge>& theEdge);
  99
 100   /// \brief Fill attributes of the Arc feature
 101   bool fillArc(FeaturePtr& theProjection,
 102                const std::shared_ptr<GeomAPI_Curve>& theArc,
 103                const std::shared_ptr<GeomAPI_Pln>& thePlane);
 104   /// \brief Fill attributes of the Circle feature
 105   bool fillCircle(FeaturePtr& theProjection,
 106                   const std::shared_ptr<GeomAPI_Curve>& theCircle,
 107                   const std::shared_ptr<GeomAPI_Pln>& thePlane);
 108   /// \brief Fill attributes of the Ellipse feature
 109   bool fillEllipse(FeaturePtr& theProjection,
 110                    const std::shared_ptr<GeomAPI_Curve>& theEllipse,
 111                    const std::shared_ptr<GeomAPI_Pln>& thePlane);
 112   /// \brief Fill attributes of the EllipticArc feature
 113   bool fillEllipticArc(FeaturePtr& theProjection,
 114                        const std::shared_ptr<GeomAPI_Curve>& theEllipticArc,
 115                        const std::shared_ptr<GeomAPI_Pln>& thePlane);
 116   /// \brief Fill attributes of the B-spline feature
 117   bool fillBSpline(FeaturePtr& theProjection,
 118                    const std::shared_ptr<GeomAPI_Curve>& theCurve,
 119                    const std::shared_ptr<GeomAPI_Pln>& thePlane);
 120
 121   /// \brief Delete already calculated projected feature
 122   ///        if the selection of the projection is changed
 123   /// \param[in/out] theProjection   projected feature
 124   /// \param[in] theSupportedTypes   types supported relatively to the base selection
 125   /// \param[in] theRequestedFeature type of the new feature to be created
 126   ///                                (remove only if empty string).
 127   bool rebuildProjectedFeature(FeaturePtr& theProjection,
 128                                const std::set<std::string>& theSupportedTypes,
 129                                const std::string& theRequestedFeature = std::string());
 130
 131   bool myIsComputing;
 132 };
 133
 134 #endif