Salome HOME
Issue #1941 Split auxiliary line.
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
index 8db945e80eb58f24647e82aceb9e2b0a11a776df..b4b26139c345fcc1fb82aba57441dbb2f8d65c68 100755 (executable)
@@ -9,7 +9,6 @@
 
 #include "PartSet.h"
 
-#include <ModuleBase_ViewerPrs.h>
 #include <gp_Pnt.hxx>
 
 #include <QPoint>
 
 #include <memory>
 
-class Handle_V3d_View;
+class V3d_View;
 class ModuleBase_ViewerPrs;
 class ModuleBase_IWorkshop;
 class GeomDataAPI_Point2D;
+class GeomAPI_Shape;
 class GeomAPI_Pln;
 class GeomAPI_Pnt2d;
 class GeomAPI_Pnt;
 class GeomAPI_Edge;
 class GeomAPI_Vertex;
+class ModelAPI_Result;
 
 /*!
  * \class PartSet_Tools
@@ -54,10 +55,14 @@ public:
   };
 
  public:
+  /// Returns default value of AIS presentation
+  /// \return integer value
+  static int getAISDefaultWidth();
+
   /// 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
@@ -73,13 +78,15 @@ public:
   /// \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);
+  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
-  static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY, FeaturePtr theSketch);
+  static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY,
+                                                  FeaturePtr theSketch);
 
   /// Returns pointer to the root document.
   static std::shared_ptr<ModelAPI_Document> document();
@@ -128,7 +135,7 @@ public:
   static std::shared_ptr<GeomDataAPI_Point2D> findFirstEqualPoint(const FeaturePtr& theFeature,
                                        const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
 
-  /// Creates constrains of the current 
+  /// Creates constrains of the current
   /// \param theSketch a sketch feature
   /// \param theFeature a source feature
   /// \param theAttribute a name of the requried attribute attribute
@@ -155,8 +162,9 @@ public:
   /// \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, 
+  static std::shared_ptr<ModelAPI_Result> findFixedObjectByExternal(
+                                             const TopoDS_Shape& theShape,
+                                             const ObjectPtr& theObject,
                                              CompositeFeaturePtr theSketch);
 
   /// Creates a line (arc or circle) by given edge
@@ -166,29 +174,32 @@ public:
   /// \param theSketch a sketch feature
   /// \param theTemporary the created external object is temporary, execute is not performed for it
   /// \return result of created feature
-  static ResultPtr createFixedObjectByExternal(const TopoDS_Shape& theShape, 
-                                               const ObjectPtr& theObject, 
+  static std::shared_ptr<ModelAPI_Result> createFixedObjectByExternal(
+                                               const TopoDS_Shape& theShape,
+                                               const ObjectPtr& theObject,
                                                CompositeFeaturePtr theSketch,
                                                const bool theTemporary = false);
 
-  /// Checks whether the list of selected presentations contains the given one
+    /// 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);
+  static bool isContainPresentation(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theSelected,
+                                    const std::shared_ptr<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);
+  static std::shared_ptr<ModelAPI_Result> 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);
+  static std::shared_ptr<ModelAPI_Result> 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
@@ -196,8 +207,9 @@ public:
   /// \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);
+  static bool hasVertexShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
+                             FeaturePtr theSketch,
+                             Handle(V3d_View) theView, double& theX, double& theY);
 
 
   /**
@@ -215,7 +227,7 @@ public:
   * \param theWorkshop a reference to workshop
   * \return a geometry shape
   */
-  static GeomShapePtr findShapeBy2DPoint(const AttributePtr& theAttribute,
+  static std::shared_ptr<GeomAPI_Shape> findShapeBy2DPoint(const AttributePtr& theAttribute,
                                          ModuleBase_IWorkshop* theWorkshop);
 
   /**
@@ -230,8 +242,8 @@ public:
   * Gets all references to the feature, take coincidence constraint features, get point 2d attributes
   * and compare the point value to be equal with the given. Returns the first feature, which has
   * equal points.
-  * \param theSearchInResults a flag whether the conicidence feature shoudl be searched in
-  * references of the feature results.
+  * \param theFeature the coincidence feature
+  * \param thePoint a 2d point
   * \return the coincidence feature or null
   */
   static FeaturePtr findFirstCoincidence(const FeaturePtr& theFeature,
@@ -241,6 +253,7 @@ public:
   * Returns list of features connected in a councedence feature point
   * \param theStartCoin the coincidence feature
   * \param theList a list which collects lines features
+  * \param theCoincidencies a list of coincidence features
   * \param theAttr the attribute name
   */
   static void findCoincidences(FeaturePtr theStartCoin, QList<FeaturePtr>& theList,
@@ -256,6 +269,13 @@ public:
   /// Sends redisplay event for all sub-features of the composite. Flush it.
   static void sendSubFeaturesEvent(const CompositeFeaturePtr& theComposite,
                                    const Events_ID theId);
+
+  /**
+   * Returns true if the object is a sketch entity, where auxiliary attribute has true vlaue
+   * \param theObject a result or feature
+   * \return boolean result
+   */
+  static bool isAuxiliarySketchEntity(const ObjectPtr& theObject);
 };
 
 #endif