taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
ir_snake.html
View File

@@ -3,6 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ArduinoLibs: Snake Video Game Using an Infrared Remote Control</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -78,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="title">Snake Video Game Using an Infrared Remote Control </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This example demonstrates the use of the <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> and <a class="el" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control.">IRreceiver</a> classes. The full source code follows:</p>
<div class="textblock"><p>This example demonstrates the use of the <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s. ">DMD</a> and <a class="el" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control. ">IRreceiver</a> classes. The full source code follows:</p>
<div class="fragment"><div class="line"><span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span></div>
<div class="line"><span class="comment"> *</span></div>
@@ -116,8 +117,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> <span class="keywordtype">int</span> x, y;</div>
<div class="line">};</div>
<div class="line"></div>
<div class="line"><a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> display;</div>
<div class="line"><a class="code" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control.">IRreceiver</a> ir;</div>
<div class="line"><a class="code" href="classDMD.html">DMD</a> display;</div>
<div class="line"><a class="code" href="classIRreceiver.html">IRreceiver</a> ir;</div>
<div class="line"><span class="keywordtype">bool</span> paused;</div>
<div class="line"><span class="keywordtype">bool</span> gameOver;</div>
<div class="line"><span class="keywordtype">bool</span> waitForStart;</div>
@@ -130,23 +131,23 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"></div>
<div class="line">ISR(TIMER1_OVF_vect)</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8" title="Refresh the display.">refresh</a>();</div>
<div class="line"> display.<a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8">refresh</a>();</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> setup() {</div>
<div class="line"> display.<a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2" title="Enables Timer1 overflow interrupts for updating this display.">enableTimer1</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(Mono5x7);</div>
<div class="line"> display.<a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2">enableTimer1</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(Mono5x7);</div>
<div class="line"> startGame();</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawSnake(<a class="code" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba" title="Type that represents the color of a pixel in a bitmap.">Bitmap::Color</a> color) {</div>
<div class="line"><span class="keywordtype">void</span> drawSnake(<a class="code" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Bitmap::Color</a> color) {</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> index = 0; index &lt; snakeLength; ++index)</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114" title="Sets the pixel at (x, y) to color.">setPixel</a>(snakeParts[index].x, snakeParts[index].y, color);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114">setPixel</a>(snakeParts[index].x, snakeParts[index].y, color);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> loop() {</div>
<div class="line"> <span class="comment">// Handle the &quot;Game Over&quot; state. Any key press starts a new game.</span></div>
<div class="line"> <span class="keywordtype">int</span> cmd = ir.<a class="code" href="classIRreceiver.html#a4b021592a2b089dc2f1e138a38506fda" title="Returns the next command from the remote control.">command</a>();</div>
<div class="line"> <span class="keywordtype">int</span> cmd = ir.<a class="code" href="classIRreceiver.html#a4b021592a2b089dc2f1e138a38506fda">command</a>();</div>
<div class="line"> <span class="keywordflow">if</span> (gameOver) {</div>
<div class="line"> <span class="keywordflow">if</span> (cmd != -1 &amp;&amp; (cmd &amp; IRreceiver::AUTO_REPEAT) == 0)</div>
<div class="line"> startGame();</div>
@@ -159,12 +160,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> <span class="keywordflow">if</span> (cmd == -1) {</div>
<div class="line"> <span class="keywordflow">if</span> ((millis() - lastChange) &gt;= SNAKE_BLINK_TIME) {</div>
<div class="line"> snakeDrawn = !snakeDrawn;</div>
<div class="line"> drawSnake(snakeDrawn ? <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">Bitmap::White</a> : <a class="code" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc" title="Color value corresponding to &quot;black&quot;.">Bitmap::Black</a>);</div>
<div class="line"> drawSnake(snakeDrawn ? <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a> : <a class="code" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Bitmap::Black</a>);</div>
<div class="line"> lastChange += SNAKE_BLINK_TIME;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> drawSnake(<a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">Bitmap::White</a>);</div>
<div class="line"> drawSnake(<a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a>);</div>
<div class="line"> waitForStart = <span class="keyword">false</span>;</div>
<div class="line"> snakeDrawn = <span class="keyword">true</span>;</div>
<div class="line"> lastChange = millis();</div>
@@ -210,18 +211,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> startGame() {</div>
<div class="line"> randomSeed(micros() + analogRead(A0)); <span class="comment">// Analog read adds some noise.</span></div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac61e3f7f625db568e37d88b52b3b2fc" title="Draws a rectangle from (x1, y1) to (x2, y2), with the outline in borderColor and the interior filled ...">drawRect</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>() - 1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height</a>() - 1);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac61e3f7f625db568e37d88b52b3b2fc">drawRect</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>() - 1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a>() - 1);</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> count = 0; count &lt; 10; ++count) {</div>
<div class="line"> <span class="keywordtype">int</span> x, y;</div>
<div class="line"> <span class="keywordflow">if</span> (random(0, 2) == 0) {</div>
<div class="line"> x = random(1, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>() - 5);</div>
<div class="line"> y = random(1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height</a>() - 1);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine</a>(x, y, x + 4, y);</div>
<div class="line"> x = random(1, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>() - 5);</div>
<div class="line"> y = random(1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a>() - 1);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767">drawLine</a>(x, y, x + 4, y);</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
<div class="line"> x = random(1, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>() - 1);</div>
<div class="line"> y = random(1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height</a>() - 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine</a>(x, y, x, y + 2);</div>
<div class="line"> x = random(1, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>() - 1);</div>
<div class="line"> y = random(1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a>() - 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767">drawLine</a>(x, y, x, y + 2);</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> paused = <span class="keyword">false</span>;</div>
@@ -236,8 +237,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> index = 0; index &lt; snakeLength; ++index) {</div>
<div class="line"> snakeParts[index].x = 3 + index;</div>
<div class="line"> snakeParts[index].y = 4;</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114" title="Sets the pixel at (x, y) to color.">setPixel</a></div>
<div class="line"> (snakeParts[index].x, snakeParts[index].y, <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">Bitmap::White</a>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114">setPixel</a></div>
<div class="line"> (snakeParts[index].x, snakeParts[index].y, <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a>);</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"></div>
@@ -249,15 +250,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><span class="keywordtype">void</span> advanceSnake(<span class="keywordtype">bool</span> increase) {</div>
<div class="line"> <span class="keywordtype">int</span> x = snakeParts[snakeLength - 1].x + direction.x;</div>
<div class="line"> <span class="keywordtype">int</span> y = snakeParts[snakeLength - 1].y + direction.y;</div>
<div class="line"> <span class="keywordflow">if</span> (display.<a class="code" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203" title="Returns the color of the pixel at (x, y); either Black or White.">pixel</a>(x, y) == <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">Bitmap::White</a>) {</div>
<div class="line"> <span class="keywordflow">if</span> (display.<a class="code" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203">pixel</a>(x, y) == <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a>) {</div>
<div class="line"> gameOver = <span class="keyword">true</span>;</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(5, 0, <span class="stringliteral">&quot;Game&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(3, 8, <span class="stringliteral">&quot;Over!&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(5, 0, <span class="stringliteral">&quot;Game&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(3, 8, <span class="stringliteral">&quot;Over!&quot;</span>);</div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">if</span> (!increase || snakeLength &gt;= SNAKE_MAX_LENGTH) {</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114" title="Sets the pixel at (x, y) to color.">setPixel</a>(snakeParts[0].x, snakeParts[0].y, <a class="code" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc" title="Color value corresponding to &quot;black&quot;.">Bitmap::Black</a>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114">setPixel</a>(snakeParts[0].x, snakeParts[0].y, <a class="code" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Bitmap::Black</a>);</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> index = 0; index &lt; snakeLength - 1; ++index)</div>
<div class="line"> snakeParts[index] = snakeParts[index + 1];</div>
<div class="line"> } <span class="keywordflow">else</span> {</div>
@@ -265,16 +266,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> }</div>
<div class="line"> snakeParts[snakeLength - 1].x = x;</div>
<div class="line"> snakeParts[snakeLength - 1].y = y;</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114" title="Sets the pixel at (x, y) to color.">setPixel</a>(x, y, <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">Bitmap::White</a>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac994b75418e7d37ec66829437329114">setPixel</a>(x, y, <a class="code" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (increase)</div>
<div class="line"> incStep = 0;</div>
<div class="line">}</div>
</div><!-- fragment --> </div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>