0022627: Change OCCT memory management defaults
[occt.git] / src / ShapeCustom / ShapeCustom_DirectModification.cdl
1 -- File:        ShapeCustom_DirectModification.cdl
2 -- Created:     Wed Jun  3 12:41:36 1998
3 -- Author:      data exchange team
4 --              <det@loufox.nnov.matra-dtv.fr>
5 ---Copyright:    Matra Datavision 1998
6
7
8 class DirectModification from ShapeCustom 
9 inherits Modification from BRepTools 
10
11         ---Purpose: implements a modification for the BRepTools
12         --          Modifier algortihm. Will redress indirect
13         --          surfaces.
14
15 uses
16     Vertex   from TopoDS,
17     Edge     from TopoDS,
18     Face     from TopoDS,
19     Location from TopLoc,
20      
21     Shape    from GeomAbs,
22      
23     Pnt      from gp,
24     Curve    from Geom,
25     Curve    from Geom2d,
26     Surface  from Geom
27
28 is
29
30     Create returns mutable DirectModification from ShapeCustom;
31
32     NewSurface(me: mutable; F  :     Face     from TopoDS;
33                             S  : out Surface  from Geom;
34                             L  : out Location from TopLoc;
35                             Tol: out Real     from Standard;
36                             RevWires : out Boolean from Standard;
37                             RevFace  : out Boolean from Standard)
38     returns Boolean from Standard;
39         ---Purpose: Returns Standard_True if the face <F> has  been
40         --          modified. In this case, <S> is the new geometric
41         --          support of the face, <L> the new location,  <Tol>
42         --          the new tolerance.  Otherwise, returns
43         --          Standard_False, and <S>, <L>, <Tol> are  not
44         --          significant.
45         
46     NewCurve(me: mutable; E  :     Edge     from TopoDS;
47                           C  : out Curve    from Geom;
48                           L  : out Location from TopLoc;
49                           Tol: out Real     from Standard)
50     returns Boolean from Standard;
51         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
52         --          modified.  In this case,  <C> is the new geometric
53         --          support of the  edge, <L> the  new location, <Tol>
54         --          the         new    tolerance.   Otherwise, returns
55         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
56         --          significant.
57
58     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
59                           P  : out Pnt      from gp;
60                           Tol: out Real     from Standard)
61     returns Boolean from Standard;
62         ---Purpose: Returns  Standard_True if the  vertex <V> has been
63         --          modified.  In this  case, <P> is the new geometric
64         --          support of the vertex,   <Tol> the new  tolerance.
65         --          Otherwise, returns Standard_False, and <P>,  <Tol>
66         --          are not significant.
67
68     NewCurve2d(me: mutable; E    :     Edge     from TopoDS;
69                             F    :     Face     from TopoDS;
70                             NewE :     Edge     from TopoDS;
71                             NewF :     Face     from TopoDS;
72                             C    : out Curve    from Geom2d;
73                             Tol  : out Real     from Standard)
74     returns Boolean from Standard;
75         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
76         --          curve on surface on the face <F>.In this case, <C>
77         --          is the new geometric support of  the edge, <L> the
78         --          new location, <Tol> the new tolerance.
79         --          
80         --          Otherwise, returns  Standard_False, and <C>,  <L>,
81         --          <Tol> are not significant.
82         --          
83         --          <NewE> is the new  edge created from  <E>.  <NewF>
84         --          is the new face created from <F>. They may be usefull.
85
86     NewParameter(me: mutable; V  :     Vertex from TopoDS;
87                               E  :     Edge   from TopoDS;
88                               P  : out Real   from Standard;
89                               Tol: out Real   from Standard)
90     returns Boolean from Standard;
91         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
92         --          parameter on the  edge <E>. In  this case,  <P> is
93         --          the parameter,    <Tol>  the     new    tolerance.
94         --          Otherwise, returns Standard_False, and <P>,  <Tol>
95         --          are not significant.
96
97     Continuity(me: mutable; E          : Edge from TopoDS;
98                             F1,F2      : Face from TopoDS;
99                             NewE       : Edge from TopoDS;
100                             NewF1,NewF2: Face from TopoDS)
101     returns Shape from GeomAbs;
102         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
103         --          and <NewF2>.
104         --          
105         --          <NewE> is the new  edge created from <E>.  <NewF1>
106         --          (resp. <NewF2>) is the new  face created from <F1>
107         --          (resp. <F2>).
108
109 end DirectModification;