0031939: Coding - correction of spelling errors in comments
[occt.git] / src / GccAna / GccAna_Lin2dTanObl.hxx
1 // Created on: 1991-04-03
2 // Created by: Remi GILET
3 // Copyright (c) 1991-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 _GccAna_Lin2dTanObl_HeaderFile
18 #define _GccAna_Lin2dTanObl_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Integer.hxx>
26 #include <TColgp_Array1OfLin2d.hxx>
27 #include <GccEnt_Array1OfPosition.hxx>
28 #include <TColgp_Array1OfPnt2d.hxx>
29 #include <TColStd_Array1OfReal.hxx>
30 #include <Standard_Real.hxx>
31 #include <GccEnt_Position.hxx>
32 class Standard_OutOfRange;
33 class GccEnt_BadQualifier;
34 class StdFail_NotDone;
35 class gp_Pnt2d;
36 class gp_Lin2d;
37 class GccEnt_QualifiedCirc;
38
39
40 //! This class implements the algorithms used to
41 //! create 2d line tangent to a circle or a point and
42 //! making an angle with a line.
43 //! The angle is in radians.
44 //! The origin of the solution is the tangency point
45 //! with the first argument.
46 //! Its direction is making an angle Angle with the
47 //! second argument.
48 class GccAna_Lin2dTanObl 
49 {
50 public:
51
52   DEFINE_STANDARD_ALLOC
53
54   
55   //! This class implements the algorithms used to
56   //! create 2d line passing through a point and
57   //! making an angle with a line.
58   Standard_EXPORT GccAna_Lin2dTanObl(const gp_Pnt2d& ThePoint, const gp_Lin2d& TheLine, const Standard_Real TheAngle);
59   
60   //! This class implements the algorithms used to
61   //! create 2d line tangent to a circle and
62   //! making an angle with a line.
63   //! Exceptions
64   //! GccEnt_BadQualifier if a qualifier is inconsistent with
65   //! the argument it qualifies (for example, enclosed for a circle).
66   Standard_EXPORT GccAna_Lin2dTanObl(const GccEnt_QualifiedCirc& Qualified1, const gp_Lin2d& TheLine, const Standard_Real TheAngle);
67   
68   //! Returns True if the algorithm succeeded.
69   //! Note: IsDone protects against a failure arising from a
70   //! more internal intersection algorithm, which has reached
71   //! its numeric limits.
72   Standard_EXPORT Standard_Boolean IsDone() const;
73   
74   //! Returns the number of  of lines, representing solutions computed by this algorithm.
75   //! Raises NotDone if the construction algorithm didn't succeed.
76   Standard_EXPORT Standard_Integer NbSolutions() const;
77   
78   //! Returns the solution number Index.
79   //! Be careful: the Index is only a way to get all the
80   //! solutions, but is not associated to theses outside the
81   //! context of the algorithm-object.
82   //! raises NotDone if the construction algorithm didn't succeed.
83   //! It raises OutOfRange if Index is greater than the   number of solutions.
84   Standard_EXPORT gp_Lin2d ThisSolution (const Standard_Integer Index) const;
85   
86   //! Returns the qualifier Qualif1 of the tangency argument
87   //! for the solution of index Index computed by this algorithm.
88   //! The returned qualifier is:
89   //! -   that specified at the start of construction when the
90   //! solutions are defined as enclosing or outside with
91   //! respect to the argument, or
92   //! -   that computed during construction (i.e. enclosing or
93   //! outside) when the solutions are defined as unqualified
94   //! with respect to the argument, or
95   //! -   GccEnt_noqualifier if the tangency argument is a point.
96   //! Exceptions
97   //! Standard_OutOfRange if Index is less than zero or
98   //! greater than the number of solutions computed by this algorithm.
99   //! StdFail_NotDone if the construction fails.
100   Standard_EXPORT void WhichQualifier (const Standard_Integer Index, GccEnt_Position& Qualif1) const;
101   
102   //! Returns information about the tangency point between the
103   //! result number Index and the first argument.
104   //! ParSol is the intrinsic parameter of the point ParSol on
105   //! the solution curv.
106   //! ParArg is the intrinsic parameter of the point ParArg on
107   //! the argument curv. Raises NotDone if the construction algorithm
108   //! didn't succeed.
109   //! It raises OutOfRange if Index is greater than the  number of solutions.
110   Standard_EXPORT void Tangency1 (const Standard_Integer Index, Standard_Real& ParSol, Standard_Real& ParArg, gp_Pnt2d& PntSol) const;
111   
112   //! Returns information about the intersection between the
113   //! result number Index and the third argument.
114   //! Raises NotDone if the construction algorithm  didn't succeed.
115   //! It raises OutOfRange if Index is greater than the number of solutions.
116   Standard_EXPORT void Intersection2 (const Standard_Integer Index, Standard_Real& ParSol, Standard_Real& ParArg, gp_Pnt2d& PntSol) const;
117
118
119
120
121 protected:
122
123
124
125
126
127 private:
128
129
130
131   Standard_Boolean WellDone;
132   Standard_Integer NbrSol;
133   TColgp_Array1OfLin2d linsol;
134   GccEnt_Array1OfPosition qualifier1;
135   TColgp_Array1OfPnt2d pnttg1sol;
136   TColgp_Array1OfPnt2d pntint2sol;
137   TColStd_Array1OfReal par1sol;
138   TColStd_Array1OfReal par2sol;
139   TColStd_Array1OfReal pararg1;
140   TColStd_Array1OfReal pararg2;
141
142
143 };
144
145
146
147
148
149
150
151 #endif // _GccAna_Lin2dTanObl_HeaderFile