SHAPER  9.12.0
GeomAPI_Ellipse2d.h
1 // Copyright (C) 2017-2023 CEA, EDF
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 // File: GeomAPI_Ellipse2d.h
21 // Created: 26 April 2017
22 // Author: Artem ZHIDKOV
23 
24 #ifndef GeomAPI_Ellipse2d_H_
25 #define GeomAPI_Ellipse2d_H_
26 
27 #include <GeomAPI_Interface.h>
28 
29 class GeomAPI_Circ2d;
30 class GeomAPI_Dir2d;
31 class GeomAPI_Lin2d;
32 class GeomAPI_Pnt2d;
33 
39 {
40 public:
42  GEOMAPI_EXPORT GeomAPI_Ellipse2d(const std::shared_ptr<GeomAPI_Pnt2d>& theCenter,
43  const std::shared_ptr<GeomAPI_Dir2d>& theXAxis,
44  const double theMajorRadius,
45  const double theMinorRadius);
46 
50  GEOMAPI_EXPORT GeomAPI_Ellipse2d(const std::shared_ptr<GeomAPI_Pnt2d>& theCenter,
51  const std::shared_ptr<GeomAPI_Pnt2d>& theAxisPoint,
52  const std::shared_ptr<GeomAPI_Pnt2d>& thePassingPoint);
53 
55  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> center() const;
56 
58  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> firstFocus() const;
59 
61  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> secondFocus() const;
62 
64  GEOMAPI_EXPORT double minorRadius() const;
65 
67  GEOMAPI_EXPORT double majorRadius() const;
68 
70  GEOMAPI_EXPORT const std::shared_ptr<GeomAPI_Pnt2d> project(
71  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) const;
72 
82  GEOMAPI_EXPORT const bool parameter(const std::shared_ptr<GeomAPI_Pnt2d> thePoint,
83  const double theTolerance,
84  double& theParameter) const;
85 
88  GEOMAPI_EXPORT double distance(const std::shared_ptr<GeomAPI_Lin2d>& theLine,
89  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnMe,
90  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnLine);
91 
94  GEOMAPI_EXPORT double distance(const std::shared_ptr<GeomAPI_Circ2d>& theCircle,
95  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnMe,
96  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnCircle);
97 
100  GEOMAPI_EXPORT double distance(const std::shared_ptr<GeomAPI_Ellipse2d>& theEllipse,
101  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnMe,
102  std::shared_ptr<GeomAPI_Pnt2d>& thePointOnEllipse);
103 };
104 
105 #endif
Circle in 2D.
Definition: GeomAPI_Circ2d.h:37
2D direction defined by three normalized coordinates
Definition: GeomAPI_Dir2d.h:34
Ellipse in 2D.
Definition: GeomAPI_Ellipse2d.h:39
GEOMAPI_EXPORT GeomAPI_Ellipse2d(const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, const std::shared_ptr< GeomAPI_Dir2d > &theXAxis, const double theMajorRadius, const double theMinorRadius)
Constructs ellipse by center, X-axis and given radii.
Definition: GeomAPI_Ellipse2d.cpp:82
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_Pnt2d > project(const std::shared_ptr< GeomAPI_Pnt2d > &thePoint) const
Project point on ellipse.
Definition: GeomAPI_Ellipse2d.cpp:210
GEOMAPI_EXPORT const bool parameter(const std::shared_ptr< GeomAPI_Pnt2d > thePoint, const double theTolerance, double &theParameter) const
Computes the parameter of a given point on an ellipse.
Definition: GeomAPI_Ellipse2d.cpp:230
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt2d > center() const
Returns center of the ellipse.
Definition: GeomAPI_Ellipse2d.cpp:98
GEOMAPI_EXPORT double distance(const std::shared_ptr< GeomAPI_Lin2d > &theLine, std::shared_ptr< GeomAPI_Pnt2d > &thePointOnMe, std::shared_ptr< GeomAPI_Pnt2d > &thePointOnLine)
Calculate minimal distance between the ellipse and a line.
Definition: GeomAPI_Ellipse2d.cpp:176
GEOMAPI_EXPORT double majorRadius() const
Returns major radius of the ellipse.
Definition: GeomAPI_Ellipse2d.cpp:121
GEOMAPI_EXPORT double minorRadius() const
Returns minor radius of the ellipse.
Definition: GeomAPI_Ellipse2d.cpp:116
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt2d > firstFocus() const
Returns first focus of the ellipse.
Definition: GeomAPI_Ellipse2d.cpp:104
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt2d > secondFocus() const
Returns second focus of the ellipse.
Definition: GeomAPI_Ellipse2d.cpp:110
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
Line in 2D.
Definition: GeomAPI_Lin2d.h:35
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36