0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepFilletAPI / BRepFilletAPI_LocalOperation.cdl
1 -- Created on: 1998-01-29
2 -- Created by: Laurent BOURESCHE
3 -- Copyright (c) 1998-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 deferred class LocalOperation from BRepFilletAPI inherits MakeShape from BRepBuilderAPI
18
19         ---Purpose: Construction of fillets on the edges of a Shell.
20
21 uses
22
23     Shape             from TopoDS,
24     Edge              from TopoDS,
25     Vertex            from TopoDS,
26     ListOfShape       from TopTools,
27     SecHArray1        from ChFiDS
28     
29 is
30
31     ------------------------------------------------------------------
32     --- Add d contour 
33     ------------------------------------------------------------------
34
35     Add(me : in out; E : Edge from TopoDS) 
36         ---Purpose: Adds a  contour in  the  builder  (builds a
37         --          contour  of tangent edges).
38         ---Level: Public
39     is deferred;
40
41     ResetContour(me     : in out; 
42                  IC     : Integer from Standard) 
43         ---Purpose: Reset the contour of index IC, there is nomore 
44         --          information in the contour.
45         ---Level: Public
46     is deferred;
47
48     NbContours(me) 
49         ---Purpose: Number of contours. 
50         ---Level: Advanced
51     returns Integer from Standard is deferred;
52
53     Contour(me; E : Edge from TopoDS) 
54         ---Purpose: Returns the index of  the  contour containing the edge
55         --          E, returns 0 if E doesn't belong to any contour.
56         ---Level: Public
57     returns Integer from Standard is deferred;
58
59     NbEdges(me; I : Integer from Standard) 
60         ---Purpose: Number of Edges in the contour I. 
61         --          
62         ---Level: Advanced
63     returns Integer from Standard       
64     is deferred;
65     
66     Edge(me; I,J : Integer from Standard) 
67         ---Purpose: Returns the Edge J in the contour I. 
68         --          
69         ---C++: return const &
70         ---Level: Advanced
71     returns Edge from TopoDS 
72     is deferred;
73
74     Remove(me : in out; E : Edge from TopoDS) 
75         ---Purpose: remove the contour containing the Edge E.
76         ---Level: Advanced
77     is deferred;
78
79     Length(me; IC : Integer from Standard) returns Real from Standard
80     ---Purpose: returns the length the contour of index IC.
81     is deferred; 
82
83     FirstVertex(me; IC : Integer from Standard) returns Vertex from TopoDS
84         ---Purpose: Returns the first Vertex of the contour of index IC.
85         ---Level: Advanced
86     is deferred;
87
88     LastVertex(me; IC : Integer from Standard) returns Vertex from TopoDS
89         ---Purpose: Returns the last Vertex of the contour of index IC.
90         ---Level: Advanced
91     is deferred;
92
93     Abscissa(me; 
94              IC : Integer from Standard;
95              V  : Vertex  from TopoDS) 
96     returns Real from Standard
97     ---Purpose: returns the abscissa of the vertex V on
98     --          the contour of index IC.
99     is deferred;
100
101     RelativeAbscissa(me; 
102                      IC : Integer from Standard;
103                      V  : Vertex  from TopoDS) 
104     returns Real from Standard
105     ---Purpose: returns the relative abscissa([0.,1.]) of the 
106     --          vertex V on the contour of index IC.
107     is deferred;
108
109     ClosedAndTangent(me; IC : Integer from Standard) 
110     returns Boolean from Standard
111     ---Purpose: returns true if the contour of index IC is closed
112     --          an tangent.
113     is deferred; 
114
115     Closed(me; IC : Integer from Standard) 
116     returns Boolean from Standard
117     ---Purpose: returns true if the contour of index IC is closed
118     is deferred; 
119
120     Reset(me : in out)
121     ---Purpose: Reset all the fields updated   by Build operation  and
122     --          leave the  algorithm in  the  same state  than  before
123     --          build    call.  It   allows   contours    and   radius
124     --          modifications  to build the result another time.
125     ---Level: Advanced
126     is deferred;
127  
128     -------------------------------
129     ---Methods for quick simulation
130     -------------------------------
131
132     Simulate(me : in out; IC : Integer from Standard)
133     is deferred;
134
135     NbSurf(me; IC : Integer from Standard)
136     returns Integer from Standard
137     is deferred;
138          
139     Sect(me; IC, IS : Integer from Standard)
140     returns SecHArray1 from ChFiDS
141     is deferred;
142
143 end LocalOperation;