X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_Circ2d.h;h=478c9986a76e7d3648569f78c7973b71e1c3a4a7;hb=4d6bb9de0e54f09a9bbacc94a058cb7cd437d535;hp=e95d8643c670fb551e31953f3ddc4d69a2f17c71;hpb=142e6a7451245b1c39e5d0afbabb5dc4f678520e;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_Circ2d.h b/src/GeomAPI/GeomAPI_Circ2d.h index e95d8643c..478c9986a 100644 --- a/src/GeomAPI/GeomAPI_Circ2d.h +++ b/src/GeomAPI/GeomAPI_Circ2d.h @@ -1,12 +1,14 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: GeomAPI_Circ2d.h // Created: 29 May 2014 // Author: Artem ZHIDKOV -#ifndef GeomAPI_Circ2d_HeaderFile -#define GeomAPI_Circ2d_HeaderFile +#ifndef GeomAPI_Circ2d_H_ +#define GeomAPI_Circ2d_H_ #include -#include +#include class GeomAPI_Pnt2d; class GeomAPI_Dir2d; @@ -16,26 +18,52 @@ class GeomAPI_Dir2d; * \brief Circle in 2D */ -class GEOMAPI_EXPORT GeomAPI_Circ2d: public GeomAPI_Interface +class GeomAPI_Circ2d : public GeomAPI_Interface { -public: + public: /// Creation of circle defined by center point and circle radius - GeomAPI_Circ2d(const boost::shared_ptr& theCenter, - const boost::shared_ptr& theCirclePoint); + GEOMAPI_EXPORT + GeomAPI_Circ2d(const std::shared_ptr& theCenter, + const std::shared_ptr& theCirclePoint); /// Creation of circle defined by center point, direction and circle radius - GeomAPI_Circ2d(const boost::shared_ptr& theCenter, - const boost::shared_ptr& theDir, - double theRadius); + GEOMAPI_EXPORT + GeomAPI_Circ2d(const std::shared_ptr& theCenter, + const std::shared_ptr& theDir, double theRadius); /// Return center of the circle - const boost::shared_ptr center() const; + GEOMAPI_EXPORT + const std::shared_ptr center() const; /// Return radius of the circle + GEOMAPI_EXPORT double radius() 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; + + /** \brief Computes the parameter of a given point on a circle. The point must be + * located either on the circle itself or relatively to the latter + * at a distance less than the tolerance value. Return FALSE if the point + * is beyond the tolerance limit or if computation fails. + * Max Tolerance value is currently limited to 1.e-4 + * \param[in] thePoint point of origin. + * \param[in] theTolerance tolerance of computation. + * \param[out] theParameter resulting parameter. + */ + GEOMAPI_EXPORT const bool parameter(const std::shared_ptr thePoint, + const double theTolerance, + double& theParameter) const; + + /** \brief Returns in thePoint the point of parameter theU. + * P = C + R * Cos (U) * XDir + R * Sin (U) * YDir where C is the center of the circle, + * XDir the XDirection and YDir the YDirection of the circle's local coordinate system. + * \param[in] theU parameter. + * \param[out] thePoint resulting point. + */ + GEOMAPI_EXPORT void D0(const double theU, std::shared_ptr& thePoint); }; #endif