include/opencascade/GccAna_Circ2dBisec.hxx

0001 // Created on: 1991-04-03
0002 // Created by: Remi GILET
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_Circ2dBisec_HeaderFile
0018 #define _GccAna_Circ2dBisec_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <gp_Circ2d.hxx>
0027 class GccInt_Bisec;
0028
0029 //! This class describes functions for building bisecting curves between two 2D circles.
0030 //! A bisecting curve between two circles is a curve such
0031 //! that each of its points is at the same distance from the
0032 //! two circles. It can be an ellipse, hyperbola, circle or line,
0033 //! depending on the relative position of the two circles.
0034 //! The algorithm computes all the elementary curves which
0035 //! are solutions. There is no solution if the two circles are coincident.
0036 //! A Circ2dBisec object provides a framework for:
0037 //! -   defining the construction of the bisecting curves,
0038 //! -   implementing the construction algorithm, and consulting the result.
0039 class GccAna_Circ2dBisec
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Constructs bisecting curves between the two circles Circ1 and Circ2.
0045   Standard_EXPORT GccAna_Circ2dBisec(const gp_Circ2d& Circ1, const gp_Circ2d& Circ2);
0046
0047   //! This method returns True if the construction algorithm succeeded.
0048   Standard_EXPORT bool IsDone() const;
0049
0050   //! This method returns the number of solutions.
0051   //! Raises NotDone if the construction algorithm didn't succeed.
0052   Standard_EXPORT int NbSolutions() const;
0053
0054   //! Returns the solution number Index
0055   //! Raises OutOfRange exception if Index is greater than
0056   //! the number of solutions.
0057   //! It raises NotDone if the construction algorithm
0058   //! didn't succeed.
0059   Standard_EXPORT occ::handle<GccInt_Bisec> ThisSolution(const int Index) const;
0060
0061 private:
0062   bool      WellDone;
0063   int       NbrSol;
0064   int       intersection;
0065   bool      sameradius;
0066   gp_Circ2d circle1;
0067   gp_Circ2d circle2;
0068 };
0069
0070 #endif // _GccAna_Circ2dBisec_HeaderFile