42cf5bc1 |
1 | // Created on: 1992-08-26 |
2 | // Created by: Remi GILET |
3 | // Copyright (c) 1992-1999 Matra Datavision |
4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
5 | // |
6 | // This file is part of Open CASCADE Technology software library. |
7 | // |
8 | // This library is free software; you can redistribute it and/or modify it under |
9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
10 | // by the Free Software Foundation, with special exception defined in the file |
11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | // distribution for complete text of the license and disclaimer of any warranty. |
13 | // |
14 | // Alternatively, this file may be used under the terms of Open CASCADE |
15 | // commercial license or contractual agreement. |
16 | |
17 | #ifndef _gce_MakeCirc2d_HeaderFile |
18 | #define _gce_MakeCirc2d_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_DefineAlloc.hxx> |
42cf5bc1 |
22 | |
23 | #include <gp_Circ2d.hxx> |
24 | #include <gce_Root.hxx> |
42cf5bc1 |
25 | class gp_Ax2d; |
26 | class gp_Ax22d; |
42cf5bc1 |
27 | class gp_Pnt2d; |
28 | |
29 | |
30 | //! This class implements the following algorithms used |
31 | //! to create Circ2d from gp. |
32 | //! |
33 | //! * Create a Circ2d concentric with another and passing |
34 | //! though a point. |
35 | //! * Create a Circ2d concentric with another at the distance |
36 | //! Dist. |
37 | //! * Create a Circ2d passing through 3 points. |
38 | //! * Create a Circ2d with its center and radius. |
39 | //! * Create a Circ2d with its center and a point given |
40 | //! the radius. |
41 | //! * Create a Circ2d with its axis and its radius. |
42 | class gce_MakeCirc2d : public gce_Root |
43 | { |
44 | public: |
45 | |
46 | DEFINE_STANDARD_ALLOC |
47 | |
48 | |
49 | |
50 | //! The location point of XAxis is the center of the circle. |
51 | //! Warnings : |
52 | //! It is not forbidden to create a circle with Radius = 0.0 |
53 | //! If Sense is true the local coordinate system of the solution |
54 | //! is direct and non direct in the other case. |
55 | //! The status is "NegativeRadius" if Radius < 0.0. |
56 | Standard_EXPORT gce_MakeCirc2d(const gp_Ax2d& XAxis, const Standard_Real Radius, const Standard_Boolean Sense = Standard_True); |
57 | |
58 | |
59 | //! The location point of Axis is the center of the circle. |
60 | //! Warnings : |
61 | //! It is not forbidden to create a circle with Radius = 0.0 |
62 | Standard_EXPORT gce_MakeCirc2d(const gp_Ax22d& Axis, const Standard_Real Radius); |
63 | |
64 | //! Makes a Circ2d from gp <TheCirc> concentric with another |
65 | //! circ2d <Circ> with a distance <Dist>. |
66 | //! If Dist is greater than zero the result encloses |
67 | //! the circle <Circ>, else the result is enclosed by the |
68 | //! circle <Circ>. |
69 | //! The local coordinate system of the solution is the |
70 | //! same as Circ. |
71 | Standard_EXPORT gce_MakeCirc2d(const gp_Circ2d& Circ, const Standard_Real Dist); |
72 | |
73 | //! Makes a Circ2d from gp <TheCirc> concentric with another |
74 | //! circ2d <Circ> and passing through a Pnt2d <Point>. |
75 | //! The local coordinate system of the solution is the |
76 | //! same as Circ. |
77 | Standard_EXPORT gce_MakeCirc2d(const gp_Circ2d& Circ, const gp_Pnt2d& Point); |
78 | |
79 | //! Makes a Circ2d from gp <TheCirc> passing through 3 |
80 | //! Pnt2d <P1>,<P2>,<P3>. |
81 | //! The local coordinate system of the solution is given |
82 | //! by the three points P1, P2, P3. |
83 | Standard_EXPORT gce_MakeCirc2d(const gp_Pnt2d& P1, const gp_Pnt2d& P2, const gp_Pnt2d& P3); |
84 | |
85 | //! Makes a Circ2d from gp <TheCirc> with its center |
86 | //! <Center> and its radius <Radius>. |
87 | //! If Sense is true the local coordinate system of |
88 | //! the solution is direct and non direct in the other case. |
89 | Standard_EXPORT gce_MakeCirc2d(const gp_Pnt2d& Center, const Standard_Real Radius, const Standard_Boolean Sense = Standard_True); |
90 | |
91 | //! Makes a Circ2d from gp <TheCirc> with its center |
92 | //! <Center> and a point giving the radius. |
93 | //! If Sense is true the local coordinate system of |
94 | //! the solution is direct and non direct in the other case. |
95 | Standard_EXPORT gce_MakeCirc2d(const gp_Pnt2d& Center, const gp_Pnt2d& Point, const Standard_Boolean Sense = Standard_True); |
96 | |
97 | //! Returns the constructed circle. |
98 | //! Exceptions StdFail_NotDone if no circle is constructed. |
99 | Standard_EXPORT const gp_Circ2d& Value() const; |
100 | |
101 | Standard_EXPORT const gp_Circ2d& Operator() const; |
102 | Standard_EXPORT operator gp_Circ2d() const; |
103 | |
104 | |
105 | |
106 | |
107 | protected: |
108 | |
109 | |
110 | |
111 | |
112 | |
113 | private: |
114 | |
115 | |
116 | |
117 | gp_Circ2d TheCirc2d; |
118 | |
119 | |
120 | }; |
121 | |
122 | |
123 | |
124 | |
125 | |
126 | |
127 | |
128 | #endif // _gce_MakeCirc2d_HeaderFile |