include/opencascade/IntSurf_PntOn2S.hxx

0001 // Created on: 1992-05-06
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1992-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 _IntSurf_PntOn2S_HeaderFile
0018 #define _IntSurf_PntOn2S_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Pnt.hxx>
0025 #include <Standard_Boolean.hxx>
0026 class gp_Pnt2d;
0027
0028
0029 //! This class defines the geometric information
0030 //! for an intersection point between 2 surfaces :
0031 //! The coordinates ( Pnt from gp ), and two
0032 //! parametric coordinates.
0033 class IntSurf_PntOn2S
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   //! Empty constructor.
0041   Standard_EXPORT IntSurf_PntOn2S();
0042
0043   //! Sets the value of the point in 3d space.
0044     void SetValue (const gp_Pnt& Pt);
0045
0046   //! Sets the values of the point in 3d space, and
0047   //! in the parametric space of one of the surface.
0048   Standard_EXPORT void SetValue (const gp_Pnt& Pt, const Standard_Boolean OnFirst, const Standard_Real U, const Standard_Real V);
0049
0050   //! Sets the values of the point in 3d space, and
0051   //! in the parametric space of each surface.
0052     void SetValue (const gp_Pnt& Pt, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2);
0053
0054   //! Set the values of the point in the parametric
0055   //! space of one of the surface.
0056   Standard_EXPORT void SetValue (const Standard_Boolean OnFirst, const Standard_Real U, const Standard_Real V);
0057
0058   //! Set the values of the point in the parametric
0059   //! space of one of the surface.
0060       void SetValue (const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2) ;
0061
0062   //! Returns the point in 3d space.
0063      const  gp_Pnt& Value()  const;
0064
0065   //! Returns the point in 2d space of one of the surfaces.
0066   Standard_EXPORT   gp_Pnt2d ValueOnSurface (const Standard_Boolean OnFirst)  const;
0067
0068   //! Returns the parameters of the point on the first surface.
0069     void ParametersOnS1 (Standard_Real& U1, Standard_Real& V1) const;
0070
0071   //! Returns the parameters of the point on the second surface.
0072       void ParametersOnS2 (Standard_Real& U2, Standard_Real& V2)  const;
0073
0074   //! Returns the parameters of the point in the
0075   //! parametric space of one of the surface.
0076   Standard_EXPORT   void ParametersOnSurface (const Standard_Boolean OnFirst, Standard_Real& U, Standard_Real& V)  const;
0077
0078   //! Returns the parameters of the point on both surfaces.
0079       void Parameters (Standard_Real& U1, Standard_Real& V1, Standard_Real& U2, Standard_Real& V2)  const;
0080
0081   //! Returns TRUE if 2D- and 3D-coordinates of theOterPoint are equal to
0082   //! corresponding coordinates of me (with given tolerance).
0083   //! If theTol2D < 0.0 we will compare 3D-points only.
0084   Standard_EXPORT Standard_Boolean IsSame (const IntSurf_PntOn2S& theOtherPoint, const Standard_Real theTol3D = 0.0, const Standard_Real theTol2D = -1.0) const;
0085
0086
0087
0088
0089 protected:
0090
0091
0092
0093
0094
0095 private:
0096
0097
0098
0099   gp_Pnt pt;
0100   Standard_Real u1;
0101   Standard_Real v1;
0102   Standard_Real u2;
0103   Standard_Real v2;
0104
0105
0106 };
0107
0108
0109 #include <IntSurf_PntOn2S.lxx>
0110
0111
0112
0113
0114
0115 #endif // _IntSurf_PntOn2S_HeaderFile