LG.wb.Class.Item.html 22 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Item</title>
  6. <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
  7. <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
  8. <link type="text/css" rel="stylesheet" href="styles/node-dark.css">
  9. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  10. </head>
  11. <body>
  12. <div id="main">
  13. <h1 class="page-title">Class: Item</h1>
  14. <section>
  15. <header>
  16. <h2><span class="ancestors"><a href="LG.html">LG</a> &gt; <a href="LG.wb.html">wb</a> &gt; <a href="LG.wb.Class.html">Class</a> &gt; </span>Item</h2>
  17. <p class="class-description">LG.wb.Class.Item An Item Object containing the data and its representation of a Wikipedia page</p>
  18. </header>
  19. <article>
  20. <dt id="LG.wb.Class.Item">
  21. <h4 class="name" id="Item"><span class="type-signature"></span>new Item(brw, wpage)<span class="type-signature"></span></h4>
  22. </dt>
  23. <dd>
  24. <dl class="details">
  25. <dt>Source:</dt>
  26. <dd>../export/js/wb_item.js, line 13</dd>
  27. </dl>
  28. <h5>Parameters:</h5>
  29. <table class="params">
  30. <thead>
  31. <tr>
  32. <th>Name</th>
  33. <th>Type</th>
  34. <th class="last">Description</th>
  35. </tr>
  36. </thead>
  37. <tbody>
  38. <tr>
  39. <td class="name"><code>brw</code></td>
  40. <td class="type">
  41. Object
  42. </td>
  43. <td class="description last"></td>
  44. </tr>
  45. <tr>
  46. <td class="name"><code>wpage</code></td>
  47. <td class="type">
  48. String
  49. </td>
  50. <td class="description last"></td>
  51. </tr>
  52. </tbody>
  53. </table>
  54. </dd>
  55. <h3 class="subsection-title">Properties</h3>
  56. <dl>
  57. <dt id="property:LG.wb.Class.Item#alc">
  58. <h4 class="name"><span class="type-signature"></span>alc<span class="type-signature"></span></h4>
  59. </dt>
  60. <dd>
  61. <p class="description">
  62. an array for Alchemy API results
  63. </p>
  64. <dl class="details">
  65. <dt>Source:</dt>
  66. <dd>../export/js/wb_item.js, line 13</dd>
  67. </dl>
  68. </dd>
  69. <dt id="property:LG.wb.Class.Item#alurl">
  70. <h4 class="name"><span class="type-signature"></span>alurl<span class="type-signature"></span></h4>
  71. </dt>
  72. <dd>
  73. <p class="description">
  74. The current Alchemy api url
  75. </p>
  76. <dl class="details">
  77. <dt>Source:</dt>
  78. <dd>../export/js/wb_item.js, line 52</dd>
  79. </dl>
  80. </dd>
  81. <dt id="property:LG.wb.Class.Item#categories">
  82. <h4 class="name"><span class="type-signature"></span>categories<span class="type-signature"></span></h4>
  83. </dt>
  84. <dd>
  85. <p class="description">
  86. an array for Wikipedia Categories
  87. </p>
  88. <dl class="details">
  89. <dt>Source:</dt>
  90. <dd>../export/js/wb_item.js, line 13</dd>
  91. </dl>
  92. </dd>
  93. <dt id="property:LG.wb.Class.Item#click_items">
  94. <h4 class="name"><span class="type-signature"></span>click_items<span class="type-signature"></span></h4>
  95. </dt>
  96. <dd>
  97. <p class="description">
  98. an array for clickable 3D objects
  99. </p>
  100. <dl class="details">
  101. <dt>Source:</dt>
  102. <dd>../export/js/wb_item.js, line 13</dd>
  103. </dl>
  104. </dd>
  105. <dt id="property:LG.wb.Class.Item#deftbUrl">
  106. <h4 class="name"><span class="type-signature"></span>deftbUrl<span class="type-signature"></span></h4>
  107. </dt>
  108. <dd>
  109. <p class="description">
  110. Default Thumbnail URL
  111. </p>
  112. <dl class="details">
  113. <dt>Source:</dt>
  114. <dd>../export/js/wb_item.js, line 13</dd>
  115. </dl>
  116. </dd>
  117. <dt id="property:LG.wb.Class.Item#dest">
  118. <h4 class="name"><span class="type-signature"></span>dest<span class="type-signature"></span></h4>
  119. </dt>
  120. <dd>
  121. <p class="description">
  122. The current destination of the item
  123. </p>
  124. <dl class="details">
  125. <dt>Source:</dt>
  126. <dd>../export/js/wb_item.js, line 46</dd>
  127. </dl>
  128. </dd>
  129. <dt id="property:LG.wb.Class.Item#drift">
  130. <h4 class="name"><span class="type-signature"></span>drift<span class="type-signature"></span></h4>
  131. </dt>
  132. <dd>
  133. <p class="description">
  134. The current drift of the item
  135. </p>
  136. <dl class="details">
  137. <dt>Source:</dt>
  138. <dd>../export/js/wb_item.js, line 44</dd>
  139. </dl>
  140. </dd>
  141. <dt id="property:LG.wb.Class.Item#favmeUrl">
  142. <h4 class="name"><span class="type-signature"></span>favmeUrl<span class="type-signature"></span></h4>
  143. </dt>
  144. <dd>
  145. <p class="description">
  146. FavMe Icon Image
  147. </p>
  148. <dl class="details">
  149. <dt>Source:</dt>
  150. <dd>../export/js/wb_item.js, line 13</dd>
  151. </dl>
  152. </dd>
  153. <dt id="property:LG.wb.Class.Item#gottext">
  154. <h4 class="name"><span class="type-signature"></span>gottext<span class="type-signature"></span></h4>
  155. </dt>
  156. <dd>
  157. <p class="description">
  158. true if Wikipedia API returned Text
  159. </p>
  160. <dl class="details">
  161. <dt>Source:</dt>
  162. <dd>../export/js/wb_item.js, line 59</dd>
  163. </dl>
  164. </dd>
  165. <dt id="property:LG.wb.Class.Item#images">
  166. <h4 class="name"><span class="type-signature"></span>images<span class="type-signature"></span></h4>
  167. </dt>
  168. <dd>
  169. <p class="description">
  170. an object to hold some images
  171. </p>
  172. <dl class="details">
  173. <dt>Source:</dt>
  174. <dd>../export/js/wb_item.js, line 13</dd>
  175. </dl>
  176. </dd>
  177. <dt id="property:LG.wb.Class.Item#links">
  178. <h4 class="name"><span class="type-signature"></span>links<span class="type-signature"></span></h4>
  179. </dt>
  180. <dd>
  181. <p class="description">
  182. an array for Wikipedia Links
  183. </p>
  184. <dl class="details">
  185. <dt>Source:</dt>
  186. <dd>../export/js/wb_item.js, line 40</dd>
  187. </dl>
  188. </dd>
  189. <dt id="property:LG.wb.Class.Item#url">
  190. <h4 class="name"><span class="type-signature"></span>url<span class="type-signature"></span></h4>
  191. </dt>
  192. <dd>
  193. <p class="description">
  194. The Wikipedia Page URL of this item
  195. </p>
  196. <dl class="details">
  197. <dt>Source:</dt>
  198. <dd>../export/js/wb_item.js, line 55</dd>
  199. </dl>
  200. </dd>
  201. <dt id="property:LG.wb.Class.Item#wpage">
  202. <h4 class="name"><span class="type-signature"></span>wpage<span class="type-signature"></span></h4>
  203. </dt>
  204. <dd>
  205. <p class="description">
  206. The Wikipage
  207. </p>
  208. <dl class="details">
  209. <dt>Source:</dt>
  210. <dd>../export/js/wb_item.js, line 37</dd>
  211. </dl>
  212. </dd>
  213. <dt id="property:LG.wb.Class.Item#wpurl">
  214. <h4 class="name"><span class="type-signature"></span>wpurl<span class="type-signature"></span></h4>
  215. </dt>
  216. <dd>
  217. <p class="description">
  218. The current Wikipedia api url
  219. </p>
  220. <dl class="details">
  221. <dt>Source:</dt>
  222. <dd>../export/js/wb_item.js, line 49</dd>
  223. </dl>
  224. </dd>
  225. </dl>
  226. <h3 class="subsection-title">Methods</h3>
  227. <dl>
  228. <dt id="LG.wb.Class.Item#animate">
  229. <h4 class="name" id="animate"><span class="type-signature"></span>animate()<span class="type-signature"></span></h4>
  230. </dt>
  231. <dd>
  232. <p class="description">
  233. Animates the Item periodically
  234. </p>
  235. <dl class="details">
  236. <dt>Source:</dt>
  237. <dd>../export/js/wb_item.js, line 13</dd>
  238. </dl>
  239. </dd>
  240. <dt id="LG.wb.Class.Item#clickedFavme">
  241. <h4 class="name" id="clickedFavme"><span class="type-signature"></span>clickedFavme()<span class="type-signature"></span></h4>
  242. </dt>
  243. <dd>
  244. <p class="description">
  245. the favme icon was clicked
  246. </p>
  247. <dl class="details">
  248. <dt>Source:</dt>
  249. <dd>../export/js/wb_item.js, line 13</dd>
  250. </dl>
  251. </dd>
  252. <dt id="LG.wb.Class.Item#clickedImage">
  253. <h4 class="name" id="clickedImage"><span class="type-signature"></span>clickedImage()<span class="type-signature"></span></h4>
  254. </dt>
  255. <dd>
  256. <p class="description">
  257. the image was clicked
  258. </p>
  259. <dl class="details">
  260. <dt>Source:</dt>
  261. <dd>../export/js/wb_item.js, line 13</dd>
  262. </dl>
  263. </dd>
  264. <dt id="LG.wb.Class.Item#clickedLabel">
  265. <h4 class="name" id="clickedLabel"><span class="type-signature"></span>clickedLabel()<span class="type-signature"></span></h4>
  266. </dt>
  267. <dd>
  268. <p class="description">
  269. the label was clicked
  270. </p>
  271. <dl class="details">
  272. <dt>Source:</dt>
  273. <dd>../export/js/wb_item.js, line 13</dd>
  274. </dl>
  275. </dd>
  276. <dt id="LG.wb.Class.Item#goTo">
  277. <h4 class="name" id="goTo"><span class="type-signature"></span>goTo(x, y, z)<span class="type-signature"></span></h4>
  278. </dt>
  279. <dd>
  280. <p class="description">
  281. Tells the item to animate its position to the given coordinates
  282. </p>
  283. <dl class="details">
  284. <dt>Source:</dt>
  285. <dd>../export/js/wb_item.js, line 13</dd>
  286. </dl>
  287. <h5>Parameters:</h5>
  288. <table class="params">
  289. <thead>
  290. <tr>
  291. <th>Name</th>
  292. <th>Type</th>
  293. <th class="last">Description</th>
  294. </tr>
  295. </thead>
  296. <tbody>
  297. <tr>
  298. <td class="name"><code>x</code></td>
  299. <td class="type">
  300. Float
  301. </td>
  302. <td class="description last"></td>
  303. </tr>
  304. <tr>
  305. <td class="name"><code>y</code></td>
  306. <td class="type">
  307. Float
  308. </td>
  309. <td class="description last"></td>
  310. </tr>
  311. <tr>
  312. <td class="name"><code>z</code></td>
  313. <td class="type">
  314. Float
  315. </td>
  316. <td class="description last"></td>
  317. </tr>
  318. </tbody>
  319. </table>
  320. </dd>
  321. <dt id="LG.wb.Class.Item#makeImage">
  322. <h4 class="name" id="makeImage"><span class="type-signature"></span>makeImage(w, h, img)<span class="type-signature"> &rarr; {THREE.Mesh}</span></h4>
  323. </dt>
  324. <dd>
  325. <p class="description">
  326. make us an image of given width and height
  327. </p>
  328. <dl class="details">
  329. <dt>Source:</dt>
  330. <dd>../export/js/wb_item.js, line 13</dd>
  331. </dl>
  332. <h5>Parameters:</h5>
  333. <table class="params">
  334. <thead>
  335. <tr>
  336. <th>Name</th>
  337. <th>Type</th>
  338. <th class="last">Description</th>
  339. </tr>
  340. </thead>
  341. <tbody>
  342. <tr>
  343. <td class="name"><code>w</code></td>
  344. <td class="type">
  345. int
  346. </td>
  347. <td class="description last">The desired width of the image</td>
  348. </tr>
  349. <tr>
  350. <td class="name"><code>h</code></td>
  351. <td class="type">
  352. int
  353. </td>
  354. <td class="description last">The desired height of the image</td>
  355. </tr>
  356. <tr>
  357. <td class="name"><code>img</code></td>
  358. <td class="type">
  359. String
  360. </td>
  361. <td class="description last">The image Url</td>
  362. </tr>
  363. </tbody>
  364. </table>
  365. <h5>Returns:</h5><p>the finished Image</p>
  366. </dd>
  367. <dt id="LG.wb.Class.Item#makeLabel">
  368. <h4 class="name" id="makeLabel"><span class="type-signature"></span>makeLabel(w, h, t, col)<span class="type-signature"> &rarr; {THREE.Mesh}</span></h4>
  369. </dt>
  370. <dd>
  371. <p class="description">
  372. make us a label of given width and height with arbitrary text and color
  373. </p>
  374. <dl class="details">
  375. <dt>Source:</dt>
  376. <dd>../export/js/wb_item.js, line 13</dd>
  377. </dl>
  378. <h5>Parameters:</h5>
  379. <table class="params">
  380. <thead>
  381. <tr>
  382. <th>Name</th>
  383. <th>Type</th>
  384. <th class="last">Description</th>
  385. </tr>
  386. </thead>
  387. <tbody>
  388. <tr>
  389. <td class="name"><code>w</code></td>
  390. <td class="type">
  391. int
  392. </td>
  393. <td class="description last">The desired width of the label</td>
  394. </tr>
  395. <tr>
  396. <td class="name"><code>h</code></td>
  397. <td class="type">
  398. int
  399. </td>
  400. <td class="description last">The desired height of the label</td>
  401. </tr>
  402. <tr>
  403. <td class="name"><code>t</code></td>
  404. <td class="type">
  405. String
  406. </td>
  407. <td class="description last">The desired text of the label</td>
  408. </tr>
  409. <tr>
  410. <td class="name"><code>col</code></td>
  411. <td class="type">
  412. String
  413. </td>
  414. <td class="description last">a string representing the text color e.g. "rgba(127,127,127,1)"</td>
  415. </tr>
  416. </tbody>
  417. </table>
  418. <h5>Returns:</h5><p>the finished Text Label</p>
  419. </dd>
  420. <dt id="LG.wb.Class.Item#search_dbp">
  421. <h4 class="name" id="search_dbp"><span class="type-signature"></span>search_dbp()<span class="type-signature"></span></h4>
  422. </dt>
  423. <dd>
  424. <p class="description">
  425. This will initiate a DBpedia parse action
  426. </p>
  427. <dl class="details">
  428. <dt>Source:</dt>
  429. <dd>../export/js/wb_item.js, line 13</dd>
  430. </dl>
  431. </dd>
  432. <dt id="LG.wb.Class.Item#search_wp">
  433. <h4 class="name" id="search_wp"><span class="type-signature"></span>search_wp()<span class="type-signature"></span></h4>
  434. </dt>
  435. <dd>
  436. <p class="description">
  437. This will initiate a wikipedia parse action
  438. </p>
  439. <dl class="details">
  440. <dt>Source:</dt>
  441. <dd>../export/js/wb_item.js, line 13</dd>
  442. </dl>
  443. </dd>
  444. <dt id="LG.wb.Class.Item#searchComplete">
  445. <h4 class="name" id="searchComplete"><span class="type-signature"></span>searchComplete(searcher)<span class="type-signature"></span></h4>
  446. </dt>
  447. <dd>
  448. <dl class="details">
  449. <dt>Source:</dt>
  450. <dd>../export/js/wb_item.js, line 13</dd>
  451. </dl>
  452. <h5>Parameters:</h5>
  453. <table class="params">
  454. <thead>
  455. <tr>
  456. <th>Name</th>
  457. <th>Type</th>
  458. <th class="last">Description</th>
  459. </tr>
  460. </thead>
  461. <tbody>
  462. <tr>
  463. <td class="name"><code>searcher</code></td>
  464. <td class="type">
  465. Object
  466. </td>
  467. <td class="description last">The google image search api results Callback for google image search</td>
  468. </tr>
  469. </tbody>
  470. </table>
  471. </dd>
  472. <dt id="LG.wb.Class.Item#setimage">
  473. <h4 class="name" id="setimage"><span class="type-signature"></span>setimage(imgurl)<span class="type-signature"></span></h4>
  474. </dt>
  475. <dd>
  476. <p class="description">
  477. Sets the image of the texture this.imgmat to the given url
  478. </p>
  479. <dl class="details">
  480. <dt>Source:</dt>
  481. <dd>../export/js/wb_item.js, line 13</dd>
  482. </dl>
  483. <h5>Parameters:</h5>
  484. <table class="params">
  485. <thead>
  486. <tr>
  487. <th>Name</th>
  488. <th>Type</th>
  489. <th class="last">Description</th>
  490. </tr>
  491. </thead>
  492. <tbody>
  493. <tr>
  494. <td class="name"><code>imgurl</code></td>
  495. <td class="type">
  496. String
  497. </td>
  498. <td class="description last">the url of the image we want to display</td>
  499. </tr>
  500. </tbody>
  501. </table>
  502. </dd>
  503. <dt id="LG.wb.Class.Item#wp_callback">
  504. <h4 class="name" id="wp_callback"><span class="type-signature"></span>wp_callback(data)<span class="type-signature"></span></h4>
  505. </dt>
  506. <dd>
  507. <p class="description">
  508. Wikipedia Calls this function when returning results
  509. </p>
  510. <dl class="details">
  511. <dt>Source:</dt>
  512. <dd>../export/js/wb_item.js, line 13</dd>
  513. </dl>
  514. <h5>Parameters:</h5>
  515. <table class="params">
  516. <thead>
  517. <tr>
  518. <th>Name</th>
  519. <th>Type</th>
  520. <th class="last">Description</th>
  521. </tr>
  522. </thead>
  523. <tbody>
  524. <tr>
  525. <td class="name"><code>data</code></td>
  526. <td class="type">
  527. Array
  528. </td>
  529. <td class="description last">The resultset</td>
  530. </tr>
  531. </tbody>
  532. </table>
  533. </dd>
  534. </dl>
  535. </article>
  536. </section>
  537. </div>
  538. <nav>
  539. <h3>Classes</h3><ul><li><a href="LG.THREE.FirstPersonCamera.html">FirstPersonCamera</a></li><li><a href="LG.wb.Class.Browser.html">Browser</a></li><li><a href="LG.wb.Class.Item.html">Item</a></li></ul><h3>Namespaces</h3><ul><li><a href="LG.html">LG</a></li><li><a href="LG.THREE.html">THREE</a></li><li><a href="LG.wb.html">wb</a></li><li><a href="LG.wb.Class.html">Class</a></li></ul>
  540. </nav>
  541. <br clear="both">
  542. <footer>
  543. Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Aug 19 2011 02:20:28 GMT+0200 (CEST)
  544. </footer>
  545. <script> sh_highlightDocument(); </script>
  546. </body>
  547. </html>