Salome HOME
updated copyright message
[modules/shaper.git] / src / PartSet / PartSet_Tools.h
old mode 100755 (executable)
new mode 100644 (file)
index 69b9838..6a1ebf5
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef PartSet_Tools_H
 
 #include <QPoint>
 #include <QList>
+#include <QCursor>
 
 #include <ModelAPI_CompositeFeature.h>
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Attribute.h>
+#include <ModelAPI_AttributeSelection.h>
 
 #include <Events_Message.h>
 
@@ -143,6 +144,11 @@ public:
   /// \return API object of geom plane
   static std::shared_ptr<GeomAPI_Pln> sketchPlane(CompositeFeaturePtr theSketch);
 
+  /// Create a sketch plane instance
+  /// \param theSketch a sketch feature
+  /// \return API object of geom plane
+  static void nullifySketchPlane(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
@@ -166,12 +172,14 @@ public:
   /// \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
+  /// \param theCreatedFeature a new projection feature
   /// \return result of created feature
   static std::shared_ptr<ModelAPI_Result> createFixedObjectByExternal(
-                                               const TopoDS_Shape& theShape,
+                                               const std::shared_ptr<GeomAPI_Shape>& theShape,
                                                const ObjectPtr& theObject,
                                                CompositeFeaturePtr theSketch,
-                                               const bool theTemporary = false);
+                                               const bool theTemporary,
+                                               FeaturePtr& theCreatedFeature);
 
     /// Checks whether the list of selected presentations contains the given one
   /// \param theSelected a list of presentations
@@ -180,39 +188,16 @@ public:
   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 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 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
-  /// \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 std::shared_ptr<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
+  * \return Found attribute and index of point if the attribute is an array
   */
-  static AttributePtr findAttributeBy2dPoint(ObjectPtr theObj, const TopoDS_Shape theShape,
-                                             FeaturePtr theSketch);
+  static std::pair<AttributePtr, int> findAttributeBy2dPoint(ObjectPtr theObj,
+                                                             const TopoDS_Shape theShape,
+                                                             FeaturePtr theSketch);
 
   /**
   * Finds an attribute value in attribute reference attribute value
@@ -233,7 +218,7 @@ public:
 
   /**
   * Convertes parameters into a geom point
-  * \theEvent a Qt event to find mouse position
+  * \param theEvent a Qt event to find mouse position
   * \param theWindow view window to define eye of view
   * \param theSketch to convert 3D point coordinates into coorditates of the sketch plane
   */
@@ -241,6 +226,16 @@ public:
                                                  ModuleBase_IViewWindow* theWindow,
                                                  const FeaturePtr& theSketch);
 
+  /** Returns point 2d from selected shape
+   *  \param theView a view window
+   *  \param theShape a vertex shape
+   *  \param theX an output value of X coordinate
+   *  \param theY an output value of Y coordinate
+   */
+  static std::shared_ptr<GeomAPI_Pnt2d> getPnt2d(const Handle(V3d_View)& theView,
+                                                 const TopoDS_Shape& theShape,
+                                                 const FeaturePtr& theSketch);
+
   /**
   * 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
@@ -263,6 +258,27 @@ public:
                                QList<FeaturePtr>& theCoincidencies,
                                std::string theAttr, QList<bool>& theIsAttributes);
 
+  /*
+  * Finds and returns feature reerenced to the paramenter feature with the given name if found
+  * \param theFeature a source feature where refsToMe is obtained
+  * \param theFeatureId an indentifier of the searched feature
+  */
+  static FeaturePtr findRefsToMeFeature(FeaturePtr theFeature, const std::string& theFeatureId)
+  {
+    if (!theFeature.get())
+      return FeaturePtr();
+
+    // find first projected feature and edit it
+    const std::set<AttributePtr>& aRefsList = theFeature->data()->refsToMe();
+    std::set<AttributePtr>::const_iterator anIt;
+    for (anIt = aRefsList.cbegin(); anIt != aRefsList.cend(); ++anIt) {
+      FeaturePtr aRefFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*anIt)->owner());
+      if (aRefFeature && aRefFeature->getKind() == theFeatureId)
+        return aRefFeature;
+    }
+    return FeaturePtr();
+  }
+
   /**
   * Returns point of a coincedence
   * \param theStartCoin the coincedence feature
@@ -274,11 +290,51 @@ public:
                                    const Events_ID theId);
 
   /**
-   * Returns true if the object is a sketch entity, where auxiliary attribute has true vlaue
+   * Returns true if the object is a sketch entity, where auxiliary attribute has true value
    * \param theObject a result or feature
    * \return boolean result
    */
   static bool isAuxiliarySketchEntity(const ObjectPtr& theObject);
+
+  /**
+   * Returns true if the object is a sketch entity produced by projection or intersection feature
+   * and if it should not be included into the sketch result
+   */
+  static bool isIncludeIntoSketchResult(const ObjectPtr& theObject);
+
+  static ResultPtr createFixedByExternalCenter(const ObjectPtr& theObject,
+                                               const std::shared_ptr<GeomAPI_Edge>& theEdge,
+                                               ModelAPI_AttributeSelection::CenterType theType,
+                                               const CompositeFeaturePtr& theSketch,
+                                               bool theTemporary,
+                                               FeaturePtr& theCreatedFeature);
+
+
+  static void getFirstAndLastIndexInFolder(const ObjectPtr& theFolder,
+    int& theFirst, int& theLast);
+
+
+  /**
+  * Returns default color value for the given object
+  */
+  static void getDefaultColor(ObjectPtr theObject, const bool isEmptyColorValid,
+    std::vector<int>& theColor);
+
+  /**
+  * Returns default deflection value for the given object
+  */
+  static double getDefaultDeflection(const ObjectPtr& theObject);
+
+
+  /**
+  * Returns default transparency value
+  */
+  static double getDefaultTransparency();
+
+  /**
+  * Returns cursor according to (SKETCH_TAB_NAME, "operation_cursor") property value
+  */
+  static QCursor getOperationCursor();
 };
 
 #endif