include/opencascade/GccAna_CircLin2dBisec.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_CircLin2dBisec_HeaderFile
0018 #define _GccAna_CircLin2dBisec_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 #include <gp_Lin2d.hxx>
0028 class GccInt_Bisec;
0029
0030 //! Describes functions for building bisecting curves between a 2D line and a 2D circle.
0031 //! A bisecting curve between a circle and a line is a curve
0032 //! such that each of its points is at the same distance from
0033 //! the circle and the line. It can be a parabola or a line,
0034 //! depending of the relative position of the line and the
0035 //! circle. The algorithm computes all the elementary curves which are solutions.
0036 //! A CircLin2dBisec object provides a framework for:
0037 //! -   defining the construction of the bisecting curves,
0038 //! -   implementing the construction algorithm, and
0039 //! -   consulting the result.
0040 class GccAna_CircLin2dBisec
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Constructs bisecting curves between the circle Circle and the line Line.
0046   Standard_EXPORT GccAna_CircLin2dBisec(const gp_Circ2d& Circle, const gp_Lin2d& Line);
0047
0048   //! Returns true (this construction algorithm never fails).
0049   Standard_EXPORT Standard_Boolean IsDone() const;
0050
0051   //! Returns the number of curves, representing solutions computed by this algorithm.
0052   Standard_EXPORT Standard_Integer NbSolutions() const;
0053
0054   //! Returns the solution number Index and raises OutOfRange
0055   //! exception if Index is greater than the number of solutions
0056   //! Exceptions
0057   //! Standard_OutOfRange if Index is less than zero or
0058   //! greater than the number of solutions computed by this algorithm.
0059   Standard_EXPORT Handle(GccInt_Bisec) ThisSolution(const Standard_Integer Index) const;
0060
0061 protected:
0062 private:
0063   Standard_Boolean WellDone;
0064   Standard_Integer NbrSol;
0065   gp_Circ2d        circle;
0066   gp_Lin2d         line;
0067 };
0068
0069 #endif // _GccAna_CircLin2dBisec_HeaderFile