X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_PointBuilder.h;h=53db01ac67471c9abd9ff379f63951ccc4c5a994;hb=06e7f5859095193fc7f498bd89a7d28009794f53;hp=2715062bbed60759b0ef54597374bc2fb7d797e3;hpb=ae347a8a8014a15245199a3bb603413628e3f7d4;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_PointBuilder.h b/src/GeomAlgoAPI/GeomAlgoAPI_PointBuilder.h index 2715062bb..53db01ac6 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_PointBuilder.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_PointBuilder.h @@ -1,27 +1,86 @@ -// File: GeomAlgoAPI_PointBuilder.h -// Created: 02 Jun 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2023 CEA, EDF +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// -#ifndef GeomAlgoAPI_PointBuilder_HeaderFile -#define GeomAlgoAPI_PointBuilder_HeaderFile +#ifndef GeomAlgoAPI_PointBuilder_H_ +#define GeomAlgoAPI_PointBuilder_H_ #include -#include +#include -class GeomAPI_Shape; +class GeomAPI_Edge; +class GeomAPI_Face; class GeomAPI_Pnt; +class GeomAPI_Shape; +class GeomAPI_Vertex; -/**\class GeomAlgoAPI_PointBuilder - * \ingroup DataAlgo - * \brief Allows to create face-shapes by different parameters - */ - +/// \class GeomAlgoAPI_PointBuilder +/// \ingroup DataAlgo +/// \brief Allows to create vertex-shapes by different parameters class GEOMALGOAPI_EXPORT GeomAlgoAPI_PointBuilder { public: - /// Creates linear edge by two points - static boost::shared_ptr point( - boost::shared_ptr thePoint); + /// Creates a vertex by point + static std::shared_ptr vertex(const std::shared_ptr thePoint); + + /// Creates a vertex by point coordinates + static std::shared_ptr vertex(const double theX, + const double theY, + const double theZ); + + /// \brief Creates vertex by edge and distance on it. + /// \param[in] theEdge edge. + /// \param[in] theValue distance value. + /// \param[in] theIsPercent if true theValue will be treated + /// as a percentage of theEdge total length. + /// \param[in] theIsReverse if true the distance will be measured from the edge end point. + /// \return created vertex. + static std::shared_ptr vertexOnEdge(const std::shared_ptr theEdge, + const double theValue, + const bool theIsPercent = false, + const bool theIsReverse = false); + + /// \brief Creates vertex by projection another vertex on edge. + /// \param[in] theVertex vertex to project. + /// \param[in] theEdge edge for projection. + /// \return created vertex. + static std::shared_ptr + vertexByProjection(const std::shared_ptr theVertex, + const std::shared_ptr theEdge); + + /// \brief Creates vertex by projection another vertex on plane. + /// \param[in] theVertex vertex to project. + /// \param[in] theFace face for projection. Should be planar. + /// \return created vertex. + static std::shared_ptr + vertexByProjection(const std::shared_ptr theVertex, + const std::shared_ptr theFace); + + /// \brief Creates vertex by intersection two coplanar lines. + /// \param[in] theEdge1 first linear edge. + /// \param[in] theEdge2 second linear edge. + /// \return created vertex. + static std::shared_ptr + vertexByIntersection(const std::shared_ptr theEdge1, + const std::shared_ptr theEdge2); + + /// Return point by shape vertex + static std::shared_ptr point(const std::shared_ptr theVertex); }; #endif