Salome HOME
be1521bdc460313c56fb54362784d1b42d7d7099
[modules/shaper.git] / src / ModelGeomAlgo / ModelGeomAlgo_Point2D.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelGeomAlgo_Point2D.h
4 // Created:     20 Jul 2016
5 // Author:      Natalia ERMOLAEVA
6
7 #ifndef ModelGeomAlgo_Point2D_H
8 #define ModelGeomAlgo_Point2D_H
9
10 #include "ModelGeomAlgo.h"
11 #include "ModelAPI_Feature.h"
12
13 class ModelAPI_Feature;
14 class ModelAPI_Object;
15 class GeomAPI_Shape;
16 class GeomAPI_Pnt;
17 class GeomAPI_Dir;
18
19 class GeomDataAPI_Point2D;
20
21 #include <memory>
22 #include <string>
23 #include <set>
24
25
26 namespace ModelGeomAlgo_Point2D {
27
28   /// Searches Point2D attribute of reference of the attribute of given feature
29   /// \param theFeature a feature to obtain AttributeRefAttr
30   /// \param theAttribute a name of AttributeRefAttr on the given feature
31   /// \param theObjectFeatureKind a feature kind in object of attribute that satisfies the search
32   /// \param theObjectFeatureAttribute a feature attribute in object that satisfies the search
33   /// \param isSkipFeatureAttributes a boolean value if coincidences to the feature attributes
34   /// \returns found point attribute or NULL
35   MODELGEOMALGO_EXPORT std::shared_ptr<GeomDataAPI_Point2D> getPointOfRefAttr(
36                         ModelAPI_Feature* theFeature,
37                         const std::string& theAttribute,
38                         const std::string& theObjectFeatureKind = "",
39                         const std::string& theObjectFeatureAttribute = "");
40
41   /// Fills container of point 2D attributes, which refer to the feature through the references
42   /// features with the given kind
43   /// \param theObject an object where references should be searched (e.g. a sketch line or result)
44   /// \param theReferenceFeatureKind a kind of the feature to be processed (e.g. coincidence constraint)
45   /// \param theAttributes a container of found point 2D attributes
46   /// \param theObjectFeatureKind a feature kind in object of attribute that satisfies the search
47   /// \param theObjectFeatureAttribute a feature attribute in object that satisfies the search
48   /// \param isSkipFeatureAttributes a boolean value if coincidences to the feature attributes
49   /// should be skipped
50   /// \returns found point attribute or NULL
51   MODELGEOMALGO_EXPORT void getPointsOfReference(const std::shared_ptr<ModelAPI_Object>& theObject,
52                                           const std::string& theReferenceFeatureKind,
53                                           std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theAttributes,
54                                           const std::string& theObjectFeatureKind = "",
55                                           const std::string& theObjectFeatureAttribute = "",
56                                           const bool isSkipFeatureAttributes = true);
57
58   /// Removes attributes which points are out of the base shape
59   /// \param theBaseShape a shape of check
60   /// \param theAttributes a container of point 2D attributes
61   /// \param theOrigin origin of a plane to generate 3D point by 2D attribute point
62   /// \param theDirX plane X direction to generate 3D point by 2D attribute point
63   /// \param theDirY plane X direction to generate 3D point by 2D attribute point
64   /// \param thePoints a container of 3D points belong to the shape
65   MODELGEOMALGO_EXPORT void getPointsInsideShape(
66                               const std::shared_ptr<GeomAPI_Shape> theBaseShape,
67                               const std::set<std::shared_ptr<GeomDataAPI_Point2D> >& theAttributes,
68                               const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
69                               const std::shared_ptr<GeomAPI_Dir>& theDirX,
70                               const std::shared_ptr<GeomAPI_Dir>& theDirY,
71                               std::set<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
72
73   /// Finds projected point to the given shape line
74   /// \param theBaseShape a shape of check
75   /// \param thePoint [in] a point to project
76   /// \param theProjectedPoint [out] a projected point
77   MODELGEOMALGO_EXPORT bool isPointOnEdge(const std::shared_ptr<GeomAPI_Shape> theBaseShape,
78                                           const std::shared_ptr<GeomAPI_Pnt>& thePoint,
79                                           std::shared_ptr<GeomAPI_Pnt>& theProjectedPoint);
80 }
81
82 #endif