0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IntTools / IntTools_TopolTool.hxx
1 // Created on: 2002-04-18
2 // Created by: Michael KLOKOV
3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _IntTools_TopolTool_HeaderFile
17 #define _IntTools_TopolTool_HeaderFile
18
19 #include <Adaptor3d_TopolTool.hxx>
20 #include <Adaptor3d_Surface.hxx>
21
22 class gp_Pnt2d;
23 class gp_Pnt;
24
25
26 class IntTools_TopolTool;
27 DEFINE_STANDARD_HANDLE(IntTools_TopolTool, Adaptor3d_TopolTool)
28
29 //! Class redefine methods of TopolTool from Adaptor3d
30 //! concerning sample points
31 class IntTools_TopolTool : public Adaptor3d_TopolTool
32 {
33
34 public:
35
36   
37
38   //! Empty constructor
39   Standard_EXPORT IntTools_TopolTool();
40   
41
42   //! Initializes me by surface
43   Standard_EXPORT IntTools_TopolTool(const Handle(Adaptor3d_Surface)& theSurface);
44   
45
46   //! Redefined empty initializer
47   //!
48   //! Warning:
49   //! Raises the exception NotImplemented
50   Standard_EXPORT virtual void Initialize() Standard_OVERRIDE;
51   
52
53   //! Initializes me by surface
54   Standard_EXPORT virtual void Initialize (const Handle(Adaptor3d_Surface)& theSurface) Standard_OVERRIDE;
55   
56   Standard_EXPORT virtual void ComputeSamplePoints() Standard_OVERRIDE;
57   
58
59   //! Computes the sample-points for the intersections algorithms
60   Standard_EXPORT virtual Standard_Integer NbSamplesU() Standard_OVERRIDE;
61   
62
63   //! Computes the sample-points for the intersections algorithms
64   Standard_EXPORT virtual Standard_Integer NbSamplesV() Standard_OVERRIDE;
65   
66
67   //! Computes the sample-points for the intersections algorithms
68   Standard_EXPORT virtual Standard_Integer NbSamples() Standard_OVERRIDE;
69   
70
71   //! Returns a 2d point from surface myS
72   //! and a corresponded 3d point
73   //! for given index.
74   //! The index should be from 1 to NbSamples()
75   Standard_EXPORT virtual void SamplePoint (const Standard_Integer Index, gp_Pnt2d& P2d, gp_Pnt& P3d) Standard_OVERRIDE;
76   
77   //! compute the sample-points for the intersections algorithms
78   //! by adaptive algorithm for BSpline surfaces. For other surfaces algorithm
79   //! is the same as in method ComputeSamplePoints(), but only fill arrays of U
80   //! and V sample parameters;
81   //! theDefl is a required deflection
82   //! theNUmin, theNVmin are minimal nb points for U and V.
83   Standard_EXPORT virtual void SamplePnts (const Standard_Real theDefl, const Standard_Integer theNUmin, const Standard_Integer theNVmin) Standard_OVERRIDE;
84
85
86
87
88   DEFINE_STANDARD_RTTIEXT(IntTools_TopolTool,Adaptor3d_TopolTool)
89
90 protected:
91
92
93
94
95 private:
96
97
98   Standard_Integer myNbSmplU;
99   Standard_Integer myNbSmplV;
100   Standard_Real myU0;
101   Standard_Real myV0;
102   Standard_Real myDU;
103   Standard_Real myDV;
104
105
106 };
107
108
109
110
111
112
113
114 #endif // _IntTools_TopolTool_HeaderFile