3a3280b110bff26934a690de70bb9406446712a2
[occt.git] / src / Geom / Geom_SurfaceOfRevolution.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_SurfaceOfRevolution_HeaderFile
18 #define _Geom_SurfaceOfRevolution_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_Pnt.hxx>
24 #include <Geom_SweptSurface.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_Integer.hxx>
28 class Standard_ConstructionError;
29 class Standard_RangeError;
30 class Geom_UndefinedDerivative;
31 class Geom_Curve;
32 class gp_Ax1;
33 class gp_Dir;
34 class gp_Pnt;
35 class gp_Ax2;
36 class gp_Trsf;
37 class gp_GTrsf2d;
38 class gp_Vec;
39 class Geom_Geometry;
40
41
42 class Geom_SurfaceOfRevolution;
43 DEFINE_STANDARD_HANDLE(Geom_SurfaceOfRevolution, Geom_SweptSurface)
44
45 //! Describes a surface of revolution (revolved surface).
46 //! Such a surface is obtained by rotating a curve (called
47 //! the "meridian") through a complete revolution about
48 //! an axis (referred to as the "axis of revolution"). The
49 //! curve and the axis must be in the same plane (the
50 //! "reference plane" of the surface).
51 //! Rotation around the axis of revolution in the
52 //! trigonometric sense defines the u parametric
53 //! direction. So the u parameter is an angle, and its
54 //! origin is given by the position of the meridian on the surface.
55 //! The parametric range for the u parameter is: [ 0, 2.*Pi ]
56 //! The v parameter is that of the meridian.
57 //! Note: A surface of revolution is built from a copy of the
58 //! original meridian. As a result the original meridian is
59 //! not modified when the surface is modified.
60 //! The form of a surface of revolution is typically a
61 //! general revolution surface
62 //! (GeomAbs_RevolutionForm). It can be:
63 //! - a conical surface, if the meridian is a line or a
64 //! trimmed line (GeomAbs_ConicalForm),
65 //! - a cylindrical surface, if the meridian is a line or a
66 //! trimmed line parallel to the axis of revolution
67 //! (GeomAbs_CylindricalForm),
68 //! - a planar surface if the meridian is a line or a
69 //! trimmed line perpendicular to the axis of revolution
70 //! of the surface (GeomAbs_PlanarForm),
71 //! - a toroidal surface, if the meridian is a circle or a
72 //! trimmed circle (GeomAbs_ToroidalForm), or
73 //! - a spherical surface, if the meridian is a circle, the
74 //! center of which is located on the axis of the
75 //! revolved surface (GeomAbs_SphericalForm).
76 //! Warning
77 //! Be careful not to construct a surface of revolution
78 //! where the curve and the axis or revolution are not
79 //! defined in the same plane. If you do not have a
80 //! correct configuration, you can correct your initial
81 //! curve, using a cylindrical projection in the reference plane.
82 class Geom_SurfaceOfRevolution : public Geom_SweptSurface
83 {
84
85 public:
86
87   
88
89   //! C : is the meridian  or the referenced curve.
90   //! A1 is the axis of revolution.
91   //! The form of a SurfaceOfRevolution can be :
92   //! . a general revolution surface (RevolutionForm),
93   //! . a conical surface if the meridian is a line or a trimmed line
94   //! (ConicalForm),
95   //! . a cylindrical surface if the meridian is a line or a trimmed
96   //! line parallel to the revolution axis (CylindricalForm),
97   //! . a planar surface if the meridian is a line perpendicular to
98   //! the revolution axis of the surface (PlanarForm).
99   //! . a spherical surface,
100   //! . a toroidal surface,
101   //! . a quadric surface.
102   //! Warnings :
103   //! It is not checked that the curve C is planar and that the
104   //! surface axis is in the plane of the curve.
105   //! It is not checked that the revolved curve C doesn't
106   //! self-intersects.
107   Standard_EXPORT Geom_SurfaceOfRevolution(const Handle(Geom_Curve)& C, const gp_Ax1& A1);
108   
109   //! Changes the axis of revolution.
110   //! Warnings :
111   //! It is not checked that the axis is in the plane of the
112   //! revolved curve.
113   Standard_EXPORT void SetAxis (const gp_Ax1& A1);
114   
115   //! Changes the direction of the revolution axis.
116   //! Warnings :
117   //! It is not checked that the axis is in the plane of the
118   //! revolved curve.
119   Standard_EXPORT void SetDirection (const gp_Dir& V);
120   
121   //! Changes the revolved curve of the surface.
122   //! Warnings :
123   //! It is not checked that the curve C is planar and that the
124   //! surface axis is in the plane of the curve.
125   //! It is not checked that the revolved curve C doesn't
126   //! self-intersects.
127   Standard_EXPORT void SetBasisCurve (const Handle(Geom_Curve)& C);
128   
129   //! Changes the location point of the revolution axis.
130   //! Warnings :
131   //! It is not checked that the axis is in the plane of the
132   //! revolved curve.
133   Standard_EXPORT void SetLocation (const gp_Pnt& P);
134   
135   //! Returns the revolution axis of the surface.
136   Standard_EXPORT gp_Ax1 Axis() const;
137   
138
139   //! Returns the location point of the axis of revolution.
140   Standard_EXPORT const gp_Pnt& Location() const;
141   
142
143   //! Computes the position of the reference plane of the surface
144   //! defined by the basis curve and the symmetry axis.
145   //! The location point is the location point of the revolution's
146   //! axis, the XDirection of the plane is given by the revolution's
147   //! axis and the orientation of the normal to the plane is given
148   //! by the sense of revolution.
149   //!
150   //! Raised if the revolved curve is not planar or if the revolved
151   //! curve and the symmetry axis are not in the same plane or if
152   //! the maximum of distance between the axis and the revolved
153   //! curve is lower or equal to Resolution from gp.
154   Standard_EXPORT gp_Ax2 ReferencePlane() const;
155   
156   //! Changes the orientation of this surface of revolution
157   //! in the u  parametric direction. The bounds of the
158   //! surface are not changed but the given parametric
159   //! direction is reversed. Hence the orientation of the
160   //! surface is reversed.
161   //! As a consequence:
162   //! - UReverse reverses the direction of the axis of
163   //! revolution of this surface,
164   Standard_EXPORT void UReverse();
165   
166   //! Computes the u  parameter on the modified
167   //! surface, when reversing its u  parametric
168   //! direction, for any point of u parameter U  on this surface of revolution.
169   //! In the case of a revolved surface:
170   //! - UReversedParameter returns 2.*Pi - U
171   Standard_EXPORT Standard_Real UReversedParameter (const Standard_Real U) const;
172   
173   //! Changes the orientation of this surface of revolution
174   //! in the v parametric direction. The bounds of the
175   //! surface are not changed but the given parametric
176   //! direction is reversed. Hence the orientation of the
177   //! surface is reversed.
178   //! As a consequence:
179   //! - VReverse reverses the meridian of this surface of revolution.
180   Standard_EXPORT void VReverse();
181   
182   //! Computes the  v parameter on the modified
183   //! surface, when reversing its  v parametric
184   //! direction, for any point of v parameter V on this surface of revolution.
185   //! In the case of a revolved surface:
186   //! - VReversedParameter returns the reversed
187   //! parameter given by the function
188   //! ReversedParameter called with V on the meridian.
189   Standard_EXPORT Standard_Real VReversedParameter (const Standard_Real V) const;
190   
191   //! Computes the  parameters on the  transformed  surface for
192   //! the transform of the point of parameters U,V on <me>.
193   //!
194   //! me->Transformed(T)->Value(U',V')
195   //!
196   //! is the same point as
197   //!
198   //! me->Value(U,V).Transformed(T)
199   //!
200   //! Where U',V' are the new values of U,V after calling
201   //!
202   //! me->TranformParameters(U,V,T)
203   //!
204   //! This methods multiplies V by
205   //! BasisCurve()->ParametricTransformation(T)
206   Standard_EXPORT virtual void TransformParameters (Standard_Real& U, Standard_Real& V, const gp_Trsf& T) const Standard_OVERRIDE;
207   
208   //! Returns a 2d transformation  used to find the  new
209   //! parameters of a point on the transformed surface.
210   //!
211   //! me->Transformed(T)->Value(U',V')
212   //!
213   //! is the same point as
214   //!
215   //! me->Value(U,V).Transformed(T)
216   //!
217   //! Where U',V' are  obtained by transforming U,V with
218   //! th 2d transformation returned by
219   //!
220   //! me->ParametricTransformation(T)
221   //!
222   //! This  methods  returns  a scale  centered  on  the
223   //! U axis with BasisCurve()->ParametricTransformation(T)
224   Standard_EXPORT virtual gp_GTrsf2d ParametricTransformation (const gp_Trsf& T) const Standard_OVERRIDE;
225   
226   //! Returns the parametric bounds U1, U2 , V1 and V2 of this surface.
227   //! A surface of revolution is always complete, so U1 = 0, U2 = 2*PI.
228   Standard_EXPORT void Bounds (Standard_Real& U1, Standard_Real& U2, Standard_Real& V1, Standard_Real& V2) const;
229   
230   //! IsUClosed always returns true.
231   Standard_EXPORT Standard_Boolean IsUClosed() const;
232   
233   //! IsVClosed returns true if the meridian of this
234   //! surface of revolution is closed.
235   Standard_EXPORT Standard_Boolean IsVClosed() const;
236   
237   //! IsCNu always returns true.
238   Standard_EXPORT Standard_Boolean IsCNu (const Standard_Integer N) const;
239   
240   //! IsCNv returns true if the degree of continuity of the
241   //! meridian of this surface of revolution is at least N.
242   //! Raised if N < 0.
243   Standard_EXPORT Standard_Boolean IsCNv (const Standard_Integer N) const;
244   
245   //! Returns True.
246   Standard_EXPORT Standard_Boolean IsUPeriodic() const;
247   
248   //! IsVPeriodic returns true if the meridian of this
249   //! surface of revolution is periodic.
250   Standard_EXPORT Standard_Boolean IsVPeriodic() const;
251   
252   //! Computes the U isoparametric curve of this surface
253   //! of revolution. It is the curve obtained by rotating the
254   //! meridian through an angle U about the axis of revolution.
255   Standard_EXPORT Handle(Geom_Curve) UIso (const Standard_Real U) const;
256   
257   //! Computes the U isoparametric curve of this surface
258   //! of revolution. It is the curve obtained by rotating the
259   //! meridian through an angle U about the axis of revolution.
260   Standard_EXPORT Handle(Geom_Curve) VIso (const Standard_Real V) const;
261   
262   //! Computes the  point P (U, V) on the surface.
263   //! U is the angle of the rotation around the revolution axis.
264   //! The direction of this axis gives the sense of rotation.
265   //! V is the parameter of the revolved curve.
266   Standard_EXPORT void D0 (const Standard_Real U, const Standard_Real V, gp_Pnt& P) const;
267   
268
269   //! Computes the current point and the first derivatives
270   //! in the directions U and V.
271   //! Raised if the continuity of the surface is not C1.
272   Standard_EXPORT void D1 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const;
273   
274
275   //! Computes the current point, the first and the second derivatives
276   //! in the directions U and V.
277   //! Raised if the continuity of the surface is not C2.
278   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;
279   
280
281   //! Computes the current point, the first,the second and the third
282   //! derivatives in the directions U and V.
283   //! Raised if the continuity of the surface is not C3.
284   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;
285   
286
287   //! Computes the derivative of order Nu in the direction u and
288   //! Nv in the direction v.
289   //!
290   //! Raised if the continuity of the surface is not CNu in the u
291   //! direction and CNv in the v direction.
292   //! Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.
293   //! The following  functions  evaluates the  local
294   //! derivatives on surface. Useful to manage discontinuities
295   //! on the surface.
296   //! if    Side  =  1  ->  P  =  S( U+,V )
297   //! if    Side  = -1  ->  P  =  S( U-,V )
298   //! else  P  is betveen discontinuities
299   //! can be evaluated using methods  of
300   //! global evaluations    P  =  S( U ,V )
301   Standard_EXPORT gp_Vec DN (const Standard_Real U, const Standard_Real V, const Standard_Integer Nu, const Standard_Integer Nv) const;
302   
303   Standard_EXPORT void LocalD0 (const Standard_Real U, const Standard_Real V, const Standard_Integer USide, gp_Pnt& P) const;
304   
305   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;
306   
307   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;
308   
309   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;
310   
311   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;
312   
313   //! Applies the transformation T to this surface of revolution.
314   Standard_EXPORT void Transform (const gp_Trsf& T);
315   
316   //! Creates a new object which is a copy of this surface of revolution.
317   Standard_EXPORT Handle(Geom_Geometry) Copy() const;
318
319
320
321
322   DEFINE_STANDARD_RTTI(Geom_SurfaceOfRevolution,Geom_SweptSurface)
323
324 protected:
325
326
327
328
329 private:
330
331
332   gp_Pnt loc;
333
334
335 };
336
337
338
339
340
341
342
343 #endif // _Geom_SurfaceOfRevolution_HeaderFile