1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_ConstraintSplit.h
4 // Created: 25 Aug 2016
5 // Author: Natalia ERMOLAEVA
7 #ifndef SketchPlugin_ConstraintSplit_H_
8 #define SketchPlugin_ConstraintSplit_H_
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Sketch.h>
12 #include "SketchPlugin_ConstraintBase.h"
14 class GeomDataAPI_Point2D;
15 class ModelAPI_Feature;
16 class ModelAPI_Result;
18 typedef std::pair<std::string, std::shared_ptr<GeomDataAPI_Point2D> > IdToPointPair;
20 /** \class SketchPlugin_ConstraintSplit
22 * \brief Feature for creation of a new constraint splitting object. Entities for split:
23 * - Linear segment by point(s) on this line
24 * - Arc by point(s) on this arc
25 * - Circle by at least 2 split-points on this circle
27 * The following constraints will be applied after split to keep the divided segments geometry:
28 * - Coincident constraints for both parts of created segments in the point of splitting
29 * - For linear segments parallel, for circles
\96 tangent constraint, for arc
\96 tangent and equal
30 * constraints. In case of three segments in result two couple of constraints are created
31 * - parallel and equal constraints: the first is between 1st and middle entity, the second is
32 * between 1st and 3rd.
33 * - tangency constraints: the first between 1st and 2nd, the second between 2nd and 3rd.
34 * - Constraints assigned to the feature before split operation are assigned after using rules:
35 * - Coincident constraints are assigned to the segment where they belong to. Segment of split
36 * has only a coincidence to the neighbor segment. All constraints used in the splitting of
37 * this segment are moved to point of neighbor segment. If constraint was initially built
38 * to the point of splitting segment, it stays for this point.
39 * - Geometrical and dimensional constraints are assigned to one of result segment, not the
40 * selected for split. In case of 3 result segments, this will be the segment nearest to the
41 * start point of arc/line.
42 * - Replication constraint used split feature will be deleted in the same way as it is deleted
43 * by any of entity delete in sketch which is used in this constraint.
45 * This constraint has three attributes:
46 * SketchPlugin_Constraint::VALUE() contains reference object to be splitted
47 * SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B() for the points of split;
50 class SketchPlugin_ConstraintSplit : public SketchPlugin_ConstraintBase
53 /// Split constraint kind
54 inline static const std::string& ID()
56 static const std::string MY_CONSTRAINT_SPLIT_ID("SketchConstraintSplit");
57 return MY_CONSTRAINT_SPLIT_ID;
59 /// \brief Returns the kind of a feature
60 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
62 static std::string MY_KIND = SketchPlugin_ConstraintSplit::ID();
66 /// \brief Creates a new part document if needed
67 SKETCHPLUGIN_EXPORT virtual void execute();
69 /// \brief Request for initialization of data model of the feature: adding all attributes
70 SKETCHPLUGIN_EXPORT virtual void initAttributes();
72 /// Reimplemented from ModelAPI_Feature::isMacro().
74 SKETCHPLUGIN_EXPORT virtual bool isMacro() const;
76 /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
77 /// This is necessary to perform execute only by apply the feature
78 SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
80 /// \brief Use plugin manager for features creation
81 SketchPlugin_ConstraintSplit();
83 /// \return map of base points and features;
84 //SKETCHPLUGIN_EXPORT const std::map<AttributePtr, FilletFeatures> pointsFeaturesMap() const {
85 // return myPointFeaturesMap;
89 /// Returns geom point attribute of the feature bounds. It processes line or arc.
90 /// For circle feature, the result attributes are null
91 /// \param theStartPointAttr an out attribute to start point
92 /// \param theStartPointAttr an out attribute to end point
93 void getFeaturePoints(std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
94 std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr);
96 /// Returns cast of attribute to geometrical point if the attribute is a ref attr attribute
97 /// \param theAttribute an attribute
98 /// \param geom point 2D or NULL
99 std::shared_ptr<GeomDataAPI_Point2D> getPointOfRefAttr(const AttributePtr& theAttribute);
101 /// Obtains those constraints of the feature that should be modified. output maps contain
102 /// point of coincidence and attribute id to be modified after split
103 /// \param theFeaturesToDelete [out] constrains that will be deleted after split
104 /// \param theFeaturesToUpdate [out] constrains that will be updated after split
105 /// \param theTangentFeatures [out] tangent feature to be connected to new feature
106 /// \param theCoincidenceToFeature [out] coincidence to feature to be connected to new feature
107 /// \param theCoincidenceToPoint [out] coincidence to point be connected to new feature
108 void getConstraints(std::set<std::shared_ptr<ModelAPI_Feature>>& theFeaturesToDelete,
109 std::set<std::shared_ptr<ModelAPI_Feature>>& theFeaturesToUpdate,
110 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
111 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature/*,
112 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToPoint*/);
114 void getRefAttributes(const FeaturePtr& theFeature,
115 std::map<AttributePtr, std::list<AttributePtr> >& theRefs);
117 /// Move coincidence constraint from feature to point if it is found
118 /// \param theCoincidenceToFeature coincidence to feature to be connected to new feature
119 /// \param theFurtherCoincidences a list of points where coincidences will be build
120 /// \paramv theFeatureResults created results after split where constaint might be connected
121 void updateCoincidenceConstraintsToFeature(
122 const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature,
123 const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences,
124 const std::set<ResultPtr>& theFeatureResults);
126 /// Move tangency constraint to the nearest split feature that has a coincidence to the tangent
127 /// \param theTangentFeatures tangencies to feature to be connected to nearest feature
128 /// \param theFurtherCoincidences a list of points where coincidences is built
129 void updateTangentConstraintsToFeature(
130 const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
131 const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences);
133 /// Move constraints from attribute of base feature to attribute after modification
134 /// \param theBaseRefAttributes container of references to the attributes of base feature
135 /// \param theModifiedAttributes container of attributes placed instead of base attributes
136 /// at the same place
137 void updateRefAttConstraints(
138 const std::map<AttributePtr, std::list<AttributePtr> >& theBaseRefAttributes,
139 const std::set<std::pair<AttributePtr, AttributePtr> >& theModifiedAttributes);
141 /// Make the base object is splitted by the point attributes
142 /// \param theSplitFeature a result split feature
143 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
144 /// \param theAfterFeature a feature between last point of split feature and the end point
145 /// \param thePoints a list of points where coincidences will be build
146 /// \param theCreatedFeatures a container of created features
147 /// \param theModifiedAttributes a container of attribute on base feature to attribute on new feature
148 void splitLine(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
149 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
150 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
151 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
152 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
153 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
155 /// Make the base object is splitted by the point attributes
156 /// \param theSplitFeature a result split feature
157 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
158 /// \param theAfterFeature a feature between last point of split feature and the end point
159 /// \param thePoints a list of points where coincidences will be build
160 /// \param theCreatedFeatures a container of created features
161 void splitArc(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
162 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
163 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
164 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
165 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
166 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
168 /// Make the base object is splitted by the point attributes
169 /// \param theSplitFeature a result split feature
170 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
171 /// \param theAfterFeature a feature between last point of split feature and the end point
172 /// \param thePoints a list of points where coincidences will be build
173 /// \param theCreatedFeatures a container of created features
174 void splitCircle(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
175 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
176 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
177 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
178 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
179 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
181 /// Correct the first and the second point to provide condition that the first is closer to
182 /// the start point and the second point - to the last end of current segment. To rearrange
183 /// them if this condition is not satisfied.
184 /// \param theStartPointAttr a start point of a segment
185 /// \param theEndPointAttr an end point of a segment
186 /// \param theFirstPointAttr a start point of a segment
187 /// \param theSecondPointAttr an end point of a segment
188 void arrangePointsOnLine(const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
189 const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
190 std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
191 std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr) const;
193 /// Correct the first and the second point to provide condition that the first is closer to
194 /// the start point and the second point - to the last end of current segment. To rearrange
195 /// them if this condition is not satisfied.
196 /// \param theArc an arc to be split
197 /// \param theStartPointAttr a start point of a segment
198 /// \param theEndPointAttr an end point of a segment
199 /// \param theFirstPointAttr a start point of a segment
200 /// \param theSecondPointAttr an end point of a segment
201 void arrangePointsOnArc(const FeaturePtr& theArc,
202 const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
203 const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
204 std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
205 std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr) const;
207 /// Fill attribute by value of another attribute. It processes only Point 2D attributes.
208 /// \param theModifiedAttribute an attribute of GeomDataAPI_Point2D on feature to be modified
209 /// \param theSourceAttribute an attribute of GeomDataAPI_Point2D to obtain data
210 void fillAttribute(const AttributePtr& theModifiedAttribute,
211 const AttributePtr& theSourceAttribute);
213 /// Creates a line feature filled by center of base feature and given points
214 /// \param theBaseFeature another arc feature
215 /// \param theFirstAttribute an attribute with coordinates for the start point
216 /// \param theSecondAttribute an attribute with coordinates for the end point
217 FeaturePtr createLineFeature(const FeaturePtr& theBaseFeature,
218 const AttributePtr& theFirstPointAttr,
219 const AttributePtr& theSecondPointAttr);
221 /// Creates an arc feature filled by center of base feature and given points
222 /// \param theBaseFeature another arc feature
223 /// \param theFirstAttribute an attribute with coordinates for the start point
224 /// \param theSecondAttribute an attribute with coordinates for the end point
225 FeaturePtr createArcFeature(const FeaturePtr& theBaseFeature,
226 const AttributePtr& theFirstPointAttr,
227 const AttributePtr& theSecondPointAttr);
229 /// Add feature coincidence constraint between given attributes
230 /// \param theConstraintId a constraint index
231 /// \param theFirstAttribute an attribute of further coincidence
232 /// \param theSecondAttribute an attribute of further coincidence
233 std::shared_ptr<ModelAPI_Feature> createConstraint(const std::string& theConstraintId,
234 const std::shared_ptr<ModelAPI_Attribute>& theFirstAttribute,
235 const std::shared_ptr<ModelAPI_Attribute>& theSecondAttribute);
237 /// Add feature coincidence constraint between given attributes
238 /// \param theConstraintId a constraint index
239 /// \param theFirstAttribute an attribute of further coincidence
240 /// \param theFirstAttribute an attribute of further coincidence
241 std::shared_ptr<ModelAPI_Feature> createConstraintForObjects(const std::string& theConstraintId,
242 const std::shared_ptr<ModelAPI_Object>& theFirstObject,
243 const std::shared_ptr<ModelAPI_Object>& theSecondObject);
245 /// Add feature coincidence constraint between given attributes
246 /// \param theFeaturesToUpdate a constraint index
247 void updateFeaturesAfterSplit(const std::set<FeaturePtr>& theFeaturesToUpdate);
249 /// Result result of the feature to build constraint with. For arc, circle it is an edge result.
250 /// \param theFeature a feature
251 /// \return result object
252 std::shared_ptr<ModelAPI_Result> getFeatureResult(
253 const std::shared_ptr<ModelAPI_Feature>& theFeature);
255 /// Returns attributes of the feature, used in edge build, for arc it is end and start points
256 /// \param theFeature a feature
257 /// \return container of attributes
258 std::set<std::shared_ptr<ModelAPI_Attribute> > getEdgeAttributes(
259 const std::shared_ptr<ModelAPI_Feature>& theFeature);
261 /// Return feature name, kind, point attribute values united in a string
262 /// \param theFeature an investigated feature
263 /// \return string value
264 std::string getFeatureInfo(const std::shared_ptr<ModelAPI_Feature>& theFeature,
265 const bool isUseAttributesInfo = true);