Salome HOME
refs #80 - Sketch base GUI: create/draw point, circle and arc
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
index 759f490d540b0edd87a4aadc0cfec040ae2fe1b8..6aebb10322b3bdb86b80bbe937fefed7b9f539b8 100644 (file)
 
 #include <QPoint>
 
+#include <ModelAPI_Feature.h>
+
 #include <boost/shared_ptr.hpp>
 
+#include <list>
+
 class Handle_V3d_View;
-class ModelAPI_Feature;
+class XGUI_ViewerPrs;
+class GeomDataAPI_Point2D;
+class GeomAPI_Pln;
+class GeomAPI_Pnt2d;
+class GeomAPI_Pnt;
+class PartSet_FeaturePrs;
 
 /*!
  \class PartSet_Tools
@@ -26,15 +35,105 @@ public:
   /// 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
-  static gp_Pnt ConvertClickToPoint(QPoint thePoint, Handle_V3d_View theView);
+  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 theX the X coordinate
   /// \param theY the Y coordinate
-  static void ConvertTo2D(const gp_Pnt& thePoint, boost::shared_ptr<ModelAPI_Feature> theSketch,
-                          double& theX, double& theY);
+  static void convertTo2D(const gp_Pnt& thePoint, FeaturePtr theSketch,
+                          Handle(V3d_View) theView, double& theX, double& theY);
+
+  /// \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 void convertTo3D(const double theX, const double theY, FeaturePtr theSketch,
+                          gp_Pnt& thePoint);
+
+  /// Creates the feature presentation
+  /// \param theKind a feature kind
+  /// \param theSketch the sketch of the feature
+  /// \param theFeature the feature
+  static boost::shared_ptr<PartSet_FeaturePrs> createFeaturePrs(const std::string& theKind,
+                                                                FeaturePtr theSketch,
+                                                                FeaturePtr theFeature = FeaturePtr());
+
+  /// Returns a feature that is under the mouse point
+  /// \param thePoint a screen point
+  /// \param theView a 3D view
+  /// \param theSketch the sketch feature
+  /// \param theFeatures the list of selected presentations
+  static FeaturePtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
+                                   const std::list<XGUI_ViewerPrs>& theFeatures);
+
+  /// Returns pointer to the root document.
+  static boost::shared_ptr<ModelAPI_Document> document();
+
+  /// \brief Save the point to the feature. If the attribute is 2D geometry point, it is filled.
+  /// \param theFeature the feature
+  /// \param theX the horizontal coordinate
+  /// \param theY the vertical coordinate
+  /// \param theAttribute the feature attribute
+  static void setFeaturePoint(FeaturePtr theFeature, double theX, double theY,
+                              const std::string& theAttribute);
+
+  /// \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 theAttribute the feature attribute
+  static void setFeatureValue(FeaturePtr theFeature, double theX, const std::string& theAttribute);
+
+  /// \brief Returns the feature double value if it is.
+  /// \param theFeature the feature
+  /// \param theAttribute the feature attribute
+  /// \param isValid an output parameter whether the value is valid
+  /// \returns the feature value
+  static double featureValue(FeaturePtr theFeature, const std::string& theAttribute,
+                             bool& isValid);
+
+  /// Find a feature in the attribute of the given feature. If the kind is not empty,
+  /// the return feature should be this type. Otherwise it is null
+  /// \param theFeature a source feature
+  /// \param theAttribute a name of the requried attribute attribute
+  /// \param theKind an output feature kind
+  /// \return the feature
+  static FeaturePtr feature(FeaturePtr theFeature, const std::string& theAttribute,
+                             const std::string& theKind);
+
+  /// Creates a constraint on two points
+  /// \param thePoint1 the first point
+  /// \param thePoint1 the second point
+  static void createConstraint(FeaturePtr theSketch,
+                               boost::shared_ptr<GeomDataAPI_Point2D> thePoint1,
+                               boost::shared_ptr<GeomDataAPI_Point2D> thePoint2);
+
+  /// Creates constrains of the current 
+  /// \param theSketch a sketch feature
+  /// \param theFeature a source feature
+  /// \param theAttribute a name of the requried attribute attribute
+  /// \param theClickedX the horizontal coordnate of the point
+  /// \param theClickedY the vertical coordnate of the point
+  static void setConstraints(FeaturePtr theSketch, FeaturePtr theFeature,
+                             const std::string& theAttribute, double theClickedX, double theClickedY);
+
+  /// Create a sketch plane instance
+  /// \param theSketch a sketch feature
+  /// \return API object of geom plane
+  static boost::shared_ptr<GeomAPI_Pln> sketchPlane(FeaturePtr theSketch);
+
+  /// Create a point 3D on a basis of point 2D and sketch feature
+  /// \param thePoint2D a point on a sketch
+  /// \param theSketch a sketch feature
+  /// \return API object of point 3D
+  static boost::shared_ptr<GeomAPI_Pnt> point3D(boost::shared_ptr<GeomAPI_Pnt2d> thePoint2D,
+                                                FeaturePtr 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);
 };
 
 #endif