Simple single-color 8x8x8 LED Cube with AVRs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

AFrame.html 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_29) on Sun Dec 04 21:35:10 CET 2011 -->
  6. <TITLE>
  7. AFrame
  8. </TITLE>
  9. <META NAME="date" CONTENT="2011-12-04">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="AFrame";
  16. }
  17. }
  18. </SCRIPT>
  19. <NOSCRIPT>
  20. </NOSCRIPT>
  21. </HEAD>
  22. <BODY BGCOLOR="white" onload="windowTitle();">
  23. <HR>
  24. <!-- ========= START OF TOP NAVBAR ======= -->
  25. <A NAME="navbar_top"><!-- --></A>
  26. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  27. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  28. <TR>
  29. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  30. <A NAME="navbar_top_firstrow"><!-- --></A>
  31. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  32. <TR ALIGN="center" VALIGN="top">
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  39. </TR>
  40. </TABLE>
  41. </TD>
  42. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  43. </EM>
  44. </TD>
  45. </TR>
  46. <TR>
  47. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  48. &nbsp;PREV CLASS&nbsp;
  49. &nbsp;<A HREF="Animation.html" title="class in &lt;Unnamed&gt;"><B>NEXT CLASS</B></A></FONT></TD>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. <A HREF="index.html?AFrame.html" target="_top"><B>FRAMES</B></A> &nbsp;
  52. &nbsp;<A HREF="AFrame.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  53. &nbsp;<SCRIPT type="text/javascript">
  54. <!--
  55. if(window==top) {
  56. document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
  57. }
  58. //-->
  59. </SCRIPT>
  60. <NOSCRIPT>
  61. <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
  62. </NOSCRIPT>
  63. </FONT></TD>
  64. </TR>
  65. <TR>
  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  67. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  68. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  69. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  70. </TR>
  71. </TABLE>
  72. <A NAME="skip-navbar_top"></A>
  73. <!-- ========= END OF TOP NAVBAR ========= -->
  74. <HR>
  75. <!-- ======== START OF CLASS DATA ======== -->
  76. <H2>
  77. Class AFrame</H2>
  78. <PRE>
  79. java.lang.Object
  80. <IMG SRC="./resources/inherit.gif" ALT="extended by "><B>AFrame</B>
  81. </PRE>
  82. <HR>
  83. <DL>
  84. <DT><PRE>public class <B>AFrame</B><DT>extends java.lang.Object</DL>
  85. </PRE>
  86. <P>
  87. The representation of a single frame. Contains the data of all 512 LEDs in a given time.
  88. <P>
  89. <P>
  90. <HR>
  91. <P>
  92. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  93. <A NAME="constructor_summary"><!-- --></A>
  94. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  95. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  96. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  97. <B>Constructor Summary</B></FONT></TH>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD><CODE><B><A HREF="AFrame.html#AFrame()">AFrame</A></B>()</CODE>
  101. <BR>
  102. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  103. </TR>
  104. </TABLE>
  105. &nbsp;
  106. <!-- ========== METHOD SUMMARY =========== -->
  107. <A NAME="method_summary"><!-- --></A>
  108. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  109. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  110. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  111. <B>Method Summary</B></FONT></TH>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  115. <CODE>&nbsp;short[]</CODE></FONT></TD>
  116. <TD><CODE><B><A HREF="AFrame.html#getData()">getData</A></B>()</CODE>
  117. <BR>
  118. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets tha Data of this Frame</TD>
  119. </TR>
  120. <TR BGCOLOR="white" CLASS="TableRowColor">
  121. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  122. <CODE>&nbsp;short[]</CODE></FONT></TD>
  123. <TD><CODE><B><A HREF="AFrame.html#getLayer(int)">getLayer</A></B>(int&nbsp;i)</CODE>
  124. <BR>
  125. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Data of the Layer you want</TD>
  126. </TR>
  127. <TR BGCOLOR="white" CLASS="TableRowColor">
  128. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  129. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  130. <TD><CODE><B><A HREF="AFrame.html#getName()">getName</A></B>()</CODE>
  131. <BR>
  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Name of this Frame</TD>
  133. </TR>
  134. <TR BGCOLOR="white" CLASS="TableRowColor">
  135. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  136. <CODE>&nbsp;short</CODE></FONT></TD>
  137. <TD><CODE><B><A HREF="AFrame.html#getTime()">getTime</A></B>()</CODE>
  138. <BR>
  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Duration of this Frame</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  143. <CODE>&nbsp;void</CODE></FONT></TD>
  144. <TD><CODE><B><A HREF="AFrame.html#setData(short[])">setData</A></B>(short[]&nbsp;d)</CODE>
  145. <BR>
  146. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Data of this Frame</TD>
  147. </TR>
  148. <TR BGCOLOR="white" CLASS="TableRowColor">
  149. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  150. <CODE>&nbsp;void</CODE></FONT></TD>
  151. <TD><CODE><B><A HREF="AFrame.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;s)</CODE>
  152. <BR>
  153. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Name of this Frame</TD>
  154. </TR>
  155. <TR BGCOLOR="white" CLASS="TableRowColor">
  156. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  157. <CODE>&nbsp;void</CODE></FONT></TD>
  158. <TD><CODE><B><A HREF="AFrame.html#setTime(short)">setTime</A></B>(short&nbsp;t)</CODE>
  159. <BR>
  160. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Duration of this Frame</TD>
  161. </TR>
  162. </TABLE>
  163. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  164. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  165. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  166. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  167. </TR>
  168. <TR BGCOLOR="white" CLASS="TableRowColor">
  169. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  170. </TR>
  171. </TABLE>
  172. &nbsp;
  173. <P>
  174. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  175. <A NAME="constructor_detail"><!-- --></A>
  176. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  177. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  178. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  179. <B>Constructor Detail</B></FONT></TH>
  180. </TR>
  181. </TABLE>
  182. <A NAME="AFrame()"><!-- --></A><H3>
  183. AFrame</H3>
  184. <PRE>
  185. public <B>AFrame</B>()</PRE>
  186. <DL>
  187. </DL>
  188. <!-- ============ METHOD DETAIL ========== -->
  189. <A NAME="method_detail"><!-- --></A>
  190. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  191. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  192. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  193. <B>Method Detail</B></FONT></TH>
  194. </TR>
  195. </TABLE>
  196. <A NAME="getName()"><!-- --></A><H3>
  197. getName</H3>
  198. <PRE>
  199. public java.lang.String <B>getName</B>()</PRE>
  200. <DL>
  201. <DD>Gets the Name of this Frame
  202. <P>
  203. <DD><DL>
  204. <DT><B>Returns:</B><DD>Name of the Frame</DL>
  205. </DD>
  206. </DL>
  207. <HR>
  208. <A NAME="setName(java.lang.String)"><!-- --></A><H3>
  209. setName</H3>
  210. <PRE>
  211. public void <B>setName</B>(java.lang.String&nbsp;s)</PRE>
  212. <DL>
  213. <DD>Sets the Name of this Frame
  214. <P>
  215. <DD><DL>
  216. <DT><B>Parameters:</B><DD><CODE>s</CODE> - New Name</DL>
  217. </DD>
  218. </DL>
  219. <HR>
  220. <A NAME="setData(short[])"><!-- --></A><H3>
  221. setData</H3>
  222. <PRE>
  223. public void <B>setData</B>(short[]&nbsp;d)</PRE>
  224. <DL>
  225. <DD>Sets the Data of this Frame
  226. <P>
  227. <DD><DL>
  228. <DT><B>Parameters:</B><DD><CODE>d</CODE> - 64 bytes that contain data (8 bit per byte, so 8 LEDs)</DL>
  229. </DD>
  230. </DL>
  231. <HR>
  232. <A NAME="getData()"><!-- --></A><H3>
  233. getData</H3>
  234. <PRE>
  235. public short[] <B>getData</B>()</PRE>
  236. <DL>
  237. <DD>Gets tha Data of this Frame
  238. <P>
  239. <DD><DL>
  240. <DT><B>Returns:</B><DD>64 bytes that contain data (8 bits / LEDs per byte)</DL>
  241. </DD>
  242. </DL>
  243. <HR>
  244. <A NAME="setTime(short)"><!-- --></A><H3>
  245. setTime</H3>
  246. <PRE>
  247. public void <B>setTime</B>(short&nbsp;t)</PRE>
  248. <DL>
  249. <DD>Sets the Duration of this Frame
  250. <P>
  251. <DD><DL>
  252. <DT><B>Parameters:</B><DD><CODE>t</CODE> - Duration of frame in (( t * (1/24) ) + (1/24)) seconds</DL>
  253. </DD>
  254. </DL>
  255. <HR>
  256. <A NAME="getTime()"><!-- --></A><H3>
  257. getTime</H3>
  258. <PRE>
  259. public short <B>getTime</B>()</PRE>
  260. <DL>
  261. <DD>Gets the Duration of this Frame
  262. <P>
  263. <DD><DL>
  264. <DT><B>Returns:</B><DD>Duration of frame.<DT><B>See Also:</B><DD><A HREF="AFrame.html#setTime(short)"><CODE>setTime()</CODE></A></DL>
  265. </DD>
  266. </DL>
  267. <HR>
  268. <A NAME="getLayer(int)"><!-- --></A><H3>
  269. getLayer</H3>
  270. <PRE>
  271. public short[] <B>getLayer</B>(int&nbsp;i)</PRE>
  272. <DL>
  273. <DD>Gets the Data of the Layer you want
  274. <P>
  275. <DD><DL>
  276. <DT><B>Parameters:</B><DD><CODE>i</CODE> - Number of Layer you want
  277. <DT><B>Returns:</B><DD>8 byte array with data of selected layer</DL>
  278. </DD>
  279. </DL>
  280. <!-- ========= END OF CLASS DATA ========= -->
  281. <HR>
  282. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  283. <A NAME="navbar_bottom"><!-- --></A>
  284. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  285. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  286. <TR>
  287. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  288. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  289. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  290. <TR ALIGN="center" VALIGN="top">
  291. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  292. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  293. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  294. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  295. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  296. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  297. </TR>
  298. </TABLE>
  299. </TD>
  300. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  301. </EM>
  302. </TD>
  303. </TR>
  304. <TR>
  305. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  306. &nbsp;PREV CLASS&nbsp;
  307. &nbsp;<A HREF="Animation.html" title="class in &lt;Unnamed&gt;"><B>NEXT CLASS</B></A></FONT></TD>
  308. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  309. <A HREF="index.html?AFrame.html" target="_top"><B>FRAMES</B></A> &nbsp;
  310. &nbsp;<A HREF="AFrame.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  311. &nbsp;<SCRIPT type="text/javascript">
  312. <!--
  313. if(window==top) {
  314. document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
  315. }
  316. //-->
  317. </SCRIPT>
  318. <NOSCRIPT>
  319. <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
  320. </NOSCRIPT>
  321. </FONT></TD>
  322. </TR>
  323. <TR>
  324. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  325. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  326. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  327. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  328. </TR>
  329. </TABLE>
  330. <A NAME="skip-navbar_bottom"></A>
  331. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  332. <HR>
  333. </BODY>
  334. </HTML>