src/GccAna/GccAna_LinPnt2dBisec.hxx

   1 // Created on: 1991-04-03
   2 // Created by: Remi GILET
   3 // Copyright (c) 1991-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _GccAna_LinPnt2dBisec_HeaderFile
  18 #define _GccAna_LinPnt2dBisec_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 class GccInt_Bisec;
  26 class Standard_ConstructionError;
  27 class StdFail_NotDone;
  28 class gp_Lin2d;
  29 class gp_Pnt2d;
  30
  31
  32 //! Describes functions for building bisecting curves between a 2D line and a point.
  33 //! A bisecting curve between a line and a point is such a
  34 //! curve that each of its points is at the same distance from
  35 //! the circle and the point. It can be a parabola or a line,
  36 //! depending on the relative position of the line and the
  37 //! circle. There is always one unique solution.
  38 //! A LinPnt2dBisec object provides a framework for:
  39 //! - defining the construction of the bisecting curve,
  40 //! - implementing the construction algorithm, and
  41 //! - consulting the result.
  42 class GccAna_LinPnt2dBisec
  43 {
  44 public:
  45
  46   DEFINE_STANDARD_ALLOC
  47
  48
  49   //! Constructs a bisecting curve between the line Line1 and the point Point2.
  50   Standard_EXPORT GccAna_LinPnt2dBisec(const gp_Lin2d& Line1, const gp_Pnt2d& Point2);
  51
  52   //! Returns True if the algorithm succeeded.
  53   Standard_EXPORT Standard_Boolean IsDone() const;
  54
  55   //! Returns the number of solutions.
  56   //! It raises NotDone if the construction algorithm didn't succeed.
  57   Standard_EXPORT Handle(GccInt_Bisec) ThisSolution() const;
  58
  59
  60
  61
  62 protected:
  63
  64
  65
  66
  67
  68 private:
  69
  70
  71
  72   Standard_Boolean WellDone;
  73   Handle(GccInt_Bisec) bissol;
  74
  75
  76 };
  77
  78
  79
  80
  81
  82
  83
  84 #endif // _GccAna_LinPnt2dBisec_HeaderFile