1baa0c7a743580d72512972e4a2e898830732f0a
[occt.git] / src / GeomAdaptor / GeomAdaptor_Surface.hxx
1 // Created on: 1993-05-14
2 // Created by: Bruno DUMORTIER
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 _GeomAdaptor_Surface_HeaderFile
18 #define _GeomAdaptor_Surface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <GeomAbs_SurfaceType.hxx>
25 #include <Standard_Real.hxx>
26 #include <BSplSLib_Cache.hxx>
27 #include <Adaptor3d_Surface.hxx>
28 #include <GeomAbs_Shape.hxx>
29 #include <Standard_Integer.hxx>
30 #include <TColStd_Array1OfReal.hxx>
31 #include <Standard_Boolean.hxx>
32 class Geom_Surface;
33 class Standard_NoSuchObject;
34 class Standard_OutOfRange;
35 class Standard_ConstructionError;
36 class Standard_DomainError;
37 class Adaptor3d_HSurface;
38 class gp_Pnt;
39 class gp_Vec;
40 class gp_Pln;
41 class gp_Cylinder;
42 class gp_Cone;
43 class gp_Sphere;
44 class gp_Torus;
45 class Geom_BezierSurface;
46 class Geom_BSplineSurface;
47 class gp_Ax1;
48 class gp_Dir;
49 class Adaptor3d_HCurve;
50
51
52 //! An interface between the services provided by any
53 //! surface from the package Geom and those required
54 //! of the surface by algorithms which use it.
55 //! Creation of the loaded surface the surface is C1 by piece
56 class GeomAdaptor_Surface  : public Adaptor3d_Surface
57 {
58 public:
59
60   DEFINE_STANDARD_ALLOC
61
62   
63     GeomAdaptor_Surface();
64   
65     GeomAdaptor_Surface(const Handle(Geom_Surface)& S);
66   
67   //! ConstructionError is raised if UFirst>ULast or VFirst>VLast
68     GeomAdaptor_Surface(const Handle(Geom_Surface)& S, const Standard_Real UFirst, const Standard_Real ULast, const Standard_Real VFirst, const Standard_Real VLast, const Standard_Real TolU = 0.0, const Standard_Real TolV = 0.0);
69   
70     void Load (const Handle(Geom_Surface)& S);
71   
72   //! ConstructionError is raised if UFirst>ULast or VFirst>VLast
73     void Load (const Handle(Geom_Surface)& S, const Standard_Real UFirst, const Standard_Real ULast, const Standard_Real VFirst, const Standard_Real VLast, const Standard_Real TolU = 0.0, const Standard_Real TolV = 0.0);
74   
75     const Handle(Geom_Surface)& Surface() const;
76   
77     Standard_Real FirstUParameter() const Standard_OVERRIDE;
78   
79     Standard_Real LastUParameter() const Standard_OVERRIDE;
80   
81     Standard_Real FirstVParameter() const Standard_OVERRIDE;
82   
83     Standard_Real LastVParameter() const Standard_OVERRIDE;
84   
85   Standard_EXPORT GeomAbs_Shape UContinuity() const Standard_OVERRIDE;
86   
87   Standard_EXPORT GeomAbs_Shape VContinuity() const Standard_OVERRIDE;
88   
89   //! Returns the number of U intervals for  continuity
90   //! <S>. May be one if UContinuity(me) >= <S>
91   Standard_EXPORT Standard_Integer NbUIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
92   
93   //! Returns the number of V intervals for  continuity
94   //! <S>. May be one if VContinuity(me) >= <S>
95   Standard_EXPORT Standard_Integer NbVIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
96   
97   //! Returns the  intervals with the requested continuity
98   //! in the U direction.
99   Standard_EXPORT void UIntervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
100   
101   //! Returns the  intervals with the requested continuity
102   //! in the V direction.
103   Standard_EXPORT void VIntervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
104   
105   //! Returns    a  surface trimmed in the U direction
106   //! equivalent   of  <me>  between
107   //! parameters <First>  and <Last>. <Tol>  is used  to
108   //! test for 3d points confusion.
109   //! If <First> >= <Last>
110   Standard_EXPORT Handle(Adaptor3d_HSurface) UTrim (const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE;
111   
112   //! Returns    a  surface trimmed in the V direction  between
113   //! parameters <First>  and <Last>. <Tol>  is used  to
114   //! test for 3d points confusion.
115   //! If <First> >= <Last>
116   Standard_EXPORT Handle(Adaptor3d_HSurface) VTrim (const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE;
117   
118   Standard_EXPORT Standard_Boolean IsUClosed() const Standard_OVERRIDE;
119   
120   Standard_EXPORT Standard_Boolean IsVClosed() const Standard_OVERRIDE;
121   
122   Standard_EXPORT Standard_Boolean IsUPeriodic() const Standard_OVERRIDE;
123   
124   Standard_EXPORT Standard_Real UPeriod() const Standard_OVERRIDE;
125   
126   Standard_EXPORT Standard_Boolean IsVPeriodic() const Standard_OVERRIDE;
127   
128   Standard_EXPORT Standard_Real VPeriod() const Standard_OVERRIDE;
129   
130   //! Computes the point of parameters U,V on the surface.
131   Standard_EXPORT gp_Pnt Value (const Standard_Real U, const Standard_Real V) const Standard_OVERRIDE;
132   
133   //! Computes the point of parameters U,V on the surface.
134   Standard_EXPORT void D0 (const Standard_Real U, const Standard_Real V, gp_Pnt& P) const Standard_OVERRIDE;
135   
136   //! Computes the point  and the first derivatives on
137   //! the surface.
138   //!
139   //! Warning : On the specific case of BSplineSurface:
140   //! if the surface is cut in interval of continuity at least C1,
141   //! the derivatives are computed on the current interval.
142   //! else the derivatives are computed on the basis surface.
143   Standard_EXPORT void D1 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const Standard_OVERRIDE;
144   
145   //! Computes   the point,  the  first  and  second
146   //! derivatives on the surface.
147   //!
148   //! Warning : On the specific case of BSplineSurface:
149   //! if the surface is cut in interval of continuity at least C2,
150   //! the derivatives are computed on the current interval.
151   //! else the derivatives are computed on the basis surface.
152   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 Standard_OVERRIDE;
153   
154   //! Computes the point,  the first, second and third
155   //! derivatives on the surface.
156   //!
157   //! Warning : On the specific case of BSplineSurface:
158   //! if the surface is cut in interval of continuity at least C3,
159   //! the derivatives are computed on the current interval.
160   //! else the derivatives are computed on the basis surface.
161   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 Standard_OVERRIDE;
162   
163   //! Computes the derivative of order Nu in the
164   //! direction U and Nv in the direction V at the point P(U, V).
165   //!
166   //! Warning : On the specific case of BSplineSurface:
167   //! if the surface is cut in interval of continuity CN,
168   //! the derivatives are computed on the current interval.
169   //! else the derivatives are computed on the basis surface.
170   //! Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.
171   Standard_EXPORT gp_Vec DN (const Standard_Real U, const Standard_Real V, const Standard_Integer Nu, const Standard_Integer Nv) const Standard_OVERRIDE;
172   
173   //! Returns the parametric U  resolution corresponding
174   //! to the real space resolution <R3d>.
175   Standard_EXPORT Standard_Real UResolution (const Standard_Real R3d) const Standard_OVERRIDE;
176   
177   //! Returns the parametric V  resolution corresponding
178   //! to the real space resolution <R3d>.
179   Standard_EXPORT Standard_Real VResolution (const Standard_Real R3d) const Standard_OVERRIDE;
180   
181   //! Returns the type of the surface : Plane, Cylinder,
182   //! Cone,      Sphere,        Torus,    BezierSurface,
183   //! BSplineSurface,               SurfaceOfRevolution,
184   //! SurfaceOfExtrusion, OtherSurface
185     GeomAbs_SurfaceType GetType() const Standard_OVERRIDE;
186   
187   Standard_EXPORT gp_Pln Plane() const Standard_OVERRIDE;
188   
189   Standard_EXPORT gp_Cylinder Cylinder() const Standard_OVERRIDE;
190   
191   Standard_EXPORT gp_Cone Cone() const Standard_OVERRIDE;
192   
193   Standard_EXPORT gp_Sphere Sphere() const Standard_OVERRIDE;
194   
195   Standard_EXPORT gp_Torus Torus() const Standard_OVERRIDE;
196   
197   Standard_EXPORT Standard_Integer UDegree() const Standard_OVERRIDE;
198   
199   Standard_EXPORT Standard_Integer NbUPoles() const Standard_OVERRIDE;
200   
201   Standard_EXPORT Standard_Integer VDegree() const Standard_OVERRIDE;
202   
203   Standard_EXPORT Standard_Integer NbVPoles() const Standard_OVERRIDE;
204   
205   Standard_EXPORT Standard_Integer NbUKnots() const Standard_OVERRIDE;
206   
207   Standard_EXPORT Standard_Integer NbVKnots() const Standard_OVERRIDE;
208   
209   Standard_EXPORT Standard_Boolean IsURational() const Standard_OVERRIDE;
210   
211   Standard_EXPORT Standard_Boolean IsVRational() const Standard_OVERRIDE;
212   
213   //! This will NOT make a copy of the
214   //! Bezier Surface : If you want to modify
215   //! the Surface please make a copy yourself
216   //! Also it will NOT trim the surface to
217   //! myU/VFirst/Last.
218   Standard_EXPORT Handle(Geom_BezierSurface) Bezier() const Standard_OVERRIDE;
219   
220   //! This will NOT make a copy of the
221   //! BSpline Surface : If you want to modify
222   //! the Surface please make a copy yourself
223   //! Also it will NOT trim the surface to
224   //! myU/VFirst/Last.
225   Standard_EXPORT Handle(Geom_BSplineSurface) BSpline() const Standard_OVERRIDE;
226   
227   Standard_EXPORT gp_Ax1 AxeOfRevolution() const Standard_OVERRIDE;
228   
229   Standard_EXPORT gp_Dir Direction() const Standard_OVERRIDE;
230   
231   Standard_EXPORT Handle(Adaptor3d_HCurve) BasisCurve() const Standard_OVERRIDE;
232   
233   Standard_EXPORT Handle(Adaptor3d_HSurface) BasisSurface() const Standard_OVERRIDE;
234   
235   Standard_EXPORT Standard_Real OffsetValue() const Standard_OVERRIDE;
236
237
238
239
240 protected:
241
242
243
244
245
246 private:
247
248   
249   Standard_EXPORT void Span (const Standard_Integer Side, const Standard_Integer Ideb, const Standard_Integer Ifin, Standard_Integer& OutIdeb, Standard_Integer& OutIfin, const Standard_Integer FKIndx, const Standard_Integer LKIndx) const;
250   
251   Standard_EXPORT Standard_Boolean IfUVBound (const Standard_Real U, const Standard_Real V, Standard_Integer& Ideb, Standard_Integer& Ifin, Standard_Integer& IVdeb, Standard_Integer& IVfin, const Standard_Integer USide, const Standard_Integer VSide) const;
252   
253   Standard_EXPORT void load (const Handle(Geom_Surface)& S, const Standard_Real UFirst, const Standard_Real ULast, const Standard_Real VFirst, const Standard_Real VLast, const Standard_Real TolU = 0.0, const Standard_Real TolV = 0.0);
254   
255   //! Rebuilds B-spline cache
256   //! \param theU first parameter to identify the span for caching
257   //! \param theV second parameter to identify the span for caching
258   Standard_EXPORT void RebuildCache (const Standard_Real theU, const Standard_Real theV) const;
259
260
261   Handle(Geom_Surface) mySurface;
262   GeomAbs_SurfaceType mySurfaceType;
263   Standard_Real myUFirst;
264   Standard_Real myULast;
265   Standard_Real myVFirst;
266   Standard_Real myVLast;
267   Standard_Real myTolU;
268   Standard_Real myTolV;
269   Handle(BSplSLib_Cache) mySurfaceCache;
270
271
272 };
273
274
275 #include <GeomAdaptor_Surface.lxx>
276
277
278
279
280
281 #endif // _GeomAdaptor_Surface_HeaderFile