summaryrefslogtreecommitdiff
path: root/inc/GCPnts_QuasiUniformDeflection.hxx
blob: d48f884cbeff5947015a0887e72f25c787f1b0fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _GCPnts_QuasiUniformDeflection_HeaderFile
#define _GCPnts_QuasiUniformDeflection_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _TColStd_SequenceOfReal_HeaderFile
#include <TColStd_SequenceOfReal.hxx>
#endif
#ifndef _TColgp_SequenceOfPnt_HeaderFile
#include <TColgp_SequenceOfPnt.hxx>
#endif
#ifndef _GeomAbs_Shape_HeaderFile
#include <GeomAbs_Shape.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Standard_DomainError;
class Standard_ConstructionError;
class Standard_OutOfRange;
class StdFail_NotDone;
class Adaptor3d_Curve;
class Adaptor2d_Curve2d;
class gp_Pnt;


//! This  class computes  a  distribution of  points  on a <br>
//!          curve. The points may respect the deflection. The algorithm <br>
//!          is not based on the  classical prediction (with second <br>
//!          derivative of curve), but either  on the evaluation of <br>
//!          the distance between the   mid point and the  point of <br>
//!          mid parameter of    the two points,   or  the distance <br>
//!          between the mid point and  the point at parameter  0.5 <br>
//!          on the cubic interpolation of the two points and their <br>
//!          tangents. <br>
//! Note: this algorithm is faster than a <br>
//! GCPnts_UniformDeflection algorithm, and is <br>
//! able to work with non-"C2" continuous curves. <br>
//! However, it generates more points in the distribution. <br>
class GCPnts_QuasiUniformDeflection  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Constructs an empty algorithm. To define the problem <br>
//! to be solved, use the function Initialize. <br>
  Standard_EXPORT   GCPnts_QuasiUniformDeflection();
  //! Computes  a QuasiUniform Deflection distribution <br>
//!  of points on the Curve <C>. <br>
  Standard_EXPORT   GCPnts_QuasiUniformDeflection(Adaptor3d_Curve& C,const Standard_Real Deflection,const GeomAbs_Shape Continuity = GeomAbs_C1);
  //! Computes  a QuasiUniform Deflection distribution <br>
//!  of points on the Curve <C>. <br>
  Standard_EXPORT   GCPnts_QuasiUniformDeflection(Adaptor2d_Curve2d& C,const Standard_Real Deflection,const GeomAbs_Shape Continuity = GeomAbs_C1);
  //! Computes a QuasiUniform Deflection distribution <br>
//!  of points on a part of the Curve <C>. <br>
  Standard_EXPORT   GCPnts_QuasiUniformDeflection(Adaptor3d_Curve& C,const Standard_Real Deflection,const Standard_Real U1,const Standard_Real U2,const GeomAbs_Shape Continuity = GeomAbs_C1);
  //!  Computes  a QuasiUniform Deflection distribution <br>
//!  of points on a part of the Curve <C>. <br>
//! This and the above algorithms compute a distribution of points: <br>
//! -   on the curve C, or <br>
//! -   on the part of curve C limited by the two <br>
//!   parameter values U1 and U2, <br>
//! where the deflection resulting from the distributed <br>
//! points is not greater than Deflection. <br>
//! The first point of the distribution is either the origin of <br>
//! curve C or the point of parameter U1. The last point <br>
//! of the distribution is either the end point of curve C or <br>
//! the point of parameter U2. <br>
//! Intermediate points of the distribution are built such <br>
//! that the deflection is not greater than Deflection. <br>
//! Using the following evaluation of the deflection: <br>
//! if Pi and Pj are two consecutive points of the <br>
//! distribution, respectively of parameter ui and uj on <br>
//! the curve, the deflection is the distance between: <br>
//! -   the mid-point of Pi and Pj (the center of the <br>
//!   chord joining these two points) <br>
//! -   and the point of mid-parameter of these two <br>
//!   points (the point of parameter [(ui+uj) / 2 ] on curve C). <br>
//!   Continuity, defaulted to GeomAbs_C1, gives the <br>
//!   degree of continuity of the curve C. (Note that C is an <br>
//! Adaptor3d_Curve or an Adaptor2d_Curve2d <br>
//! object, and does not know the degree of continuity of <br>
//! the underlying curve). <br>
//! Use the function IsDone to verify that the <br>
//! computation was successful, the function NbPoints <br>
//! to obtain the number of points of the computed <br>
//! distribution, and the function Parameter to read the <br>
//! parameter of each point. <br>
//! Warning <br>
//! -   The roles of U1 and U2 are inverted if U1 > U2. <br>
//! -   Derivative functions on the curve are called <br>
//!   according to Continuity. An error may occur if <br>
//!   Continuity is greater than the real degree of <br>
//!   continuity of the curve. <br>
//! Warning <br>
//! C is an adapted curve, i.e. an object which is an <br>
//! interface between: <br>
//! -   the services provided by either a 2D curve from <br>
//!   the package Geom2d (in the case of an <br>
//!   Adaptor2d_Curve2d curve) or a 3D curve from <br>
//!   the package Geom (in the case of an <br>
//!   Adaptor3d_Curve curve), <br>
//! -   and those required on the curve by the <br>
//!   computation algorithm. <br>
  Standard_EXPORT   GCPnts_QuasiUniformDeflection(Adaptor2d_Curve2d& C,const Standard_Real Deflection,const Standard_Real U1,const Standard_Real U2,const GeomAbs_Shape Continuity = GeomAbs_C1);
  //! Initialize the algoritms with <C>, <Deflection> <br>
  Standard_EXPORT     void Initialize(Adaptor3d_Curve& C,const Standard_Real Deflection,const GeomAbs_Shape Continuity = GeomAbs_C1) ;
  //! Initialize the algoritms with <C>, <Deflection> <br>
  Standard_EXPORT     void Initialize(Adaptor2d_Curve2d& C,const Standard_Real Deflection,const GeomAbs_Shape Continuity = GeomAbs_C1) ;
  //! Initialize the algoritms with <C>, <Deflection>, <br>
//!          <U1>,<U2> <br>
  Standard_EXPORT     void Initialize(Adaptor3d_Curve& C,const Standard_Real Deflection,const Standard_Real U1,const Standard_Real U2,const GeomAbs_Shape Continuity = GeomAbs_C1) ;
  //! Initialize  the  algoritms with <C>, <Deflection>, <br>
//!          -- <U1>,<U2> <br>
//!    This and the above algorithms initialize (or reinitialize) <br>
//!        this algorithm and compute a distribution of points: <br>
//! -   on the curve C, or <br>
//! -   on the part of curve C limited by the two <br>
//!   parameter values U1 and U2, <br>
//! where the deflection resulting from the distributed <br>
//! points is not greater than Deflection. <br>
//! The first point of the distribution is either the origin <br>
//! of curve C or the point of parameter U1. The last <br>
//! point of the distribution is either the end point of <br>
//! curve C or the point of parameter U2. <br>
//! Intermediate points of the distribution are built in <br>
//! such a way that the deflection is not greater than <br>
//! Deflection. Using the following evaluation of the deflection: <br>
//! if Pi and Pj are two consecutive points of the <br>
//! distribution, respectively of parameter ui and uj <br>
//! on the curve, the deflection is the distance between: <br>
//! -   the mid-point of Pi and Pj (the center of the <br>
//!   chord joining these two points) <br>
//! -   and the point of mid-parameter of these two <br>
//!   points (the point of parameter [(ui+uj) / 2 ] on curve C). <br>
//!   Continuity, defaulted to GeomAbs_C1, gives the <br>
//! degree of continuity of the curve C. (Note that C is <br>
//! an Adaptor3d_Curve or an <br>
//! Adaptor2d_Curve2d object, and does not know <br>
//! the degree of continuity of the underlying curve). <br>
//! Use the function IsDone to verify that the <br>
//! computation was successful, the function NbPoints <br>
//! to obtain the number of points of the computed <br>
//! distribution, and the function Parameter to read <br>
//! the parameter of each point. <br>
//! Warning <br>
//! -   The roles of U1 and U2 are inverted if U1 > U2. <br>
//! -   Derivative functions on the curve are called <br>
//!   according to Continuity. An error may occur if <br>
//!   Continuity is greater than the real degree of <br>
//!   continuity of the curve. <br>
//! Warning <br>
//! C is an adapted curve, i.e. an object which is an <br>
//! interface between: <br>
//! -   the services provided by either a 2D curve from <br>
//!   the package Geom2d (in the case of an <br>
//!   Adaptor2d_Curve2d curve) or a 3D curve from <br>
//!   the package Geom (in the case of an Adaptor3d_Curve curve), <br>
//! and those required on the curve by the computation algorithm. <br>
  Standard_EXPORT     void Initialize(Adaptor2d_Curve2d& C,const Standard_Real Deflection,const Standard_Real U1,const Standard_Real U2,const GeomAbs_Shape Continuity = GeomAbs_C1) ;
  
//! Returns true if the computation was successful. <br>
//! IsDone is a protection against: <br>
//! -   non-convergence of the algorithm <br>
//! -   querying the results before computation. <br>
        Standard_Boolean IsDone() const;
  
//! Returns the number of points of the distribution <br>
//! computed by this algorithm. <br>
//! Exceptions <br>
//! StdFail_NotDone if this algorithm has not been <br>
//! initialized, or if the computation was not successful. <br>
        Standard_Integer NbPoints() const;
  //! Returns the parameter of the point of index Index in <br>
//! the distribution computed by this algorithm. <br>
//! Warning <br>
//! Index must be greater than or equal to 1, and less <br>
//! than or equal to the number of points of the <br>
//! distribution. However, pay particular attention as this <br>
//! condition is not checked by this function. <br>
//! Exceptions <br>
//! StdFail_NotDone if this algorithm has not been <br>
//! initialized, or if the computation was not successful. <br>
        Standard_Real Parameter(const Standard_Integer Index) const;
  //! Returns the point of index Index in the distribution <br>
//! computed by this algorithm. <br>
//! Warning <br>
//! Index must be greater than or equal to 1, and less <br>
//! than or equal to the number of points of the <br>
//! distribution. However, pay particular attention as this <br>
//! condition is not checked by this function. <br>
//! Exceptions <br>
//! StdFail_NotDone if this algorithm has not been <br>
//! initialized, or if the computation was not successful. <br>
  Standard_EXPORT     gp_Pnt Value(const Standard_Integer Index) const;
  //! Returns the deflection between the curve and the <br>
//! polygon resulting from the points of the distribution <br>
//! computed by this algorithm. <br>
//! This is the value given to the algorithm at the time <br>
//! of construction (or initialization). <br>
//! Exceptions <br>
//! StdFail_NotDone if this algorithm has not been <br>
//! initialized, or if the computation was not successful. <br>
        Standard_Real Deflection() const;





protected:





private:



Standard_Boolean myDone;
Standard_Real myDeflection;
TColStd_SequenceOfReal myParams;
TColgp_SequenceOfPnt myPoints;
GeomAbs_Shape myCont;


};


#include <GCPnts_QuasiUniformDeflection.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif