-// File: GeomAPI_Circ.h
-// Created: 24 Jun 2014
-// Author: Artem ZHIDKOV
+// Copyright (C) 2014-2020 CEA/DEN, EDF R&D
+//
+// 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_Circ_H_
#define GeomAPI_Circ_H_
#include <GeomAPI_Interface.h>
-#include <boost/shared_ptr.hpp>
+#include <GeomAPI_Curve.h>
+#include <memory>
+class GeomAPI_Ax2;
class GeomAPI_Pnt;
class GeomAPI_Dir;
* \brief Circle in 3D
*/
-class GEOMAPI_EXPORT GeomAPI_Circ: public GeomAPI_Interface
+class GeomAPI_Circ : public GeomAPI_Interface
{
-public:
+ public:
+
+ /** \brief Constructs a circle of radius Radius, where theAx2 locates
+ * the circle and defines its orientation in 3D space such that:\n
+ * - the center of the circle is the origin of theAx2;\n
+ * - the origin, "X Direction" and "Y Direction" of theAx2 define the plane of the circle;\n
+ * - theAx2 is the local coordinate system of the circle.\n
+ * Note: It is possible to create a circle where Radius is equal to 0.0. raised if Radius < 0.
+ */
+ GEOMAPI_EXPORT GeomAPI_Circ(const std::shared_ptr<GeomAPI_Ax2> theAx2,
+ const double theRadius);
+
/// Creation of circle defined by center point, direction and circle radius
- GeomAPI_Circ(const boost::shared_ptr<GeomAPI_Pnt>& theCenter,
- const boost::shared_ptr<GeomAPI_Dir>& theDir,
- double theRadius);
+ GEOMAPI_EXPORT GeomAPI_Circ(const std::shared_ptr<GeomAPI_Pnt>& theCenter,
+ const std::shared_ptr<GeomAPI_Dir>& theDir, double theRadius);
+
+ /// Creation of circle defined by a curve
+ GEOMAPI_EXPORT GeomAPI_Circ(const GeomCurvePtr& theCurve);
/// Return center of the circle
- const boost::shared_ptr<GeomAPI_Pnt> center() const;
+ GEOMAPI_EXPORT const std::shared_ptr<GeomAPI_Pnt> center() const;
/// Return radius of the circle
- double radius() const;
+ GEOMAPI_EXPORT double radius() const;
+
+ /// Return orthogonal direction to the circle's plane
+ GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> normal() const;
/// Project point on circle
- const boost::shared_ptr<GeomAPI_Pnt> project(const boost::shared_ptr<GeomAPI_Pnt>& thePoint) const;
+ GEOMAPI_EXPORT const std::shared_ptr<GeomAPI_Pnt> project(
+ const std::shared_ptr<GeomAPI_Pnt>& 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<GeomAPI_Pnt> thePoint,
+ const double theTolerance,
+ double& theParameter) const;
};
+//! Pointer on the object
+typedef std::shared_ptr<GeomAPI_Circ> GeomCirclePtr;
+
#endif
