0024624: Lost word in license statement in source files
[occt.git] / src / BRepTools / BRepTools_GTrsfModification.cdl
1 -- Created on: 1996-12-30
2 -- Created by: Stagiaire Mary FABIEN
3 -- Copyright (c) 1996-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 class GTrsfModification from BRepTools inherits Modification from BRepTools
18
19         ---Purpose: Defines a modification of the  geometry by a  GTrsf
20         --          from gp. All methods return True and transform the
21         --          geometry.
22
23 uses Face     from TopoDS,
24      Edge     from TopoDS,
25      Vertex   from TopoDS,
26      Location from TopLoc,
27      Shape    from GeomAbs,
28      
29      Surface  from Geom,
30      Curve    from Geom,
31      Curve    from Geom2d,
32      
33      GTrsf     from gp,
34      Pnt      from gp
35
36 is
37
38     Create (T : GTrsf from gp) returns mutable GTrsfModification from BRepTools; 
39     
40     GTrsf(me: mutable)
41         ---Purpose: Gives an access on the GTrsf.
42         ---C++: return &
43         returns GTrsf from gp
44         is static;
45
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     
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.<RevWires> has  to  be set   to
58         --          Standard_True   when the modification reverses the
59         --          normal of  the   surface.(the wires   have  to  be
60         --          reversed).   <RevFace>   has   to   be   set    to
61         --          Standard_True if  the orientation  of the modified
62         --          face changes in the  shells which contain  it.  --
63         --          Here, <RevFace>  will  return Standard_True if the
64         --          -- gp_Trsf is negative. 
65     
66     
67         returns Boolean from Standard
68         ;
69         
70
71     NewCurve(me: mutable; E  :     Edge     from TopoDS;
72                           C  : out Curve    from Geom;
73                           L  : out Location from TopLoc;
74                           Tol: out Real     from Standard)
75     
76         returns Boolean from Standard
77         ;
78         
79         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
80         --          modified.  In this case,  <C> is the new geometric
81         --          support of the  edge, <L> the  new location, <Tol>
82         --          the         new    tolerance.   Otherwise, returns
83         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
84         --          significant.
85     
86
87     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
88                           P  : out Pnt      from gp;
89                           Tol: out Real     from Standard)
90     
91         returns Boolean from Standard
92         ;
93         
94         ---Purpose: Returns  Standard_True if the  vertex <V> has been
95         --          modified.  In this  case, <P> is the new geometric
96         --          support of the vertex,   <Tol> the new  tolerance.
97         --          Otherwise, returns Standard_False, and <P>,  <Tol>
98         --          are not significant.
99     
100
101     NewCurve2d(me: mutable;  E    :     Edge     from TopoDS;
102                              F    :     Face     from TopoDS;
103                              NewE :     Edge     from TopoDS;
104                              NewF :     Face     from TopoDS;
105                              C    : out Curve    from Geom2d;
106                              Tol  : out Real     from Standard)
107     
108         returns Boolean from Standard
109         ;
110         
111         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
112         --          curve on surface on the face <F>.In this case, <C>
113         --          is the new geometric support of  the edge, <L> the
114         --          new location, <Tol> the new tolerance.
115         --          Otherwise, returns  Standard_False, and <C>,  <L>,
116         --          <Tol> are not significant.
117     
118
119     NewParameter(me: mutable; V  :     Vertex   from TopoDS;
120                               E  :     Edge     from TopoDS;
121                               P  : out Real     from Standard;
122                               Tol: out Real     from Standard)
123     
124         returns Boolean from Standard
125         ;
126         
127         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
128         --          parameter on the  edge <E>. In  this case,  <P> is
129         --          the parameter,    <Tol>  the     new    tolerance.
130         --          Otherwise, returns Standard_False, and <P>,  <Tol>
131         --          are not significant.
132     
133
134
135     
136
137     Continuity(me: mutable; E          : Edge from TopoDS;
138                             F1,F2      : Face from TopoDS;
139                             NewE       : Edge from TopoDS;
140                             NewF1,NewF2: Face from TopoDS)
141     
142         returns Shape from GeomAbs
143         
144         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
145         --          and <NewF2>.
146         --          
147         --          <NewE> is the new  edge created from <E>.  <NewF1>
148         --          (resp. <NewF2>) is the new  face created from <F1>
149         --          (resp. <F2>).
150
151         ;
152
153
154
155 fields
156
157     myGTrsf : GTrsf from gp;
158     myGScale: Real;
159
160 end GTrsfModification;