1 // Copyright (C) 2014-2020 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAlgoAPI_PointBuilder_H_
21 #define GeomAlgoAPI_PointBuilder_H_
23 #include <GeomAlgoAPI.h>
32 /// \class GeomAlgoAPI_PointBuilder
34 /// \brief Allows to create vertex-shapes by different parameters
35 class GEOMALGOAPI_EXPORT GeomAlgoAPI_PointBuilder
38 /// Creates a vertex by point
39 static std::shared_ptr<GeomAPI_Vertex> vertex(const std::shared_ptr<GeomAPI_Pnt> thePoint);
41 /// Creates a vertex by point coordinates
42 static std::shared_ptr<GeomAPI_Vertex> vertex(const double theX,
46 /// \brief Creates vertex by edge and distance on it.
47 /// \param[in] theEdge edge.
48 /// \param[in] theValue distance value.
49 /// \param[in] theIsPercent if true theValue will be treated
50 /// as a percentage of theEdge total length.
51 /// \param[in] theIsReverse if true the distance will be measured from the edge end point.
52 /// \return created vertex.
53 static std::shared_ptr<GeomAPI_Vertex> vertexOnEdge(const std::shared_ptr<GeomAPI_Edge> theEdge,
54 const double theValue,
55 const bool theIsPercent = false,
56 const bool theIsReverse = false);
58 /// \brief Creates vertex by projection another vertex on edge.
59 /// \param[in] theVertex vertex to project.
60 /// \param[in] theEdge edge for projection.
61 /// \return created vertex.
62 static std::shared_ptr<GeomAPI_Vertex>
63 vertexByProjection(const std::shared_ptr<GeomAPI_Vertex> theVertex,
64 const std::shared_ptr<GeomAPI_Edge> theEdge);
66 /// \brief Creates vertex by projection another vertex on plane.
67 /// \param[in] theVertex vertex to project.
68 /// \param[in] theFace face for projection. Should be planar.
69 /// \return created vertex.
70 static std::shared_ptr<GeomAPI_Vertex>
71 vertexByProjection(const std::shared_ptr<GeomAPI_Vertex> theVertex,
72 const std::shared_ptr<GeomAPI_Face> theFace);
74 /// \brief Creates vertex by intersection two coplanar lines.
75 /// \param[in] theEdge1 first linear edge.
76 /// \param[in] theEdge2 second linear edge.
77 /// \return created vertex.
78 static std::shared_ptr<GeomAPI_Vertex>
79 vertexByIntersection(const std::shared_ptr<GeomAPI_Edge> theEdge1,
80 const std::shared_ptr<GeomAPI_Edge> theEdge2);
82 /// Return point by shape vertex
83 static std::shared_ptr<GeomAPI_Pnt> point(const std::shared_ptr<GeomAPI_Shape> theVertex);