SloodleLayoutEntry.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class SloodleLayoutEntry</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <script src="../media/lib/classTree.js"></script>
  9. <script language="javascript" type="text/javascript">
  10. var imgPlus = new Image();
  11. var imgMinus = new Image();
  12. imgPlus.src = "../media/images/plus.png";
  13. imgMinus.src = "../media/images/minus.png";
  14. function showNode(Node){
  15. switch(navigator.family){
  16. case 'nn4':
  17. // Nav 4.x code fork...
  18. var oTable = document.layers["span" + Node];
  19. var oImg = document.layers["img" + Node];
  20. break;
  21. case 'ie4':
  22. // IE 4/5 code fork...
  23. var oTable = document.all["span" + Node];
  24. var oImg = document.all["img" + Node];
  25. break;
  26. case 'gecko':
  27. // Standards Compliant code fork...
  28. var oTable = document.getElementById("span" + Node);
  29. var oImg = document.getElementById("img" + Node);
  30. break;
  31. }
  32. oImg.src = imgMinus.src;
  33. oTable.style.display = "block";
  34. }
  35. function hideNode(Node){
  36. switch(navigator.family){
  37. case 'nn4':
  38. // Nav 4.x code fork...
  39. var oTable = document.layers["span" + Node];
  40. var oImg = document.layers["img" + Node];
  41. break;
  42. case 'ie4':
  43. // IE 4/5 code fork...
  44. var oTable = document.all["span" + Node];
  45. var oImg = document.all["img" + Node];
  46. break;
  47. case 'gecko':
  48. // Standards Compliant code fork...
  49. var oTable = document.getElementById("span" + Node);
  50. var oImg = document.getElementById("img" + Node);
  51. break;
  52. }
  53. oImg.src = imgPlus.src;
  54. oTable.style.display = "none";
  55. }
  56. function nodeIsVisible(Node){
  57. switch(navigator.family){
  58. case 'nn4':
  59. // Nav 4.x code fork...
  60. var oTable = document.layers["span" + Node];
  61. break;
  62. case 'ie4':
  63. // IE 4/5 code fork...
  64. var oTable = document.all["span" + Node];
  65. break;
  66. case 'gecko':
  67. // Standards Compliant code fork...
  68. var oTable = document.getElementById("span" + Node);
  69. break;
  70. }
  71. return (oTable && oTable.style.display == "block");
  72. }
  73. function toggleNodeVisibility(Node){
  74. if (nodeIsVisible(Node)){
  75. hideNode(Node);
  76. }else{
  77. showNode(Node);
  78. }
  79. }
  80. </script>
  81. </head>
  82. <body>
  83. <div class="page-body">
  84. <h2 class="class-name"><img src="../media/images/Class_logo.png"
  85. alt=" Class"
  86. title=" Class"
  87. style="vertical-align: middle"> SloodleLayoutEntry</h2>
  88. <a name="sec-description"></a>
  89. <div class="info-box">
  90. <div class="info-box-title">Description</div>
  91. <div class="nav-bar">
  92. <span class="disabled">Description</span> |
  93. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  94. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <!-- ========== Info from phpDoc block ========= -->
  98. <p class="short-description">Stores data for a single entry in a layout profile.</p>
  99. <p class="description"><p>Used with <a href="../sloodle/SloodleCourse.html">SloodleCourse</a></p></p>
  100. <p class="notes">
  101. Located in <a class="field" href="_lib---layout_profile.php.html">/lib/layout_profile.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a20">20</a></span>)
  102. </p>
  103. <pre></pre>
  104. </div>
  105. </div>
  106. <a name="sec-var-summary"></a>
  107. <div class="info-box">
  108. <div class="info-box-title">Variable Summary</span></div>
  109. <div class="nav-bar">
  110. <a href="#sec-description">Description</a> |
  111. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  112. |
  113. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  114. </div>
  115. <div class="info-box-body">
  116. <div class="var-summary">
  117. <div class="var-title">
  118. <img src="../media/images/Variable.png" alt=" " />
  119. <span class="var-type">string</span>
  120. <a href="#$name" title="details" class="var-name">$name</a>
  121. </div>
  122. <div class="var-title">
  123. <img src="../media/images/Variable.png" alt=" " />
  124. <span class="var-type">string</span>
  125. <a href="#$position" title="details" class="var-name">$position</a>
  126. </div>
  127. <div class="var-title">
  128. <img src="../media/images/Variable.png" alt=" " />
  129. <span class="var-type">string</span>
  130. <a href="#$rotation" title="details" class="var-name">$rotation</a>
  131. </div>
  132. </div>
  133. </div>
  134. </div>
  135. <a name="sec-method-summary"></a>
  136. <div class="info-box">
  137. <div class="info-box-title">Method Summary</span></div>
  138. <div class="nav-bar">
  139. <a href="#sec-description">Description</a> |
  140. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  141. |
  142. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  143. </div>
  144. <div class="info-box-body">
  145. <div class="method-summary">
  146. <div class="method-definition">
  147. <img src="../media/images/Method.png" alt=" "/>
  148. <span class="method-result">void</span>
  149. <a href="#set_position_xyz" title="details" class="method-name">set_position_xyz</a>
  150. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  151. </div>
  152. <div class="method-definition">
  153. <img src="../media/images/Method.png" alt=" "/>
  154. <span class="method-result">void</span>
  155. <a href="#set_rotation_xyz" title="details" class="method-name">set_rotation_xyz</a>
  156. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  157. </div>
  158. </div>
  159. </div>
  160. </div>
  161. <a name="sec-vars"></a>
  162. <div class="info-box">
  163. <div class="info-box-title">Variables</div>
  164. <div class="nav-bar">
  165. <a href="#sec-description">Description</a> |
  166. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  167. |
  168. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  169. </div>
  170. <div class="info-box-body">
  171. <a name="var$name" id="$name"><!-- --></A>
  172. <div class="oddrow">
  173. <div class="var-header">
  174. <img src="../media/images/Variable.png" />
  175. <span class="var-title">
  176. <span class="var-type">string</span>
  177. <span class="var-name">$name</span>
  178. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a29">29</a></span>)
  179. </span>
  180. </div>
  181. <!-- ========== Info from phpDoc block ========= -->
  182. <p class="short-description">The name of the object this entry represents.</p>
  183. <ul class="tags">
  184. <li><span class="field">access:</span> public</li>
  185. </ul>
  186. </div>
  187. <a name="var$position" id="$position"><!-- --></A>
  188. <div class="evenrow">
  189. <div class="var-header">
  190. <img src="../media/images/Variable.png" />
  191. <span class="var-title">
  192. <span class="var-type">string</span>
  193. <span class="var-name">$position</span>
  194. = <span class="var-default"> '&lt;0.0,0.0,0.0&gt;'</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a36">36</a></span>)
  195. </span>
  196. </div>
  197. <!-- ========== Info from phpDoc block ========= -->
  198. <p class="short-description">The position of the object, as a 3d vector, in string format &quot;&lt;x,y,z&gt;&quot;</p>
  199. <ul class="tags">
  200. <li><span class="field">access:</span> public</li>
  201. </ul>
  202. </div>
  203. <a name="var$rotation" id="$rotation"><!-- --></A>
  204. <div class="oddrow">
  205. <div class="var-header">
  206. <img src="../media/images/Variable.png" />
  207. <span class="var-title">
  208. <span class="var-type">string</span>
  209. <span class="var-name">$rotation</span>
  210. = <span class="var-default"> '&lt;0.0,0.0,0.0&gt;'</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a43">43</a></span>)
  211. </span>
  212. </div>
  213. <!-- ========== Info from phpDoc block ========= -->
  214. <p class="short-description">The rotation of the object, as a 3d vector of Euler angles, in string format &quot;&lt;x,y,z&gt;&quot;</p>
  215. <ul class="tags">
  216. <li><span class="field">access:</span> public</li>
  217. </ul>
  218. </div>
  219. </div>
  220. </div>
  221. <a name="sec-methods"></a>
  222. <div class="info-box">
  223. <div class="info-box-title">Methods</div>
  224. <div class="nav-bar">
  225. <a href="#sec-description">Description</a> |
  226. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  227. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  228. </div>
  229. <div class="info-box-body">
  230. <A NAME='method_detail'></A>
  231. <a name="methodset_position_xyz" id="set_position_xyz"><!-- --></a>
  232. <div class="evenrow">
  233. <div class="method-header">
  234. <img src="../media/images/Method.png" />
  235. <span class="method-title">set_position_xyz</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a55">55</a></span>)
  236. </div>
  237. <!-- ========== Info from phpDoc block ========= -->
  238. <p class="short-description">Sets the position as separate X,Y,Z components</p>
  239. <div class="method-signature">
  240. <span class="method-result">void</span>
  241. <span class="method-name">
  242. set_position_xyz
  243. </span>
  244. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  245. </div>
  246. <ul class="parameters">
  247. <li>
  248. <span class="var-type">float</span>
  249. <span class="var-name">$x</span><span class="var-description">: The X component to set</span> </li>
  250. <li>
  251. <span class="var-type">float</span>
  252. <span class="var-name">$y</span><span class="var-description">: The Y component to set</span> </li>
  253. <li>
  254. <span class="var-type">float</span>
  255. <span class="var-name">$z</span><span class="var-description">: The Z component to set</span> </li>
  256. </ul>
  257. </div>
  258. <a name="methodset_rotation_xyz" id="set_rotation_xyz"><!-- --></a>
  259. <div class="oddrow">
  260. <div class="method-header">
  261. <img src="../media/images/Method.png" />
  262. <span class="method-title">set_rotation_xyz</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a67">67</a></span>)
  263. </div>
  264. <!-- ========== Info from phpDoc block ========= -->
  265. <p class="short-description">Sets the rotation as separate X,Y,Z components</p>
  266. <div class="method-signature">
  267. <span class="method-result">void</span>
  268. <span class="method-name">
  269. set_rotation_xyz
  270. </span>
  271. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  272. </div>
  273. <ul class="parameters">
  274. <li>
  275. <span class="var-type">float</span>
  276. <span class="var-name">$x</span><span class="var-description">: The X component to set</span> </li>
  277. <li>
  278. <span class="var-type">float</span>
  279. <span class="var-name">$y</span><span class="var-description">: The Y component to set</span> </li>
  280. <li>
  281. <span class="var-type">float</span>
  282. <span class="var-name">$z</span><span class="var-description">: The Z component to set</span> </li>
  283. </ul>
  284. </div>
  285. </div>
  286. </div>
  287. <p class="notes" id="credit">
  288. Documentation generated on Mon, 07 Jul 2008 12:32:35 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  289. </p>
  290. </div></body>
  291. </html>