Code owners
Assign users and groups as approvers for specific file changes. Learn more.
class_pic_puzzle_1_1_nonogram.html 12.94 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.10"/>
<title>PicPuzzle: PicPuzzle.Nonogram Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PicPuzzle
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>PicPuzzle</b></li><li class="navelem"><a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_pic_puzzle_1_1_nonogram-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PicPuzzle.Nonogram Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for PicPuzzle.Nonogram:</div>
<div class="dyncontent">
<div class="center"><img src="class_pic_puzzle_1_1_nonogram__coll__graph.png" border="0" usemap="#_pic_puzzle_8_nonogram_coll__map" alt="Collaboration graph"/></div>
<map name="_pic_puzzle_8_nonogram_coll__map" id="_pic_puzzle_8_nonogram_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acd1150af27cd24b96ca0301af51098fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#acd1150af27cd24b96ca0301af51098fd">Nonogram</a> (File image) throws IOException </td></tr>
<tr class="separator:acd1150af27cd24b96ca0301af51098fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b871baa6c26e9bb12e1f06406065b01"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#a9b871baa6c26e9bb12e1f06406065b01">Nonogram</a> (int width, int height)</td></tr>
<tr class="separator:a9b871baa6c26e9bb12e1f06406065b01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d52bfc7ade8e3da3698cb60f8ef4601"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#a2d52bfc7ade8e3da3698cb60f8ef4601">setPixel</a> (int x, int y, boolean value)</td></tr><tr class="separator:a2d52bfc7ade8e3da3698cb60f8ef4601"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fd3dabbde16859532c85f30f4db8d19"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#a1fd3dabbde16859532c85f30f4db8d19">getPixel</a> (int x, int y)</td></tr>
<tr class="separator:a1fd3dabbde16859532c85f30f4db8d19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88f0fd20cc7543ca4f84892d6e3b8fe8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#a88f0fd20cc7543ca4f84892d6e3b8fe8">getWidth</a> ()</td></tr>
<tr class="separator:a88f0fd20cc7543ca4f84892d6e3b8fe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a843e56a4da9efcab29813597e2fc06e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#a843e56a4da9efcab29813597e2fc06e1">getHeight</a> ()</td></tr>
<tr class="separator:a843e56a4da9efcab29813597e2fc06e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaeef1c59d9be340084ca7554b4eca339"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pic_puzzle_1_1_nonogram.html#aaeef1c59d9be340084ca7554b4eca339">equals</a> (<a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> n2)</td></tr>
<tr class="separator:aaeef1c59d9be340084ca7554b4eca339"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used to represent the state of a <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> which is a type of logic puzzle </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="acd1150af27cd24b96ca0301af51098fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PicPuzzle.Nonogram.Nonogram </td>
<td>(</td>
<td class="paramtype">File </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td> throws IOException</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> from an image </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>A black and white image to initialize the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a>'s state to </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b871baa6c26e9bb12e1f06406065b01"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PicPuzzle.Nonogram.Nonogram </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a blank <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> where all pixels are white </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>The width of the new <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </td></tr>
<tr><td class="paramname">height</td><td>The height of the new <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </td></tr>
</table>
</dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aaeef1c59d9be340084ca7554b4eca339"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean PicPuzzle.Nonogram.equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </td>
<td class="paramname"><em>n2</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare this <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> to another </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n2</td><td>The other <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> to compare with </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the Nonograms have the exact same pixels, otherwise false </dd></dl>
</div>
</div>
<a class="anchor" id="a843e56a4da9efcab29813597e2fc06e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PicPuzzle.Nonogram.getHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the height of the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </p><dl class="section return"><dt>Returns</dt><dd>The height of the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> in pixels </dd></dl>
</div>
</div>
<a class="anchor" id="a1fd3dabbde16859532c85f30f4db8d19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean PicPuzzle.Nonogram.getPixel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get if a pixel is black or white </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The x coordinate of the pixel to get </td></tr> <tr><td class="paramname">y</td><td>The y coordinate of the pixel to get </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the pixel is black this is true, otherwise it is false </dd></dl>
</div>
</div>
<a class="anchor" id="a88f0fd20cc7543ca4f84892d6e3b8fe8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PicPuzzle.Nonogram.getWidth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the width of the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> </p><dl class="section return"><dt>Returns</dt><dd>The width of the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> in pixels </dd></dl>
</div>
</div>
<a class="anchor" id="a2d52bfc7ade8e3da3698cb60f8ef4601"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PicPuzzle.Nonogram.setPixel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a pixel in the <a class="el" href="class_pic_puzzle_1_1_nonogram.html">Nonogram</a> to either black or white </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The x coordinate of the pixel to set </td></tr>
<tr><td class="paramname">y</td><td>The y coordinate of the pixel to set </td></tr>
<tr><td class="paramname">value</td><td>If true, set the pixel to black, otherwise set it to white </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/PicPuzzle/Nonogram.java</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>