source: main/trunk/model-sites-dev/von-sparql/js/paper/docs/classes/Line.html@ 28914

Last change on this file since 28914 was 28914, checked in by ak19, 10 years ago

Supporting javascript libraries and bespoke code written by Steffan to support the von-sparql user interface
File size: 4.4 KB
Line 
1<!DOCTYPE html>
2<html>
3<head>
4<meta charset="UTF-8">
5<title>Line</title>
6<base target="class-frame">
7<link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
8<script src="../assets/js/paper.js"></script>
9<script src="../assets/js/jquery.js"></script>
10<script src="../assets/js/codemirror.js"></script>
11<script src="../assets/js/docs.js"></script>
12</head>
13<body class="reference">
14<div class="reference-class">
15<h1>Line</h1>
16
17<p>The Line object represents..</p>
18
19</div>
20
21<!-- ============================== constructors ========================= -->
22<div class="reference-members"><h2>Constructors</h2>
23
24
25<div id="line-point1-point2-arg3-arg4" class="member">
26<div class="member-link">
27<a name="line-point1-point2-arg3-arg4" href="#line-point1-point2-arg3-arg4"><tt><b>Line</b>(point1, point2[, asVector, arg3, arg4])</tt></a>
28</div>
29<div class="member-description hidden">
30<div class="member-text">
31<p>Creates a Line object.</p>
32
33<ul><b>Parameters:</b>
34
35<li>
36<tt>point1:</tt>
37<a href="../classes/Point.html"><tt>Point</tt></a>
38
39
40</li>
41
42<li>
43<tt>point2:</tt>
44<a href="../classes/Point.html"><tt>Point</tt></a>
45
46
47</li>
48
49<li>
50<tt>asVector:</tt>
51<tt>Boolean</tt>
52
53&mdash;&nbsp;optional, default: <tt>false</tt>
54</li>
55
56<li>
57<tt>arg3:</tt>
58
59
60
61</li>
62
63<li>
64<tt>arg4:</tt>
65
66
67
68</li>
69
70</ul>
71
72
73
74
75</div>
76</div>
77</div>
78
79</div>
80
81
82
83
84
85 <div class="reference-members"><h2>Properties</h2>
86
87
88<div id="point" class="member">
89<div class="member-link">
90<a name="point" href="#point"><tt><b>point</b></tt></a>
91</div>
92<div class="member-description hidden">
93
94<div class="member-text">
95 <p>The starting point of the line</p>
96
97
98 <ul><b>Type:</b>
99 <li>
100 <a href="../classes/Point.html"><tt>Point</tt></a>
101 </li>
102 </ul>
103
104
105</div>
106
107</div>
108</div>
109
110
111<div id="vector" class="member">
112<div class="member-link">
113<a name="vector" href="#vector"><tt><b>vector</b></tt></a>
114</div>
115<div class="member-description hidden">
116
117<div class="member-text">
118 <p>The vector of the line</p>
119
120
121 <ul><b>Type:</b>
122 <li>
123 <a href="../classes/Point.html"><tt>Point</tt></a>
124 </li>
125 </ul>
126
127
128</div>
129
130</div>
131</div>
132
133
134<div id="length" class="member">
135<div class="member-link">
136<a name="length" href="#length"><tt><b>length</b></tt></a>
137</div>
138<div class="member-description hidden">
139
140<div class="member-text">
141 <p>The length of the line</p>
142
143
144 <ul><b>Type:</b>
145 <li>
146 <tt>Number</tt>
147 </li>
148 </ul>
149
150
151</div>
152
153</div>
154</div>
155
156 </div>
157
158
159
160<!-- ============================== methods ================================ -->
161 <div class="reference-members"><h2>Methods</h2>
162
163
164<div id="intersect-line" class="member">
165<div class="member-link">
166<a name="intersect-line" href="#intersect-line"><tt><b>intersect</b>(line[, isInfinite])</tt></a>
167</div>
168<div class="member-description hidden">
169<div class="member-text">
170
171
172<ul><b>Parameters:</b>
173
174<li>
175<tt>line:</tt>
176<a href="../classes/Line.html"><tt>Line</tt></a>
177
178
179</li>
180
181<li>
182<tt>isInfinite:</tt>
183<tt>Boolean</tt>
184
185&mdash;&nbsp;optional, default: <tt>false</tt>
186</li>
187
188</ul>
189
190
191 <ul><b>Returns:</b>
192
193 <li>
194<tt><a href="../classes/Point.html"><tt>Point</tt></a></tt>&nbsp;&mdash;&nbsp;the intersection point of the lines, <tt>undefined</tt>
195if the two lines are colinear, or <tt>null</tt> if they don't intersect.
196</li>
197
198 </ul>
199
200
201
202</div>
203</div>
204</div>
205
206
207<div id="getside-point" class="member">
208<div class="member-link">
209<a name="getside-point" href="#getside-point"><tt><b>getSide</b>(point)</tt></a>
210</div>
211<div class="member-description hidden">
212<div class="member-text">
213
214
215<ul><b>Parameters:</b>
216
217<li>
218<tt>point:</tt>
219<a href="../classes/Point.html"><tt>Point</tt></a>
220
221
222</li>
223
224</ul>
225
226
227 <ul><b>Returns:</b>
228
229 <li>
230<tt><tt>Number</tt></tt>
231</li>
232
233 </ul>
234
235
236
237</div>
238</div>
239</div>
240
241
242<div id="getdistance-point" class="member">
243<div class="member-link">
244<a name="getdistance-point" href="#getdistance-point"><tt><b>getDistance</b>(point)</tt></a>
245</div>
246<div class="member-description hidden">
247<div class="member-text">
248
249
250<ul><b>Parameters:</b>
251
252<li>
253<tt>point:</tt>
254<a href="../classes/Point.html"><tt>Point</tt></a>
255
256
257</li>
258
259</ul>
260
261
262 <ul><b>Returns:</b>
263
264 <li>
265<tt><tt>Number</tt></tt>
266</li>
267
268 </ul>
269
270
271
272</div>
273</div>
274</div>
275
276 </div>
277
278
279
280
281<!-- =========================== copyright notice ========================= -->
282<p class="footer">Copyright &#169; 2011 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
283<div class="content-end"></div>
284
285</body>
Note: See TracBrowser for help on using the repository browser.