+// 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_Feature.h>
+#include <ModelAPI_CompositeFeature.h>
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
-#include <boost/shared_ptr.hpp>
+#include <TopoDS_Shape.hxx>
-#include <list>
+#include <memory>
class Handle_V3d_View;
-class XGUI_ViewerPrs;
+class ModuleBase_ViewerPrs;
+class GeomDataAPI_Point2D;
+class GeomAPI_Pln;
+class GeomAPI_Pnt2d;
+class GeomAPI_Pnt;
+class GeomAPI_Edge;
+class GeomAPI_Vertex;
/*!
- \class PartSet_Tools
+ * \class PartSet_Tools
+ * \ingroup Modules
* \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
/// \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 theView a view 3d object
/// \param theX the X coordinate
/// \param theY the Y coordinate
static void convertTo2D(const gp_Pnt& thePoint, FeaturePtr theSketch,
- Handle(V3d_View) theView, double& theX, double& theY);
+ 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
- /// \param thePoint the 3D point in the viewer
- static void convertTo3D(const double theX, const double theY,
- FeaturePtr theSketch,
- gp_Pnt& thePoint);
-
- /// Returns the point of intersection of the two lines, the first is (v0, v1), the second is (v2, v3),
- /// where vi - {xi,yi}. If the v0 is on the second line, the result is a projection of the v1 to this line
- /// \param theX0 the horizontal coordinate of 0 point
- /// \param theY0 the vertical coordinate of 0 point
- /// \param theX1 the horizontal coordinate of 1 point
- /// \param theY1 the vertical coordinate of 1 point
- /// \param theX2 the horizontal coordinate of 2 point
- /// \param theY2 the vertical coordinate of 2 point
- /// \param theX3 the horizontal coordinate of 3 point
- /// \param theY3 the vertical coordinate of 3 point
- /// \param theX the output horizontal coordinate of the intersection point
- /// \param theY the outpup vertical coordinate of the intersection point
- static void intersectLines(double theX0, double theY0, double theX1, double theY1,
- double theX2, double theY2, double theX3, double theY3,
- double& theX, double& theY);
-
- /// Returns the coordinates of projection of the point to the line
- /// \param thePointX the projected point horizontal coordinate
- /// \param thePointY the projected point vertictal coordinate
- /// \param theX1 the horizontal coordinate of the first line point
- /// \param theY1 the vertical coordinate of the first line point
- /// \param theX2 the horizontal coordinate of the second line point
- /// \param theY2 the vertical coordinate of the second line point
- static void projectPointOnLine(double theX1, double theY1, double theX2, double theY2,
- double thePointX, double thePointY, double& theX, double& theY);
-
- /// Returns a feature that is under the mouse point
+ 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
+ /// \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 theSketch a sketch feature
+ /// \param thePoint1 the first point
+ /// \param thePoint2 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);
+
+ /// 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 ResultPtr 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
+ /// \return result of created feature
+ static ResultPtr createFixedObjectByExternal(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 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);
+
+ /// 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 theFeatures the list of selected presentations
- static FeaturePtr nearestFeature(QPoint thePoint, Handle_V3d_View theView,
- FeaturePtr theSketch,
- const std::list<XGUI_ViewerPrs>& theFeatures);
-private:
- /// Return the distance between the feature and the point
- /// \param theFeature feature object
- /// \param theX the horizontal coordinate of the point
- /// \param theX the vertical coordinate of the point
- static double distanceToPoint(FeaturePtr theFeature,
- double theX, double theY);
+ /// \param thePresentations the list of presentations
+ static ObjectPtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
+ const QList<ModuleBase_ViewerPrs>& thePresentations);
+
};
#endif