0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IntSurf / IntSurf_PntOn2S.hxx
1 // Created on: 1992-05-06
2 // Created by: Jacques GOUSSARD
3 // Copyright (c) 1992-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 _IntSurf_PntOn2S_HeaderFile
18 #define _IntSurf_PntOn2S_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <gp_Pnt.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Boolean.hxx>
27 class gp_Pnt;
28 class gp_Pnt2d;
29
30
31 //! This class defines the geometric information
32 //! for an intersection point between 2 surfaces :
33 //! The coordinates ( Pnt from gp ), and two
34 //! parametric coordinates.
35 class IntSurf_PntOn2S 
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Empty constructor.
43   Standard_EXPORT IntSurf_PntOn2S();
44   
45   //! Sets the value of the point in 3d space.
46     void SetValue (const gp_Pnt& Pt);
47   
48   //! Sets the values of the point in 3d space, and
49   //! in the parametric space of one of the surface.
50   Standard_EXPORT void SetValue (const gp_Pnt& Pt, const Standard_Boolean OnFirst, const Standard_Real U, const Standard_Real V);
51   
52   //! Sets the values of the point in 3d space, and
53   //! in the parametric space of each surface.
54     void SetValue (const gp_Pnt& Pt, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2);
55   
56   //! Set the values of the point in the parametric
57   //! space of one of the surface.
58   Standard_EXPORT void SetValue (const Standard_Boolean OnFirst, const Standard_Real U, const Standard_Real V);
59   
60   //! Set the values of the point in the parametric
61   //! space of one of the surface.
62       void SetValue (const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2) ;
63   
64   //! Returns the point in 3d space.
65      const  gp_Pnt& Value()  const;
66   
67   //! Returns the point in 2d space of one of the surfaces.
68   Standard_EXPORT   gp_Pnt2d ValueOnSurface (const Standard_Boolean OnFirst)  const;
69   
70   //! Returns the parameters of the point on the first surface.
71     void ParametersOnS1 (Standard_Real& U1, Standard_Real& V1) const;
72   
73   //! Returns the parameters of the point on the second surface.
74       void ParametersOnS2 (Standard_Real& U2, Standard_Real& V2)  const;
75   
76   //! Returns the parameters of the point in the
77   //! parametric space of one of the surface.
78   Standard_EXPORT   void ParametersOnSurface (const Standard_Boolean OnFirst, Standard_Real& U, Standard_Real& V)  const;
79   
80   //! Returns the parameters of the point on both surfaces.
81       void Parameters (Standard_Real& U1, Standard_Real& V1, Standard_Real& U2, Standard_Real& V2)  const;
82   
83   //! Returns TRUE if 2D- and 3D-coordinates of theOterPoint are equal to
84   //! corresponding coordinates of me (with given tolerance).
85   //! If theTol2D < 0.0 we will compare 3D-points only.
86   Standard_EXPORT Standard_Boolean IsSame (const IntSurf_PntOn2S& theOtherPoint, const Standard_Real theTol3D = 0.0, const Standard_Real theTol2D = -1.0) const;
87
88
89
90
91 protected:
92
93
94
95
96
97 private:
98
99
100
101   gp_Pnt pt;
102   Standard_Real u1;
103   Standard_Real v1;
104   Standard_Real u2;
105   Standard_Real v2;
106
107
108 };
109
110
111 #include <IntSurf_PntOn2S.lxx>
112
113
114
115
116
117 #endif // _IntSurf_PntOn2S_HeaderFile