File: Geom2d_TrimmedCurve.hxx

package info (click to toggle)
oce 0.18.2-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 301,460 kB
  • sloc: cpp: 1,190,610; ansic: 67,225; sh: 11,667; tcl: 7,954; cs: 5,221; python: 2,867; java: 1,522; makefile: 344; xml: 292; perl: 37
file content (274 lines) | stat: -rw-r--r-- 10,433 bytes parent folder | download | duplicates (3)
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
265
266
267
268
269
270
271
272
273
274
// 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 _Geom2d_TrimmedCurve_HeaderFile
#define _Geom2d_TrimmedCurve_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_Geom2d_TrimmedCurve.hxx>

#include <Handle_Geom2d_Curve.hxx>
#include <Standard_Real.hxx>
#include <Geom2d_BoundedCurve.hxx>
#include <Standard_Boolean.hxx>
#include <GeomAbs_Shape.hxx>
#include <Standard_Integer.hxx>
#include <Handle_Geom2d_Geometry.hxx>
class Geom2d_Curve;
class Standard_ConstructionError;
class Standard_RangeError;
class Standard_NoSuchObject;
class Geom2d_UndefinedDerivative;
class Geom2d_UndefinedValue;
class gp_Pnt2d;
class gp_Vec2d;
class gp_Trsf2d;
class Geom2d_Geometry;



//! Defines a portion of a curve limited by two values of
//! parameters inside the parametric domain of the curve.
//! The trimmed curve is defined by:
//! - the basis curve, and
//! - the two parameter values which limit it.
//! The trimmed curve can either have the same
//! orientation as the basis curve or the opposite orientation.
class Geom2d_TrimmedCurve : public Geom2d_BoundedCurve
{

public:

  

  //! Creates a trimmed curve from the basis curve C limited between
  //! U1 and U2.
  //!
  //! . U1 can be greater or lower than U2.
  //! . The returned curve is oriented from U1 to U2.
  //! . If the basis curve C is periodic there is an ambiguity
  //! because two parts are available. In this case by default
  //! the trimmed curve has the same orientation as the basis
  //! curve (Sense = True). If Sense = False then the orientation
  //! of the trimmed curve is opposite to the orientation of the
  //! basis curve C.
  //! If the curve is closed but not periodic it is not possible
  //! to keep the part of the curve including the junction point
  //! (except if the junction point is at the beginning or
  //! at the end of the trimmed curve) because you could lose the
  //! fundamental characteristics of the basis curve which are
  //! used for example to compute the derivatives of the trimmed
  //! curve. So for a closed curve the rules are the same as for
  //! a open curve.
  //! Warnings :
  //! In this package the entities are not shared. The TrimmedCurve is
  //! built with a copy of the curve C. So when C is modified the
  //! TrimmedCurve is not modified
  //! Warnings :
  //! If <C> is periodic and <theAdjustPeriodic> is True, parametrics
  //! bounds of the TrimmedCurve, can be different to [<U1>;<U2>},
  //! if <U1> or <U2> are not in the principal period.
  //! Include :
  //! For more explanation see the scheme given with this class.
  //! Raises ConstructionError the C is not periodic and U1 or U2 are out of
  //! the bounds of C.
  //! Raised if U1 = U2.
  Standard_EXPORT Geom2d_TrimmedCurve(const Handle(Geom2d_Curve)& C, const Standard_Real U1, const Standard_Real U2, const Standard_Boolean Sense = Standard_True, const Standard_Boolean theAdjustPeriodic = Standard_True);
  

  //! Changes the direction of parametrization of <me>. The first and
  //! the last parametric values are modified. The "StartPoint"
  //! of the initial curve becomes the "EndPoint" of the reversed
  //! curve and the "EndPoint" of the initial curve becomes the
  //! "StartPoint" of the reversed curve.
  //! Example  -   If the trimmed curve is defined by:
  //! - a basis curve whose parameter range is [ 0.,1. ], and
  //! - the two trim values U1 (first parameter) and U2 (last parameter),
  //! the reversed trimmed curve is defined by:
  //! - the reversed basis curve, whose parameter range is still [ 0.,1. ], and
  //! - the two trim values 1. - U2 (first parameter)
  //! and 1. - U1 (last parameter).
  Standard_EXPORT   void Reverse() ;
  
  //! Returns the  parameter on the  reversed  curve for
  //! the point of parameter U on <me>.
  //!
  //! returns UFirst + ULast - U
  Standard_EXPORT   Standard_Real ReversedParameter (const Standard_Real U)  const;
  
  //! Changes this trimmed curve, by redefining the
  //! parameter values U1 and U2, which limit its basis curve.
  //! Note: If the basis curve is periodic, the trimmed curve
  //! has the same orientation as the basis curve if Sense
  //! is true (default value) or the opposite orientation if Sense is false.
  //! Warning
  //! If the basis curve is periodic and theAdjustPeriodic is True,
  //! the bounds of the trimmed curve may be different from U1 and U2 if the
  //! parametric origin of the basis curve is within the arc
  //! of the trimmed curve. In this case, the modified
  //! parameter will be equal to U1 or U2 plus or minus the period.
  //! If theAdjustPeriodic is False, parameters U1 and U2 will stay unchanged.
  //! Exceptions
  //! Standard_ConstructionError if:
  //! - the basis curve is not periodic, and either U1 or U2
  //! are outside the bounds of the basis curve, or
  //! - U1 is equal to U2.
  Standard_EXPORT   void SetTrim (const Standard_Real U1, const Standard_Real U2, const Standard_Boolean Sense = Standard_True, const Standard_Boolean theAdjustPeriodic = Standard_True) ;
  
  //! Returns the basis curve.
  //! Warning
  //! This function does not return a constant reference.
  //! Consequently, any modification of the returned value
  //! directly modifies the trimmed curve.
  Standard_EXPORT   Handle(Geom2d_Curve) BasisCurve()  const;
  

  //! Returns the global continuity of the basis curve of this trimmed curve.
  //! C0 : only geometric continuity,
  //! C1 : continuity of the first derivative all along the Curve,
  //! C2 : continuity of the second derivative all along the Curve,
  //! C3 : continuity of the third derivative all along the Curve,
  //! CN : the order of continuity is infinite.
  Standard_EXPORT   GeomAbs_Shape Continuity()  const;
  
  //! --- Purpose
  //! Returns True if the order of continuity of the
  //! trimmed curve is N. A trimmed curve is at least "C0" continuous.
  //! Warnings :
  //! The continuity of the trimmed curve can be greater than
  //! the continuity of the basis curve because you consider
  //! only a part of the basis curve.
  //! Raised if N < 0.
  Standard_EXPORT   Standard_Boolean IsCN (const Standard_Integer N)  const;
  

  //! Returns the end point of <me>. This point is the
  //! evaluation of the curve for the "LastParameter".
  Standard_EXPORT   gp_Pnt2d EndPoint()  const;
  

  //! Returns the value of the first parameter of <me>.
  //! The first parameter is the parameter of the "StartPoint"
  //! of the trimmed curve.
  Standard_EXPORT   Standard_Real FirstParameter()  const;
  

  //! Returns True if the distance between the StartPoint and
  //! the EndPoint is lower or equal to Resolution from package
  //! gp.
  Standard_EXPORT   Standard_Boolean IsClosed()  const;
  
  //! Returns true if the basis curve of this trimmed curve is periodic.
  Standard_EXPORT   Standard_Boolean IsPeriodic()  const;
  
  //! Returns the period of the basis curve of this trimmed curve.
  //! Exceptions
  //! Standard_NoSuchObject if the basis curve is not periodic.
  Standard_EXPORT virtual   Standard_Real Period()  const;
  

  //! Returns the value of the last parameter of <me>.
  //! The last parameter is the parameter of the "EndPoint" of the
  //! trimmed curve.
  Standard_EXPORT   Standard_Real LastParameter()  const;
  

  //! Returns the start point of <me>.
  //! This point is the evaluation of the curve from the
  //! "FirstParameter".
  //! value and derivatives
  //! Warnings :
  //! The returned derivatives have the same orientation as the
  //! derivatives of the basis curve.
  Standard_EXPORT   gp_Pnt2d StartPoint()  const;
  

  //! If the basis curve is an OffsetCurve sometimes it is not
  //! possible to do the evaluation of the curve at the parameter
  //! U (see class OffsetCurve).
  Standard_EXPORT   void D0 (const Standard_Real U, gp_Pnt2d& P)  const;
  
  //! Raised if the continuity of the curve is not C1.
  Standard_EXPORT   void D1 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1)  const;
  
  //! Raised if the continuity of the curve is not C2.
  Standard_EXPORT   void D2 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2)  const;
  
  //! Raised if the continuity of the curve is not C3.
  Standard_EXPORT   void D3 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2, gp_Vec2d& V3)  const;
  
  //! For the point of parameter U of this trimmed curve,
  //! computes the vector corresponding to the Nth derivative.
  //! Warning
  //! The returned derivative vector has the same
  //! orientation as the derivative vector of the basis curve,
  //! even if the trimmed curve does not have the same
  //! orientation as the basis curve.
  //! Exceptions
  //! Standard_RangeError if N is less than 1.
  //! geometric transformations
  Standard_EXPORT   gp_Vec2d DN (const Standard_Real U, const Standard_Integer N)  const;
  
  //! Applies the transformation T to this trimmed curve.
  //! Warning The basis curve is also modified.
  Standard_EXPORT   void Transform (const gp_Trsf2d& T) ;
  
  //! Returns the  parameter on the  transformed  curve for
  //! the transform of the point of parameter U on <me>.
  //!
  //! me->Transformed(T)->Value(me->TransformedParameter(U,T))
  //!
  //! is the same point as
  //!
  //! me->Value(U).Transformed(T)
  //!
  //! This methods calls the basis curve method.
  Standard_EXPORT virtual   Standard_Real TransformedParameter (const Standard_Real U, const gp_Trsf2d& T)  const;
  
  //! Returns a  coefficient to compute the parameter on
  //! the transformed  curve  for  the transform  of the
  //! point on <me>.
  //!
  //! Transformed(T)->Value(U * ParametricTransformation(T))
  //!
  //! is the same point as
  //!
  //! Value(U).Transformed(T)
  //!
  //! This methods calls the basis curve method.
  Standard_EXPORT virtual   Standard_Real ParametricTransformation (const gp_Trsf2d& T)  const;
  

  //! Creates a new object, which is a copy of this trimmed curve.
  Standard_EXPORT   Handle(Geom2d_Geometry) Copy()  const;




  DEFINE_STANDARD_RTTI(Geom2d_TrimmedCurve)

protected:




private: 


  Handle(Geom2d_Curve) basisCurve;
  Standard_Real uTrim1;
  Standard_Real uTrim2;


};







#endif // _Geom2d_TrimmedCurve_HeaderFile