// Created on: 1991-03-21
// Created by: Philippe DAUTRY
// Copyright (c) 1991-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _GccAna_Circ2d2TanRad_HeaderFile
#define _GccAna_Circ2d2TanRad_HeaderFile

#include "Standard.hxx"
#include "Standard_DefineAlloc.hxx"

#include "GccEnt_Position.hxx"
#include "NCollection_Array1.hxx"
#include "Standard_Integer.hxx"
#include "gp_Circ2d.hxx"
#include "gp_Pnt2d.hxx"
class GccEnt_QualifiedCirc;
class GccEnt_QualifiedLin;
class gp_Pnt2d;
class gp_Circ2d;

//! This class implements the algorithms used to
//! create 2d circles tangent to 2
//! points/lines/circles and with a given radius.
//! For each construction methods arguments are:
//! - Two Qualified elements for tangency constraints.
//! (for example EnclosedCirc if we want the
//! solution inside the argument EnclosedCirc).
//! - Two Reals. One (Radius) for the radius and the
//! other (Tolerance) for the tolerance.
//! Tolerance is only used for the limit cases.
//! For example :
//! We want to create a circle inside a circle C1 and
//! inside a circle C2 with a radius Radius and a
//! tolerance Tolerance.
//! If we do not use Tolerance it is impossible to
//! find a solution in the following case : C2 is
//! inside C1 and there is no intersection point
//! between the two circles.
//! With Tolerance it gives a solution if the lowest
//! distance between C1 and C2 is lower than or equal
//! Tolerance.
class GccAna_Circ2d2TanRad
{
public:
  DEFINE_STANDARD_ALLOC

  //! This method implements the algorithms used to
  //! create 2d circles TANgent to two 2d circle with a
  //! radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
                                       const GccEnt_QualifiedCirc& Qualified2,
                                       const double                Radius,
                                       const double                Tolerance);

  //! This method implements the algorithms used to
  //! create 2d circles TANgent to a 2d circle and a 2d line
  //! with a radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
                                       const GccEnt_QualifiedLin&  Qualified2,
                                       const double                Radius,
                                       const double                Tolerance);

  //! This method implements the algorithms used to
  //! create 2d circles TANgent to a 2d circle and a point
  //! with a radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedCirc& Qualified1,
                                       const gp_Pnt2d&             Point2,
                                       const double                Radius,
                                       const double                Tolerance);

  //! This method implements the algorithms used to
  //! create 2d circles TANgent to a 2d line and a point
  //! with a radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedLin& Qualified1,
                                       const gp_Pnt2d&            Point2,
                                       const double               Radius,
                                       const double               Tolerance);

  //! This method implements the algorithms used to
  //! create 2d circles TANgent to two 2d lines
  //! with a radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const GccEnt_QualifiedLin& Qualified1,
                                       const GccEnt_QualifiedLin& Qualified2,
                                       const double               Radius,
                                       const double               Tolerance);

  //! This method implements the algorithms used to
  //! create 2d circles passing through two points with a
  //! radius of Radius.
  //! It raises NegativeValue if Radius is lower than zero.
  Standard_EXPORT GccAna_Circ2d2TanRad(const gp_Pnt2d& Point1,
                                       const gp_Pnt2d& Point2,
                                       const double    Radius,
                                       const double    Tolerance);

  //! This method returns True if the algorithm succeeded.
  //! Note: IsDone protects against a failure arising from a
  //! more internal intersection algorithm, which has reached its numeric limits.
  Standard_EXPORT bool IsDone() const;

  //! This method returns the number of circles, representing solutions computed by this algorithm.
  //! Exceptions
  //! StdFail_NotDone if the construction fails. of solutions.
  Standard_EXPORT int NbSolutions() const;

  //! Returns the solution number Index.
  //! Be careful: the Index is only a way to get all the
  //! solutions, but is not associated to those outside the context
  //! of the algorithm-object. Raises OutOfRange exception if Index is greater
  //! than the number of solutions.
  //! It raises NotDone if the construction algorithm did not
  //! succeed.
  Standard_EXPORT gp_Circ2d ThisSolution(const int Index) const;

  //! Returns the information about the qualifiers of
  //! the tangency arguments concerning the solution number Index.
  //! It returns the real qualifiers (the qualifiers given to the
  //! constructor method in case of enclosed, enclosing and outside
  //! and the qualifiers computedin case of unqualified).
  Standard_EXPORT void WhichQualifier(const int        Index,
                                      GccEnt_Position& Qualif1,
                                      GccEnt_Position& Qualif2) const;

  //! Returns information about the tangency point between the
  //! result number Index and the first argument.
  //! ParSol is the intrinsic parameter of the point PntSol on the solution.
  //! ParArg is the intrinsic parameter of the point PntSol on the first
  //! argument. Raises OutOfRange if Index is greater than the number
  //! of solutions.
  //! It raises NotDone if the construction algorithm did not succeed
  Standard_EXPORT void Tangency1(const int Index,
                                 double&   ParSol,
                                 double&   ParArg,
                                 gp_Pnt2d& PntSol) const;

  //! Returns information about the tangency point between the
  //! result number Index and the second argument.
  //! ParSol is the intrinsic parameter of the point PntSol on
  //! the solution.
  //! ParArg is the intrinsic parameter of the point PntArg on
  //! the second argument. Raises OutOfRange if Index is greater than the number
  //! of solutions.
  //! It raises NotDone if the construction algorithm did not succeed.
  Standard_EXPORT void Tangency2(const int Index,
                                 double&   ParSol,
                                 double&   ParArg,
                                 gp_Pnt2d& PntSol) const;

  //! Returns True if the solution number Index is equal to
  //! the first argument. Raises OutOfRange if Index is greater than the number
  //! of solutions.
  //! It raises NotDone if the construction algorithm did not
  //! succeed.
  Standard_EXPORT bool IsTheSame1(const int Index) const;

  //! Returns True if the solution number Index is equal to
  //! the second argument. Raises OutOfRange if Index is greater than the number
  //! of solutions.
  //! It raises NotDone if the construction algorithm did not succeed.
  Standard_EXPORT bool IsTheSame2(const int Index) const;

private:
  bool                                WellDone;
  NCollection_Array1<GccEnt_Position> qualifier1;
  NCollection_Array1<GccEnt_Position> qualifier2;
  NCollection_Array1<int>             TheSame1;
  NCollection_Array1<int>             TheSame2;
  int                                 NbrSol;
  NCollection_Array1<gp_Circ2d>       cirsol;
  NCollection_Array1<gp_Pnt2d>        pnttg1sol;
  NCollection_Array1<gp_Pnt2d>        pnttg2sol;
  NCollection_Array1<double>          par1sol;
  NCollection_Array1<double>          par2sol;
  NCollection_Array1<double>          pararg1;
  NCollection_Array1<double>          pararg2;
};

#endif // _GccAna_Circ2d2TanRad_HeaderFile