0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / ShapeCustom / ShapeCustom_Surface.hxx
1 // Created on: 1998-06-03
2 // Created by: data exchange team
3 // Copyright (c) 1998-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 _ShapeCustom_Surface_HeaderFile
18 #define _ShapeCustom_Surface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <Standard_Boolean.hxx>
26 class Geom_Surface;
27
28
29 //! Converts a surface to the analitical form with given
30 //! precision. Conversion is done only the surface is bspline
31 //! of bezier and this can be approximed by some analytical
32 //! surface with that precision.
33 class ShapeCustom_Surface 
34 {
35 public:
36
37   DEFINE_STANDARD_ALLOC
38
39   
40   Standard_EXPORT ShapeCustom_Surface();
41   
42   Standard_EXPORT ShapeCustom_Surface(const Handle(Geom_Surface)& S);
43   
44   Standard_EXPORT void Init (const Handle(Geom_Surface)& S);
45   
46   //! Returns maximal deviation of converted surface from the original
47   //! one computed by last call to ConvertToAnalytical
48     Standard_Real Gap() const;
49   
50   //! Tries to convert the Surface to an Analytic form
51   //! Returns the result
52   //! Works only if the Surface is BSpline or Bezier.
53   //! Else, or in case of failure, returns a Null Handle
54   //!
55   //! If <substitute> is True, the new surface replaces the actual
56   //! one in <me>
57   //!
58   //! It works by analysing the case which can apply, creating the
59   //! corresponding analytic surface, then checking coincidence
60   //! Warning: Parameter laws are not kept, hence PCurves should be redone
61   Standard_EXPORT Handle(Geom_Surface) ConvertToAnalytical (const Standard_Real tol, const Standard_Boolean substitute);
62   
63   //! Tries to convert the Surface to the Periodic form
64   //! Returns the resulting surface
65   //! Works only if the Surface is BSpline and is closed with
66   //! Precision::Confusion()
67   //! Else, or in case of failure, returns a Null Handle
68   Standard_EXPORT Handle(Geom_Surface) ConvertToPeriodic (const Standard_Boolean substitute, const Standard_Real preci = -1);
69
70
71
72
73 protected:
74
75
76
77
78
79 private:
80
81
82
83   Handle(Geom_Surface) mySurf;
84   Standard_Real myGap;
85
86
87 };
88
89
90 #include <ShapeCustom_Surface.lxx>
91
92
93
94
95
96 #endif // _ShapeCustom_Surface_HeaderFile