1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef SketchPlugin_Projection_H_
21 #define SketchPlugin_Projection_H_
23 #include "SketchPlugin_SketchEntity.h"
27 /** \class SketchPlugin_Projection
29 * \brief Feature for creation of external feature as a projection onto the sketch plane.
31 class SketchPlugin_Projection : public SketchPlugin_SketchEntity
34 /// Projection feature kind
35 inline static const std::string& ID()
37 static const std::string MY_PROJECTION_ID("SketchProjection");
38 return MY_PROJECTION_ID;
40 /// Returns the kind of a feature
41 virtual const std::string& getKind()
43 static std::string MY_KIND = SketchPlugin_Projection::ID();
47 static const std::string& EXTERNAL_FEATURE_ID()
49 static std::string MY_EXT_FEATURE_ID("ExternalFeature");
50 return MY_EXT_FEATURE_ID;
53 static const std::string& PROJECTED_FEATURE_ID()
55 static std::string MY_PROJ_FEATURE_ID("ProjectedFeature");
56 return MY_PROJ_FEATURE_ID;
59 static const std::string& INCLUDE_INTO_RESULT()
61 static std::string MY_INCLUDE("IncludeToResult");
65 /// Returns true because projected feature is always external
66 virtual bool isFixed()
69 /// Returns true if the feature and the feature results can be displayed.
71 SKETCHPLUGIN_EXPORT virtual bool canBeDisplayed() const
76 /// Creates a new part document if needed
77 SKETCHPLUGIN_EXPORT virtual void execute();
79 /// Called on change of any argument-attribute of this object: for external point
80 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
82 /// Use plugin manager for features creation
83 SketchPlugin_Projection();
86 /// \brief Initializes attributes of derived class.
87 virtual void initDerivedClassAttributes();
90 /// \brief Find projection of a feature onto sketch plane
91 void computeProjection(const std::string& theID);
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);
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);
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());