+// 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 ModuleBase_IWorkshop;
class GeomDataAPI_Point2D;
class GeomAPI_Pln;
class GeomAPI_Pnt2d;
class GeomAPI_Pnt;
-class PartSet_FeaturePrs;
+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:
+ /// \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
+ Any // both, geometrical and dimensional, types of constraints
+ };
+
+ 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);
-
- /// Creates the feature presentation
- /// \param theKind a feature kind
- /// \param theSketch the sketch of the feature
- /// \param theFeature the feature
- static boost::shared_ptr<PartSet_FeaturePrs> createFeaturePrs(const std::string& theKind,
- FeaturePtr theSketch,
- FeaturePtr theFeature = FeaturePtr());
-
- /// Returns a feature that is under the mouse point
- /// \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);
-
- /// \brief Move the feature.
- /// \param theFeature the source feature
- /// \param theDeltaX the delta for X coordinate is moved
- /// \param theDeltaY the delta for Y coordinate is moved
- static void moveFeature(FeaturePtr theFeature, double theDeltaX, double theDeltaY);
+ static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY, FeaturePtr theSketch);
/// Returns pointer to the root document.
- static boost::shared_ptr<ModelAPI_Document> document();
-
- /// \brief Save the point to the feature. If the attribute is 2D geometry point, it is filled.
- /// \param theFeature the feature
- /// \param theX the horizontal coordinate
- /// \param theY the vertical coordinate
- /// \param theAttribute the feature attribute
- static void setFeaturePoint(FeaturePtr theFeature, double theX, double theY,
- const std::string& theAttribute);
+ static std::shared_ptr<ModelAPI_Document> document();
/// \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 theX the horizontal coordinate
/// \param theAttribute the feature attribute
static void setFeatureValue(FeaturePtr theFeature, double theX, const std::string& theAttribute);
/// \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);
+ 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 thePoint1 the second point
- static void createConstraint(FeaturePtr theSketch,
- boost::shared_ptr<GeomDataAPI_Point2D> thePoint1,
- boost::shared_ptr<GeomDataAPI_Point2D> thePoint2);
-
- /// Find a point in the line with given coordinates
- /// \param theFeature the line feature
- /// \param theX the horizontal point coordinate
- /// \param theY the vertical point coordinate
- static boost::shared_ptr<GeomDataAPI_Point2D> findPoint(FeaturePtr theFeature, double theX,
- double theY);
+ /// \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 boost::shared_ptr<GeomAPI_Pln> sketchPlane(FeaturePtr theSketch);
+ 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 boost::shared_ptr<GeomAPI_Pnt> point3D(boost::shared_ptr<GeomAPI_Pnt2d> thePoint2D,
- FeaturePtr theSketch);
-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);
+ 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
+ /// \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,
+ 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);
+
+ /// 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);
+
+ /**
+ * 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 GeomShapePtr 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 theSearchInResults a flag whether the conicidence feature shoudl be searched in
+ * references of the feature results.
+ * \return the coincidence feature or null
+ */
+ static FeaturePtr findFirstCoincidence(const FeaturePtr& theFeature,
+ std::shared_ptr<GeomAPI_Pnt2d> thePoint,
+ const bool theSearchInResults = false);
+
+ /**
+ * Returns list of features connected in a councedence feature point
+ * \param theStartCoin the coincidence feature
+ * \param theList a list which collects lines features
+ * \param theAttr the attribute name
+ */
+ static void findCoincidences(FeaturePtr theStartCoin, QList<FeaturePtr>& theList,
+ std::string theAttr);
+
+ /**
+ * Returns point of a coincedence
+ * \param theStartCoin the coincedence feature
+ */
+ static std::shared_ptr<GeomAPI_Pnt2d> getCoincedencePoint(FeaturePtr theStartCoin);
};
#endif
