Back to home page

EIC code displayed by LXR

 
 

    


Warning, file /include/opencascade/GccAna_Circ2d2TanRad.hxx was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

0001 // Created on: 1991-03-21
0002 // Created by: Philippe DAUTRY
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016 
0017 #ifndef _GccAna_Circ2d2TanRad_HeaderFile
0018 #define _GccAna_Circ2d2TanRad_HeaderFile
0019 
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 
0023 #include <GccEnt_Array1OfPosition.hxx>
0024 #include <TColStd_Array1OfInteger.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TColgp_Array1OfCirc2d.hxx>
0027 #include <TColgp_Array1OfPnt2d.hxx>
0028 #include <TColStd_Array1OfReal.hxx>
0029 #include <GccEnt_Position.hxx>
0030 class GccEnt_QualifiedCirc;
0031 class GccEnt_QualifiedLin;
0032 class gp_Pnt2d;
0033 class gp_Circ2d;
0034 
0035 //! This class implements the algorithms used to
0036 //! create 2d circles tangent to 2
0037 //! points/lines/circles and with a given radius.
0038 //! For each construction methods arguments are:
0039 //! - Two Qualified elements for tangency constraints.
0040 //! (for example EnclosedCirc if we want the
0041 //! solution inside the argument EnclosedCirc).
0042 //! - Two Reals. One (Radius) for the radius and the
0043 //! other (Tolerance) for the tolerance.
0044 //! Tolerance is only used for the limit cases.
0045 //! For example :
0046 //! We want to create a circle inside a circle C1 and
0047 //! inside a circle C2 with a radius Radius and a
0048 //! tolerance Tolerance.
0049 //! If we do not use Tolerance it is impossible to
0050 //! find a solution in the following case : C2 is
0051 //! inside C1 and there is no intersection point
0052 //! between the two circles.
0053 //! With Tolerance it gives a solution if the lowest
0054 //! distance between C1 and C2 is lower than or equal
0055 //! Tolerance.
0056 class GccAna_Circ2d2TanRad
0057 {
0058 public:
0059   DEFINE_STANDARD_ALLOC
0060 
0061   //! This method implements the algorithms used to
0062   //! create 2d circles TANgent to two 2d circle with a
0063   //! radius of Radius.
0064   //! It raises NegativeValue if Radius is lower than zero.
0065   Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
0066                                        const GccEnt_QualifiedCirc& Qualified2,
0067                                        const Standard_Real         Radius,
0068                                        const Standard_Real         Tolerance);
0069 
0070   //! This method implements the algorithms used to
0071   //! create 2d circles TANgent to a 2d circle and a 2d line
0072   //! with a radius of Radius.
0073   //! It raises NegativeValue if Radius is lower than zero.
0074   Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
0075                                        const GccEnt_QualifiedLin&  Qualified2,
0076                                        const Standard_Real         Radius,
0077                                        const Standard_Real         Tolerance);
0078 
0079   //! This method implements the algorithms used to
0080   //! create 2d circles TANgent to a 2d circle and a point
0081   //! with a radius of Radius.
0082   //! It raises NegativeValue if Radius is lower than zero.
0083   Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
0084                                        const gp_Pnt2d&             Point2,
0085                                        const Standard_Real         Radius,
0086                                        const Standard_Real         Tolerance);
0087 
0088   //! This method implements the algorithms used to
0089   //! create 2d circles TANgent to a 2d line and a point
0090   //! with a radius of Radius.
0091   //! It raises NegativeValue if Radius is lower than zero.
0092   Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedLin& Qualified1,
0093                                        const gp_Pnt2d&            Point2,
0094                                        const Standard_Real        Radius,
0095                                        const Standard_Real        Tolerance);
0096 
0097   //! This method implements the algorithms used to
0098   //! create 2d circles TANgent to two 2d lines
0099   //! with a radius of Radius.
0100   //! It raises NegativeValue if Radius is lower than zero.
0101   Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedLin& Qualified1,
0102                                        const GccEnt_QualifiedLin& Qualified2,
0103                                        const Standard_Real        Radius,
0104                                        const Standard_Real        Tolerance);
0105 
0106   //! This method implements the algorithms used to
0107   //! create 2d circles passing through two points with a
0108   //! radius of Radius.
0109   //! It raises NegativeValue if Radius is lower than zero.
0110   Standard_EXPORT GccAna_Circ2d2TanRad(const gp_Pnt2d&     Point1,
0111                                        const gp_Pnt2d&     Point2,
0112                                        const Standard_Real Radius,
0113                                        const Standard_Real Tolerance);
0114 
0115   //! This method returns True if the algorithm succeeded.
0116   //! Note: IsDone protects against a failure arising from a
0117   //! more internal intersection algorithm, which has reached its numeric limits.
0118   Standard_EXPORT Standard_Boolean IsDone() const;
0119 
0120   //! This method returns the number of circles, representing solutions computed by this algorithm.
0121   //! Exceptions
0122   //! StdFail_NotDone if the construction fails. of solutions.
0123   Standard_EXPORT Standard_Integer NbSolutions() const;
0124 
0125   //! Returns the solution number Index.
0126   //! Be careful: the Index is only a way to get all the
0127   //! solutions, but is not associated to those outside the context
0128   //! of the algorithm-object. Raises OutOfRange exception if Index is greater
0129   //! than the number of solutions.
0130   //! It raises NotDone if the construction algorithm did not
0131   //! succeed.
0132   Standard_EXPORT gp_Circ2d ThisSolution(const Standard_Integer Index) const;
0133 
0134   //! Returns the information about the qualifiers of
0135   //! the tangency arguments concerning the solution number Index.
0136   //! It returns the real qualifiers (the qualifiers given to the
0137   //! constructor method in case of enclosed, enclosing and outside
0138   //! and the qualifiers computedin case of unqualified).
0139   Standard_EXPORT void WhichQualifier(const Standard_Integer Index,
0140                                       GccEnt_Position&       Qualif1,
0141                                       GccEnt_Position&       Qualif2) const;
0142 
0143   //! Returns information about the tangency point between the
0144   //! result number Index and the first argument.
0145   //! ParSol is the intrinsic parameter of the point PntSol on the solution.
0146   //! ParArg is the intrinsic parameter of the point PntSol on the first
0147   //! argument. Raises OutOfRange if Index is greater than the number
0148   //! of solutions.
0149   //! It raises NotDone if the construction algorithm did not succeed
0150   Standard_EXPORT void Tangency1(const Standard_Integer Index,
0151                                  Standard_Real&         ParSol,
0152                                  Standard_Real&         ParArg,
0153                                  gp_Pnt2d&              PntSol) const;
0154 
0155   //! Returns information about the tangency point between the
0156   //! result number Index and the second argument.
0157   //! ParSol is the intrinsic parameter of the point PntSol on
0158   //! the solution.
0159   //! ParArg is the intrinsic parameter of the point PntArg on
0160   //! the second argument. Raises OutOfRange if Index is greater than the number
0161   //! of solutions.
0162   //! It raises NotDone if the construction algorithm did not succeed.
0163   Standard_EXPORT void Tangency2(const Standard_Integer Index,
0164                                  Standard_Real&         ParSol,
0165                                  Standard_Real&         ParArg,
0166                                  gp_Pnt2d&              PntSol) const;
0167 
0168   //! Returns True if the solution number Index is equal to
0169   //! the first argument. Raises OutOfRange if Index is greater than the number
0170   //! of solutions.
0171   //! It raises NotDone if the construction algorithm did not
0172   //! succeed.
0173   Standard_EXPORT Standard_Boolean IsTheSame1(const Standard_Integer Index) const;
0174 
0175   //! Returns True if the solution number Index is equal to
0176   //! the second argument. Raises OutOfRange if Index is greater than the number
0177   //! of solutions.
0178   //! It raises NotDone if the construction algorithm did not  succeed.
0179   Standard_EXPORT Standard_Boolean IsTheSame2(const Standard_Integer Index) const;
0180 
0181 protected:
0182 private:
0183   Standard_Boolean        WellDone;
0184   GccEnt_Array1OfPosition qualifier1;
0185   GccEnt_Array1OfPosition qualifier2;
0186   TColStd_Array1OfInteger TheSame1;
0187   TColStd_Array1OfInteger TheSame2;
0188   Standard_Integer        NbrSol;
0189   TColgp_Array1OfCirc2d   cirsol;
0190   TColgp_Array1OfPnt2d    pnttg1sol;
0191   TColgp_Array1OfPnt2d    pnttg2sol;
0192   TColStd_Array1OfReal    par1sol;
0193   TColStd_Array1OfReal    par2sol;
0194   TColStd_Array1OfReal    pararg1;
0195   TColStd_Array1OfReal    pararg2;
0196 };
0197 
0198 #endif // _GccAna_Circ2d2TanRad_HeaderFile