0024171: Eliminate CLang compiler warning -Wreorder
[occt.git] / src / ShapeCustom / ShapeCustom_DirectModification.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 DirectModification from ShapeCustom 
24 inherits Modification from BRepTools 
25
26         ---Purpose: implements a modification for the BRepTools
27         --          Modifier algortihm. Will redress indirect
28         --          surfaces.
29
30 uses
31     Vertex   from TopoDS,
32     Edge     from TopoDS,
33     Face     from TopoDS,
34     Location from TopLoc,
35      
36     Shape    from GeomAbs,
37      
38     Pnt      from gp,
39     Curve    from Geom,
40     Curve    from Geom2d,
41     Surface  from Geom
42
43 is
44
45     Create returns mutable DirectModification from ShapeCustom;
46
47     NewSurface(me: mutable; F  :     Face     from TopoDS;
48                             S  : out Surface  from Geom;
49                             L  : out Location from TopLoc;
50                             Tol: out Real     from Standard;
51                             RevWires : out Boolean from Standard;
52                             RevFace  : out Boolean from Standard)
53     returns Boolean from Standard;
54         ---Purpose: Returns Standard_True if the face <F> has  been
55         --          modified. In this case, <S> is the new geometric
56         --          support of the face, <L> the new location,  <Tol>
57         --          the new tolerance.  Otherwise, returns
58         --          Standard_False, and <S>, <L>, <Tol> are  not
59         --          significant.
60         
61     NewCurve(me: mutable; E  :     Edge     from TopoDS;
62                           C  : out Curve    from Geom;
63                           L  : out Location from TopLoc;
64                           Tol: out Real     from Standard)
65     returns Boolean from Standard;
66         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
67         --          modified.  In this case,  <C> is the new geometric
68         --          support of the  edge, <L> the  new location, <Tol>
69         --          the         new    tolerance.   Otherwise, returns
70         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
71         --          significant.
72
73     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
74                           P  : out Pnt      from gp;
75                           Tol: out Real     from Standard)
76     returns Boolean from Standard;
77         ---Purpose: Returns  Standard_True if the  vertex <V> has been
78         --          modified.  In this  case, <P> is the new geometric
79         --          support of the vertex,   <Tol> the new  tolerance.
80         --          Otherwise, returns Standard_False, and <P>,  <Tol>
81         --          are not significant.
82
83     NewCurve2d(me: mutable; E    :     Edge     from TopoDS;
84                             F    :     Face     from TopoDS;
85                             NewE :     Edge     from TopoDS;
86                             NewF :     Face     from TopoDS;
87                             C    : out Curve    from Geom2d;
88                             Tol  : out Real     from Standard)
89     returns Boolean from Standard;
90         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
91         --          curve on surface on the face <F>.In this case, <C>
92         --          is the new geometric support of  the edge, <L> the
93         --          new location, <Tol> the new tolerance.
94         --          
95         --          Otherwise, returns  Standard_False, and <C>,  <L>,
96         --          <Tol> are not significant.
97         --          
98         --          <NewE> is the new  edge created from  <E>.  <NewF>
99         --          is the new face created from <F>. They may be usefull.
100
101     NewParameter(me: mutable; V  :     Vertex from TopoDS;
102                               E  :     Edge   from TopoDS;
103                               P  : out Real   from Standard;
104                               Tol: out Real   from Standard)
105     returns Boolean from Standard;
106         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
107         --          parameter on the  edge <E>. In  this case,  <P> is
108         --          the parameter,    <Tol>  the     new    tolerance.
109         --          Otherwise, returns Standard_False, and <P>,  <Tol>
110         --          are not significant.
111
112     Continuity(me: mutable; E          : Edge from TopoDS;
113                             F1,F2      : Face from TopoDS;
114                             NewE       : Edge from TopoDS;
115                             NewF1,NewF2: Face from TopoDS)
116     returns Shape from GeomAbs;
117         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
118         --          and <NewF2>.
119         --          
120         --          <NewE> is the new  edge created from <E>.  <NewF1>
121         --          (resp. <NewF2>) is the new  face created from <F1>
122         --          (resp. <F2>).
123
124 end DirectModification;