← Back to branch summary

~ubuntu-branches/ubuntu/precise/ipe/precise

« back to all changes in this revision

Viewing changes to doc/class_ipe_segment.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2004-06-08 00:44:02 UTC
  • Revision ID: james.westby@ubuntu.com-20040608004402-72yu51xlh7vt6p9m
Tags: upstream-6.0pre16
Import upstream version 6.0pre16

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/class_ipe_segment.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>Ipelib: IpeSegment class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
</head><body>
 
6
<!-- Generated by Doxygen 1.3.4 -->
 
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
 
8
<h1>IpeSegment Class Reference<br>
 
9
<small>
 
10
[<a class="el" href="group__geo.html">Ipe Geometry</a>]</small>
 
11
</h1>A directed line segment.  
 
12
<a href="#_details">More...</a>
 
13
<p>
 
14
<a href="class_ipe_segment-members.html">List of all members.</a><h2>Public Member Functions</h2>
 
15
<ul>
 
16
<li><a class="el" href="class_ipe_segment.html#a0">IpeSegment</a> ()
 
17
<li><a class="anchor" name="a1" doxytag="IpeSegment::IpeSegment" ></a>
 
18
<b>IpeSegment</b> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;p, const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;q)
 
19
<li><a class="el" href="class_ipe_line.html">IpeLine</a> <a class="el" href="class_ipe_segment.html#a2">Line</a> () const 
 
20
<li>double <a class="el" href="class_ipe_segment.html#a3">Distance</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v, double bound) const 
 
21
<li>double <a class="el" href="class_ipe_segment.html#a4">Distance</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v) const 
 
22
<li>bool <a class="el" href="class_ipe_segment.html#a5">Project</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v, <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;projection) const 
 
23
<li>bool <a class="el" href="class_ipe_segment.html#a6">Intersects</a> (const  <a class="el" href="class_ipe_segment.html">IpeSegment</a> &amp;seg, <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;pt) const 
 
24
<li>bool <a class="el" href="class_ipe_segment.html#a7">Intersects</a> (const  <a class="el" href="class_ipe_line.html">IpeLine</a> &amp;l, <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;pt) const 
 
25
</ul>
 
26
<h2>Public Attributes</h2>
 
27
<ul>
 
28
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#o0">iP</a>
 
29
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#o1">iQ</a>
 
30
</ul>
 
31
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
32
A directed line segment. 
 
33
<p>
 
34
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
35
<a class="anchor" name="a0" doxytag="IpeSegment::IpeSegment" ></a><p>
 
36
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
37
  <tr>
 
38
    <td class="mdRow">
 
39
      <table cellpadding="0" cellspacing="0" border="0">
 
40
        <tr>
 
41
          <td class="md" nowrap valign="top"> IpeSegment::IpeSegment </td>
 
42
          <td class="md" valign="top">(&nbsp;</td>
 
43
          <td class="mdname1" valign="top" nowrap>          </td>
 
44
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
45
          <td class="md" nowrap><code> [inline]</code></td>
 
46
        </tr>
 
47
 
 
48
      </table>
 
49
    </td>
 
50
  </tr>
 
51
</table>
 
52
<table cellspacing=5 cellpadding=0 border=0>
 
53
  <tr>
 
54
    <td>
 
55
      &nbsp;
 
56
    </td>
 
57
    <td>
 
58
 
 
59
<p>
 
60
Create default segment. 
 
61
<p>
 
62
    </td>
 
63
  </tr>
 
64
</table>
 
65
<hr><h2>Member Function Documentation</h2>
 
66
<a class="anchor" name="a2" doxytag="IpeSegment::Line" ></a><p>
 
67
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
68
  <tr>
 
69
    <td class="mdRow">
 
70
      <table cellpadding="0" cellspacing="0" border="0">
 
71
        <tr>
 
72
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_line.html">IpeLine</a> IpeSegment::Line </td>
 
73
          <td class="md" valign="top">(&nbsp;</td>
 
74
          <td class="mdname1" valign="top" nowrap>          </td>
 
75
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
76
          <td class="md" nowrap> const<code> [inline]</code></td>
 
77
        </tr>
 
78
 
 
79
      </table>
 
80
    </td>
 
81
  </tr>
 
82
</table>
 
83
<table cellspacing=5 cellpadding=0 border=0>
 
84
  <tr>
 
85
    <td>
 
86
      &nbsp;
 
87
    </td>
 
88
    <td>
 
89
 
 
90
<p>
 
91
Return directed line supporting the segment. 
 
92
<p>
 
93
    </td>
 
94
  </tr>
 
95
</table>
 
96
<a class="anchor" name="a3" doxytag="IpeSegment::Distance" ></a><p>
 
97
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
98
  <tr>
 
99
    <td class="mdRow">
 
100
      <table cellpadding="0" cellspacing="0" border="0">
 
101
        <tr>
 
102
          <td class="md" nowrap valign="top"> double IpeSegment::Distance </td>
 
103
          <td class="md" valign="top">(&nbsp;</td>
 
104
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
105
          <td class="mdname" nowrap> <em>v</em>, </td>
 
106
        </tr>
 
107
        <tr>
 
108
          <td></td>
 
109
          <td></td>
 
110
          <td class="md" nowrap>double&nbsp;</td>
 
111
          <td class="mdname" nowrap> <em>bound</em></td>
 
112
        </tr>
 
113
        <tr>
 
114
          <td></td>
 
115
          <td class="md">)&nbsp;</td>
 
116
          <td class="md" colspan="2"> const</td>
 
117
        </tr>
 
118
 
 
119
      </table>
 
120
    </td>
 
121
  </tr>
 
122
</table>
 
123
<table cellspacing=5 cellpadding=0 border=0>
 
124
  <tr>
 
125
    <td>
 
126
      &nbsp;
 
127
    </td>
 
128
    <td>
 
129
 
 
130
<p>
 
131
Returns distance between segment and point <em>v</em>, but may just return <em>bound</em> when its larger than <em>bound</em>.     </td>
 
132
  </tr>
 
133
</table>
 
134
<a class="anchor" name="a4" doxytag="IpeSegment::Distance" ></a><p>
 
135
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
136
  <tr>
 
137
    <td class="mdRow">
 
138
      <table cellpadding="0" cellspacing="0" border="0">
 
139
        <tr>
 
140
          <td class="md" nowrap valign="top"> double IpeSegment::Distance </td>
 
141
          <td class="md" valign="top">(&nbsp;</td>
 
142
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
143
          <td class="mdname1" valign="top" nowrap> <em>v</em>          </td>
 
144
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
145
          <td class="md" nowrap> const</td>
 
146
        </tr>
 
147
 
 
148
      </table>
 
149
    </td>
 
150
  </tr>
 
151
</table>
 
152
<table cellspacing=5 cellpadding=0 border=0>
 
153
  <tr>
 
154
    <td>
 
155
      &nbsp;
 
156
    </td>
 
157
    <td>
 
158
 
 
159
<p>
 
160
Returns distance between segment and point <em>v</em>     </td>
 
161
  </tr>
 
162
</table>
 
163
<a class="anchor" name="a5" doxytag="IpeSegment::Project" ></a><p>
 
164
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
165
  <tr>
 
166
    <td class="mdRow">
 
167
      <table cellpadding="0" cellspacing="0" border="0">
 
168
        <tr>
 
169
          <td class="md" nowrap valign="top"> bool IpeSegment::Project </td>
 
170
          <td class="md" valign="top">(&nbsp;</td>
 
171
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
172
          <td class="mdname" nowrap> <em>v</em>, </td>
 
173
        </tr>
 
174
        <tr>
 
175
          <td></td>
 
176
          <td></td>
 
177
          <td class="md" nowrap><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
178
          <td class="mdname" nowrap> <em>projection</em></td>
 
179
        </tr>
 
180
        <tr>
 
181
          <td></td>
 
182
          <td class="md">)&nbsp;</td>
 
183
          <td class="md" colspan="2"> const</td>
 
184
        </tr>
 
185
 
 
186
      </table>
 
187
    </td>
 
188
  </tr>
 
189
</table>
 
190
<table cellspacing=5 cellpadding=0 border=0>
 
191
  <tr>
 
192
    <td>
 
193
      &nbsp;
 
194
    </td>
 
195
    <td>
 
196
 
 
197
<p>
 
198
Project point <em>v</em> orthogonally on segment. Returns false if the point falls outside the segment.     </td>
 
199
  </tr>
 
200
</table>
 
201
<a class="anchor" name="a6" doxytag="IpeSegment::Intersects" ></a><p>
 
202
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
203
  <tr>
 
204
    <td class="mdRow">
 
205
      <table cellpadding="0" cellspacing="0" border="0">
 
206
        <tr>
 
207
          <td class="md" nowrap valign="top"> bool IpeSegment::Intersects </td>
 
208
          <td class="md" valign="top">(&nbsp;</td>
 
209
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_segment.html">IpeSegment</a> &amp;&nbsp;</td>
 
210
          <td class="mdname" nowrap> <em>seg</em>, </td>
 
211
        </tr>
 
212
        <tr>
 
213
          <td></td>
 
214
          <td></td>
 
215
          <td class="md" nowrap><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
216
          <td class="mdname" nowrap> <em>pt</em></td>
 
217
        </tr>
 
218
        <tr>
 
219
          <td></td>
 
220
          <td class="md">)&nbsp;</td>
 
221
          <td class="md" colspan="2"> const</td>
 
222
        </tr>
 
223
 
 
224
      </table>
 
225
    </td>
 
226
  </tr>
 
227
</table>
 
228
<table cellspacing=5 cellpadding=0 border=0>
 
229
  <tr>
 
230
    <td>
 
231
      &nbsp;
 
232
    </td>
 
233
    <td>
 
234
 
 
235
<p>
 
236
Compute intersection point. Return <code>false</code> if segs don't intersect. 
 
237
<p>
 
238
    </td>
 
239
  </tr>
 
240
</table>
 
241
<a class="anchor" name="a7" doxytag="IpeSegment::Intersects" ></a><p>
 
242
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
243
  <tr>
 
244
    <td class="mdRow">
 
245
      <table cellpadding="0" cellspacing="0" border="0">
 
246
        <tr>
 
247
          <td class="md" nowrap valign="top"> bool IpeSegment::Intersects </td>
 
248
          <td class="md" valign="top">(&nbsp;</td>
 
249
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_line.html">IpeLine</a> &amp;&nbsp;</td>
 
250
          <td class="mdname" nowrap> <em>l</em>, </td>
 
251
        </tr>
 
252
        <tr>
 
253
          <td></td>
 
254
          <td></td>
 
255
          <td class="md" nowrap><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
256
          <td class="mdname" nowrap> <em>pt</em></td>
 
257
        </tr>
 
258
        <tr>
 
259
          <td></td>
 
260
          <td class="md">)&nbsp;</td>
 
261
          <td class="md" colspan="2"> const</td>
 
262
        </tr>
 
263
 
 
264
      </table>
 
265
    </td>
 
266
  </tr>
 
267
</table>
 
268
<table cellspacing=5 cellpadding=0 border=0>
 
269
  <tr>
 
270
    <td>
 
271
      &nbsp;
 
272
    </td>
 
273
    <td>
 
274
 
 
275
<p>
 
276
Compute intersection point. Return <code>false</code> if no intersection. 
 
277
<p>
 
278
    </td>
 
279
  </tr>
 
280
</table>
 
281
<hr><h2>Member Data Documentation</h2>
 
282
<a class="anchor" name="o0" doxytag="IpeSegment::iP" ></a><p>
 
283
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
284
  <tr>
 
285
    <td class="mdRow">
 
286
      <table cellpadding="0" cellspacing="0" border="0">
 
287
        <tr>
 
288
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#o0">IpeSegment::iP</a>
 
289
      </table>
 
290
    </td>
 
291
  </tr>
 
292
</table>
 
293
<table cellspacing=5 cellpadding=0 border=0>
 
294
  <tr>
 
295
    <td>
 
296
      &nbsp;
 
297
    </td>
 
298
    <td>
 
299
 
 
300
<p>
 
301
First endpoint. 
 
302
<p>
 
303
    </td>
 
304
  </tr>
 
305
</table>
 
306
<a class="anchor" name="o1" doxytag="IpeSegment::iQ" ></a><p>
 
307
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
308
  <tr>
 
309
    <td class="mdRow">
 
310
      <table cellpadding="0" cellspacing="0" border="0">
 
311
        <tr>
 
312
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#o1">IpeSegment::iQ</a>
 
313
      </table>
 
314
    </td>
 
315
  </tr>
 
316
</table>
 
317
<table cellspacing=5 cellpadding=0 border=0>
 
318
  <tr>
 
319
    <td>
 
320
      &nbsp;
 
321
    </td>
 
322
    <td>
 
323
 
 
324
<p>
 
325
Second endpoint. 
 
326
<p>
 
327
    </td>
 
328
  </tr>
 
329
</table>
 
330
<hr>The documentation for this class was generated from the following files:<ul>
 
331
<li>ipegeo.h<li>ipegeo.cpp</ul>
 
332
<hr>
 
333
</body></html>