0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPTools / BOPTools_AlgoTools2D.cdl
CommitLineData
4e57c75e 1-- Created by: Peter KURNEV
973c2be1 2-- Copyright (c) 1999-2014 OPEN CASCADE SAS
4e57c75e 3--
973c2be1 4-- This file is part of Open CASCADE Technology software library.
4e57c75e 5--
d5f74e42 6-- This library is free software; you can redistribute it and/or modify it under
7-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 8-- by the Free Software Foundation, with special exception defined in the file
9-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10-- distribution for complete text of the license and disclaimer of any warranty.
4e57c75e 11--
973c2be1 12-- Alternatively, this file may be used under the terms of Open CASCADE
13-- commercial license or contractual agreement.
4e57c75e 14
15class AlgoTools2D from BOPTools
16
17 ---Purpose:
18 --- The class contains handy static functions
19 --- dealing with the topology
20 --- This is the copy of the BOPTools_AlgoTools2D.cdl
21uses
22 Vec from gp,
23 Dir from gp,
24 Vertex from TopoDS,
25 Edge from TopoDS,
26 Face from TopoDS,
fd372378 27 Surface from BRepAdaptor,
4e57c75e 28 Curve from Geom2d,
29 Curve from Geom,
905522ee 30 ProjectedCurve from ProjLib,
31 Context from IntTools,
acccace3 32 ListOfShape from BOPCol
33
4e57c75e 34is
35
36 BuildPCurveForEdgeOnFace (myclass;
37 aE: Edge from TopoDS;
38 aF: Face from TopoDS);
39 ---Purpose:
40 --- Compute P-Curve for the edge <aE> on the face <aF>
b9a7d225 41 --- Raises exception Standard_ConstructionError if projection algorithm fails
42
4e57c75e 43 EdgeTangent (myclass;
44 anE : Edge from TopoDS;
45 aT : Real from Standard;
46 Tau : out Vec from gp)
47 returns Boolean from Standard;
48 ---Purpose:
49 --- Compute tangent for the edge <aE> [in 3D] at parameter <aT>
50 ---
51
52 PointOnSurface (myclass;
53 aE: Edge from TopoDS;
54 aF: Face from TopoDS;
55 aT: Real from Standard;
56 U : out Real from Standard;
57 V : out Real from Standard);
58 ---Purpose:
59 --- Compute surface parameters <U,V> of the face <aF>
b9a7d225 60 --- for the point from the edge <aE> at parameter <aT>.
61 --- If <aE> has't pcurve on surface, algorithm tries to get it by
62 --- projection and can
63 --- raise exception Standard_ConstructionError if projection algorithm fails
64
4e57c75e 65 CurveOnSurface (myclass;
66 aE: Edge from TopoDS;
67 aF: Face from TopoDS;
68 aC : out Curve from Geom2d;
69 aToler: out Real from Standard);
70 ---Purpose:
71 --- Get P-Curve <aC> for the edge <aE> on surface <aF> .
72 --- If the P-Curve does not exist, build it using Make2D().
73 --- [aToler] - reached tolerance
b9a7d225 74 --- Raises exception Standard_ConstructionError if algorithm Make2D() fails
75
4e57c75e 76 CurveOnSurface (myclass;
77 aE: Edge from TopoDS;
78 aF: Face from TopoDS;
79 aC : out Curve from Geom2d;
80 aFirst: out Real from Standard;
81 aLast : out Real from Standard;
82 aToler: out Real from Standard);
83
84 ---Purpose:
85 --- Get P-Curve <aC> for the edge <aE> on surface <aF> .
86 --- If the P-Curve does not exist, build it using Make2D().
87 --- [aFirst, aLast] - range of the P-Curve
88 --- [aToler] - reached tolerance
b9a7d225 89 --- Raises exception Standard_ConstructionError if algorithm Make2D() fails
90
4e57c75e 91 HasCurveOnSurface (myclass;
92 aE: Edge from TopoDS;
93 aF: Face from TopoDS;
94 aC : out Curve from Geom2d;
95 aFirst: out Real from Standard;
96 aLast : out Real from Standard;
97 aToler: out Real from Standard)
98 returns Boolean from Standard;
99 ---Purpose:
100 --- Returns TRUE if the edge <aE> has P-Curve <aC>
101 --- on surface <aF> .
102 --- [aFirst, aLast] - range of the P-Curve
103 --- [aToler] - reached tolerance
104 --- If the P-Curve does not exist, aC.IsNull()=TRUE.
105 ---
106 HasCurveOnSurface (myclass;
107 aE: Edge from TopoDS;
108 aF: Face from TopoDS)
109 returns Boolean from Standard;
110 ---Purpose:
111 --- Returns TRUE if the edge <aE> has P-Curve <aC>
112 --- on surface <aF> .
113 --- If the P-Curve does not exist, aC.IsNull()=TRUE.
114 ---
115
116 AdjustPCurveOnFace (myclass;
117 aF : Face from TopoDS;
118 C3D : Curve from Geom;
119 aC2D : Curve from Geom2d;
120 aC2DA : out Curve from Geom2d);
121 ---Purpose:
122 --- Adjust P-Curve <aC2D> (3D-curve <C3D>) on surface <aF> .
123 ---
124 AdjustPCurveOnFace (myclass;
125 aF : Face from TopoDS;
126 aT1 : Real from Standard;
127 aT2 : Real from Standard;
128 aC2D : Curve from Geom2d;
129 aC2DA : out Curve from Geom2d);
130 ---Purpose:
131 --- Adjust P-Curve <aC2D> (3D-curve <C3D>) on surface <aF> .
132 --- [aT1, aT2] - range to adjust
133 ---
fd372378 134 AdjustPCurveOnFace (myclass;
135 aF : Surface from BRepAdaptor;
136 aT1 : Real from Standard;
137 aT2 : Real from Standard;
138 aC2D : Curve from Geom2d;
139 aC2DA : out Curve from Geom2d);
140 ---Purpose:
141 --- Adjust P-Curve <aC2D> (3D-curve <C3D>) on surface <aF> .
142 --- [aT1, aT2] - range to adjust
143 ---
4e57c75e 144 IntermediatePoint (myclass;
145 aFirst: Real from Standard;
146 aLast : Real from Standard)
147 returns Real from Standard;
148 ---Purpose:
149 --- Compute intermediate value in between [aFirst, aLast] .
150 ---
151 IntermediatePoint (myclass;
152 anE : Edge from TopoDS)
153 returns Real from Standard;
154 ---Purpose:
155 --- Compute intermediate value of parameter for the edge <anE>.
156 ---
157 BuildPCurveForEdgeOnPlane(myclass;
158 theE : Edge from TopoDS;
acccace3 159 theF : Face from TopoDS);
160
161 BuildPCurveForEdgesOnPlane(myclass;
162 theLE : ListOfShape from BOPCol;
4e57c75e 163 theF : Face from TopoDS);
164
165 Make2D (myclass;
166 aE: Edge from TopoDS;
167 aF: Face from TopoDS;
168 aC : out Curve from Geom2d;
169 aFirst: out Real from Standard;
170 aLast : out Real from Standard;
171 aToler: out Real from Standard);
172 ---Purpose:
173 --- Make P-Curve <aC> for the edge <aE> on surface <aF> .
174 --- [aFirst, aLast] - range of the P-Curve
175 --- [aToler] - reached tolerance
b9a7d225 176 --- Raises exception Standard_ConstructionError if algorithm fails
4e57c75e 177
4e57c75e 178 MakePCurveOnFace (myclass;
179 aF: Face from TopoDS;
180 C3D : Curve from Geom;
181 aC : out Curve from Geom2d;
182 aToler: out Real from Standard) ;
183 ---Purpose:
184 --- Make P-Curve <aC> for the 3D-curve <C3D> on surface <aF> .
185 --- [aToler] - reached tolerance
b9a7d225 186 --- Raises exception Standard_ConstructionError if projection algorithm fails
187
4e57c75e 188 MakePCurveOnFace (myclass;
189 aF: Face from TopoDS;
190 C3D : Curve from Geom;
191 aT1 : Real from Standard;
192 aT2 : Real from Standard;
193 aC : out Curve from Geom2d;
194 aToler: out Real from Standard) ;
195 ---Purpose:
196 --- Make P-Curve <aC> for the 3D-curve <C3D> on surface <aF> .
197 --- [aT1, aT2] - range to build
198 --- [aToler] - reached tolerance
b9a7d225 199 --- Raises exception Standard_ConstructionError if projection algorithm fails
200
4e57c75e 201 MakePCurveOfType (myclass;
202 PC : ProjectedCurve from ProjLib;
203 aC : out Curve from Geom2d);
204 ---Purpose:
205 --- Make empty P-Curve <aC> of relevant to <PC> type
206 ---
905522ee 207 AttachExistingPCurve (myclass;
208 aEold : Edge from TopoDS;
209 aEnew : Edge from TopoDS;
210 aF : Face from TopoDS;
211 aCtx : Context from IntTools)
212 returns Integer from Standard;
213 ---Purpose:
214 --- Attach P-Curve from the edge <aEold> on surface <aF>
215 --- to the edge <aEnew>
216 --- Returns 0 in case of success
217
4e57c75e 218end AlgoTools2D;