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

« back to all changes in this revision

Viewing changes to doc/class_ipe_line.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:
 
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: IpeLine 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>IpeLine Class Reference<br>
 
9
<small>
 
10
[<a class="el" href="group__geo.html">Ipe Geometry</a>]</small>
 
11
</h1>A directed line.  
 
12
<a href="#_details">More...</a>
 
13
<p>
 
14
<a href="class_ipe_line-members.html">List of all members.</a><h2>Public Member Functions</h2>
 
15
<ul>
 
16
<li><a class="el" href="class_ipe_line.html#a0">IpeLine</a> ()
 
17
<li><a class="el" href="class_ipe_line.html#a1">IpeLine</a> (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;dir)
 
18
<li>double <a class="el" href="class_ipe_line.html#a2">Side</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;p) const 
 
19
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_line.html#a3">Normal</a> () const 
 
20
<li>double <a class="el" href="class_ipe_line.html#a4">Distance</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v) const 
 
21
<li>bool <a class="el" href="class_ipe_line.html#a5">Intersects</a> (const  <a class="el" href="class_ipe_line.html">IpeLine</a> &amp;line, <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;pt)
 
22
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_line.html#a6">Project</a> (const  <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v) const 
 
23
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_line.html#a7">Dir</a> () const 
 
24
</ul>
 
25
<h2>Static Public Member Functions</h2>
 
26
<ul>
 
27
<li><a class="el" href="class_ipe_line.html">IpeLine</a> <a class="el" href="class_ipe_line.html#e0">Through</a> (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)
 
28
</ul>
 
29
<h2>Public Attributes</h2>
 
30
<ul>
 
31
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_line.html#o0">iP</a>
 
32
</ul>
 
33
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
34
A directed line. 
 
35
<p>
 
36
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
37
<a class="anchor" name="a0" doxytag="IpeLine::IpeLine" ></a><p>
 
38
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
39
  <tr>
 
40
    <td class="mdRow">
 
41
      <table cellpadding="0" cellspacing="0" border="0">
 
42
        <tr>
 
43
          <td class="md" nowrap valign="top"> IpeLine::IpeLine </td>
 
44
          <td class="md" valign="top">(&nbsp;</td>
 
45
          <td class="mdname1" valign="top" nowrap>          </td>
 
46
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
47
          <td class="md" nowrap><code> [inline, explicit]</code></td>
 
48
        </tr>
 
49
 
 
50
      </table>
 
51
    </td>
 
52
  </tr>
 
53
</table>
 
54
<table cellspacing=5 cellpadding=0 border=0>
 
55
  <tr>
 
56
    <td>
 
57
      &nbsp;
 
58
    </td>
 
59
    <td>
 
60
 
 
61
<p>
 
62
Create default line (x-axis). 
 
63
<p>
 
64
    </td>
 
65
  </tr>
 
66
</table>
 
67
<a class="anchor" name="a1" doxytag="IpeLine::IpeLine" ></a><p>
 
68
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
69
  <tr>
 
70
    <td class="mdRow">
 
71
      <table cellpadding="0" cellspacing="0" border="0">
 
72
        <tr>
 
73
          <td class="md" nowrap valign="top"> IpeLine::IpeLine </td>
 
74
          <td class="md" valign="top">(&nbsp;</td>
 
75
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
76
          <td class="mdname" nowrap> <em>p</em>, </td>
 
77
        </tr>
 
78
        <tr>
 
79
          <td></td>
 
80
          <td></td>
 
81
          <td class="md" nowrap>const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
82
          <td class="mdname" nowrap> <em>dir</em></td>
 
83
        </tr>
 
84
        <tr>
 
85
          <td></td>
 
86
          <td class="md">)&nbsp;</td>
 
87
          <td class="md" colspan="2"><code> [explicit]</code></td>
 
88
        </tr>
 
89
 
 
90
      </table>
 
91
    </td>
 
92
  </tr>
 
93
</table>
 
94
<table cellspacing=5 cellpadding=0 border=0>
 
95
  <tr>
 
96
    <td>
 
97
      &nbsp;
 
98
    </td>
 
99
    <td>
 
100
 
 
101
<p>
 
102
Construct a line from <em>p</em> with direction <em>dir</em>. 
 
103
<p>
 
104
Asserts unit length of <em>dir</em>.     </td>
 
105
  </tr>
 
106
</table>
 
107
<hr><h2>Member Function Documentation</h2>
 
108
<a class="anchor" name="e0" doxytag="IpeLine::Through" ></a><p>
 
109
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
110
  <tr>
 
111
    <td class="mdRow">
 
112
      <table cellpadding="0" cellspacing="0" border="0">
 
113
        <tr>
 
114
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_line.html">IpeLine</a> IpeLine::Through </td>
 
115
          <td class="md" valign="top">(&nbsp;</td>
 
116
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
117
          <td class="mdname" nowrap> <em>p</em>, </td>
 
118
        </tr>
 
119
        <tr>
 
120
          <td></td>
 
121
          <td></td>
 
122
          <td class="md" nowrap>const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
123
          <td class="mdname" nowrap> <em>q</em></td>
 
124
        </tr>
 
125
        <tr>
 
126
          <td></td>
 
127
          <td class="md">)&nbsp;</td>
 
128
          <td class="md" colspan="2"><code> [static]</code></td>
 
129
        </tr>
 
130
 
 
131
      </table>
 
132
    </td>
 
133
  </tr>
 
134
</table>
 
135
<table cellspacing=5 cellpadding=0 border=0>
 
136
  <tr>
 
137
    <td>
 
138
      &nbsp;
 
139
    </td>
 
140
    <td>
 
141
 
 
142
<p>
 
143
Construct a line through two points. 
 
144
<p>
 
145
    </td>
 
146
  </tr>
 
147
</table>
 
148
<a class="anchor" name="a2" doxytag="IpeLine::Side" ></a><p>
 
149
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
150
  <tr>
 
151
    <td class="mdRow">
 
152
      <table cellpadding="0" cellspacing="0" border="0">
 
153
        <tr>
 
154
          <td class="md" nowrap valign="top"> double IpeLine::Side </td>
 
155
          <td class="md" valign="top">(&nbsp;</td>
 
156
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
157
          <td class="mdname1" valign="top" nowrap> <em>p</em>          </td>
 
158
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
159
          <td class="md" nowrap> const</td>
 
160
        </tr>
 
161
 
 
162
      </table>
 
163
    </td>
 
164
  </tr>
 
165
</table>
 
166
<table cellspacing=5 cellpadding=0 border=0>
 
167
  <tr>
 
168
    <td>
 
169
      &nbsp;
 
170
    </td>
 
171
    <td>
 
172
 
 
173
<p>
 
174
Result is &gt; 0, = 0, &lt; 0 if point lies to the left, on, to the right. 
 
175
<p>
 
176
    </td>
 
177
  </tr>
 
178
</table>
 
179
<a class="anchor" name="a3" doxytag="IpeLine::Normal" ></a><p>
 
180
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
181
  <tr>
 
182
    <td class="mdRow">
 
183
      <table cellpadding="0" cellspacing="0" border="0">
 
184
        <tr>
 
185
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> IpeLine::Normal </td>
 
186
          <td class="md" valign="top">(&nbsp;</td>
 
187
          <td class="mdname1" valign="top" nowrap>          </td>
 
188
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
189
          <td class="md" nowrap> const<code> [inline]</code></td>
 
190
        </tr>
 
191
 
 
192
      </table>
 
193
    </td>
 
194
  </tr>
 
195
</table>
 
196
<table cellspacing=5 cellpadding=0 border=0>
 
197
  <tr>
 
198
    <td>
 
199
      &nbsp;
 
200
    </td>
 
201
    <td>
 
202
 
 
203
<p>
 
204
Return a normal vector pointing to the left of the directed line. 
 
205
<p>
 
206
    </td>
 
207
  </tr>
 
208
</table>
 
209
<a class="anchor" name="a4" doxytag="IpeLine::Distance" ></a><p>
 
210
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
211
  <tr>
 
212
    <td class="mdRow">
 
213
      <table cellpadding="0" cellspacing="0" border="0">
 
214
        <tr>
 
215
          <td class="md" nowrap valign="top"> double IpeLine::Distance </td>
 
216
          <td class="md" valign="top">(&nbsp;</td>
 
217
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
218
          <td class="mdname1" valign="top" nowrap> <em>v</em>          </td>
 
219
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
220
          <td class="md" nowrap> const</td>
 
221
        </tr>
 
222
 
 
223
      </table>
 
224
    </td>
 
225
  </tr>
 
226
</table>
 
227
<table cellspacing=5 cellpadding=0 border=0>
 
228
  <tr>
 
229
    <td>
 
230
      &nbsp;
 
231
    </td>
 
232
    <td>
 
233
 
 
234
<p>
 
235
Returns distance between line and <em>v</em>. 
 
236
<p>
 
237
    </td>
 
238
  </tr>
 
239
</table>
 
240
<a class="anchor" name="a5" doxytag="IpeLine::Intersects" ></a><p>
 
241
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
242
  <tr>
 
243
    <td class="mdRow">
 
244
      <table cellpadding="0" cellspacing="0" border="0">
 
245
        <tr>
 
246
          <td class="md" nowrap valign="top"> bool IpeLine::Intersects </td>
 
247
          <td class="md" valign="top">(&nbsp;</td>
 
248
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_line.html">IpeLine</a> &amp;&nbsp;</td>
 
249
          <td class="mdname" nowrap> <em>line</em>, </td>
 
250
        </tr>
 
251
        <tr>
 
252
          <td></td>
 
253
          <td></td>
 
254
          <td class="md" nowrap><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
255
          <td class="mdname" nowrap> <em>pt</em></td>
 
256
        </tr>
 
257
        <tr>
 
258
          <td></td>
 
259
          <td class="md">)&nbsp;</td>
 
260
          <td class="md" colspan="2"></td>
 
261
        </tr>
 
262
 
 
263
      </table>
 
264
    </td>
 
265
  </tr>
 
266
</table>
 
267
<table cellspacing=5 cellpadding=0 border=0>
 
268
  <tr>
 
269
    <td>
 
270
      &nbsp;
 
271
    </td>
 
272
    <td>
 
273
 
 
274
<p>
 
275
Does this line intersect <em>line</em>? If so, computes intersection point. 
 
276
<p>
 
277
    </td>
 
278
  </tr>
 
279
</table>
 
280
<a class="anchor" name="a6" doxytag="IpeLine::Project" ></a><p>
 
281
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
282
  <tr>
 
283
    <td class="mdRow">
 
284
      <table cellpadding="0" cellspacing="0" border="0">
 
285
        <tr>
 
286
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> IpeLine::Project </td>
 
287
          <td class="md" valign="top">(&nbsp;</td>
 
288
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
 
289
          <td class="mdname1" valign="top" nowrap> <em>v</em>          </td>
 
290
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
291
          <td class="md" nowrap> const</td>
 
292
        </tr>
 
293
 
 
294
      </table>
 
295
    </td>
 
296
  </tr>
 
297
</table>
 
298
<table cellspacing=5 cellpadding=0 border=0>
 
299
  <tr>
 
300
    <td>
 
301
      &nbsp;
 
302
    </td>
 
303
    <td>
 
304
 
 
305
<p>
 
306
Orthogonally project point <em>v</em> onto the line. 
 
307
<p>
 
308
    </td>
 
309
  </tr>
 
310
</table>
 
311
<a class="anchor" name="a7" doxytag="IpeLine::Dir" ></a><p>
 
312
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
313
  <tr>
 
314
    <td class="mdRow">
 
315
      <table cellpadding="0" cellspacing="0" border="0">
 
316
        <tr>
 
317
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> IpeLine::Dir </td>
 
318
          <td class="md" valign="top">(&nbsp;</td>
 
319
          <td class="mdname1" valign="top" nowrap>          </td>
 
320
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
321
          <td class="md" nowrap> const<code> [inline]</code></td>
 
322
        </tr>
 
323
 
 
324
      </table>
 
325
    </td>
 
326
  </tr>
 
327
</table>
 
328
<table cellspacing=5 cellpadding=0 border=0>
 
329
  <tr>
 
330
    <td>
 
331
      &nbsp;
 
332
    </td>
 
333
    <td>
 
334
 
 
335
<p>
 
336
Return direction of line. 
 
337
<p>
 
338
    </td>
 
339
  </tr>
 
340
</table>
 
341
<hr><h2>Member Data Documentation</h2>
 
342
<a class="anchor" name="o0" doxytag="IpeLine::iP" ></a><p>
 
343
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
344
  <tr>
 
345
    <td class="mdRow">
 
346
      <table cellpadding="0" cellspacing="0" border="0">
 
347
        <tr>
 
348
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_line.html#o0">IpeLine::iP</a>
 
349
      </table>
 
350
    </td>
 
351
  </tr>
 
352
</table>
 
353
<table cellspacing=5 cellpadding=0 border=0>
 
354
  <tr>
 
355
    <td>
 
356
      &nbsp;
 
357
    </td>
 
358
    <td>
 
359
 
 
360
<p>
 
361
Point on the line. 
 
362
<p>
 
363
    </td>
 
364
  </tr>
 
365
</table>
 
366
<hr>The documentation for this class was generated from the following files:<ul>
 
367
<li>ipegeo.h<li>ipegeo.cpp</ul>
 
368
<hr>
 
369
</body></html>