Salome HOME
Update classes documentation
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
old mode 100644 (file)
new mode 100755 (executable)
index 4ff7da4..3bbebc7
@@ -9,7 +9,6 @@
 
 #include "PartSet.h"
 
-#include <ModuleBase_ViewerPrs.h>
 #include <gp_Pnt.hxx>
 
 #include <QPoint>
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Attribute.h>
 
+#include <Events_Message.h>
+
 #include <TopoDS_Shape.hxx>
 
 #include <memory>
 
 class Handle_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
@@ -39,7 +43,22 @@ class GeomAPI_Vertex;
  */
 class PARTSET_EXPORT PartSet_Tools
 {
+public:
+  /// \enum ConstraintVisibleState types of constraints which visible state can be
+  /// changed in the sketch widget
+  enum ConstraintVisibleState
+  {
+    Geometrical = 0, // all constrains excepting dimensional
+    Dimensional,     // lenght, distance, radius and angle constraints
+    Expressions,     // parameter text should be shown in dimensional constraint
+    Any              // both, geometrical and dimensional, types of constraints
+  };
+
  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
@@ -55,44 +74,21 @@ class PARTSET_EXPORT PartSet_Tools
                           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
   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();
 
-  /// 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);
-
   /// \brief Save the double to the feature. If the attribute is double, it is filled.
   /// \param theFeature the feature
   /// \param theX the horizontal coordinate
@@ -123,6 +119,20 @@ class PARTSET_EXPORT PartSet_Tools
                                std::shared_ptr<GeomDataAPI_Point2D> thePoint1,
                                std::shared_ptr<GeomDataAPI_Point2D> thePoint2);
 
+  /// Finds in the feature's sub-features first Point2D attribute with the given point coordinates
+  /// \param theFeature a feature with sub-feature attributes
+  /// \param thePoint a point to provided searched coordinates
+  /// \return found point or null
+  static std::shared_ptr<GeomDataAPI_Point2D> findFirstEqualPointInArgumentFeatures(
+                  const FeaturePtr& theFeature, const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+
+  /// Finds in the feature first Point2D attribute with the given point coordinates
+  /// \param theFeature a feature with point attributes
+  /// \param thePoint a point to provided searched coordinates
+  /// \return found point or null
+  static std::shared_ptr<GeomDataAPI_Point2D> findFirstEqualPoint(const FeaturePtr& theFeature,
+                                       const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+
   /// Creates constrains of the current 
   /// \param theSketch a sketch feature
   /// \param theFeature a source feature
@@ -144,39 +154,50 @@ 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 std::shared_ptr<ModelAPI_Result> 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 theShape an edge
   /// \param theObject a selected result object
   /// \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, 
+  static std::shared_ptr<ModelAPI_Result> createFixedObjectByExternal(
+                                               const TopoDS_Shape& theShape, 
                                                const ObjectPtr& theObject, 
-                                               CompositeFeaturePtr theSketch);
+                                               CompositeFeaturePtr theSketch,
+                                               const bool theTemporary = false);
 
   /// 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
@@ -184,7 +205,7 @@ class PARTSET_EXPORT PartSet_Tools
   /// \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,
+  static bool hasVertexShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs, FeaturePtr theSketch,
                              Handle_V3d_View theView, double& theX, double& theY);
 
 
@@ -194,20 +215,64 @@ class PARTSET_EXPORT PartSet_Tools
   * \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);
+  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);
+  /**
+  * Finds an attribute value in attribute reference attribute value
+  * \param theAttribute - an attribure reference filled with an attribute
+  * \param theWorkshop a reference to workshop
+  * \return a geometry shape
+  */
+  static std::shared_ptr<GeomAPI_Shape> findShapeBy2DPoint(const AttributePtr& theAttribute,
+                                         ModuleBase_IWorkshop* theWorkshop);
 
+  /**
+  * Returns point of coincidence feature
+  * \param theFeature the coincidence feature
+  * \param theAttribute the attribute name
+  */
+  static std::shared_ptr<GeomAPI_Pnt2d> getPoint(std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                                 const std::string& theAttribute);
+
+  /**
+  * 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 theFeature the coincidence feature
+  * \param thePoint a 2d point
+  * \return the coincidence feature or null
+  */
+  static FeaturePtr findFirstCoincidence(const FeaturePtr& theFeature,
+                                         std::shared_ptr<GeomAPI_Pnt2d> thePoint);
+
+  /**
+  * 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,
+                               QList<FeaturePtr>& theCoincidencies,
+                               std::string theAttr);
+
+  /**
+  * Returns point of a coincedence
+  * \param theStartCoin the coincedence feature
+  */
+  static std::shared_ptr<GeomAPI_Pnt2d> getCoincedencePoint(FeaturePtr theStartCoin);
+
+  /// 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