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 theTangentFeatures [out] tangent feature to be connected to new feature
105 /// \param theCoincidenceToFeature [out] coincidence to feature to be connected to new feature
106 /// \param theCoincidenceToPoint [out] coincidence to point be connected to new feature
107 void getConstraints(std::set<std::shared_ptr<ModelAPI_Feature>>& theFeaturesToDelete,
108 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
109 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature/*,
110 std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToPoint*/);
112 void getRefAttributes(const FeaturePtr& theFeature,
113 std::map<AttributePtr, std::list<AttributePtr> >& theRefs);
115 /// Move coincidence constraint from feature to point if it is found
116 /// \param theCoincidenceToFeature coincidence to feature to be connected to new feature
117 /// \param theFurtherCoincidences a list of points where coincidences will be build
118 /// \paramv theFeatureResults created results after split where constaint might be connected
119 void updateCoincidenceConstraintsToFeature(
120 const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature,
121 const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences,
122 const std::set<ResultPtr>& theFeatureResults);
124 /// Move tangency constraint to the nearest split feature that has a coincidence to the tangent
125 /// \param theTangentFeatures tangencies to feature to be connected to nearest feature
126 /// \param theFurtherCoincidences a list of points where coincidences is built
127 void updateTangentConstraintsToFeature(
128 const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
129 const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences);
131 /// Move constraints from attribute of base feature to attribute after modification
132 /// \param theBaseRefAttributes container of references to the attributes of base feature
133 /// \param theModifiedAttributes container of attributes placed instead of base attributes
134 /// at the same place
135 void updateRefAttConstraints(
136 const std::map<AttributePtr, std::list<AttributePtr> >& theBaseRefAttributes,
137 const std::set<std::pair<AttributePtr, AttributePtr> >& theModifiedAttributes);
139 /// Make the base object is splitted by the point attributes
140 /// \param theSplitFeature a result split feature
141 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
142 /// \param theAfterFeature a feature between last point of split feature and the end point
143 /// \param thePoints a list of points where coincidences will be build
144 /// \param theCreatedFeatures a container of created features
145 /// \param theModifiedAttributes a container of attribute on base feature to attribute on new feature
146 void splitLine(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
147 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
148 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
149 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
150 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
151 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
153 /// Make the base object is splitted by the point attributes
154 /// \param theSplitFeature a result split feature
155 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
156 /// \param theAfterFeature a feature between last point of split feature and the end point
157 /// \param thePoints a list of points where coincidences will be build
158 /// \param theCreatedFeatures a container of created features
159 void splitArc(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
160 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
161 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
162 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
163 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
164 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
166 /// Make the base object is splitted by the point attributes
167 /// \param theSplitFeature a result split feature
168 /// \param theBeforeFeature a feature between start point and the 1st point of split feature
169 /// \param theAfterFeature a feature between last point of split feature and the end point
170 /// \param thePoints a list of points where coincidences will be build
171 /// \param theCreatedFeatures a container of created features
172 void splitCircle(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
173 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
174 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
175 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
176 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
177 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
179 /// Correct the first and the second point to provide condition that the first is closer to
180 /// the start point and the second point - to the last end of current segment. To rearrange
181 /// them if this condition is not satisfied.
182 /// \param theStartPointAttr a start point of a segment
183 /// \param theEndPointAttr an end point of a segment
184 /// \param theFirstPointAttr a start point of a segment
185 /// \param theSecondPointAttr an end point of a segment
186 void arrangePoints(const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
187 const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
188 std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
189 std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr);
191 /// Fill attribute by value of another attribute. It processes only Point 2D attributes.
192 /// \param theModifiedAttribute an attribute of GeomDataAPI_Point2D on feature to be modified
193 /// \param theSourceAttribute an attribute of GeomDataAPI_Point2D to obtain data
194 void fillAttribute(const AttributePtr& theModifiedAttribute,
195 const AttributePtr& theSourceAttribute);
197 /// Creates a line feature filled by center of base feature and given points
198 /// \param theBaseFeature another arc feature
199 /// \param theFirstAttribute an attribute with coordinates for the start point
200 /// \param theSecondAttribute an attribute with coordinates for the end point
201 FeaturePtr createLineFeature(const FeaturePtr& theBaseFeature,
202 const AttributePtr& theFirstPointAttr,
203 const AttributePtr& theSecondPointAttr);
205 /// Creates an arc feature filled by center of base feature and given points
206 /// \param theBaseFeature another arc feature
207 /// \param theFirstAttribute an attribute with coordinates for the start point
208 /// \param theSecondAttribute an attribute with coordinates for the end point
209 FeaturePtr createArcFeature(const FeaturePtr& theBaseFeature,
210 const AttributePtr& theFirstPointAttr,
211 const AttributePtr& theSecondPointAttr);
213 /// Add feature coincidence constraint between given attributes
214 /// \param theConstraintId a constraint index
215 /// \param theFirstAttribute an attribute of further coincidence
216 /// \param theSecondAttribute an attribute of further coincidence
217 std::shared_ptr<ModelAPI_Feature> createConstraint(const std::string& theConstraintId,
218 const std::shared_ptr<ModelAPI_Attribute>& theFirstAttribute,
219 const std::shared_ptr<ModelAPI_Attribute>& theSecondAttribute);
221 /// Add feature coincidence constraint between given attributes
222 /// \param theConstraintId a constraint index
223 /// \param theFirstAttribute an attribute of further coincidence
224 /// \param theFirstAttribute an attribute of further coincidence
225 std::shared_ptr<ModelAPI_Feature> createConstraintForObjects(const std::string& theConstraintId,
226 const std::shared_ptr<ModelAPI_Object>& theFirstObject,
227 const std::shared_ptr<ModelAPI_Object>& theSecondObject);
229 /// Result result of the feature to build constraint with. For arc, circle it is an edge result.
230 /// \param theFeature a feature
231 /// \return result object
232 std::shared_ptr<ModelAPI_Result> getFeatureResult(
233 const std::shared_ptr<ModelAPI_Feature>& theFeature);
235 /// Returns attributes of the feature, used in edge build, for arc it is end and start points
236 /// \param theFeature a feature
237 /// \return container of attributes
238 std::set<std::shared_ptr<ModelAPI_Attribute> > getEdgeAttributes(
239 const std::shared_ptr<ModelAPI_Feature>& theFeature);
241 /// Return feature name, kind, point attribute values united in a string
242 /// \param theFeature an investigated feature
243 /// \return string value
244 std::string getFeatureInfo(const std::shared_ptr<ModelAPI_Feature>& theFeature,
245 const bool isUseAttributesInfo = true);