1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_Tools.h
4 // Created: 28 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef PartSet_Tools_H
8 #define PartSet_Tools_H
12 #include <ModuleBase_ViewerPrs.h>
18 #include <ModelAPI_CompositeFeature.h>
19 #include <ModelAPI_Object.h>
20 #include <ModelAPI_Attribute.h>
22 #include <TopoDS_Shape.hxx>
26 class Handle_V3d_View;
27 class ModuleBase_ViewerPrs;
28 class GeomDataAPI_Point2D;
37 * \brief The operation for the sketch feature creation
39 class PARTSET_EXPORT PartSet_Tools
42 /// Converts the 2D screen point to the 3D point on the view according to the point of view
43 /// \param thePoint a screen point
44 /// \param theView a 3D view
45 // Transferred to ModuleBase
46 static gp_Pnt convertClickToPoint(QPoint thePoint, Handle_V3d_View theView);
48 /// \brief Converts the 3D point to the projected coodinates on the sketch plane.
49 /// \param thePoint the 3D point in the viewer
50 /// \param theSketch the sketch feature
51 /// \param theX the X coordinate
52 /// \param theY the Y coordinate
53 static void convertTo2D(const gp_Pnt& thePoint, FeaturePtr theSketch,
54 Handle(V3d_View) theView,
55 double& theX, double& theY);
57 /// \brief Converts the 2D projected coodinates on the sketch plane to the 3D point.
58 /// \param theX the X coordinate
59 /// \param theY the Y coordinate
60 /// \param theSketch the sketch feature
61 /// \param thePoint the 3D point in the viewer
62 static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY, FeaturePtr theSketch);
64 /// Returns an object that is under the mouse point. Firstly it checks the highlighting,
65 /// if it exists, the first object is returned. Secondly, there is an iteration on
66 /// the selected list to find the point. Thirdly, if the object is not found under the
67 /// the point, the first selected object is returned.
68 /// \param thePoint a screen point
69 /// \param theView a 3D view
70 /// \param theSketch the sketch feature
71 /// \param theSelected the list of selected presentations
72 /// \param theHighlighted the list of highlighted presentations
73 static ObjectPtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
74 const QList<ModuleBase_ViewerPrs>& theSelected,
75 const QList<ModuleBase_ViewerPrs>& theHighlighted);
77 /// Returns pointer to the root document.
78 static std::shared_ptr<ModelAPI_Document> document();
81 /// Returns a point attribute of the feature by the coordinates if it is
82 /// \param theFeature the feature
83 /// \param theX the horizontal coordinate
84 /// \param theY the vertical coordinate
85 static std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(FeaturePtr theFeature,
86 double theX, double theY);
88 /// \brief Save the double to the feature. If the attribute is double, it is filled.
89 /// \param theFeature the feature
90 /// \param theValue the horizontal coordinate
91 /// \param theAttribute the feature attribute
92 static void setFeatureValue(FeaturePtr theFeature, double theX, const std::string& theAttribute);
94 /// \brief Returns the feature double value if it is.
95 /// \param theFeature the feature
96 /// \param theAttribute the feature attribute
97 /// \param isValid an output parameter whether the value is valid
98 /// \returns the feature value
99 static double featureValue(FeaturePtr theFeature, const std::string& theAttribute, bool& isValid);
101 /// Find a feature in the attribute of the given feature. If the kind is not empty,
102 /// the return feature should be this type. Otherwise it is null
103 /// \param theFeature a source feature
104 /// \param theAttribute a name of the requried attribute attribute
105 /// \param theKind an output feature kind
106 /// \return the feature
107 static FeaturePtr feature(FeaturePtr theFeature, const std::string& theAttribute,
108 const std::string& theKind);
110 /// Creates a constraint on two points
111 /// \param thePoint1 the first point
112 /// \param thePoint1 the second point
113 static void createConstraint(CompositeFeaturePtr theSketch,
114 std::shared_ptr<GeomDataAPI_Point2D> thePoint1,
115 std::shared_ptr<GeomDataAPI_Point2D> thePoint2);
117 /// Creates constrains of the current
118 /// \param theSketch a sketch feature
119 /// \param theFeature a source feature
120 /// \param theAttribute a name of the requried attribute attribute
121 /// \param theClickedX the horizontal coordnate of the point
122 /// \param theClickedY the vertical coordnate of the point
123 static void setConstraints(CompositeFeaturePtr theSketch, FeaturePtr theFeature,
124 const std::string& theAttribute, double theClickedX,
127 /// Create a sketch plane instance
128 /// \param theSketch a sketch feature
129 /// \return API object of geom plane
130 static std::shared_ptr<GeomAPI_Pln> sketchPlane(CompositeFeaturePtr theSketch);
132 /// Create a point 3D on a basis of point 2D and sketch feature
133 /// \param thePoint2D a point on a sketch
134 /// \param theSketch a sketch feature
135 /// \return API object of point 3D
136 static std::shared_ptr<GeomAPI_Pnt> point3D(std::shared_ptr<GeomAPI_Pnt2d> thePoint2D,
137 CompositeFeaturePtr theSketch);
138 /// Check whether there is a constraint with the feature kind given
139 /// \param theKind a feature kind
140 /// \return the boolean value
141 static bool isConstraintFeature(const std::string& theKind);
143 /// Creates a line (arc or circle) by given edge
144 /// Created line will have fixed constraint
145 /// \param theEdge - an edge
146 /// \return - result of created feature
147 static ResultPtr createFixedObjectByEdge(const TopoDS_Shape& theShape,
148 const ObjectPtr& theObject,
149 CompositeFeaturePtr theSketch);
151 /// Checks whether the list of selected presentations contains the given one
152 /// \param theSelected a list of presentations
153 /// \param thePrs a presentation to be found
154 /// \return - result of check, true if the list contains the prs
155 static bool isContainPresentation(const QList<ModuleBase_ViewerPrs>& theSelected,
156 const ModuleBase_ViewerPrs& thePrs);
158 /// Returns Result object if the given skietch contains external edge equal to the given
159 /// \param theSketch - the sketch feature
160 /// \param theEdge - the edge
161 /// \return result object with external edge if it is found
162 static ResultPtr findExternalEdge(CompositeFeaturePtr theSketch, std::shared_ptr<GeomAPI_Edge> theEdge);
164 /// Returns Result object if the given sketch contains external vertex equal to the given
165 /// \param theSketch - the sketch feature
166 /// \param theVert - the vertex
167 /// \return result object with external vertex if it is found
168 static ResultPtr findExternalVertex(CompositeFeaturePtr theSketch, std::shared_ptr<GeomAPI_Vertex> theVert);
170 /// Returns whether the selected presentation has a shape with the vertex type
171 /// \param thePrs a selected presentation
172 /// \param theSketch the sketch feature
173 /// \param theView a 3D view
174 /// \param theX the output horizontal coordinate of the point
175 /// \param theY the output vertical coordinate of the point
176 static bool hasVertexShape(const ModuleBase_ViewerPrs& thePrs, FeaturePtr theSketch,
177 Handle_V3d_View theView, double& theX, double& theY);
181 * Find attribute of object which corresponds to the given shape
182 * \param theObj - an object
183 * \param theShape - a Shape
184 * \param theSketch - a Sketch to get a plane of converting to 2d
186 static AttributePtr findAttributeBy2dPoint(ObjectPtr theObj, const TopoDS_Shape theShape, FeaturePtr theSketch);
189 /// Returns an object that is under the mouse point. Firstly it checks the highlighting,
190 /// if it exists, the first object is returned. Secondly, there is an iteration on
191 /// the selected list to find the point. Thirdly, if the object is not found under the
192 /// the point, the first selected object is returned.
193 /// \param thePoint a screen point
194 /// \param theView a 3D view
195 /// \param theSketch the sketch feature
196 /// \param thePresentations the list of presentations
197 static ObjectPtr nearestFeature(QPoint thePoint, Handle_V3d_View theView, FeaturePtr theSketch,
198 const QList<ModuleBase_ViewerPrs>& thePresentations);