include/opencascade/GccAna_Pnt2dBisec.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_Pnt2dBisec_HeaderFile
0018 #define _GccAna_Pnt2dBisec_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Lin2d.hxx>
0024 class gp_Pnt2d;
0025
0026 //! This class implements the algorithms used to
0027 //! create the bisecting line between two 2d points
0028 //! Describes functions for building a bisecting line between two 2D points.
0029 //! The bisecting line between two points is the bisector of
0030 //! the segment which joins the two points, if these are not coincident.
0031 //! The algorithm does not find a solution if the two points are coincident.
0032 //! A Pnt2dBisec object provides a framework for:
0033 //! -   defining the construction of the bisecting line,
0034 //! -   implementing the construction algorithm, and consulting the result.
0035 class GccAna_Pnt2dBisec
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   //! Constructs a bisecting line between the points Point1 and Point2.
0041   Standard_EXPORT GccAna_Pnt2dBisec(const gp_Pnt2d& Point1, const gp_Pnt2d& Point2);
0042
0043   //! Returns true (this construction algorithm never fails).
0044   Standard_EXPORT bool IsDone() const;
0045
0046   //! Returns true if this algorithm has a solution, i.e. if the
0047   //! two points are not coincident.
0048   Standard_EXPORT bool HasSolution() const;
0049
0050   //! Returns a line, representing the solution computed by this algorithm.
0051   Standard_EXPORT gp_Lin2d ThisSolution() const;
0052
0053 private:
0054   bool     WellDone;
0055   bool     HasSol;
0056   gp_Lin2d linsol;
0057 };
0058
0059 #endif // _GccAna_Pnt2dBisec_HeaderFile