1 // Copyright (C) 2020 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_Offset_H_
21 #define SketchPlugin_Offset_H_
23 #include <SketchPlugin.h>
24 #include <SketchPlugin_SketchEntity.h>
26 #include <GeomDataAPI_Point2D.h>
27 #include <GeomAPI_Edge.h>
29 /**\class SketchPlugin_Offset
31 * \brief Builds offset curves in the sketch.
33 class SketchPlugin_Offset : public SketchPlugin_SketchEntity
36 /// Offset macro feature kind
37 inline static const std::string& ID()
39 static const std::string ID("SketchOffset");
43 /// Returns the kind of a feature
44 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
46 static std::string MY_KIND = SketchPlugin_Offset::ID();
50 /// list of offset edges
51 inline static const std::string& EDGES_ID()
53 static const std::string ID("segments");
57 /// attribute to store the offset value
58 inline static const std::string& VALUE_ID()
60 static const std::string ID("offset_value");
64 /// attribute to store the reversed offset direction
65 inline static const std::string& REVERSED_ID()
67 static const std::string ID("reversed");
71 /// name for add wire action
72 inline static const std::string& ADD_WIRE_ACTION_ID()
74 static const std::string ID("add_wire");
78 /// Called on change of any argument-attribute of this object
79 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
81 /// Creates a new part document if needed
82 SKETCHPLUGIN_EXPORT virtual void execute();
84 /// Reimplemented from ModelAPI_Feature::isMacro().
86 SKETCHPLUGIN_EXPORT virtual bool isMacro() const { return true; }
88 //SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
89 SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return true; }
91 /// Find edges connected by coincident boundary constraint and composing a wire with
92 /// the already selected segments. It means that not more than 2 edges can be connected
93 /// with the coincident point.
94 /// \param[in] theActionId action key id (in following form: Action#Index)
95 /// \return \c false in case the action not performed.
96 SKETCHPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
98 /// Use plugin manager for features creation.
99 SketchPlugin_Offset();
102 /// \brief Initializes attributes of derived class.
103 virtual void initDerivedClassAttributes();
106 /// Find all wires connected with the selected edges
109 // Create sketch feature for each edge of theOffsetResult,
110 // and store it in myCreatedFeatures to remove on next execute()
111 void addToSketch (const std::shared_ptr<GeomAPI_Shape>& theOffsetResult);
113 // Create BSpline or BSplinePeriodic sketch feature from theEdge
114 void mkBSpline (FeaturePtr& theResult, const GeomEdgePtr& theEdge);
116 // Find edges that prolongate theEdgeFeature (in a chain) at theEndPoint
118 // \param[in] theFirstEdge Start edge of wire searching
119 // \param[in] theEdge Current edge
120 // \param[in] theEndPoint Point of the Current edge, not belonging to a previous edge
121 // \param[in/out] theEdgesSet All edges to find among. If empty, all sketch edges assumed.
122 // \param[in/out] theChain Resulting edges
123 /// \return \c true if the chain is closed
124 bool findWireOneWay (const FeaturePtr& theFirstEdge,
125 const FeaturePtr& theEdge,
126 const std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint,
127 std::set<FeaturePtr>& theEdgesSet,
128 std::list<FeaturePtr>& theChain);
131 std::set<FeaturePtr> myCreatedFeatures;