0024750: Replace instantiations of TCollection generic classes by NCollection templat...
[occt.git] / src / Contap / Contap_Contour.cdl
1 -- Created on: 1993-02-05
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1993-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 Contour from Contap
18
19 uses PathPoint               from IntSurf,
20      PathPointTool           from IntSurf,
21      SequenceOfPathPoint     from IntSurf,
22      InteriorPoint           from IntSurf,
23      InteriorPointTool       from IntSurf,
24      SequenceOfInteriorPoint from IntSurf,
25      Pnt                     from gp,
26      Vec                     from gp,
27      Point                   from Contap,
28      Line                    from Contap,
29      SurfFunction            from Contap,
30      ArcFunction             from Contap,
31      TheSequenceOfLine       from Contap,
32      TheSearch               from Contap,
33      TheSearchInside         from Contap,
34      HSurface                from Adaptor3d,
35      TopolTool               from Adaptor3d
36
37
38 raises NotDone           from StdFail,
39        OutOfRange        from Standard,
40        ConstructionError from Standard
41
42
43 is
44
45     Create
46     
47         returns Contour from Contap;
48
49
50     Create(Direction: Vec from gp)
51     
52         returns Contour from Contap;
53
54
55     Create(Direction: Vec from gp; Angle: Real from Standard)
56     
57         returns Contour from Contap;
58
59
60     Create(Eye: Pnt from gp)
61     
62         returns Contour from Contap;
63
64
65     Create(Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
66            Direction: Vec from gp)
67
68         ---Purpose: Creates the contour in a given direction.
69
70         returns Contour from Contap;
71
72
73     Create(Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
74            Direction: Vec from gp; Angle: Real from Standard)
75
76         ---Purpose: Creates the contour in a given direction.
77
78         returns Contour from Contap;
79
80
81     Create(Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
82            Eye: Pnt from gp)
83
84         ---Purpose: Creates the contour for a perspective view.
85
86         returns Contour from Contap;
87
88
89     Perform(me: in out; Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d)
90
91         ---Purpose: Creates the contour in a given direction.
92
93         raises ConstructionError from Standard
94         is static;
95
96
97     Perform(me: in out; Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
98                         Direction: Vec from gp)
99
100         ---Purpose: Creates the contour in a given direction.
101
102         is static;
103
104
105     Perform(me: in out; Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
106                         Direction: Vec from gp; Angle: Real from Standard)
107
108         ---Purpose: Creates the contour in a given direction.
109
110         is static;
111
112
113     Perform(me: in out; Surf: HSurface from Adaptor3d; Domain: TopolTool from Adaptor3d; 
114                         Eye: Pnt from gp)
115
116         ---Purpose: Creates the contour for a perspective view.
117
118         is static;
119
120
121     Init(me: in out; Direction: Vec from gp)
122     
123         is static;
124
125
126     Init(me: in out; Direction: Vec from gp; Angle: Real from Standard)
127     
128         is static;
129
130
131     Init(me: in out; Eye: Pnt from gp)
132     
133         is static;
134
135
136     IsDone(me)
137     
138         returns Boolean from Standard
139         ---C++: inline
140         
141         is static;
142
143
144     IsEmpty(me)
145     
146         ---Purpose: Returns true if the is no line.
147
148         returns Boolean from Standard
149         ---C++: inline
150
151         raises NotDone from StdFail
152
153         is static;
154
155
156     NbLines(me)
157     
158         returns Integer from Standard
159         ---C++: inline
160         
161         raises NotDone from StdFail
162         
163         is static;
164         
165         
166     Line(me; Index: Integer from Standard)
167     
168         returns Line from Contap
169         ---C++: return const& 
170         ---C++: inline
171
172         raises NotDone    from StdFail,
173                OutOfRange from Standard
174         
175         is static;
176
177
178     SurfaceFunction(me : in out)
179     returns SurfFunction
180         ---Purpose: Returns    a     reference   on     the   internal
181         --          SurfaceFunction.  This is used to compute tangents
182         --          on the lines.
183         ---C++: return &
184         ---C++: inline
185     is static;
186
187
188     Perform(me: in out; Domain: TopolTool from Adaptor3d)
189                            
190         is static private;
191
192
193     PerformAna(me: in out; Domain: TopolTool from Adaptor3d)
194                            
195         is static private;
196
197
198 fields
199
200     done     : Boolean           from Standard;
201     slin     : TheSequenceOfLine from Contap;
202     solrst   : TheSearch         from Contap;
203     solins   : TheSearchInside   from Contap;
204     mySFunc  : SurfFunction      from Contap;
205     myAFunc  : ArcFunction       from Contap;
206     modeset  : Boolean           from Standard;
207
208 end Contour;