dd9a9bdf6f329aac30adf2064e6f87e89227961a
[occt.git] / src / Geom / Geom_SurfaceOfLinearExtrusion.hxx
1 // Created on: 1993-03-10
2 // Created by: JCV
3 // Copyright (c) 1993-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 _Geom_SurfaceOfLinearExtrusion_HeaderFile
18 #define _Geom_SurfaceOfLinearExtrusion_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Geom_SweptSurface.hxx>
24 #include <Standard_Real.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Integer.hxx>
27 class Standard_RangeError;
28 class Geom_UndefinedDerivative;
29 class Geom_Curve;
30 class gp_Dir;
31 class gp_Pnt;
32 class gp_Vec;
33 class gp_Trsf;
34 class gp_GTrsf2d;
35 class Geom_Geometry;
36
37
38 class Geom_SurfaceOfLinearExtrusion;
39 DEFINE_STANDARD_HANDLE(Geom_SurfaceOfLinearExtrusion, Geom_SweptSurface)
40
41 //! Describes a surface of linear extrusion ("extruded
42 //! surface"), e.g. a generalized cylinder. Such a surface
43 //! is obtained by sweeping a curve (called the "extruded
44 //! curve" or "basis") in a given direction (referred to as
45 //! the "direction of extrusion" and defined by a unit vector).
46 //! The u parameter is along the extruded curve. The v
47 //! parameter is along the direction of extrusion.
48 //! The parameter range for the u parameter is defined
49 //! by the reference curve.
50 //! The parameter range for the v parameter is ] -
51 //! infinity, + infinity [.
52 //! The position of the curve gives the origin of the v parameter.
53 //! The surface is "CN" in the v parametric direction.
54 //! The form of a surface of linear extrusion is generally a
55 //! ruled surface (GeomAbs_RuledForm). It can be:
56 //! - a cylindrical surface, if the extruded curve is a circle,
57 //! or a trimmed circle, with an axis parallel to the
58 //! direction of extrusion (GeomAbs_CylindricalForm), or
59 //! - a planar surface, if the extruded curve is a line
60 //! (GeomAbs_PlanarForm).
61 //! Note: The surface of extrusion is built from a copy of
62 //! the original basis curve, so the original curve is not
63 //! modified when the surface is modified.
64 //! Warning
65 //! Degenerate surfaces are not detected. A degenerate
66 //! surface is obtained, for example, when the extruded
67 //! curve is a line and the direction of extrusion is parallel
68 //! to that line.
69 class Geom_SurfaceOfLinearExtrusion : public Geom_SweptSurface
70 {
71
72 public:
73
74   
75
76   //! V is the direction of extrusion.
77   //! C is the extruded curve.
78   //! The form of a SurfaceOfLinearExtrusion can be :
79   //! . ruled surface (RuledForm),
80   //! . a cylindrical surface if the extruded curve is a circle or
81   //! a trimmed circle (CylindricalForm),
82   //! . a plane surface if the extruded curve is a Line (PlanarForm).
83   //! Warnings :
84   //! Degenerated surface cases are not detected. For example if the
85   //! curve C is a line and V is parallel to the direction of this
86   //! line.
87   Standard_EXPORT Geom_SurfaceOfLinearExtrusion(const Handle(Geom_Curve)& C, const gp_Dir& V);
88   
89   //! Assigns V as the "direction of extrusion" for this
90   //! surface of linear extrusion.
91   Standard_EXPORT void SetDirection (const gp_Dir& V);
92   
93   //! Modifies this surface of linear extrusion by redefining
94   //! its "basis curve" (the "extruded curve").
95   Standard_EXPORT void SetBasisCurve (const Handle(Geom_Curve)& C);
96   
97   //! Changes the orientation of this surface of linear
98   //! extrusion in the u  parametric direction. The
99   //! bounds of the surface are not changed, but the given
100   //! parametric direction is reversed. Hence the
101   //! orientation of the surface is reversed.
102   //! In the case of a surface of linear extrusion:
103   //! - UReverse reverses the basis curve, and
104   //! - VReverse reverses the direction of linear extrusion.
105   Standard_EXPORT void UReverse();
106   
107   //! Computes the u parameter on the modified
108   //! surface, produced by reversing its u  parametric
109   //! direction, for any point of u parameter U  on this surface of linear extrusion.
110   //! In the case of an extruded surface:
111   //! - UReverseParameter returns the reversed
112   //! parameter given by the function
113   //! ReversedParameter called with U on the basis   curve,
114   Standard_EXPORT Standard_Real UReversedParameter (const Standard_Real U) const;
115   
116   //! Changes the orientation of this surface of linear
117   //! extrusion in the v parametric direction. The
118   //! bounds of the surface are not changed, but the given
119   //! parametric direction is reversed. Hence the
120   //! orientation of the surface is reversed.
121   //! In the case of a surface of linear extrusion:
122   //! - UReverse reverses the basis curve, and
123   //! - VReverse reverses the direction of linear extrusion.
124   Standard_EXPORT void VReverse();
125   
126   //! Computes the v parameter on the modified
127   //! surface, produced by reversing its u v parametric
128   //! direction, for any point of v parameter V on this surface of linear extrusion.
129   //! In the case of an extruded surface VReverse returns -V.
130   Standard_EXPORT Standard_Real VReversedParameter (const Standard_Real V) const;
131   
132   //! Returns the parametric bounds U1, U2, V1 and V2 of
133   //! this surface of linear extrusion.
134   //! A surface of linear extrusion is infinite in the v
135   //! parametric direction, so:
136   //! - V1 = Standard_Real::RealFirst()
137   //! - V2 = Standard_Real::RealLast().
138   Standard_EXPORT void Bounds (Standard_Real& U1, Standard_Real& U2, Standard_Real& V1, Standard_Real& V2) const;
139   
140   //! IsUClosed returns true if the "basis curve" of this
141   //! surface of linear extrusion is closed.
142   Standard_EXPORT Standard_Boolean IsUClosed() const;
143   
144   //! IsVClosed always returns false.
145   Standard_EXPORT Standard_Boolean IsVClosed() const;
146   
147   //! IsCNu returns true if the degree of continuity for the
148   //! "basis curve" of this surface of linear extrusion is at least N.
149   //! Raises RangeError if N < 0.
150   Standard_EXPORT Standard_Boolean IsCNu (const Standard_Integer N) const;
151   
152   //! IsCNv always returns true.
153   Standard_EXPORT Standard_Boolean IsCNv (const Standard_Integer N) const;
154   
155   //! IsUPeriodic returns true if the "basis curve" of this
156   //! surface of linear extrusion is periodic.
157   Standard_EXPORT Standard_Boolean IsUPeriodic() const;
158   
159   //! IsVPeriodic always returns false.
160   Standard_EXPORT Standard_Boolean IsVPeriodic() const;
161   
162   //! Computes the U isoparametric curve of this surface
163   //! of linear extrusion. This is the line parallel to the
164   //! direction of extrusion, passing through the point of
165   //! parameter U of the basis curve.
166   Standard_EXPORT Handle(Geom_Curve) UIso (const Standard_Real U) const;
167   
168   //! Computes the V isoparametric curve of this surface
169   //! of linear extrusion. This curve is obtained by
170   //! translating the extruded curve in the direction of
171   //! extrusion, with the magnitude V.
172   Standard_EXPORT Handle(Geom_Curve) VIso (const Standard_Real V) const;
173   
174
175   //! Computes the  point P (U, V) on the surface.
176   //! The parameter U is the parameter on the extruded curve.
177   //! The parametrization V is a linear parametrization, and
178   //! the direction of parametrization is the direction of
179   //! extrusion. If the point is on the extruded curve, V = 0.0
180   Standard_EXPORT void D0 (const Standard_Real U, const Standard_Real V, gp_Pnt& P) const;
181   
182
183   //! Computes the current point and the first derivatives in the
184   //! directions U and V.
185   //! Raises UndefinedDerivative if the continuity of the surface is not C1.
186   Standard_EXPORT void D1 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const;
187   
188   //! --- Purpose ;
189   //! Computes the current point, the first and the second derivatives
190   //! in the directions U and V.
191   //! Raises UndefinedDerivative if the continuity of the surface is not C2.
192   Standard_EXPORT void D2 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V, gp_Vec& D2U, gp_Vec& D2V, gp_Vec& D2UV) const;
193   
194
195   //! Computes the current point, the first,the second and the third
196   //! derivatives in the directions U and V.
197   //! Raises UndefinedDerivative if the continuity of the surface is not C3.
198   Standard_EXPORT void D3 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V, gp_Vec& D2U, gp_Vec& D2V, gp_Vec& D2UV, gp_Vec& D3U, gp_Vec& D3V, gp_Vec& D3UUV, gp_Vec& D3UVV) const;
199   
200
201   //! Computes the derivative of order Nu in the direction u
202   //! and Nv in the direction v.
203   //! Raises UndefinedDerivative if the continuity of the surface is not CNu in the u
204   //! direction and CNv in the v direction.
205   //! Raises RangeError if Nu + Nv < 1 or Nu < 0 or Nv < 0.
206   Standard_EXPORT gp_Vec DN (const Standard_Real U, const Standard_Real V, const Standard_Integer Nu, const Standard_Integer Nv) const;
207   
208   //! The following  functions  evaluates the  local
209   //! derivatives on surface. Useful to manage discontinuities
210   //! on the surface.
211   //! if    Side  =  1  ->  P  =  S( U+,V )
212   //! if    Side  = -1  ->  P  =  S( U-,V )
213   //! else  P  is betveen discontinuities
214   //! can be evaluated using methods  of
215   //! global evaluations    P  =  S( U ,V )
216   Standard_EXPORT void LocalD0 (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, gp_Pnt& P) const;
217   
218   Standard_EXPORT void LocalD1 (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const;
219   
220   Standard_EXPORT void LocalD2 (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V, gp_Vec& D2U, gp_Vec& D2V, gp_Vec& D2UV) const;
221   
222   Standard_EXPORT void LocalD3 (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V, gp_Vec& D2U, gp_Vec& D2V, gp_Vec& D2UV, gp_Vec& D3U, gp_Vec& D3V, gp_Vec& D3UUV, gp_Vec& D3UVV) const;
223   
224   Standard_EXPORT gp_Vec LocalDN (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, const Standard_Integer Nu, const Standard_Integer Nv) const;
225   
226   //! Applies the transformation T to this surface of linear extrusion.
227   Standard_EXPORT void Transform (const gp_Trsf& T);
228   
229   //! Computes the  parameters on the  transformed  surface for
230   //! the transform of the point of parameters U,V on <me>.
231   //!
232   //! me->Transformed(T)->Value(U',V')
233   //!
234   //! is the same point as
235   //!
236   //! me->Value(U,V).Transformed(T)
237   //!
238   //! Where U',V' are the new values of U,V after calling
239   //!
240   //! me->TranformParameters(U,V,T)
241   //!
242   //! This methods multiplies :
243   //! U by BasisCurve()->ParametricTransformation(T)
244   //! V by T.ScaleFactor()
245   Standard_EXPORT virtual void TransformParameters (Standard_Real& U, Standard_Real& V, const gp_Trsf& T) const Standard_OVERRIDE;
246   
247   //! Returns a 2d transformation  used to find the  new
248   //! parameters of a point on the transformed surface.
249   //!
250   //! me->Transformed(T)->Value(U',V')
251   //!
252   //! is the same point as
253   //!
254   //! me->Value(U,V).Transformed(T)
255   //!
256   //! Where U',V' are  obtained by transforming U,V with
257   //! th 2d transformation returned by
258   //!
259   //! me->ParametricTransformation(T)
260   //!
261   //! This  methods  returns  a scale
262   //! U by BasisCurve()->ParametricTransformation(T)
263   //! V by T.ScaleFactor()
264   Standard_EXPORT virtual gp_GTrsf2d ParametricTransformation (const gp_Trsf& T) const Standard_OVERRIDE;
265   
266   //! Creates a new object which is a copy of this surface of linear extrusion.
267   Standard_EXPORT Handle(Geom_Geometry) Copy() const;
268
269
270
271
272   DEFINE_STANDARD_RTTI(Geom_SurfaceOfLinearExtrusion,Geom_SweptSurface)
273
274 protected:
275
276
277
278
279 private:
280
281
282
283
284 };
285
286
287
288
289
290
291
292 #endif // _Geom_SurfaceOfLinearExtrusion_HeaderFile