Salome HOME
Issue #1860: fix end lines with spaces
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintSplit.h
index d06c7d548a610a07fce5bd43bbb4928ca8869821..95cb9a9327353fe571958a0627da18e77e48b69a 100755 (executable)
@@ -1,8 +1,8 @@
 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
 
 // File:    SketchPlugin_ConstraintSplit.h
-// Created: 19 Mar 2015
-// Author:  Artem ZHIDKOV
+// Created: 25 Aug 2016
+// Author:  Natalia ERMOLAEVA
 
 #ifndef SketchPlugin_ConstraintSplit_H_
 #define SketchPlugin_ConstraintSplit_H_
@@ -19,24 +19,37 @@ typedef std::pair<std::string, std::shared_ptr<GeomDataAPI_Point2D> > IdToPointP
 
 /** \class SketchPlugin_ConstraintSplit
  *  \ingroup Plugins
- *  \brief Feature for creation of a new constraint filleting two objects which have coincident point
+ *  \brief Feature for creation of a new constraint splitting object. Entities for split:
+ * - Linear segment by point(s) on this line
+ * - Arc by point(s) on this arc
+ * - Circle by at least 2 split-points on this circle
+ *
+ * The following constraints will be applied after split to keep the divided segments geometry:
+ * - Coincident constraints for both parts of created segments in the point of splitting
+ * - For linear segments parallel, for circles - tangent constraint, for arc - tangent and equal
+ *   constraints. In case of three segments in result two couple of constraints are created
+ *    - parallel and equal constraints: the first is between 1st and middle entity, the second is
+ *      between 1st and 3rd.
+ *    - tangency constraints: the first between 1st and 2nd, the second between 2nd and 3rd.
+ * - Constraints assigned to the feature before split operation are assigned after using rules:
+ *    - Coincident constraints are assigned to the segment where they belong to. Segment of split
+ *      has only a coincidence to the neighbor segment. All constraints used in the splitting of
+ *      this segment are moved to point of neighbor segment. If constraint was initially built
+ *      to the point of splitting segment, it stays for this point.
+ *    - Geometrical and dimensional constraints are assigned to one of result segment, not the
+ *      selected for split. In case of 3 result segments, this will be the segment nearest to the
+ *      start point of arc/line.
+ *    - Replication constraint used split feature will be deleted in the same way as it is deleted
+ *      by any of entity delete in sketch which is used in this constraint.
  *
  *  This constraint has three attributes:
  *  SketchPlugin_Constraint::VALUE() contains reference object to be splitted
  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B() for the points of split;
  *
- *  Also the constraint has attribute SketchPlugin_Constraint::ENTITY_C()
- *  which contains created list objects forming the fillet
  */
 class SketchPlugin_ConstraintSplit : public SketchPlugin_ConstraintBase
 {
  public:
-   /*struct FilletFeatures {
-    std::list<std::pair<FeaturePtr, bool>> baseEdgesState; ///< list of objects the fillet is based and its states
-    std::list<FeaturePtr> resultEdges; ///< list of result edges
-    std::list<FeaturePtr> resultConstraints; ///< list of constraints provided by the fillet
-   };*/
-
   /// Split constraint kind
   inline static const std::string& ID()
   {
@@ -56,9 +69,6 @@ class SketchPlugin_ConstraintSplit : public SketchPlugin_ConstraintBase
   /// \brief Request for initialization of data model of the feature: adding all attributes
   SKETCHPLUGIN_EXPORT virtual void initAttributes();
 
-  /// Returns the AIS preview
-  //SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
-
   /// Reimplemented from ModelAPI_Feature::isMacro().
   /// \returns true
   SKETCHPLUGIN_EXPORT virtual bool isMacro() const;
@@ -75,6 +85,9 @@ class SketchPlugin_ConstraintSplit : public SketchPlugin_ConstraintBase
   //  return myPointFeaturesMap;
   //};
 
+  /// Returns the AIS preview
+  SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
+
 private:
   /// Returns geom point attribute of the feature bounds. It processes line or arc.
   /// For circle feature, the result attributes are null
@@ -88,32 +101,38 @@ private:
   /// \param geom point 2D or NULL
   std::shared_ptr<GeomDataAPI_Point2D> getPointOfRefAttr(const AttributePtr& theAttribute);
 
-  /// Creates a new feature in the base shape type with bounding points given in parameters
-  /// \param theStartPointAttr an attribute of the start point
-  /// \param theEndPointAttr an attribute of the end point
-  //std::shared_ptr<ModelAPI_Feature> createFeature(
-  //                                  const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
-  //                                  const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr);
-
   /// Obtains those constraints of the feature that should be modified. output maps contain
   /// point of coincidence and attribute id to be modified after split
   /// \param theFeaturesToDelete [out] constrains that will be deleted after split
+  /// \param theFeaturesToUpdate [out] constrains that will be updated after split
   /// \param theTangentFeatures  [out] tangent feature to be connected to new feature
   /// \param theCoincidenceToFeature [out] coincidence to feature to be connected to new feature
   /// \param theCoincidenceToPoint [out] coincidence to point be connected to new feature
   void getConstraints(std::set<std::shared_ptr<ModelAPI_Feature>>& theFeaturesToDelete,
+              std::set<std::shared_ptr<ModelAPI_Feature>>& theFeaturesToUpdate,
               std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
-              std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature,
-              std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToPoint);
+              std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature/*,
+              std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToPoint*/);
+
+  /// Obtains references to feature point attributes and to feature,
+  /// e.g. for feature line: 1st container is
+  ///             <1st line point, list<entity_a in distance, entity_b in parallel> >
+  ///             <2nd line point, list<> >
+  ///      for feature circle 2nd container is <entity_a in Radius, entity_b in equal, ...>
+  /// \param theFeature an investigated feature
+  /// \param theRefs a container of list of referenced attributes
+  void getRefAttributes(const FeaturePtr& theFeature,
+                        std::map<AttributePtr, std::list<AttributePtr> >& theRefs,
+                        std::list<AttributePtr>& theRefsToFeature);
 
   /// Move coincidence constraint from feature to point if it is found
   /// \param theCoincidenceToFeature coincidence to feature to be connected to new feature
   /// \param theFurtherCoincidences a list of points where coincidences will be build
   /// \paramv theFeatureResults created results after split where constaint might be connected
   void updateCoincidenceConstraintsToFeature(
-              const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature,
-              const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences,
-              const std::set<ResultPtr>& theFeatureResults);
+      const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theCoincidenceToFeature,
+      const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences,
+      const std::set<ResultPtr>& theFeatureResults);
 
   /// Move tangency constraint to the nearest split feature that has a coincidence to the tangent
   /// \param theTangentFeatures tangencies to feature to be connected to nearest feature
@@ -122,17 +141,35 @@ private:
               const std::map<std::shared_ptr<ModelAPI_Feature>, IdToPointPair>& theTangentFeatures,
               const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theFurtherCoincidences);
 
+
+  /// Move constraints from base feature to given feature
+  /// \param theFeature a base feature
+  /// \param theRefsToFeature list of attributes referenced to base feature
+  void updateRefFeatureConstraints(const std::shared_ptr<ModelAPI_Result>& theFeatureBaseResult,
+                                   const std::list<AttributePtr>& theRefsToFeature);
+
+  /// Move constraints from attribute of base feature to attribute after modification
+  /// \param theBaseRefAttributes container of references to the attributes of base feature
+  /// \param theModifiedAttributes container of attributes placed instead of base attributes
+  /// at the same place
+  void updateRefAttConstraints(
+               const std::map<AttributePtr, std::list<AttributePtr> >& theBaseRefAttributes,
+               const std::set<std::pair<AttributePtr, AttributePtr> >& theModifiedAttributes);
+
   /// Make the base object is splitted by the point attributes
   /// \param theSplitFeature a result split feature
   /// \param theBeforeFeature a feature between start point and the 1st point of split feature
   /// \param theAfterFeature a feature between last point of split feature and the end point
   /// \param thePoints a list of points where coincidences will be build
   /// \param theCreatedFeatures a container of created features
+  /// \param theModifiedAttributes a container of attribute on base
+  /// feature to attribute on new feature
   void splitLine(std::shared_ptr<ModelAPI_Feature>& theSplitFeature,
                  std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
                  std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
                  std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
-                 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures);
+                 std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
+                 std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
 
   /// Make the base object is splitted by the point attributes
   /// \param theSplitFeature a result split feature
@@ -144,7 +181,8 @@ private:
                 std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
                 std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
                 std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
-                std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures);
+                std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
+                std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
 
   /// Make the base object is splitted by the point attributes
   /// \param theSplitFeature a result split feature
@@ -156,7 +194,8 @@ private:
                    std::shared_ptr<ModelAPI_Feature>& theBeforeFeature,
                    std::shared_ptr<ModelAPI_Feature>& theAfterFeature,
                    std::set<std::shared_ptr<GeomDataAPI_Point2D> >& thePoints,
-                   std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures);
+                   std::set<std::shared_ptr<ModelAPI_Feature>>& theCreatedFeatures,
+                   std::set<std::pair<AttributePtr, AttributePtr>>& theModifiedAttributes);
 
   /// Correct the first and the second point to provide condition that the first is closer to
   /// the start point and the second point - to the last end of current segment. To rearrange
@@ -165,10 +204,24 @@ private:
   /// \param theEndPointAttr an end point of a segment
   /// \param theFirstPointAttr a start point of a segment
   /// \param theSecondPointAttr an end point of a segment
-  void arrangePoints(const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
-                     const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
-                     std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
-                     std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr);
+  void arrangePointsOnLine(const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
+                           const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
+                           std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
+                           std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr) const;
+
+  /// Correct the first and the second point to provide condition that the first is closer to
+  /// the start point and the second point - to the last end of current segment. To rearrange
+  /// them if this condition is not satisfied.
+  /// \param theArc an arc to be split
+  /// \param theStartPointAttr a start point of a segment
+  /// \param theEndPointAttr an end point of a segment
+  /// \param theFirstPointAttr a start point of a segment
+  /// \param theSecondPointAttr an end point of a segment
+  void arrangePointsOnArc(const FeaturePtr& theArc,
+                          const std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
+                          const std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr,
+                          std::shared_ptr<GeomDataAPI_Point2D>& theFirstPointAttr,
+                          std::shared_ptr<GeomDataAPI_Point2D>& theSecondPointAttr) const;
 
   /// Fill attribute by value of another attribute. It processes only Point 2D attributes.
   /// \param theModifiedAttribute an attribute of GeomDataAPI_Point2D on feature to be modified
@@ -208,6 +261,10 @@ private:
                         const std::shared_ptr<ModelAPI_Object>& theFirstObject,
                         const std::shared_ptr<ModelAPI_Object>& theSecondObject);
 
+  /// Add feature coincidence constraint between given attributes
+  /// \param theFeaturesToUpdate a constraint index
+  void updateFeaturesAfterSplit(const std::set<FeaturePtr>& theFeaturesToUpdate);
+
   /// Result result of the feature to build constraint with. For arc, circle it is an edge result.
   /// \param theFeature a feature
   /// \return result object
@@ -225,14 +282,6 @@ private:
   /// \return string value
   std::string getFeatureInfo(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                              const bool isUseAttributesInfo = true);
-
-private:
-  //std::set<AttributePtr> myNewPoints; ///< set of new points
-  //std::map<AttributePtr, FilletFeatures> myPointFeaturesMap; ///< map of point and features for fillet
-  //bool myListOfPointsChangedInCode; ///< flag to track that list of points changed in code
-  //bool myRadiusChangedByUser; ///< flag to track that radius changed by user
-  //bool myRadiusChangedInCode; ///< flag to track that radius changed in code
-  //bool myRadiusInitialized; /// < flag to track that radius initialized
 };
 
 #endif