0024171: Eliminate CLang compiler warning -Wreorder
[occt.git] / src / ShapeCustom / ShapeCustom_Surface.cdl
1 -- Created on: 1998-06-03
2 -- Created by: data exchange team
3 -- Copyright (c) 1998-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 class Surface from ShapeCustom 
24
25     ---Purpose: Converts a surface to the analitical form with given 
26     --          precision. Conversion is done only the surface is bspline
27     --          of bezier and this can be approximed by some analytical
28     --          surface with that precision.
29
30 uses
31     Surface from Geom
32
33 is
34
35     Create returns Surface from ShapeCustom;
36     
37     Create (S: Surface from Geom) returns Surface from ShapeCustom;
38
39     Init (me: in out; S: Surface from Geom);
40
41     Gap (me) returns Real;
42     ---C++: inline
43         ---Purpose: Returns maximal deviation of converted surface from the original 
44         --          one computed by last call to ConvertToAnalytical
45
46     ConvertToAnalytical (me: in out; tol: Real;
47                                      substitute: Boolean)
48     returns Surface from Geom;
49         ---Purpose: Tries to convert the Surface to an Analytic form
50         --          Returns the result
51         --          Works only if the Surface is BSpline or Bezier.
52         --          Else, or in case of failure, returns a Null Handle
53         --
54         --          If <substitute> is True, the new surface replaces the actual
55         --          one in <me>
56         --
57         --          It works by analysing the case which can apply, creating the
58         --          corresponding analytic surface, then checking coincidence
59         --  Warning: Parameter laws are not kept, hence PCurves should be redone
60         
61     ConvertToPeriodic (me: in out; substitute: Boolean; preci: Real = -1)
62     returns Surface from Geom;
63         ---Purpose: 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 fields
69
70     mySurf: Surface from Geom;
71     myGap : Real; -- maximal deviation of converted surface from original one
72
73 end Surface;