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
0030 //! This class describes functions for building bisecting curves between two 2D circles.
0031 //! A bisecting curve between two circles is a curve such
0032 //! that each of its points is at the same distance from the
0033 //! two circles. It can be an ellipse, hyperbola, circle or line,
0034 //! depending on the relative position of the two circles.
0035 //! The algorithm computes all the elementary curves which
0036 //! are solutions. There is no solution if the two circles are coincident.
0037 //! A Circ2dBisec object provides a framework for:
0038 //! -   defining the construction of the bisecting curves,
0039 //! -   implementing the construction algorithm, and consulting the result.
0040 class GccAna_Circ2dBisec
0041 {
0042 public:
0043
0044   DEFINE_STANDARD_ALLOC
0045
0046
0047   //! Constructs bisecting curves between the two circles Circ1 and Circ2.
0048   Standard_EXPORT GccAna_Circ2dBisec(const gp_Circ2d& Circ1, const gp_Circ2d& Circ2);
0049
0050   //! This method returns True if the construction algorithm succeeded.
0051   Standard_EXPORT Standard_Boolean IsDone() const;
0052
0053   //! This method returns the number of solutions.
0054   //! Raises NotDone if the construction algorithm  didn't succeed.
0055   Standard_EXPORT Standard_Integer NbSolutions() const;
0056
0057   //! Returns the solution number Index
0058   //! Raises OutOfRange exception if Index is greater than
0059   //! the number of solutions.
0060   //! It raises NotDone if the construction algorithm
0061   //! didn't succeed.
0062   Standard_EXPORT Handle(GccInt_Bisec) ThisSolution (const Standard_Integer Index) const;
0063
0064
0065
0066
0067 protected:
0068
0069
0070
0071
0072
0073 private:
0074
0075
0076
0077   Standard_Boolean WellDone;
0078   Standard_Integer NbrSol;
0079   Standard_Integer intersection;
0080   Standard_Boolean sameradius;
0081   gp_Circ2d circle1;
0082   gp_Circ2d circle2;
0083
0084
0085 };
0086
0087
0088
0089
0090
0091
0092
0093 #endif // _GccAna_Circ2dBisec_HeaderFile