0024530: TKMesh - remove unused package IntPoly
[occt.git] / src / BRepToIGES / BRepToIGES_BRWire.cdl
CommitLineData
b311480e 1-- Created on: 1995-01-27
2-- Created by: Marie Jose MARTZ
3-- Copyright (c) 1995-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
973c2be1 8-- This library is free software; you can redistribute it and / or modify it
9-- under the terms of the GNU Lesser General Public 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class BRWire from BRepToIGES inherits BREntity from BRepToIGES
18
19 ---Purpose: This class implements the transfer of Shape Entities
20 -- from Geom To IGES. These can be :
21 -- . Vertex
22 -- . Edge
23 -- . Wire
24
25
26uses
27
28 Shape from TopoDS,
29 Vertex from TopoDS,
30 Edge from TopoDS,
31 Wire from TopoDS,
32 Face from TopoDS,
33 Surface from Geom,
34 Curve from Geom2d,
35 Location from TopLoc,
36 Pnt2d from gp,
37 IGESEntity from IGESData,
38 BREntity from BRepToIGES
39
40
41is
42
43 Create returns BRWire from BRepToIGES;
44
45
46 Create (BR : BREntity from BRepToIGES)
47 returns BRWire from BRepToIGES;
48
49
50 TransferWire (me : in out;
51 start : Shape from TopoDS)
52 returns mutable IGESEntity from IGESData;
53 ---Purpose : Transfert a Shape entity from TopoDS to IGES
54 -- this entity must be a Vertex or an Edge or a Wire.
55 -- If this Entity could not be converted,
56 -- this member returns a NullEntity.
57
58
59 TransferVertex (me : in out;
60 myvertex : Vertex from TopoDS)
61 returns mutable IGESEntity from IGESData;
62 ---Purpose : Transfert a Vertex entity from TopoDS to IGES
63 -- If this Entity could not be converted,
64 -- this member returns a NullEntity.
65
66
67 TransferVertex (me : in out;
68 myvertex : Vertex from TopoDS;
69 myedge : Edge from TopoDS;
70 parameter : out Real from Standard)
71 returns mutable IGESEntity from IGESData;
72 ---Purpose : Transfert a Vertex entity on an Edge from TopoDS to IGES
73 -- Returns the parameter of myvertex on myedge.
74 -- If this Entity could not be converted,
75 -- this member returns a NullEntity.
76
77
78 TransferVertex (me : in out;
79 myvertex : Vertex from TopoDS;
80 myedge : Edge from TopoDS;
81 myface : Face from TopoDS;
82 parameter : out Real from Standard)
83 returns mutable IGESEntity from IGESData;
84 ---Purpose : Transfert a Vertex entity of an edge on a Face
85 -- from TopoDS to IGES
86 -- Returns the parameter of myvertex on the pcurve
87 -- of myedge on myface
88 -- If this Entity could not be converted,
89 -- this member returns a NullEntity.
90
91
92 TransferVertex (me : in out;
93 myvertex : Vertex from TopoDS;
94 myedge : Edge from TopoDS;
95 mysurface : Surface from Geom;
96 myloc : Location from TopLoc;
97 parameter : out Real from Standard)
98 returns mutable IGESEntity from IGESData;
99 ---Purpose : Transfert a Vertex entity of an edge on a Surface
100 -- from TopoDS to IGES
101 -- Returns the parameter of myvertex on the pcurve
102 -- of myedge on mysurface
103 -- If this Entity could not be converted,
104 -- this member returns a NullEntity.
105
106
107 TransferVertex (me : in out;
108 myvertex : Vertex from TopoDS;
109 myface : Face from TopoDS;
110 mypoint : out Pnt2d from gp)
111 returns mutable IGESEntity from IGESData;
112 ---Purpose : Transfert a Vertex entity on a Face from TopoDS to IGES
113 -- Returns the parameters of myvertex on myface
114 -- If this Entity could not be converted,
115 -- this member returns a NullEntity.
116
117
118 TransferEdge (me : in out;
119 myedge : Edge from TopoDS;
120 -- IsRevol : in Boolean from Standard
121 isBRepMode: in Boolean from Standard)
122 returns mutable IGESEntity from IGESData;
123 ---Purpose : Transfert an Edge entity from TopoDS to IGES
124 -- If this Entity could not be converted,
125 -- this member returns a NullEntity.
126 -- isBRepMode indicates if write mode is BRep
127 -- (True when called from BRepToIGESBRep and False when from BRepToIGES)
128 -- If edge is REVERSED and isBRepMode is False 3D edge curve is reversed,
129 -- otherwise, not.
130
131
132 TransferEdge (me : in out;
133 myedge : Edge from TopoDS;
134 myface : Face from TopoDS;
135 length : in Real from Standard;
136 isBRepMode: in Boolean from Standard)
137 returns mutable IGESEntity from IGESData;
138 ---Purpose : Transfert an Edge entity on a Face from TopoDS to IGES
139 -- If this Entity could not be converted,
140 -- this member returns a NullEntity.
141 -- isBRepMode indicates if write mode is BRep
142 -- (True when called from BRepToIGESBRep and False when from BRepToIGES)
143 -- passing into Transform2dCurve()
144
145 TransferWire (me : in out;
146 mywire : Wire from TopoDS)
147 returns mutable IGESEntity from IGESData;
148 ---Purpose : Transfert a Wire entity from TopoDS to IGES
149 -- If this Entity could not be converted,
150 -- this member returns a NullEntity.
151
152
153 TransferWire (me : in out;
154 mywire : Wire from TopoDS;
155 myface : Face from TopoDS;
156 mycurve2d : out IGESEntity from IGESData;
157 length : in Real from Standard)
158 -- IsRevol : in Boolean from Standard
159 returns mutable IGESEntity from IGESData;
160 ---Purpose : Transfert a Wire entity from TopoDS to IGES.
161 -- Returns the curve associated to mywire in
162 -- the parametric space of myface.
163 -- If this Entity could not be converted,
164 -- this member returns a NullEntity.
165 -- Parameter IsRevol is not used anymore
166
167end BRWire;