X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_Lin.h;h=f6fdfc3034ed8cdeaf4ab71903af1712c0576ccc;hb=77ce6d35ac8d2f0fdaecb4f23e0870bf74e36103;hp=b0b3e265f401701289aae249eecab73451f249d3;hpb=2c4f7de06341fa7af89f47ba405fe188f13e3600;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_Lin.h b/src/GeomAPI/GeomAPI_Lin.h index b0b3e265f..f6fdfc303 100644 --- a/src/GeomAPI/GeomAPI_Lin.h +++ b/src/GeomAPI/GeomAPI_Lin.h @@ -1,13 +1,29 @@ -// File: GeomAPI_Lin.h -// Created: 29 May 2014 -// Author: Artem ZHIDKOV +// Copyright (C) 2014-2024 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 GeomAPI_Lin_H_ #define GeomAPI_Lin_H_ #include -#include +#include +class GeomAPI_Dir; class GeomAPI_Pnt; /**\class GeomAPI_Lin @@ -15,23 +31,64 @@ class GeomAPI_Pnt; * \brief Line in 3D */ -class GEOMAPI_EXPORT GeomAPI_Lin: public GeomAPI_Interface +class GeomAPI_Lin : public GeomAPI_Interface { -public: + public: /// Creation of line defined by cordinates of start and end points + GEOMAPI_EXPORT GeomAPI_Lin(const double theStartX, const double theStartY, const double theStartZ, - const double theEndX, const double theEndY, const double theEndZ); + const double theEndX, const double theEndY, const double theEndZ); /// Creation of line defined by start and end points - GeomAPI_Lin(const boost::shared_ptr& theStart, - const boost::shared_ptr& theEnd); + GEOMAPI_EXPORT + GeomAPI_Lin(const std::shared_ptr& theStart, + const std::shared_ptr& theEnd); + /// Creation of line defined by origin and direction + GEOMAPI_EXPORT + GeomAPI_Lin(const std::shared_ptr& theOrigin, + const std::shared_ptr& theDirection); + + /// Returns point on the line (first point) + GEOMAPI_EXPORT + std::shared_ptr location(); + + /// Returns a line direction + GEOMAPI_EXPORT + std::shared_ptr direction(); /// Distance between two points - double distance(const boost::shared_ptr& thePoint) const; + GEOMAPI_EXPORT + double distance(const std::shared_ptr& thePoint) const; /// Intersection of two lines - const boost::shared_ptr intersect(const boost::shared_ptr& theLine) const; + GEOMAPI_EXPORT + const std::shared_ptr intersect( + const std::shared_ptr& theLine) const; /// Project point on line - const boost::shared_ptr project(const boost::shared_ptr& thePoint) const; + GEOMAPI_EXPORT + const std::shared_ptr project( + const std::shared_ptr& thePoint) const; + + /// Returns parameter of the point projection + GEOMAPI_EXPORT + double projParam(const std::shared_ptr& thePoint) const; + + /// \return true if this line contains thePoint, that is, + /// if the distance between thePoint and this line + /// is less than or equal to theLinearTolerance. + GEOMAPI_EXPORT + bool contains(const std::shared_ptr thePoint, + const double theLinearTolerance = 1.e-7) const; + + /// \return true if lines are parallel. + GEOMAPI_EXPORT + bool isParallel(const std::shared_ptr theLin) const; + + /// \return true if lines are coplanar. + GEOMAPI_EXPORT + bool isCoplanar(const std::shared_ptr theLin) const; }; +//! Pointer on the object +typedef std::shared_ptr GeomLinePtr; + #endif