Salome HOME
Issue #698 - Distance constraint on circle - crash
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
index ec1afea13b22676a35d00deb9663952e7ff69751..1aaf66401d9856d6ff054e49187bbe82221566ff 100644 (file)
@@ -30,9 +30,11 @@ class GeomAPI_Pln;
 class GeomAPI_Pnt2d;
 class GeomAPI_Pnt;
 class GeomAPI_Edge;
+class GeomAPI_Vertex;
 
 /*!
- \class PartSet_Tools
+ * \class PartSet_Tools
+ * \ingroup Modules
  * \brief The operation for the sketch feature creation
  */
 class PARTSET_EXPORT PartSet_Tools
@@ -41,23 +43,28 @@ class PARTSET_EXPORT PartSet_Tools
   /// Converts the 2D screen point to the 3D point on the view according to the point of view
   /// \param thePoint a screen point
   /// \param theView a 3D view
-  // Transferred to ModuleBase
   static gp_Pnt convertClickToPoint(QPoint thePoint, Handle_V3d_View theView);
 
   /// \brief Converts the 3D point to the projected coodinates on the sketch plane.
   /// \param thePoint the 3D point in the viewer
   /// \param theSketch the sketch feature
+  /// \param theView a view 3d object
   /// \param theX the X coordinate
   /// \param theY the Y coordinate
   static void convertTo2D(const gp_Pnt& thePoint, FeaturePtr theSketch,
                           Handle(V3d_View) theView,
                           double& theX, double& theY);
 
+  /// \brief Converts the 3D point to the projected coodinates on the sketch plane.
+  /// \param theSketch the sketch feature
+  /// \param thePnt the 3D point in the viewer
+  /// \returns the converted point object
+  static std::shared_ptr<GeomAPI_Pnt2d> convertTo2D(FeaturePtr theSketch, const std::shared_ptr<GeomAPI_Pnt>& thePnt);
+
   /// \brief Converts the 2D projected coodinates on the sketch plane to the 3D point.
   /// \param theX the X coordinate
   /// \param theY the Y coordinate
   /// \param theSketch the sketch feature
-  /// \param thePoint the 3D point in the viewer
   static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY, FeaturePtr theSketch);
 
   /// Returns an object that is under the mouse point. Firstly it checks the highlighting,
@@ -76,17 +83,25 @@ class PARTSET_EXPORT PartSet_Tools
   /// Returns pointer to the root document.
   static std::shared_ptr<ModelAPI_Document> document();
 
+  /// Find an attribute which corresponds to a given pont coordinates
+  /// \param theSketch the sketch feature
+  /// \param theX X coordinate
+  /// \param theY Y coordinate
+  /// \param theTolerance tolerance
+  /// \param theIgnore list of features which has to be ignored
+  //static std::shared_ptr<GeomDataAPI_Point2D> findAttributePoint(CompositeFeaturePtr theSketch, 
+  //  double theX, double theY, double theTolerance, const QList<FeaturePtr>& theIgnore = QList<FeaturePtr>());
 
   /// Returns a point attribute of the feature by the coordinates if it is
   /// \param theFeature the feature
   /// \param theX the horizontal coordinate
   /// \param theY the vertical coordinate
-  static std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(FeaturePtr theFeature,
-                                                                double theX, double theY);
+  //static std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(FeaturePtr theFeature,
+  //                                                              double theX, double theY);
 
   /// \brief Save the double to the feature. If the attribute is double, it is filled.
   /// \param theFeature the feature
-  /// \param theValue the horizontal coordinate
+  /// \param theX the horizontal coordinate
   /// \param theAttribute the feature attribute
   static void setFeatureValue(FeaturePtr theFeature, double theX, const std::string& theAttribute);
 
@@ -107,8 +122,9 @@ class PARTSET_EXPORT PartSet_Tools
                             const std::string& theKind);
 
   /// Creates a constraint on two points
+  /// \param theSketch a sketch feature
   /// \param thePoint1 the first point
-  /// \param thePoint1 the second point
+  /// \param thePoint2 the second point
   static void createConstraint(CompositeFeaturePtr theSketch,
                                std::shared_ptr<GeomDataAPI_Point2D> thePoint1,
                                std::shared_ptr<GeomDataAPI_Point2D> thePoint2);
@@ -134,18 +150,25 @@ class PARTSET_EXPORT PartSet_Tools
   /// \return API object of point 3D
   static std::shared_ptr<GeomAPI_Pnt> point3D(std::shared_ptr<GeomAPI_Pnt2d> thePoint2D,
                                                 CompositeFeaturePtr theSketch);
-  /// Check whether there is a constraint with the feature kind given
-  /// \param theKind a feature kind
-  /// \return the boolean value
-  static bool isConstraintFeature(const std::string& theKind);
+
+  /// Finds a line (arc or circle) by given edge
+  /// \param theShape an edge
+  /// \param theObject a selected result object
+  /// \param theSketch a sketch feature
+  /// \return result of found feature or NULL
+  static ResultPtr findFixedObjectByExternal(const TopoDS_Shape& theShape, 
+                                             const ObjectPtr& theObject, 
+                                             CompositeFeaturePtr theSketch);
 
   /// Creates a line (arc or circle) by given edge
   /// Created line will have fixed constraint
-  /// \param theEdge - an edge
-  /// \return - result of created feature
-  static ResultPtr createFixedObjectByEdge(const TopoDS_Shape& theShape, 
-                                           const ObjectPtr& theObject, 
-                                           CompositeFeaturePtr theSketch);
+  /// \param theShape an edge
+  /// \param theObject a selected result object
+  /// \param theSketch a sketch feature
+  /// \return result of created feature
+  static ResultPtr createFixedObjectByExternal(const TopoDS_Shape& theShape, 
+                                               const ObjectPtr& theObject, 
+                                               CompositeFeaturePtr theSketch);
 
   /// Checks whether the list of selected presentations contains the given one
   /// \param theSelected a list of presentations
@@ -160,6 +183,12 @@ class PARTSET_EXPORT PartSet_Tools
   /// \return result object with external edge if it is found
   static ResultPtr findExternalEdge(CompositeFeaturePtr theSketch, std::shared_ptr<GeomAPI_Edge> theEdge);
 
+  /// Returns Result object if the given sketch contains external vertex equal to the given
+  /// \param theSketch - the sketch feature
+  /// \param theVert - the vertex
+  /// \return result object with external vertex if it is found
+  static ResultPtr findExternalVertex(CompositeFeaturePtr theSketch, std::shared_ptr<GeomAPI_Vertex> theVert);
+
   /// Returns whether the selected presentation has a shape with the vertex type
   /// \param thePrs a selected presentation
   /// \param theSketch the sketch feature