0024171: Eliminate CLang compiler warning -Wreorder
[occt.git] / src / ShapeCustom / ShapeCustom_SweptToElementary.cdl
1 -- Created on: 2003-12-10
2 -- Created by: Sergey KUUL
3 -- Copyright (c) 2003-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21 private class SweptToElementary from ShapeCustom inherits Modification from BRepTools 
22
23         ---Purpose: implements a modification for the BRepTools
24         --          Modifier algortihm. Converts all elementary
25         --          surfaces into surfaces of revolution.
26         
27 uses
28     Vertex   from TopoDS,
29     Edge     from TopoDS,
30     Face     from TopoDS,
31     Location from TopLoc,
32      
33     Shape    from GeomAbs,
34      
35     Pnt      from gp,
36     Curve    from Geom,
37     Curve    from Geom2d,
38     Surface  from Geom
39
40 is
41
42     Create returns mutable SweptToElementary from ShapeCustom;
43
44     NewSurface(me: mutable; F  :     Face     from TopoDS;
45                             S  : out Surface  from Geom;
46                             L  : out Location from TopLoc;
47                             Tol: out Real     from Standard;
48                             RevWires : out Boolean from Standard;
49                             RevFace  : out Boolean from Standard)
50     returns Boolean from Standard;
51         ---Purpose: Returns Standard_True if the face <F> has  been
52         --          modified. In this case, <S> is the new geometric
53         --          support of the face, <L> the new location,  <Tol>
54         --          the new tolerance.  Otherwise, returns
55         --          Standard_False, and <S>, <L>, <Tol> are  not
56         --          significant.
57         
58     NewCurve(me: mutable; E  :     Edge     from TopoDS;
59                           C  : out Curve    from Geom;
60                           L  : out Location from TopLoc;
61                           Tol: out Real     from Standard)
62     returns Boolean from Standard;
63         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
64         --          modified.  In this case,  <C> is the new geometric
65         --          support of the  edge, <L> the  new location, <Tol>
66         --          the         new    tolerance.   Otherwise, returns
67         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
68         --          significant.
69
70     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
71                           P  : out Pnt      from gp;
72                           Tol: out Real     from Standard)
73     returns Boolean from Standard;
74         ---Purpose: Returns  Standard_True if the  vertex <V> has been
75         --          modified.  In this  case, <P> is the new geometric
76         --          support of the vertex,   <Tol> the new  tolerance.
77         --          Otherwise, returns Standard_False, and <P>,  <Tol>
78         --          are not significant.
79
80     NewCurve2d(me: mutable; E    :     Edge     from TopoDS;
81                             F    :     Face     from TopoDS;
82                             NewE :     Edge     from TopoDS;
83                             NewF :     Face     from TopoDS;
84                             C    : out Curve    from Geom2d;
85                             Tol  : out Real     from Standard)
86     returns Boolean from Standard;
87         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
88         --          curve on surface on the face <F>.In this case, <C>
89         --          is the new geometric support of  the edge, <L> the
90         --          new location, <Tol> the new tolerance.
91         --          
92         --          Otherwise, returns  Standard_False, and <C>,  <L>,
93         --          <Tol> are not significant.
94         --          
95         --          <NewE> is the new  edge created from  <E>.  <NewF>
96         --          is the new face created from <F>. They may be usefull.
97
98     NewParameter(me: mutable; V  :     Vertex from TopoDS;
99                               E  :     Edge   from TopoDS;
100                               P  : out Real   from Standard;
101                               Tol: out Real   from Standard)
102     returns Boolean from Standard;
103         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
104         --          parameter on the  edge <E>. In  this case,  <P> is
105         --          the parameter,    <Tol>  the     new    tolerance.
106         --          Otherwise, returns Standard_False, and <P>,  <Tol>
107         --          are not significant.
108
109     Continuity(me: mutable; E          : Edge from TopoDS;
110                             F1,F2      : Face from TopoDS;
111                             NewE       : Edge from TopoDS;
112                             NewF1,NewF2: Face from TopoDS)
113     returns Shape from GeomAbs;
114         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
115         --          and <NewF2>.
116         --          
117         --          <NewE> is the new  edge created from <E>.  <NewF1>
118         --          (resp. <NewF2>) is the new  face created from <F1>
119         --          (resp. <F2>).
120
121 end SweptToElementary;