source: main/trunk/model-sites-dev/von-sparql/js/paper/docs/classes/global.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: 8.1 KB
Line 
1<!DOCTYPE html>
2<html>
3<head>
4<meta charset="UTF-8">
5<title>_global_</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>Global Scope</h1>
16
17
18
19</div>
20
21
22
23
24
25 <div class="reference-members"><h2>Properties</h2>
26
27
28<div id="paper" class="member">
29<div class="member-link">
30<a name="paper" href="#paper"><tt><b>paper</b></tt></a>
31</div>
32<div class="member-description hidden">
33
34<div class="member-text">
35 <p>A reference to the currently active <a href="../classes/PaperScope.html"><tt>PaperScope</tt></a> object.</p>
36
37
38 <ul><b>Type:</b>
39 <li>
40 <a href="../classes/PaperScope.html"><tt>PaperScope</tt></a>
41 </li>
42 </ul>
43
44
45</div>
46
47</div>
48</div>
49
50
51 <h3>Global PaperScope Properties (for PaperScript)</h3>
52
53<div id="project" class="member">
54<div class="member-link">
55<a name="project" href="#project"><tt><b>project</b></tt></a>
56</div>
57<div class="member-description hidden">
58
59<div class="member-text">
60 <p>The currently active project.</p>
61
62
63 <ul><b>Type:</b>
64 <li>
65 <a href="../classes/Project.html"><tt>Project</tt></a>
66 </li>
67 </ul>
68
69
70</div>
71
72</div>
73</div>
74
75
76<div id="projects" class="member">
77<div class="member-link">
78<a name="projects" href="#projects"><tt><b>projects</b></tt></a>
79</div>
80<div class="member-description hidden">
81
82<div class="member-text">
83 <p>The list of all open projects within the current Paper.js context.</p>
84
85
86 <ul><b>Type:</b>
87 <li>
88 Array of <a href="../classes/Project.html"><tt>Project</tt></a> objects
89 </li>
90 </ul>
91
92
93</div>
94
95</div>
96</div>
97
98
99<div id="view" class="member">
100<div class="member-link">
101<a name="view" href="#view"><tt><b>view</b></tt></a>
102</div>
103<div class="member-description hidden">
104
105<div class="member-text">
106 <p>The reference to the active project's view.</p>
107
108
109 <ul><b>Type:</b>
110 <li>
111 <a href="../classes/View.html"><tt>View</tt></a>
112 </li>
113 </ul>
114
115
116</div>
117
118</div>
119</div>
120
121
122<div id="tool" class="member">
123<div class="member-link">
124<a name="tool" href="#tool"><tt><b>tool</b></tt></a>
125</div>
126<div class="member-description hidden">
127
128<div class="member-text">
129 <p>The reference to the active tool.</p>
130
131
132 <ul><b>Type:</b>
133 <li>
134 <a href="../classes/Tool.html"><tt>Tool</tt></a>
135 </li>
136 </ul>
137
138
139</div>
140
141</div>
142</div>
143
144
145<div id="tools" class="member">
146<div class="member-link">
147<a name="tools" href="#tools"><tt><b>tools</b></tt></a>
148</div>
149<div class="member-description hidden">
150
151<div class="member-text">
152 <p>The list of available tools.</p>
153
154
155 <ul><b>Type:</b>
156 <li>
157 Array of <a href="../classes/Tool.html"><tt>Tool</tt></a> objects
158 </li>
159 </ul>
160
161
162</div>
163
164</div>
165</div>
166
167
168 <h3>View Event Handlers (for PaperScript)</h3>
169
170<div id="onframe" class="member">
171<div class="member-link">
172<a name="onframe" href="#onframe"><tt><b>onFrame</b></tt></a>
173</div>
174<div class="member-description hidden">
175
176<div class="member-text">
177 <p>A reference to the <a href="../classes/View.html#onframe"><tt>view.onFrame</tt></a> handler function.</p>
178
179
180 <ul><b>Type:</b>
181 <li>
182 <tt>Function</tt>
183 </li>
184 </ul>
185
186
187</div>
188
189</div>
190</div>
191
192
193<div id="onresize" class="member">
194<div class="member-link">
195<a name="onresize" href="#onresize"><tt><b>onResize</b></tt></a>
196</div>
197<div class="member-description hidden">
198
199<div class="member-text">
200 <p>A reference to the <a href="../classes/View.html#onresize"><tt>view.onResize</tt></a> handler function.</p>
201
202
203 <ul><b>Type:</b>
204 <li>
205 <tt>Function</tt>
206 </li>
207 </ul>
208
209
210</div>
211
212</div>
213</div>
214
215
216 <h3>Mouse Event Handlers (for PaperScript)</h3>
217
218<div id="onmousedown" class="member">
219<div class="member-link">
220<a name="onmousedown" href="#onmousedown"><tt><b>onMouseDown</b></tt></a>
221</div>
222<div class="member-description hidden">
223
224<div class="member-text">
225 <p>A reference to the <a href="../classes/Tool.html#onmousedown"><tt>tool.onMouseDown</tt></a> handler function.</p>
226
227
228 <ul><b>Type:</b>
229 <li>
230 <tt>Function</tt>
231 </li>
232 </ul>
233
234
235</div>
236
237</div>
238</div>
239
240
241<div id="onmousedrag" class="member">
242<div class="member-link">
243<a name="onmousedrag" href="#onmousedrag"><tt><b>onMouseDrag</b></tt></a>
244</div>
245<div class="member-description hidden">
246
247<div class="member-text">
248 <p>A reference to the <a href="../classes/Tool.html#onmousedrag"><tt>tool.onMouseDrag</tt></a> handler function.</p>
249
250
251 <ul><b>Type:</b>
252 <li>
253 <tt>Function</tt>
254 </li>
255 </ul>
256
257
258</div>
259
260</div>
261</div>
262
263
264<div id="onmousemove" class="member">
265<div class="member-link">
266<a name="onmousemove" href="#onmousemove"><tt><b>onMouseMove</b></tt></a>
267</div>
268<div class="member-description hidden">
269
270<div class="member-text">
271 <p>A reference to the <a href="../classes/Tool.html#onmousemove"><tt>tool.onMouseMove</tt></a> handler function.</p>
272
273
274 <ul><b>Type:</b>
275 <li>
276 <tt>Function</tt>
277 </li>
278 </ul>
279
280
281</div>
282
283</div>
284</div>
285
286
287<div id="onmouseup" class="member">
288<div class="member-link">
289<a name="onmouseup" href="#onmouseup"><tt><b>onMouseUp</b></tt></a>
290</div>
291<div class="member-description hidden">
292
293<div class="member-text">
294 <p>A reference to the <a href="../classes/Tool.html#onmouseup"><tt>tool.onMouseUp</tt></a> handler function.</p>
295
296
297 <ul><b>Type:</b>
298 <li>
299 <tt>Function</tt>
300 </li>
301 </ul>
302
303
304</div>
305
306</div>
307</div>
308
309
310 <h3>Keyboard Event Handlers (for PaperScript)</h3>
311
312<div id="onkeydown" class="member">
313<div class="member-link">
314<a name="onkeydown" href="#onkeydown"><tt><b>onKeyDown</b></tt></a>
315</div>
316<div class="member-description hidden">
317
318<div class="member-text">
319 <p>A reference to the <a href="../classes/Tool.html#onkeydown"><tt>tool.onKeyDown</tt></a> handler function.</p>
320
321
322 <ul><b>Type:</b>
323 <li>
324 <tt>Function</tt>
325 </li>
326 </ul>
327
328
329</div>
330
331</div>
332</div>
333
334
335<div id="onkeyup" class="member">
336<div class="member-link">
337<a name="onkeyup" href="#onkeyup"><tt><b>onKeyUp</b></tt></a>
338</div>
339<div class="member-description hidden">
340
341<div class="member-text">
342 <p>A reference to the <a href="../classes/Tool.html#onkeyup"><tt>tool.onKeyUp</tt></a> handler function.</p>
343
344
345 <ul><b>Type:</b>
346 <li>
347 <tt>Function</tt>
348 </li>
349 </ul>
350
351
352</div>
353
354</div>
355</div>
356
357
358<div id="color#clone
359
360returns a copy of the color object." class="member">
361<div class="member-link">
362<a name="color#clone
363
364returns a copy of the color object." href="#color#clone
365
366returns a copy of the color object."><tt><b>Color#clone
367
368Returns a copy of the color object.</b></tt></a>
369</div>
370<div class="member-description hidden">
371
372<div class="member-text">
373
374
375
376 <ul><b>Type:</b>
377 <li>
378 <a href="../classes/Color.html"><tt>Color</tt></a>
379 </li>
380 </ul>
381
382
383</div>
384
385</div>
386</div>
387
388 </div>
389
390
391
392<!-- ============================== methods ================================ -->
393 <div class="reference-members"><h2>Methods</h2>
394
395
396<div id="initialize" class="member">
397<div class="member-link">
398<a name="initialize" href="#initialize"><tt><b>initialize</b>([precision])</tt></a>
399</div>
400<div class="member-description hidden">
401<div class="member-text">
402
403
404<ul><b>Parameters:</b>
405
406<li>
407<tt>precision:</tt>
408<tt>Number</tt>
409&mdash;&nbsp;the amount of fractional digits.
410&mdash;&nbsp;optional, default: <tt>5</tt>
411</li>
412
413</ul>
414
415
416
417
418</div>
419</div>
420</div>
421
422
423<div id="number-num" class="member">
424<div class="member-link">
425<a name="number-num" href="#number-num"><tt><b>number</b>(num)</tt></a>
426</div>
427<div class="member-description hidden">
428<div class="member-text">
429 <p>Utility function for rendering numbers as strings at a precision of
430up to the amount of fractional digits.</p>
431
432<ul><b>Parameters:</b>
433
434<li>
435<tt>num:</tt>
436<tt>Number</tt>
437&mdash;&nbsp;the number to be converted to a string
438
439</li>
440
441</ul>
442
443
444
445
446</div>
447</div>
448</div>
449
450 </div>
451
452
453
454
455<!-- =========================== copyright notice ========================= -->
456<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>
457<div class="content-end"></div>
458
459</body>
Note: See TracBrowser for help on using the repository browser.