b311480e |
1 | -- Created on: 2000-10-27 |
2 | -- Created by: Peter KURNEV |
973c2be1 |
3 | -- Copyright (c) 2000-2014 OPEN CASCADE SAS |
b311480e |
4 | -- |
973c2be1 |
5 | -- This file is part of Open CASCADE Technology software library. |
b311480e |
6 | -- |
d5f74e42 |
7 | -- This library is free software; you can redistribute it and/or modify it under |
8 | -- the terms of the GNU Lesser General Public License version 2.1 as published |
973c2be1 |
9 | -- by the Free Software Foundation, with special exception defined in the file |
10 | -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
11 | -- distribution for complete text of the license and disclaimer of any warranty. |
b311480e |
12 | -- |
973c2be1 |
13 | -- Alternatively, this file may be used under the terms of Open CASCADE |
14 | -- commercial license or contractual agreement. |
7fd59977 |
15 | |
16 | class CommonPrt from IntTools |
17 | |
18 | ---Purpose: The class is to describe a common part |
19 | -- between two edges in 3-d space. |
20 | |
21 | uses |
22 | Edge from TopoDS, |
23 | ShapeEnum from TopAbs, |
24 | Range from IntTools, |
25 | SequenceOfRanges from IntTools, |
26 | Pnt from gp |
27 | is |
28 | Create |
29 | returns CommonPrt from IntTools; |
30 | ---Purpose: |
31 | --- Empty constructor |
32 | --- |
33 | |
34 | Create (aCPrt:CommonPrt from IntTools) |
35 | returns CommonPrt from IntTools; |
36 | ---Purpose: |
37 | --- Copy constructor |
38 | --- |
39 | |
40 | Assign (me:out; Other : CommonPrt from IntTools) |
41 | returns CommonPrt from IntTools; |
42 | ---C++: alias operator = |
43 | ---C++: return & |
44 | |
45 | SetEdge1 (me:out; anE:Edge from TopoDS); |
46 | ---Purpose: |
47 | --- Sets the first edge. |
48 | --- |
49 | |
50 | SetEdge2 (me:out; anE:Edge from TopoDS); |
51 | ---Purpose: |
52 | --- Sets the second edge. |
53 | --- |
54 | |
55 | SetType (me:out; aType:ShapeEnum from TopAbs); |
56 | ---Purpose: |
57 | --- Sets the type of the common part |
58 | --- Vertex or Edge |
59 | --- |
60 | |
61 | SetRange1 (me:out; aR: Range from IntTools); |
62 | ---Purpose: |
63 | --- Sets the range of first edge. |
64 | --- |
65 | |
66 | SetRange1 (me:out; tf,tl: Real from Standard); |
67 | ---Purpose: |
68 | --- Sets the range of first edge. |
69 | --- |
70 | |
71 | AppendRange2 (me:out; aR: Range from IntTools); |
72 | ---Purpose: |
73 | --- Appends the range of second edge. |
74 | --- |
75 | |
76 | AppendRange2 (me:out; tf,tl: Real from Standard); |
77 | ---Purpose: |
78 | --- Appends the range of second edge. |
79 | --- |
80 | |
81 | SetVertexParameter1( me:out; tV: Real from Standard); |
82 | ---Purpose: |
83 | --- Sets a parameter of first vertex |
84 | --- |
85 | |
86 | SetVertexParameter2( me:out; tV: Real from Standard); |
87 | ---Purpose: |
88 | --- Sets a parameter of second vertex |
89 | --- |
90 | |
91 | Edge1 (me) |
92 | returns Edge from TopoDS; |
93 | ---C++: return const& |
94 | ---Purpose: |
95 | --- Returns the first edge. |
96 | --- |
97 | |
98 | Edge2 (me) |
99 | returns Edge from TopoDS; |
100 | ---C++: return const& |
101 | ---Purpose: |
102 | --- Returns the second edge |
103 | --- |
104 | |
105 | Type (me) |
106 | returns ShapeEnum from TopAbs; |
107 | ---Purpose: |
108 | --- Returns the type of the common part |
109 | --- |
110 | |
111 | Range1 (me) |
112 | returns Range from IntTools; |
113 | ---C++: return const& |
114 | ---Purpose: |
115 | --- Returns the range of first edge |
116 | --- |
117 | |
118 | Range1 (me; tf,tl:out Real from Standard); |
119 | ---Purpose: |
120 | --- Returns the range of first edge. |
121 | --- |
122 | |
123 | Ranges2 (me) |
124 | returns SequenceOfRanges from IntTools; |
125 | ---C++: return const& |
126 | ---Purpose: |
127 | --- Returns the ranges of second edge. |
128 | --- |
129 | |
130 | ChangeRanges2 (me:out) |
131 | returns SequenceOfRanges from IntTools; |
132 | ---C++: return & |
133 | ---Purpose: |
134 | --- Returns the ranges of second edge. |
135 | --- |
136 | |
137 | VertexParameter1(me) |
138 | returns Real from Standard; |
139 | ---Purpose: |
140 | --- Returns parameter of first vertex |
141 | --- |
142 | |
143 | VertexParameter2(me) |
144 | returns Real from Standard; |
145 | ---Purpose: |
146 | --- Returns parameter of second vertex |
147 | --- |
148 | |
149 | Copy (me; anOther:out CommonPrt from IntTools); |
150 | ---Purpose: |
151 | --- Copies me to anOther |
152 | --- |
153 | |
154 | AllNullFlag(me) |
155 | returns Boolean from Standard; |
156 | ---Purpose: |
157 | --- Modifier |
158 | --- |
159 | |
160 | SetAllNullFlag(me:out; |
161 | aFlag:Boolean from Standard); |
162 | ---Purpose: |
163 | --- Selector |
164 | --- |
165 | |
166 | -- |
167 | SetBoundingPoints(me:out; |
168 | aP1: Pnt from gp; |
169 | aP2: Pnt from gp); |
170 | ---Purpose: |
171 | --- Modifier |
172 | --- |
173 | |
174 | BoundingPoints(me; |
175 | aP1:out Pnt from gp; |
176 | aP2:out Pnt from gp); |
177 | ---Purpose: |
178 | --- Selector |
179 | --- |
180 | -- |
181 | fields |
182 | myEdge1 : Edge from TopoDS; |
183 | myEdge2 : Edge from TopoDS; |
184 | myType : ShapeEnum from TopAbs; |
185 | myRange1 : Range from IntTools; |
186 | myVertPar1 : Real from Standard; |
187 | myVertPar2 : Real from Standard; |
188 | myRanges2: SequenceOfRanges from IntTools; |
189 | |
190 | myAllNullFlag: Boolean from Standard; |
191 | -- |
192 | myPnt1 : Pnt from gp; |
193 | myPnt2 : Pnt from gp; |
194 | -- |
195 | |
196 | end CommonPrt; |