src/SketchPlugin/SketchPlugin_Tools.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SKETCHPLUGIN_TOOLS_H_
  21 #define SKETCHPLUGIN_TOOLS_H_
  22
  23 #include <GeomAPI_Pnt2d.h>
  24
  25 #include <ModelAPI_Feature.h>
  26 #include <ModelAPI_Attribute.h>
  27 #include <ModelAPI_AttributeRefAttr.h>
  28 #include <GeomAPI_Shape.h>
  29 #include <GeomAPI_AISObject.h>
  30 #include <GeomDataAPI_Point2D.h>
  31 #include <GeomDataAPI_Point2DArray.h>
  32 #include <GeomAlgoAPI_ShapeTools.h>
  33
  34 #include <list>
  35 #include <map>
  36
  37 class GeomAPI_AISObject;
  38
  39 class SketchPlugin_Constraint;
  40 class SketchPlugin_Feature;
  41 class SketchPlugin_Sketch;
  42
  43 namespace SketchPlugin_Tools {
  44
  45 /// Clears text expressions for all attributes of the feature
  46 void clearExpressions(FeaturePtr theFeature);
  47
  48 /// \return coincidence point
  49 /// \param[in] theStartCoin coincidence feature
  50 std::shared_ptr<GeomAPI_Pnt2d> getCoincidencePoint(const FeaturePtr theStartCoin);
  51
  52 /// Find all Coincident constraints referred to the feature or its attribute
  53 std::set<FeaturePtr> findCoincidentConstraints(const ObjectPtr& theObject);
  54
  55 /// Finds lines coincident at point
  56 /// \param[in] theStartCoin coincidence feature
  57 /// \param[in] theAttr attribute name
  58 /// \param[out] theList list of lines
  59 /// \param[in] theIsAttrOnly if true includes only coincidences with attributes.
  60 void findCoincidences(const FeaturePtr theStartCoin,
  61                       const std::string& theAttr,
  62                       std::set<FeaturePtr>& theList,
  63                       const bool theIsAttrOnly = false);
  64
  65 /// Find all features the point is coincident to.
  66 std::set<FeaturePtr> findFeaturesCoincidentToPoint(const AttributePoint2DPtr& thePoint);
  67
  68 /// Find all points the given point is coincident to.
  69 std::set<AttributePoint2DPtr> findPointsCoincidentToPoint(const AttributePoint2DPtr& thePoint);
  70
  71 void resetAttribute(SketchPlugin_Feature* theFeature, const std::string& theId);
  72
  73 /// Create new constraint between given attributes
  74 /// \param[in] theSketch          a sketch where the constraint will be created
  75 /// \param[in] theConstraintId    a constraint identifier
  76 /// \param[in] theFirstAttribute  an attribute of further constraint
  77 /// \param[in] theSecondAttribute an attribute of further constraint
  78 FeaturePtr createConstraintAttrAttr(SketchPlugin_Sketch* theSketch,
  79                                     const std::string& theConstraintId,
  80                                     const AttributePtr& theFirstAttribute,
  81                                     const AttributePtr& theSecondAttribute);
  82
  83 /// Create new constraint between given attribute and object
  84 /// \param[in] theSketch         a sketch where the constraint will be created
  85 /// \param[in] theConstraintId   a constraint identifier
  86 /// \param[in] theFirstAttribute an attribute of further constraint
  87 /// \param[in] theSecondObject   an attribute of further constraint
  88 FeaturePtr createConstraintAttrObject(SketchPlugin_Sketch* theSketch,
  89                                       const std::string& theConstraintId,
  90                                       const AttributePtr& theFirstAttribute,
  91                                       const ObjectPtr& theSecondObject);
  92
  93 /// Create new constraint between given objects
  94 /// \param[in] theSketch       a sketch where the constraint will be created
  95 /// \param[in] theConstraintId a constraint identifier
  96 /// \param[in] theFirstObject  an attribute of further constraint
  97 /// \param[in] theSecondObject an attribute of further constraint
  98 FeaturePtr createConstraintObjectObject(SketchPlugin_Sketch* theSketch,
  99                                         const std::string& theConstraintId,
 100                                         const ObjectPtr& theFirstObject,
 101                                         const ObjectPtr& theSecondObject);
 102
 103 /// Creates coincidence or tangent constraint.
 104 /// \param[in] theFeature to get selected attribute or object
 105 /// \param[in] theId ID of attribute where selection is.
 106 /// \param[in] theObject object for constraint
 107 /// \param[in] theIsCanBeTangent if true constraint can be tangent or coincidence, depending on
 108 ///                              the selection in the attribute with passed ID.
 109 void createCoincidenceOrTangency(SketchPlugin_Feature* theFeature,
 110                                  const std::string& theId,
 111                                  const AttributePtr theAttr,
 112                                  const ObjectPtr theObject,
 113                                  const bool theIsCanBeTangent);
 114
 115 /// Creates auxiliary point for ellipse and corresponding internal constraint.
 116 /// \param[in] theEllipse   base ellipse feature
 117 /// \param[in] theAttrName  name of the attribute of the ellipse,
 118 ///                         the new point should be constrained
 119 void createAuxiliaryPointOnEllipse(const FeaturePtr& theEllipseFeature,
 120                                    const std::string& theAttrName);
 121
 122 /// Creates auxiliary axis for ellipse and corresponding internal constraints.
 123 /// \param[in] theEllipse   base ellipse feature
 124 /// \param[in] theStartAttr name of the attribute of the ellipse, the line is started
 125 /// \param[in] theEndAttr   name of the attribute of the ellipse, the line is ended
 126 void createAuxiliaryAxisOfEllipse(const FeaturePtr& theEllipseFeature,
 127                                   const std::string& theStartAttr,
 128                                   const std::string& theEndAttr);
 129
 130 /// Creates passing point or tangent curve basing on the given attributes are initialized.
 131 /// \param[in]  theRefAttr       prefered attribute to be converted
 132 /// \param[in]  theDefaultAttr   default attribute if theRefAttr is not initialized
 133 /// \param[out] theTangentCurve  tangent curve if theRefAttr refers to an edge
 134 /// \param[out] thePassingPoint  passing point if theRefAttr does not refer to an edge
 135 void convertRefAttrToPointOrTangentCurve(const AttributeRefAttrPtr&      theRefAttr,
 136                                          const AttributePtr&             theDefaultAttr,
 137                                          std::shared_ptr<GeomAPI_Shape>& theTangentCurve,
 138                                          std::shared_ptr<GeomAPI_Pnt2d>& thePassingPoint);
 139
 140 /// Calculate global coordinates for flyout point of Length constraint
 141 GeomPnt2dPtr flyoutPointCoordinates(const std::shared_ptr<SketchPlugin_Constraint>& theConstraint);
 142
 143 /// Sets attributes of feature presentation
 144 /// \param[in] thePrs a presentation
 145 /// \param[in] isAxiliary is axiliary flag
 146 void customizeFeaturePrs(const AISObjectPtr& thePrs, bool isAxiliary);
 147
 148 void setDimensionColor(const AISObjectPtr& theDimPrs);
 149
 150 /// Replace string in the name of object
 151 void replaceInName(ObjectPtr theObject, const std::wstring& theSource, const std::wstring& theDest);
 152
 153 }; // namespace SketchPlugin_Tools
 154
 155 namespace SketchPlugin_SegmentationTools
 156 {
 157   /// Returns geom point attribute of the feature bounds. It processes line or arc.
 158   /// For circle/ellipse feature, the result attributes are null
 159   /// \param theFeature        a source feature
 160   /// \param theStartPointAttr an out attribute to start point
 161   /// \param theEndPointAttr   an out attribute to end point
 162   void getFeaturePoints(const FeaturePtr& theFeature,
 163                         std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
 164                         std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr);
 165
 166   /// Obtains references to feature point attributes and to feature,
 167   /// e.g. for feature line: 1st container is
 168   ///             <1st line point, list<entity_a in distance, entity_b in parallel> >
 169   ///             <2nd line point, list<> >
 170   ///      for feature circle 2nd container is <entity_a in Radius, entity_b in equal, ...>
 171   /// \param theFeature an investigated feature
 172   /// \param theRefs a container of list of referenced attributes
 173   /// \param theRefsToFeature references to the feature result
 174   void getRefAttributes(const FeaturePtr& theFeature,
 175                         std::map<AttributePtr, std::list<AttributePtr> >& theRefs,
 176                         std::list<AttributePtr>& theRefsToFeature);
 177
 178   /// Obtains a part of shape selected/highlighted in the viewer for Split/Trim operation
 179   /// \param[in] theFeature            Split/Trim feature
 180   /// \param[in] theObjectAttributeId  name of attribute containing selected object
 181   /// \param[in] thePointAttributeId   name of attribute containing point selected on the object
 182   GeomShapePtr getSubShape(
 183       SketchPlugin_Feature* theFeature,
 184       const std::string& theObjectAttributeId,
 185       const std::string& thePointAttributeId,
 186       std::map<ObjectPtr, std::set<GeomShapePtr> >& theCashedShapes,
 187       std::map<ObjectPtr, GeomAlgoAPI_ShapeTools::PointToRefsMap>& theObjectToPoints);
 188
 189   /// Fulfill an internal containers by shapes obtained from the parameter object
 190   /// Shapes are results of Split/Trim operation by points coincident to shape of the object
 191   /// \param theOpFeture an operation feature (Split/Trim)
 192   /// \param theObject a source object (will be splitted)
 193   void fillObjectShapes(
 194       SketchPlugin_Feature* theOpFeature,
 195       const ObjectPtr& theObject,
 196       std::map<ObjectPtr, std::set<GeomShapePtr> >& theCashedShapes,
 197       std::map<ObjectPtr, GeomAlgoAPI_ShapeTools::PointToRefsMap>& theObjectToPoints);
 198
 199   /// AIS object for selected/highlighted part of splitting/triming feature
 200   /// \param[in] thePrevious  previous presentation
 201   /// \param[in] theOpFeture  an operation feature (Split/Trim)
 202   std::shared_ptr<GeomAPI_AISObject> getAISObject(std::shared_ptr<GeomAPI_AISObject> thePrevious,
 203                                                   SketchPlugin_Feature* theOpFeature,
 204                                                   const std::string& thePreviewObjectAttrName,
 205                                                   const std::string& thePreviewPointAttrName,
 206                                                   const std::string& theSelectedObjectAttrName,
 207                                                   const std::string& theSelectedPointAttrName);
 208
 209   /// Move constraints from attribute of base feature to attribute after modification
 210   /// \param theBaseRefAttributes container of references to the attributes of base feature
 211   /// \param theModifiedAttributes container of attributes placed instead of base attributes
 212   /// at the same place
 213   void updateRefAttConstraints(
 214       const std::map<AttributePtr, std::list<AttributePtr> >& theBaseRefAttributes,
 215       const std::set<std::pair<AttributePtr, AttributePtr> >& theModifiedAttributes);
 216
 217   /// Updates line length if it exist in the list
 218   /// \param theFeaturesToUpdate a constraint index
 219   void updateFeaturesAfterOperation(const std::set<FeaturePtr>& theFeaturesToUpdate);
 220
 221
 222   /// Creates a line feature filled by center of base feature and given points
 223   /// \param theBaseFeature another arc feature
 224   /// \param theFirstAttribute an attribute with coordinates for the start point
 225   /// \param theSecondAttribute an attribute with coordinates for the end point
 226   FeaturePtr createLineFeature(const FeaturePtr& theBaseFeature,
 227                                const std::shared_ptr<GeomAPI_Pnt2d>& theFirstPoint,
 228                                const std::shared_ptr<GeomAPI_Pnt2d>& theSecondPoint);
 229
 230   /// Creates a circular/elliptic arc feature filled by center
 231   /// (or by center and focus for elliptic arc) of base feature and given points
 232   /// \param theBaseFeature     another circle or ellipse or circular/elliptic arc
 233   /// \param theFirstAttribute  an attribute with coordinates for the start point
 234   /// \param theSecondAttribute an attribute with coordinates for the end point
 235   FeaturePtr createArcFeature(
 236       const FeaturePtr& theBaseFeature,
 237       const std::shared_ptr<GeomAPI_Pnt2d>& theFirstPoint,
 238       const std::shared_ptr<GeomAPI_Pnt2d>& theSecondPoint);
 239
 240 }; // namespace SketchPlugin_SegmentationTools
 241
 242 #endif // SKETCHPLUGIN_TOOLS_H_