include/opencascade/IntAna2d_IntPoint.hxx

0001 // Created on: 1991-02-20
0002 // Created by: Jacques GOUSSARD
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 _IntAna2d_IntPoint_HeaderFile
0018 #define _IntAna2d_IntPoint_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Pnt2d.hxx>
0025 #include <Standard_Boolean.hxx>
0026
0027 //! Geometrical intersection between two 2d elements.
0028 class IntAna2d_IntPoint
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   //! Create an intersection point between 2 parametric 2d lines.
0034   //! X,Y are the coordinate of the point. U1 is the parameter
0035   //! on the first element, U2 the parameter on the second one.
0036   Standard_EXPORT IntAna2d_IntPoint(const double X,
0037                                     const double Y,
0038                                     const double U1,
0039                                     const double U2);
0040
0041   //! Create an intersection point between a parametric 2d line,
0042   //! and a line given by an implicit equation (ImplicitCurve).
0043   //! X,Y are the coordinate of the point. U1 is the parameter
0044   //! on the parametric element.
0045   //! Empty constructor. It's necessary to use one of
0046   //! the SetValue method after this one.
0047   Standard_EXPORT IntAna2d_IntPoint(const double X, const double Y, const double U1);
0048
0049   Standard_EXPORT IntAna2d_IntPoint();
0050
0051   //! Set the values for a "non-implicit" point.
0052   Standard_EXPORT virtual void SetValue(const double X,
0053                                         const double Y,
0054                                         const double U1,
0055                                         const double U2);
0056
0057   //! Set the values for an "implicit" point.
0058   Standard_EXPORT virtual void SetValue(const double X, const double Y, const double U1);
0059
0060   //! Returns the geometric point.
0061   const gp_Pnt2d& Value() const;
0062
0063   //! Returns True if the second curve is implicit.
0064   bool SecondIsImplicit() const;
0065
0066   //! Returns the parameter on the first element.
0067   double ParamOnFirst() const;
0068
0069   //! Returns the parameter on the second element.
0070   //! If the second element is an implicit curve, an exception
0071   //! is raised.
0072   double ParamOnSecond() const;
0073
0074 private:
0075   double   myu1;
0076   double   myu2;
0077   gp_Pnt2d myp;
0078   bool     myimplicit;
0079 };
0080
0081 #include <IntAna2d_IntPoint.lxx>
0082
0083 #endif // _IntAna2d_IntPoint_HeaderFile