← 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: 2009-12-11 21:22:35 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20091211212235-5iio4nzpra64snab
Tags: 7.0.10-1
http://bugs.debian.org/551192
* New upstream.  Closes: #551192.
  - New build-depends: libcairo2-dev, liblua5.1-0-dev, gsfonts
  - patches/config.diff: Remove.  Upstream build system replaced.
  - Runtime lib package changed to libipe7.0.10 from libipe1c2a
  - Devel package renamed to libipe-dev (from libipe1-dev)
  - Package ipe depends on lua5.1 due to ipe-update-master.

* rules: Re-write to use dh.

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
 
<link href="tabs.css" rel="stylesheet" type="text/css">
6
 
</head><body>
7
 
<!-- Generated by Doxygen 1.5.1 -->
8
 
<div class="tabs">
9
 
  <ul>
10
 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
 
    <li><a href="modules.html"><span>Modules</span></a></li>
12
 
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13
 
  </ul></div>
14
 
<div class="tabs">
15
 
  <ul>
16
 
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
17
 
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18
 
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19
 
  </ul></div>
20
 
<h1>IpeSegment Class Reference<br>
21
 
<small>
22
 
[<a class="el" href="group__geo.html">Ipe Geometry</a>]</small>
23
 
</h1><!-- doxytag: class="IpeSegment" -->A directed line segment.  
24
 
<a href="#_details">More...</a>
25
 
<p>
26
 
<a href="class_ipe_segment-members.html">List of all members.</a><h2>Public Member Functions</h2>
27
 
<ul>
28
 
<li><a class="el" href="class_ipe_segment.html#b6c757c5da52969eaafc1dbce41a7d40">IpeSegment</a> ()
29
 
<li><a class="anchor" name="40a27e701ebf392ecd16ac0c731fc7bb"></a><!-- doxytag: member="IpeSegment::IpeSegment" ref="40a27e701ebf392ecd16ac0c731fc7bb" args="(const IpeVector &amp;p, const IpeVector &amp;q)" -->
30
 
<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)
31
 
<li><a class="el" href="class_ipe_line.html">IpeLine</a> <a class="el" href="class_ipe_segment.html#02989bdab253fcf7d649c240d2b57084">Line</a> () const
32
 
<li>double <a class="el" href="class_ipe_segment.html#6997785b07c9f57eafe69e28cd918b2b">Distance</a> (const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v, double bound) const
33
 
<li>double <a class="el" href="class_ipe_segment.html#70720cb0c7dd5b7bce0f62de66fe5662">Distance</a> (const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;v) const
34
 
<li>bool <a class="el" href="class_ipe_segment.html#acf0bd5bafecfc07ebc89cc7811bde5b">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
35
 
<li>bool <a class="el" href="class_ipe_segment.html#907fea9c22f5f377388354793c169df9">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
36
 
<li>bool <a class="el" href="class_ipe_segment.html#f181ff19847d81121142e73d53f46003">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
37
 
<li>bool <a class="el" href="class_ipe_segment.html#e70393c41d3f17b5d5ac0233468f5e40">snap</a> (const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;mouse, <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;pos, double &amp;bound) const
38
 
</ul>
39
 
<h2>Public Attributes</h2>
40
 
<ul>
41
 
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#fad5a767e97f481fa5cc036efead0253">iP</a>
42
 
<li><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#0804957831761262d7a6d16f95624966">iQ</a>
43
 
</ul>
44
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
45
 
A directed line segment. 
46
 
<p>
47
 
<hr><h2>Constructor &amp; Destructor Documentation</h2>
48
 
<a class="anchor" name="b6c757c5da52969eaafc1dbce41a7d40"></a><!-- doxytag: member="IpeSegment::IpeSegment" ref="b6c757c5da52969eaafc1dbce41a7d40" args="()" -->
49
 
<div class="memitem">
50
 
<div class="memproto">
51
 
      <table class="memname">
52
 
        <tr>
53
 
          <td class="memname">IpeSegment::IpeSegment           </td>
54
 
          <td>(</td>
55
 
          <td class="paramname">          </td>
56
 
          <td>&nbsp;)&nbsp;</td>
57
 
          <td width="100%"><code> [inline]</code></td>
58
 
        </tr>
59
 
      </table>
60
 
</div>
61
 
<div class="memdoc">
62
 
 
63
 
<p>
64
 
Create uninitialized segment. 
65
 
<p>
66
 
 
67
 
</div>
68
 
</div><p>
69
 
<hr><h2>Member Function Documentation</h2>
70
 
<a class="anchor" name="02989bdab253fcf7d649c240d2b57084"></a><!-- doxytag: member="IpeSegment::Line" ref="02989bdab253fcf7d649c240d2b57084" args="() const" -->
71
 
<div class="memitem">
72
 
<div class="memproto">
73
 
      <table class="memname">
74
 
        <tr>
75
 
          <td class="memname"><a class="el" href="class_ipe_line.html">IpeLine</a> IpeSegment::Line           </td>
76
 
          <td>(</td>
77
 
          <td class="paramname">          </td>
78
 
          <td>&nbsp;)&nbsp;</td>
79
 
          <td width="100%"> const<code> [inline]</code></td>
80
 
        </tr>
81
 
      </table>
82
 
</div>
83
 
<div class="memdoc">
84
 
 
85
 
<p>
86
 
Return directed line supporting the segment. 
87
 
<p>
88
 
 
89
 
</div>
90
 
</div><p>
91
 
<a class="anchor" name="6997785b07c9f57eafe69e28cd918b2b"></a><!-- doxytag: member="IpeSegment::Distance" ref="6997785b07c9f57eafe69e28cd918b2b" args="(const IpeVector &amp;v, double bound) const" -->
92
 
<div class="memitem">
93
 
<div class="memproto">
94
 
      <table class="memname">
95
 
        <tr>
96
 
          <td class="memname">double IpeSegment::Distance           </td>
97
 
          <td>(</td>
98
 
          <td class="paramtype">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
99
 
          <td class="paramname"> <em>v</em>, </td>
100
 
        </tr>
101
 
        <tr>
102
 
          <td class="paramkey"></td>
103
 
          <td></td>
104
 
          <td class="paramtype">double&nbsp;</td>
105
 
          <td class="paramname"> <em>bound</em></td><td>&nbsp;</td>
106
 
        </tr>
107
 
        <tr>
108
 
          <td></td>
109
 
          <td>)</td>
110
 
          <td></td><td></td><td width="100%"> const</td>
111
 
        </tr>
112
 
      </table>
113
 
</div>
114
 
<div class="memdoc">
115
 
 
116
 
<p>
117
 
Returns distance between segment and point <em>v</em>, but may just return <em>bound</em> when its larger than <em>bound</em>. 
118
 
</div>
119
 
</div><p>
120
 
<a class="anchor" name="70720cb0c7dd5b7bce0f62de66fe5662"></a><!-- doxytag: member="IpeSegment::Distance" ref="70720cb0c7dd5b7bce0f62de66fe5662" args="(const IpeVector &amp;v) const" -->
121
 
<div class="memitem">
122
 
<div class="memproto">
123
 
      <table class="memname">
124
 
        <tr>
125
 
          <td class="memname">double IpeSegment::Distance           </td>
126
 
          <td>(</td>
127
 
          <td class="paramtype">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
128
 
          <td class="paramname"> <em>v</em>          </td>
129
 
          <td>&nbsp;)&nbsp;</td>
130
 
          <td width="100%"> const</td>
131
 
        </tr>
132
 
      </table>
133
 
</div>
134
 
<div class="memdoc">
135
 
 
136
 
<p>
137
 
Returns distance between segment and point <em>v</em> 
138
 
</div>
139
 
</div><p>
140
 
<a class="anchor" name="acf0bd5bafecfc07ebc89cc7811bde5b"></a><!-- doxytag: member="IpeSegment::Project" ref="acf0bd5bafecfc07ebc89cc7811bde5b" args="(const IpeVector &amp;v, IpeVector &amp;projection) const" -->
141
 
<div class="memitem">
142
 
<div class="memproto">
143
 
      <table class="memname">
144
 
        <tr>
145
 
          <td class="memname">bool IpeSegment::Project           </td>
146
 
          <td>(</td>
147
 
          <td class="paramtype">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
148
 
          <td class="paramname"> <em>v</em>, </td>
149
 
        </tr>
150
 
        <tr>
151
 
          <td class="paramkey"></td>
152
 
          <td></td>
153
 
          <td class="paramtype"><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
154
 
          <td class="paramname"> <em>projection</em></td><td>&nbsp;</td>
155
 
        </tr>
156
 
        <tr>
157
 
          <td></td>
158
 
          <td>)</td>
159
 
          <td></td><td></td><td width="100%"> const</td>
160
 
        </tr>
161
 
      </table>
162
 
</div>
163
 
<div class="memdoc">
164
 
 
165
 
<p>
166
 
Project point <em>v</em> orthogonally on segment. Returns false if the point falls outside the segment. 
167
 
</div>
168
 
</div><p>
169
 
<a class="anchor" name="907fea9c22f5f377388354793c169df9"></a><!-- doxytag: member="IpeSegment::Intersects" ref="907fea9c22f5f377388354793c169df9" args="(const IpeSegment &amp;seg, IpeVector &amp;pt) const" -->
170
 
<div class="memitem">
171
 
<div class="memproto">
172
 
      <table class="memname">
173
 
        <tr>
174
 
          <td class="memname">bool IpeSegment::Intersects           </td>
175
 
          <td>(</td>
176
 
          <td class="paramtype">const <a class="el" href="class_ipe_segment.html">IpeSegment</a> &amp;&nbsp;</td>
177
 
          <td class="paramname"> <em>seg</em>, </td>
178
 
        </tr>
179
 
        <tr>
180
 
          <td class="paramkey"></td>
181
 
          <td></td>
182
 
          <td class="paramtype"><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
183
 
          <td class="paramname"> <em>pt</em></td><td>&nbsp;</td>
184
 
        </tr>
185
 
        <tr>
186
 
          <td></td>
187
 
          <td>)</td>
188
 
          <td></td><td></td><td width="100%"> const</td>
189
 
        </tr>
190
 
      </table>
191
 
</div>
192
 
<div class="memdoc">
193
 
 
194
 
<p>
195
 
Compute intersection point. Return <code>false</code> if segs don't intersect. 
196
 
<p>
197
 
 
198
 
</div>
199
 
</div><p>
200
 
<a class="anchor" name="f181ff19847d81121142e73d53f46003"></a><!-- doxytag: member="IpeSegment::Intersects" ref="f181ff19847d81121142e73d53f46003" args="(const IpeLine &amp;l, IpeVector &amp;pt) const" -->
201
 
<div class="memitem">
202
 
<div class="memproto">
203
 
      <table class="memname">
204
 
        <tr>
205
 
          <td class="memname">bool IpeSegment::Intersects           </td>
206
 
          <td>(</td>
207
 
          <td class="paramtype">const <a class="el" href="class_ipe_line.html">IpeLine</a> &amp;&nbsp;</td>
208
 
          <td class="paramname"> <em>l</em>, </td>
209
 
        </tr>
210
 
        <tr>
211
 
          <td class="paramkey"></td>
212
 
          <td></td>
213
 
          <td class="paramtype"><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
214
 
          <td class="paramname"> <em>pt</em></td><td>&nbsp;</td>
215
 
        </tr>
216
 
        <tr>
217
 
          <td></td>
218
 
          <td>)</td>
219
 
          <td></td><td></td><td width="100%"> const</td>
220
 
        </tr>
221
 
      </table>
222
 
</div>
223
 
<div class="memdoc">
224
 
 
225
 
<p>
226
 
Compute intersection point. Return <code>false</code> if no intersection. 
227
 
<p>
228
 
 
229
 
</div>
230
 
</div><p>
231
 
<a class="anchor" name="e70393c41d3f17b5d5ac0233468f5e40"></a><!-- doxytag: member="IpeSegment::snap" ref="e70393c41d3f17b5d5ac0233468f5e40" args="(const IpeVector &amp;mouse, IpeVector &amp;pos, double &amp;bound) const" -->
232
 
<div class="memitem">
233
 
<div class="memproto">
234
 
      <table class="memname">
235
 
        <tr>
236
 
          <td class="memname">bool IpeSegment::snap           </td>
237
 
          <td>(</td>
238
 
          <td class="paramtype">const <a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
239
 
          <td class="paramname"> <em>mouse</em>, </td>
240
 
        </tr>
241
 
        <tr>
242
 
          <td class="paramkey"></td>
243
 
          <td></td>
244
 
          <td class="paramtype"><a class="el" href="class_ipe_vector.html">IpeVector</a> &amp;&nbsp;</td>
245
 
          <td class="paramname"> <em>pos</em>, </td>
246
 
        </tr>
247
 
        <tr>
248
 
          <td class="paramkey"></td>
249
 
          <td></td>
250
 
          <td class="paramtype">double &amp;&nbsp;</td>
251
 
          <td class="paramname"> <em>bound</em></td><td>&nbsp;</td>
252
 
        </tr>
253
 
        <tr>
254
 
          <td></td>
255
 
          <td>)</td>
256
 
          <td></td><td></td><td width="100%"> const</td>
257
 
        </tr>
258
 
      </table>
259
 
</div>
260
 
<div class="memdoc">
261
 
 
262
 
<p>
263
 
Snap mouse position to this segment. 
264
 
<p>
265
 
If distance between <em>mouse</em> and the segment is less than <em>bound</em>, then set <em>pos</em> to the point on the segment, <em>bound</em> to the distance, and return true. 
266
 
</div>
267
 
</div><p>
268
 
<hr><h2>Member Data Documentation</h2>
269
 
<a class="anchor" name="fad5a767e97f481fa5cc036efead0253"></a><!-- doxytag: member="IpeSegment::iP" ref="fad5a767e97f481fa5cc036efead0253" args="" -->
270
 
<div class="memitem">
271
 
<div class="memproto">
272
 
      <table class="memname">
273
 
        <tr>
274
 
          <td class="memname"><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#fad5a767e97f481fa5cc036efead0253">IpeSegment::iP</a>          </td>
275
 
        </tr>
276
 
      </table>
277
 
</div>
278
 
<div class="memdoc">
279
 
 
280
 
<p>
281
 
First endpoint. 
282
 
<p>
283
 
 
284
 
</div>
285
 
</div><p>
286
 
<a class="anchor" name="0804957831761262d7a6d16f95624966"></a><!-- doxytag: member="IpeSegment::iQ" ref="0804957831761262d7a6d16f95624966" args="" -->
287
 
<div class="memitem">
288
 
<div class="memproto">
289
 
      <table class="memname">
290
 
        <tr>
291
 
          <td class="memname"><a class="el" href="class_ipe_vector.html">IpeVector</a> <a class="el" href="class_ipe_segment.html#0804957831761262d7a6d16f95624966">IpeSegment::iQ</a>          </td>
292
 
        </tr>
293
 
      </table>
294
 
</div>
295
 
<div class="memdoc">
296
 
 
297
 
<p>
298
 
Second endpoint. 
299
 
<p>
300
 
 
301
 
</div>
302
 
</div><p>
303
 
<hr>The documentation for this class was generated from the following files:<ul>
304
 
<li>ipegeo.h<li>ipegeo.cpp</ul>
305
 
<hr>
306
 
</body></html>