Salome HOME
Issue #273: Add copyright string
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
index 759f490d540b0edd87a4aadc0cfec040ae2fe1b8..ec1afea13b22676a35d00deb9663952e7ff69751 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSet_Tools.h
 // Created:     28 Apr 2014
 // Author:      Natalia ERMOLAEVA
 
 #include "PartSet.h"
 
+#include <ModuleBase_ViewerPrs.h>
 #include <gp_Pnt.hxx>
 
 #include <QPoint>
+#include <QList>
+
+#include <ModelAPI_CompositeFeature.h>
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
+
+#include <TopoDS_Shape.hxx>
 
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
 class Handle_V3d_View;
-class ModelAPI_Feature;
+class ModuleBase_ViewerPrs;
+class GeomDataAPI_Point2D;
+class GeomAPI_Pln;
+class GeomAPI_Pnt2d;
+class GeomAPI_Pnt;
+class GeomAPI_Edge;
 
 /*!
  \class PartSet_Tools
  * \brief The operation for the sketch feature creation
-*/
+ */
 class PARTSET_EXPORT PartSet_Tools
 {
-public:
+ 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);
+  // 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 theX the X coordinate
   /// \param theY the Y coordinate
-  static void ConvertTo2D(const gp_Pnt& thePoint, boost::shared_ptr<ModelAPI_Feature> theSketch,
+  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 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,
+  /// if it exists, the first object is returned. Secondly, there is an iteration on
+  /// the selected list to find the point. Thirdly, if the object is not found under the
+  /// the point, the first selected object is returned.
+  /// \param thePoint a screen point
+  /// \param theView a 3D view
+  /// \param theSketch the sketch feature
+  /// \param theSelected the list of selected presentations
+  /// \param theHighlighted the list of highlighted presentations
+  static ObjectPtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
+                                  const QList<ModuleBase_ViewerPrs>& theSelected,
+                                  const QList<ModuleBase_ViewerPrs>& theHighlighted);
+
+  /// Returns pointer to the root document.
+  static std::shared_ptr<ModelAPI_Document> document();
+
+
+  /// 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);
+
+  /// \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(CompositeFeaturePtr theSketch,
+                               std::shared_ptr<GeomDataAPI_Point2D> thePoint1,
+                               std::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(CompositeFeaturePtr 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 std::shared_ptr<GeomAPI_Pln> sketchPlane(CompositeFeaturePtr 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 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);
+
+  /// 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);
+
+  /// Checks whether the list of selected presentations contains the given one
+  /// \param theSelected a list of presentations
+  /// \param thePrs a presentation to be found
+  /// \return - result of check, true if the list contains the prs
+  static bool isContainPresentation(const QList<ModuleBase_ViewerPrs>& theSelected,
+                                    const ModuleBase_ViewerPrs& thePrs);
+
+  /// Returns Result object if the given skietch contains external edge equal to the given
+  /// \param theSketch - the sketch feature
+  /// \param theEdge - the edge
+  /// \return result object with external edge if it is found
+  static ResultPtr findExternalEdge(CompositeFeaturePtr theSketch, std::shared_ptr<GeomAPI_Edge> theEdge);
+
+  /// Returns whether the selected presentation has a shape with the vertex type
+  /// \param thePrs a selected presentation
+  /// \param theSketch the sketch feature
+  /// \param theView a 3D view
+  /// \param theX the output horizontal coordinate of the point
+  /// \param theY the output vertical coordinate of the point
+  static bool hasVertexShape(const ModuleBase_ViewerPrs& thePrs, FeaturePtr theSketch,
+                             Handle_V3d_View theView, double& theX, double& theY);
+
+
+  /**
+  * Find attribute of object which corresponds to the given shape
+  * \param theObj - an object
+  * \param theShape - a Shape
+  * \param theSketch - a Sketch to get a plane of converting to 2d
+  */
+  static AttributePtr findAttributeBy2dPoint(ObjectPtr theObj, const TopoDS_Shape theShape, FeaturePtr theSketch);
+
+protected:
+  /// Returns an object that is under the mouse point. Firstly it checks the highlighting,
+  /// if it exists, the first object is returned. Secondly, there is an iteration on
+  /// the selected list to find the point. Thirdly, if the object is not found under the
+  /// the point, the first selected object is returned.
+  /// \param thePoint a screen point
+  /// \param theView a 3D view
+  /// \param theSketch the sketch feature
+  /// \param thePresentations the list of presentations
+  static ObjectPtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
+                                  const QList<ModuleBase_ViewerPrs>& thePresentations);
+
 };
 
 #endif